java编码规范【终极版】

《java编码规范【终极版】》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、编码小贴士CodingTips目录结构编码规范篇项目结构篇java基础篇java性能篇java线程篇java设计篇codereview篇数据库篇模板篇开发运维篇数据库设计命名规范篇其他篇编码规范篇3命名规范Package命名包名称全部小写，包的路径符合所开发的系统模块的定义，尽量使用单一职责原则所有五阿哥的包路径命名为com.wuage.xx（其中xx为具体业务相关）比如：com.wuage.sellercom.wuage.crmcom.wuage.order类名类名首字母应该大写。全局变量、方法以及所有标识符（如参数、局部变量）的首字母应小写，且使

2、用驼峰法。命名满足见名知意4命名规范接口采用完整的英文描述符说明接口封装，所有单词的第一个字母大写。习惯上，名字前面加上大写的I,遵守单一职责原则及接口隔离原则比如：interfaceIraster方法方法采用完整的英文描述说明成员方法功能，第一个单词尽可能采用一个生动的动词，尽量满足见名知意且注意使用设计原则比如：sayHello()getName()run()5命名规范常量字段一般全部采用大写字母，单词之间用下划线分隔（也有特例，如Java类库中关于颜色的常数没有严格地全部使用大写字母）比如：staticfinalintMIN_WIDTHstat

3、icfinalintMAX_WIDTH变量字段采用驼峰标示法，遵守见名知意原则比如：intmyIndex6组合语句错误代码if(condition)statement1;if(condition1)if(condition2)statement2;elsestatement3;正确代码if(condition){statement1;}if(condition1){if(condition2){statement2;}}else{statement3;}7DAO层命名规范DAO接口全部以I开始以DAO结束,如IUserDAO.javaDAO实现类全部

4、以IBatis开始以Impl结束并继承DAO接口如：IBatisUserDAOImpl.java实体全部以Model结尾如：UserModel8service设计规范读写分离接口写接口以I开始OperateService结束，比如IUserOperateService.java读接口以I开始QueryService结束，比如IUserQueryService.java实现类以OperateServiceImpl或者QueryServiceImpl结束,比如UserQueryServiceImpl.java自包含尽量捕获异常输出日常并返回业务方错误

5、的code9使用正确的codeformat制作codetemplate和codeformat文件打开Eclipse,导入code-style/codeformat.xml10Eclipsecodetempaltes11Eclipsecodetempaltes-autoadd12EclipseSaveActions13141、应用名中用_来连接，2子工程的命名是用.如:这个应用是叫wuage_web里面的子工程可以叫wuage_web.config注意：2、autoconfig的文件需要放在src/main/resource中，或者是在war中Java

6、工程命名java文件目录结构使用标准maven结构，具体package待定15Java基础篇16规范描述单行长度不超过120个字符，多于120个字符进行换行，操作符放在新行之首；新行要进行相应的缩进，至少不能少于8个字符。不允许把多个短语句写在一行中，即一行只写一条语句。if、for、do、while、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。相对独立的程序块之间、变量说明之后必须加空行提供文件注释，列出：版权说明、版本号、生成日期、作者、模块目的、功能、修改日志

7、等信息。文件注释应放在package之前。说明：姓名使用汉语姓名。示例：/**Copyright(C),TODO**/类注释放在class或者interface关键字之前类注释放在class或者interface关键字之前，import关键字之后。注释使用“/***/”注释方式。说明：注释主要是一句话功能简述与功能详细描述。注释可根据需要列出：作者、内容、功能、与其它类的关系等。功能详细描述部分说明该类或者接口的功能、作用、使用方法和注意事项，每次修改后增加作者和更新版本号和日期，@since表示从那个版本开始就有这个类或者接口，@deprecate

8、d表示不建议使用该类或者接口。/***〈一句话功能简述〉*〈功能详细描述〉*@author[作者]（必须，使