编程约规

📄️ （一）命名风格

1. 【强制】所有编程相关的命名均不能以下划线或美元符号开始，也不能以下下划线或美元符号结束。

📄️ （二）常量定义

1. 【强制】不允许任何魔法值(即未经预先定义的常量)直接出现在代码中。

📄️ （三）代码格式

1. 【强制】如果大括号内为空，简洁地写成{}即可，大括号中间无需换行和空格;如果是非空代码块，则:

📄️ （四）OOP规约

1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用 类名来访问即可。

📄️ （五）时期时间

1. 【强制】日期格式化时，传入 pattern 中表示年份统一使用小写的 y。

📄️ （六）集合处理

1. 【强制】关于 hashCode 和 equals 的处理，遵循如下规则:

📄️ （七）并发处理

1. 【强制】获取单例对象需要保证线程安全，其中的方法也要保证线程安全。

📄️ （八）控制语句

1. 【强制】在一个 switch 块内，每个 case 要么通过 continue / break / return 等来终止，要么注释说明 程序将继续执行到哪一个 case 为止;在一个 switch 块内，都必须包含一个 default 语句并且放在最 后，即使它什么代码也没有。

📄️ （九）注释规约

1. 【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用 / 内容 */ 格式，不得使用 // xxx

📄️ （十）前后端规约

1. 【强制】前后端交互的 API，需要明确协议、域名、路径、请求方法、请求内容、状态码、响应体。

📄️ （十一）其他

1. 【强制】在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。