add
This commit is contained in:
V-LiuShuang
+76
-14
@@ -156,20 +156,82 @@ mis-modules\mis-agent\src\main\
|
|||||||
|
|
||||||
## 代码编写规范
|
## 代码编写规范
|
||||||
|
|
||||||
| 类目 | 使用原则 | 描述 |
|
<table>
|
||||||
|:--- | :--- | :--- |
|
<colgroup>
|
||||||
| JDK11~21的新特性 | 积极使用 | 局部变量类型推断、Switch表达式、模式匹配、文本块、记录类、密封类、虚拟线程，虚拟线程应当用于IO密集型的任务，而不是CPU密集型任务。|
|
<col style="width:14%">
|
||||||
| 设计模式 | 非常看重 | 为了降低代码耦合度，提高可维护性，请积极的采用工厂、模板、策略、发布订阅等常用的设计模式。一个Java源文件的代码行数不得超过300行，超出则拆成多个文件，一个方法体内的行数不得超过20行，超出则拆成多个方法。对于发布订阅模式，请根据以下情况判断：跨服务通信、集群实例广播消息，优先使用RocketMQ消息队列。进程内通信则使用ApplicationEventPublisher和@EventListener即可。|
|
<col style="width:10%; white-space:nowrap;">
|
||||||
| Lombok注解 | 积极使用 | 无需担心编译速度被拖慢。|
|
<col style="width:76%">
|
||||||
| Null值处理 | 适当应用 | 优先考虑`Optional.ofNullable(obj)`而不是`if (obj == null)` |
|
</colgroup>
|
||||||
| Stream | 积极使用 | 优先使用Stream而不是循环，若map代码块超过5行就单独写一个方法，如果需要中间对象则优先使用记录类，记录类和DTO存放在一个目录。|
|
<thead>
|
||||||
| 工具类 | 积极使用 | 优先采纳hutool，除非hutool没有提供才新建一个工具类。|
|
<tr>
|
||||||
| 构建对象 | 非常看重 | 构建JavaBean对象，优先使用构造函数而不是单独写工具类或方法，只有3个以内的属性，应提供一个全部参数的构造函数。|
|
<th align="left">类目</th>
|
||||||
| List | 适当应用 | 在非多线程场景，默认用ArrayList就够了。只有需要按照插入顺序遍历元素的场景，才考虑使用LinkedList。需考虑线程安全用CopyOnWriteArrayList。|
|
<th align="left" style="white-space:nowrap;">使用原则</th>
|
||||||
| Set | 适当应用 | 在非多线程场景，默认用HashSet。对排序要求考虑用LinkedHashSet或TreeSet。需考虑线程安全用`cn.hutool.core.collection.ConcurrentHashSet`、ConcurrentSkipListSet、CopyOnWriteArraySet等。|
|
<th align="left">描述</th>
|
||||||
| Map | 适当应用 | 在非线程场景，默认使用HashMap就够了。对排序要求考虑用LinkedHashMap或TreeMap。如果存在并发场景，需考虑线程安全用ConcurrentHashMap或ConcurrentSkipListMap等JUC工具包。|
|
</tr>
|
||||||
| Queue | 适当应用 | 要控制内存，用ArrayBlockingQueue。经典生产者消费者，用LinkedBlockingQueue。要窃取任务，用LinkedBlockingDeque。追求极致吞吐且不怕队列暴涨，用ConcurrentLinkedQueue。必须双端且高吞吐，用ConcurrentLinkedDeque。|
|
</thead>
|
||||||
| Lock | 适当应用 | 分布式锁使用Redisson相关API，单机使用ReentrantLock、StampedLock、ReentrantReadWriteLock即可。|
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left">JDK11~21的新特性</td>
|
||||||
|
<td align="left" style="white-space:nowrap;">积极使用</td>
|
||||||
|
<td align="left">局部变量类型推断、Switch表达式、模式匹配、文本块、记录类、密封类、虚拟线程，虚拟线程应当用于IO密集型的任务，而不是CPU密集型任务。</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left">设计模式</td>
|
||||||
|
<td align="left" style="white-space:nowrap;">非常看重</td>
|
||||||
|
<td align="left">为了降低代码耦合度，提高可维护性，请积极的采用工厂、模板、策略、发布订阅等常用的设计模式。一个Java源文件的代码行数不得超过300行，超出则拆成多个文件，一个方法体内的行数不得超过20行，超出则拆成多个方法。对于发布订阅模式，请根据以下情况判断：跨服务通信、集群实例广播消息，优先使用RocketMQ消息队列。进程内通信则使用ApplicationEventPublisher和@EventListener即可。</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left">Lombok注解</td>
|
||||||
|
<td align="left" style="white-space:nowrap;">积极使用</td>
|
||||||
|
<td align="left">无需担心编译速度被拖慢。</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left">Null值处理</td>
|
||||||
|
<td align="left" style="white-space:nowrap;">适当应用</td>
|
||||||
|
<td align="left">优先考虑<code>Optional.ofNullable(obj)</code>而不是<code>if (obj == null)</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left">Stream</td>
|
||||||
|
<td align="left" style="white-space:nowrap;">积极使用</td>
|
||||||
|
<td align="left">优先使用Stream而不是循环，若map代码块超过5行就单独写一个方法，如果需要中间对象则优先使用记录类，记录类和DTO存放在一个目录。</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left">工具类</td>
|
||||||
|
<td align="left" style="white-space:nowrap;">积极使用</td>
|
||||||
|
<td align="left">优先采纳hutool，除非hutool没有提供才新建一个工具类。</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left">构建对象</td>
|
||||||
|
<td align="left" style="white-space:nowrap;">非常看重</td>
|
||||||
|
<td align="left">构建JavaBean对象，优先使用构造函数而不是单独写工具类或方法，只有3个以内的属性，应提供一个全部参数的构造函数。</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left">List</td>
|
||||||
|
<td align="left" style="white-space:nowrap;">适当应用</td>
|
||||||
|
<td align="left">在非多线程场景，默认用ArrayList就够了。只有需要按照插入顺序遍历元素的场景，才考虑使用LinkedList。需考虑线程安全用CopyOnWriteArrayList。</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left">Set</td>
|
||||||
|
<td align="left" style="white-space:nowrap;">适当应用</td>
|
||||||
|
<td align="left">在非多线程场景，默认用HashSet。对排序要求考虑用LinkedHashSet或TreeSet。需考虑线程安全用<code>cn.hutool.core.collection.ConcurrentHashSet</code>、ConcurrentSkipListSet、CopyOnWriteArraySet等。</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left">Map</td>
|
||||||
|
<td align="left" style="white-space:nowrap;">适当应用</td>
|
||||||
|
<td align="left">在非线程场景，默认使用HashMap就够了。对排序要求考虑用LinkedHashMap或TreeMap。如果存在并发场景，需考虑线程安全用ConcurrentHashMap或ConcurrentSkipListMap等JUC工具包。</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left">Queue</td>
|
||||||
|
<td align="left" style="white-space:nowrap;">适当应用</td>
|
||||||
|
<td align="left">要控制内存，用ArrayBlockingQueue。经典生产者消费者，用LinkedBlockingQueue。要窃取任务，用LinkedBlockingDeque。追求极致吞吐且不怕队列暴涨，用ConcurrentLinkedQueue。必须双端且高吞吐，用ConcurrentLinkedDeque。</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left">Lock</td>
|
||||||
|
<td align="left" style="white-space:nowrap;">适当应用</td>
|
||||||
|
<td align="left">分布式锁使用Redisson相关API，单机使用ReentrantLock、StampedLock、ReentrantReadWriteLock即可。</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
## 实体类与MySQL字段类型映射规则
|
## 实体类与MySQL字段类型映射规则
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user