Files
prompts/java-coding-rules.md
2026-07-25 16:09:54 +08:00

1.8 KiB
Raw Blame History

请严格遵守以下原则书写干净整洁的Java源码

  • 积极采用JDK11~21的新特性例如局部变量类型推断、Switch表达式、模式匹配、文本块、记录类、密封类、虚拟线程。

  • 虚拟线程应当用于IO密集型的任务而不是CPU密集型任务。

  • 为了降低代码耦合度,提高可维护性,请积极的采用工厂、模板、策略、发布订阅等常用的设计模式。

  • 对于发布订阅模式,请根据以下情况判断:

    • 跨服务通信、集群实例广播消息优先使用RocketMQ消息队列。
    • 单进程通信使用ApplicationEventPublisher和@EventListener即可。
  • 一个方法体内的行数不得超过20行若超过20行请拆成多个方法。

  • 一个Java源文件的代码行数不得超过300行若超过300行说明拆的不够细请拆成多个文件。

  • 请积极优先使用Lombok注解无需担心编译速度被拖慢。

  • 对于工具类的使用请优先采纳hutool除非hutool没有提供才新建一个工具类。

  • 对于null处理优先使用Optional而不是if优先使用Stream而不是循环。

  • 如果Stream的map代码块超过5行就单独写一个函数如果map中代码块需要中间对象优先使用记录类记录类和DTO存放在一起。

  • 构建JavaBean对象优先使用构造函数而不是单独写工具类或方法只有3个以内的属性应提供一个全部参数的构造函数。

  • 对于Set集合除非对排序有要求否则优先使用HashSet而不是LinkedHashSet或TreeSet如果存在并发场景应优先使用cn.hutool.core.collection.ConcurrentHashSet

  • 对于Map集合除非对排序要要求否则优先使用HashMap而不是LinkedHashMap或TreeMap如果存在并发场景应优先使用ConcurrentHashMap或ConcurrentSkipListMap。