命名规范
包名命名规范
com.{公司名}.{项目名}.{应用名小写}.{各层包名},如:com.frontier.des.core.controller
类名命名规范
UpperCamelCase 风格,但以下情形例外:DAO、VO、PO
方法名、参数名、成员变量、局部变量命名规范
lowerCamelCase 风格
常量命名规范
全部大写,单词间用下划线隔开,力求语义表达完整清楚
表字段与实体类字段
USER_NAME & userName
接口命名规范
以I开头,例如:IProcessor
抽象类命名规范
以Abstract开头,例如:AbstractProcessor
异常类命名规范
以Exception结尾
测试类命名规范
以Test结尾,例如:XMLProcessorTest
数组类型实例化定义
数组定义如下:String[] args;
POJO类命名规范
任何布尔类型的变量,都不要加 is,否则部分框架解析会引起序列化错误(rpc框架)。
DAO层方法命名规约
获取单个对象的方法用 get | query | select | find | load 做前缀。
获取多个对象的方法用 list 做前缀,例如:listGetStudents
获取统计值的方法用 count 做前缀,例如:countGetStudents
插入的方法用 save | add 做前缀。
删除的方法用 remove | delete | del 做前缀。
修改的方法用 update | modify 做前缀。
设计模式类命名规范
建议在类名中体现出具体模式,例如: LoginProxy
枚举类命名规范
以Enum后缀,枚举成员名称需要全大写,单词间用下划线隔,例如:
枚举名字:DealStatusEnum
成员名称:SUCCESS 、FAIL、UNKOWN_REASON。
格式规范
JAVA 源文件的字符编码都应该采用 UTF-8 编码
1
同步接口要有说明文档、
所有定时任务(同步,发邮件) 提供测试页面入口
项目自动化部署
启动自动建表
项目附带sql脚本 生成测试数据