mcpField
1
122-java-type-design

122-java-type-design

github.com/jabrena开发456398 次安装1 天前更新
代码仓库

关于 122-java-type-design

面向 Java 类型设计审查与重构的技能,帮助提升代码清晰度和可维护性。其示例指导涵盖类型安全、领域建模、命名与结构,并要求修改前编译、完成后验证。

主要功能

  1. 01类型层次与命名规范
  2. 02值对象与泛型
  3. 03流式接口与构建器
  4. 04类型选择与接口设计
  5. 05修改前编译及完整构建验证

适用场景

  1. 01审查 Java 类型设计
  2. 02用值对象替代原始值
  3. 03重构类型层次与流式 API

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/jabrena/plinth --skill 122-java-type-design

安装后在 Claude Code 中输入/122-java-type-design确认已加载。

附带文件references/122-java-type-design.md

详细介绍

Java 中的类型设计思维

运用全面的类型设计原则审查并改进 Java 代码,将排版概念应用于代码结构和组织,以最大限度提升清晰度和可维护性。

此技能涵盖哪些内容?

  • 清晰的类型层次结构:嵌套静态类、逻辑结构
  • 一致的命名约定:领域驱动模式、统一的接口与实现命名
  • 通过合理留白提升可读性
  • 类型安全的封装类型:用值对象取代基本类型偏执(EmailAddress、Money)
  • 泛型类型参数:灵活的可复用类型、有界参数
  • 领域专用的流畅接口:构建器模式、方法链式调用
  • 类型权重:概念重要性——核心领域类型、支持类型与工具类型
  • 通过接口体现类型对比:分离契约与实现
  • 对齐的方法签名:相关类之间保持参数和返回类型一致
  • 自描述代码:清晰且具有描述性的名称
  • 对精度敏感的计算(金融/货币操作)使用 BigDecimal
  • 合理选择类型:Optional、Set 与 List 的选择,以及优先使用接口而非具体类型

范围: 参考文档按示例(好的/不好的代码模式)介绍各个核心领域。请根据适用的示例应用建议。

约束

在进行任何类型设计更改之前,确保项目可以编译。如果编译失败,请立即停止,解决问题后再继续。改进完成后,运行完整验证。

  • 必须执行:进行任何更改前,运行 ./mvnw compile 或 mvn compile
  • 安全要求:如果编译失败,请立即停止,不要继续——编译失败属于阻断条件
  • 验证:应用改进后,运行 ./mvnw clean verify 或 mvn clean verify
  • 应用前:阅读参考文档,了解详细示例、好的/不好的模式及约束
  • 边界情况:如果请求范围不明确,请停止并提出澄清问题,然后再应用更改
  • 边界情况:如果缺少必需的输入、文件或工具,请说明缺少的内容,并询问是否继续提供设置指导

何时使用此技能

  • 审查 Java 代码的类型设计
  • 改进 Java 代码的类型设计
  • 修复 Java 代码中的基本类型偏执
  • 在 Java 代码中创建值对象
  • 在 Java 代码中创建类型层次结构
  • 在 Java 代码中创建流畅接口

工作流

  1. 在类型设计更改前编译项目

运行 ./mvnw compile 或 mvn compile,如果编译失败,请立即停止。

  1. 阅读类型设计参考文档并检查代码

阅读 references/122-java-type-design.md,找出类型层次结构、命名和值对象方面的改进点。

  1. 应用类型设计重构

根据适用模式,实施选定的类型安全性和可读性改进。

  1. 通过完整构建进行验证

应用改进后,运行 ./mvnw clean verify 或 mvn clean verify。

参考

详细指导、示例和约束请参阅 references/122-java-type-design.md。

评论

支持 Markdown