以Java开发者为中心视角,划分为编程规约,异常日志,单元测试,安全规约,MySQL数据库,工程结构,设计规约七个维度。
左大括号是否另起一行,Go语言强制不换行,手册明确左大括号不换行。
自动化IDE检测插件,下载地址:https://github.com/alibaba/p3c
类名使用UpperCamelCase风格,但DO/BO/DTO/VO/AO/PO等情形例外。
方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格,必须遵从驼峰形式。
常量命名全部用大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。
抽象类命名使用Abstract或Base开头;
异常类命名使用Exception 结尾;
测试类命名以它要测试的类名开始,以Test结尾。
包名统一使用小写
杜绝完全不规范的缩写,比如随意缩写 AbstractClass 缩写成 AbsClass, condition 缩写成condi
如果模块、接口、类、方法使用了设计模式,应在命名时体现出具体模式
例如:public class OrderFactory
public class LoginProxy
public class ResourceObserver