《Java编码规范【终极版】》.ppt

编码小贴士Coding Tips 目录结构 编码规范篇 项目结构篇 java基础篇 java性能篇 java线程篇 java设计篇 code review篇 数据库篇 模板篇 开发运维篇 数据库设计命名规范篇 其他篇 编码规范篇 3 命名规范 Package命名 包名称全部小写，包的路径符合所开发的系统模块的定义，尽量使用单一职责原则 所有五阿哥的包路径命名为com.wuage.xx（其中xx为具体业务相关） 比如： com.wuage.seller com.wuage.crm com.wuage.order 类名 类名首字母应该大写。全局变量、方法以及所有标识符（如参数、局部变量）的首字母应小写，且使用驼峰法。命名满足见名知意 4 命名规范 接口 采用完整的英文描述符说明接口封装，所有单词的第一个字母大写。习惯上，名字前面加上大写的 I, 遵守单一职责原则及接口隔离原则 比如： interface Iraster 方法 方法采用完整的英文描述说明成员方法功能，第一个单词尽可能采用一个生动的动词，尽量满足见名知意且注意使用设计原则 比如： sayHello() getName() run() 5 命名规范 常量字段 一般全部采用大写字母，单词之间用下划线分隔（也有特例，如Java 类库中关于颜色的常数没有严格地全部使用大写字母） 比如： static final int MIN_WIDTH static final int MAX_WIDTH 变量字段 采用驼峰标示法，遵守见名知意原则 比如： int myIndex 6 组合语句 错误代码 if (condition) statement1;  if (condition1) if (condition2) statement2; else statement3; 正确代码 if (condition) { statement1; } if (condition1) { if (condition2) { statement2; } } else { statement3; } 7 DAO层命名规范 DAO接口全部以I开始以DAO结束,如IUserDAO.java DAO实现类全部以IBatis开始以Impl结束并继承DAO接口 如：IBatisUserDAOImpl.java 实体全部以Model结尾 如：UserModel 8 service设计规范 读写分离 接口 写接口以I开始OperateService结束，比如IUserOperateService.java 读接口以I开始QueryService结束，比如IUserQueryService.java 实现类 以OperateServiceImpl或者QueryServiceImpl结束, 比如UserQueryServiceImpl.java 自包含 尽量捕获异常输出日常并返回业务方错误的code 9 使用正确的code format 制作codetemplate和codeformat文件 打开Eclipse,导入code-style/codeformat.xml 10 Eclipse code tempaltes 11 Eclipse code tempaltes-auto add 12 Eclipse Save Actions 13 14 1 、应用名中用_来连接 ，2 子工程的命名是用. 如:这个应用是叫wuage_web 里面的子工程可以叫wuage_web.config 注意： 2 、autoconfig的文件需要放在src/main/resource中，或者是在war中 Java工程命名 java文件目录结构 使用标准maven结构，具体package待定 15 Java基础篇 16 规范描述 单行长度不超过120个字符，多于120个字符进行换行，操作符放在新行之首；新行要进行相应的缩进，至少不能少于8个字符。 不允许把多个短语句写在一行中，即一行只写一条语句。 if、for、do、while、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。 相对独立的程序块之间、变量说明之后必须加空行 提供文件注释，列出：版权说明、版本号、生成日期、作者、模块目的、功能、修改日志等信息。文件注释应放在package之前。 说明：姓名使用汉语姓名。 示例： /* * Copyright (C), TODO * */ 类注释放在class 或者 interface 关键字之前 类注释放在class