Java编码规范【终极版】.pptx

编码小贴士Coding Tips
目录结构
编码规范篇
项目结构篇
java基础篇
java性能篇
java线程篇
java设计篇
code review篇
数据库篇
模板篇
开发运维篇
数据库设计命名规范篇
其他篇
编码规范篇
3
命名规范
Package命名
包名称全部小写,包的路径符合所开发的系统模块的定义,尽量使用单一职责原则
.(其中xx为具体业务相关)
比如:
..wuage..
类名
类名首字母应该大写。全局变量、方法以及所有标识符(如参数、局部变量)的首字母应小写,且使用驼峰法。命名满足见名知意
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结束,
DAO实现类全部以IBatis开始以Impl结束并继承DAO接口
如:
实体全部以Model结尾
如:UserModel
8
service设计规范
读写分离
接口
写接口以I开始OperateService结束,
读接口以I开始QueryService结束,
实现类
以OperateServiceImpl或者QueryServiceImpl结束,
自包含
尽量捕获异常输出日常并返回业务方错误的code
9
使用正确的code format
制作codetemplate和codeformat文件
打开Eclipse,导入code-style/
10