V-LiuShuang
37 lines
3.8 KiB
Markdown
37 lines
3.8 KiB
Markdown
# 代码编写规范
|
|
|
|
| 类目 | 使用原则 | 描述 |
|
|
|:--- | :--- | :--- |
|
|
| 工单 | 适当应用 | 阅读文档[worksheet.md](../references/worksheet.md) <br/>拿捏不准请询问用户是否需要使用工单 |
|
|
| JDK11~21的新特性 | 积极使用 | 局部变量类型推断、Switch表达式、模式匹配、文本块、记录类、虚拟线程。<br/>**虚拟线程应当用于IO密集型的任务，而不是CPU密集型任务。**|
|
|
| 设计模式 | 非常看重 | 为了降低代码耦合度，提高可维护性。<br/>请积极的采用工厂、模板、策略、发布订阅等常用的设计模式。<br/>一个Java源文件的代码行数不得超过300行，超出则拆成多个文件。<br/>一个方法体内的行数不得超过20行，超出则拆成多个方法。<br/>对于发布订阅模式，请根据以下情况判断：<br/>跨服务通信、集群实例广播消息，优先使用RocketMQ消息队列。<br/>进程内通信则使用ApplicationEventPublisher和@EventListener即可。|
|
|
| Lombok注解 | 积极使用 | 无需担心编译速度被拖慢。|
|
|
| Null值处理 | 适当应用 | 优先考虑`Optional.ofNullable(obj)`而不是`if (obj == null)` |
|
|
| Stream | 积极使用 | 优先使用Stream而不是循环，若map代码块超过5行就单独写一个方法。<br/>如果需要中间对象则优先使用记录类，记录类和DTO存放在一个目录。|
|
|
| 工具类 | 积极使用 | 优先采纳hutool，除非hutool没有提供才新建一个工具类。|
|
|
| 构建对象 | 非常看重 | 构建JavaBean对象，优先使用构造函数而不是单独写工具类或方法。<br/>只有3个以内的属性，应提供一个全部参数的构造函数。|
|
|
| List | 适当应用 | 在非多线程场景，默认用`ArrayList`。<br/>有需要按照插入顺序遍历元素的场景，使用`LinkedList`。<br/>需考虑线程安全用`CopyOnWriteArrayList`。|
|
|
| Set | 适当应用 | 在非多线程场景，默认用`HashSet`。<br/>按照插入顺序遍历元素的场景用`LinkedHashSet`。<br/>有排序的需求则使用`TreeSet`。<br/>需考虑线程安全用：<br/>`cn.hutool.core.collection.ConcurrentHashSet`<br/>`ConcurrentSkipListSet`<br/>`CopyOnWriteArraySet`|
|
|
| Map | 适当应用 | 在非线程场景，默认用`HashMap`。<br/>对排序要求考虑用LinkedHashMap或TreeMap。<br/>如果存在并发场景，用`ConcurrentHashMap`或`ConcurrentSkipListMap`。|
|
|
| Queue | 适当应用 | 要控制内存，用`ArrayBlockingQueue`。<br/>经典生产者消费者，用`LinkedBlockingQueue`。<br/>要窃取任务，用`LinkedBlockingDeque`。<br/>追求极致吞吐且不怕队列暴涨，用`ConcurrentLinkedQueue`。<br/>必须双端且高吞吐，用`ConcurrentLinkedDeque`。|
|
|
| Lock | 适当应用 | 分布式锁使用`Redisson`相关API<br/>单机使用`ReentrantLock`、`StampedLock`。|
|
|
|
|
## 实体类与MySQL字段类型映射规则
|
|
|
|
|实体类字段类型|MySQL字段类型|
|
|
| --- | --- |
|
|
| String | VARCHAT(255) |
|
|
| Long | BIGINT |
|
|
| Integer | INT |
|
|
| LocalDate | DATE |
|
|
| LocalDateTime | DATETIME |
|
|
| BigDecimal | DECIMAL(14, 2) |
|
|
|
|
- 数据库表结构字段名称、实体类字段名称，采用驼峰与下划线映射的方式。
|
|
- `@TableField`注解中`typeHandler`等于`JacksonTypeHandler.class`时，表结构字段默认JSON类型。
|
|
- 实体类字段包含`@NotNull`注解，需要结合`@Schema`注解中的`defaultValue`属性判断是否需要设置默认值。
|
|
- 主键列是否采用MySQL自增序列，取决于实体类被`@TableId`注解修饰的字段，要看其`type`属性，如果是`IdType.AUTO`则使用自增，否则不需要。
|
|
- 如果`@Schema`注解指定了`maxLength`属性，按如下原则设置字段类型：
|
|
- 数值小于或等于2000，使用VARCHAR
|
|
- 数值大于2000且小于10000，使用TEXT
|
|
- 数值大于10000，使用LONGTEXT |