文章目录
- 引言
- I 编程规约
- II 异常日志
- III 单元测试 :
- IV 安全规约 :
- V MySQL数据库:
- VI 工程结构 :
- VII 设计规约 :
引言
手册的愿景是提升代码质量和开发效率,通过规范化的编码实践来减少错误和提高系统的稳定性。
I 编程规约
- 命名风格:规定了命名的一致性和规范性,避免使用下划线或美元符号开头和结尾,禁止使用拼音
与英文混合的方式,强调类名、方法名、变量名等的命名规范。 - 常量定义:禁止使用魔法值,强调使用大写字母和下划线命名常量,避免使用一个常量类维护所有常量。
- 代码格式 :规定了代码的格式化标准,包括大括号的使用、空格的使用、缩进、注释等。
- OOP规约:强调避免通过对象引用访问静态变量或方法,覆写方法必须加
@Override
注解,避免使用过时的类或方法。 - 日期时间 :规定了日期格式化的标准和获取当前毫秒数的方法。
- 集合处理 :强调使用 isEmpty()方法判断集合是否为空,避免在 toMap()方法中忽略
mergeFunction。 - 并发处理 :强调线程安全和锁的使用规范,避免使用 Executors创建线程池。
- 控制语句 :规定了 switch语句的使用规范,避免在高并发场景中使用“等于”判断。
- 注释规约 :强调使用Javadoc规范&#