易族智汇Java开发规范v1_0.docxVIP

易族智汇Java开发规范前言《易族智汇Java开发规范手册》是公司技术团队的集体经验总结,现代软件行业的高速 发展对开发者的综合素质要求越来越高,因为不仅是编程知识点,其它维度的知识点 也会影响到软件的最终交付质量。比如:数据库的表结构和索引设计缺陷可能带来软 件上的架构缺陷或性能风险;工程结构混乱导致后续维护艰难;没有鉴权的漏洞代码 被黑客攻击等等。所以本手册以 Java 开发者为中心视角,划分为编程规约、异常日志 规约、MySQL 规约、工程规约、安全规约五大块,再根据内容特征,细分成若干二级子 目录。根据约束力强弱及故障敏感性,规约依次分为强制、推荐、参考三大类。对于 规约条目的延伸信息中,“说明”对内容做了引申和解释;“正例” 倡什么样的编 码和实现方式;“反例”说明需要 防的雷区,以及真实的错误案例。本手册的愿景是码出质量、码出高效。代码的字里行间流淌的是软件生命中的血液,质量的 升是尽可能少踩坑,杜绝踩重复的坑,切实 升质量意识。另外,现代软件架构都需要协同开发完成,高效协作即降低协同成本, 升沟通效率,所谓无规矩不成方圆,无规范不能协作。众所周知,制订交通法规表面上是要限制行车权,实际上是保障公众的人身安全。试想如果没有限速,没有红绿灯,谁还敢上路行驶。对软件来说,适当的规范和标准绝不是消灭代码内容的创造性、优雅性,而是限制过度个性化,以一种普遍认可的统一方式一起做事, 升协作效率。编程规约命名规约【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。反例:_name / __name / $Object / name_ / name$ / Object$【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。反例: DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3 正例:alibaba / taobao / youku / hangzhou 等国际通用的名称,可视同英文。【强制】类名使用 UpperCamelCase 风格,必须遵从驼峰形式。正例：MemberListManager。【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格,必须遵从驼峰形式。正例:localValue / getHttpMessage() / inputUserId【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。正例: MAX_STOCK_COUNT反例: MAX_COUNT【强制】抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类命名以它要测试的类的名称开始,以 Test 结尾。【强制】中括号是数组类型的一部分,数组定义如下:String[] args; 反例:使用String args[]的方式来定义。【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。正例: 应用工具类包名为com.alibaba.open.util、类名为MessageUtils(此规则参考 spring 的框架结构)【强制】杜绝完全不规范的缩写,避免望文不知义。反例: AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类随意缩写严重降低了代码的可阅读性。【强制】对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部的实现类与接口用I 的前缀区别。正例:MemberManager实现IMemberManager接口。【强制】Controller类为区分前台商城和平台管理调用的不同，前台商城需要以ApiController结尾，平台管理以Controller结尾。正例：前台商城MemberApiController，平台管理MemberController。【强制】标签类，全部以Tag结尾。正例：MemberListTag。【强制】组件类，全部以Component结尾正例：MemberComponent。【强制】插件类，全部以Plugin结尾正例：MemberPointPlugin。【强制】Controller类中的方法，下面提供通用的方法名，如其他业务，请看10标准。add到添加页edit到修改页saveAdd保存添加saveEdit保存修改delete删除list到列表页listJson列表的json【强制】Controller类的RequestMapping的路径格式。基本原则：将驼峰命名改为以中横线连接，将驼峰的大写母小写，注意不能以下划线连接