java服务端项目开发规范

2015-03-13
(请先更新svn的mybatis.xml、BaseMapper.java、Pager.java文件)
加入测试类规范
加入事物控制规范
加入mapper接口规则

注意问题

一、一定要严格按照本文档的规范进行开发,有利于后期维护和修改。
二、每完成一个接口,需要在maven测试包中加入相应的测试方法。确保测试通过。详见测试类的添加
三、所有项目文件编码统一使用UTF8

新项目需要做如下操作:
1.修改工作空间编码为UTF8。
2.修改项目的编码为UTF8(项目右键-属性-resource)。
3.修改文件编码为UTF8(以后新建文件的默认编码为UTF8),包括properties、xml、java、java class文件等所有的编码都改为UTF-8。

Eclipse修改工作空间编码方法:

java服务端项目开发规范

Eclipse修改文件编码方法:

java服务端项目开发规范

命名规范 包命名规范

目的:包的命名规范应当体现出项目资源良好的划分

控制层包命名规范:公司名称.开发组名称.项目名称.mod.模块名.controller
例如:com.osen.app.mod.模块名.controller

逻辑层实现类包命名规范:公司名称.开发组名称.项目名称.mod.模块名.service.impl
例如:com.osen.app.mod.模块名.service.impl

逻辑层接口类包命名规范:公司名称.开发组名称.项目名称.mod.模块名.service
例如:com.osen.app.mod.模块名.service

DAO层实现类所在包命名规范:公司名称.开发组名称.项目名称.mod.模块名.dao.impl
例如:com.osen.app.mod.模块名.dao.impl (不含实现类可以忽略)

DAO层接口类所在包命名规范:公司名称.开发组名称.项目名称.mod.模块名.dao
例如:com.osen.app.mod.模块名.dao

POJO类与映射文件所在包命名规范:公司名称.开发组名称.项目名称.mod.模块名.dao
例如:com.osen.app.mod.模块名.dao

全局公共类、接口类所在包命名规范:公司名称.开发组名称.项目名称.mod.common
例如:com.osen.app.mod.common

全局公用dao类所在包命名规范:公司名称.开发组名称.项目名称.mod.common.dao
例如:com.osen.app.mod.common.dao

全局公用逻辑接口类所在包命名规范:公司名称.开发组名称.项目名称.mod.common. service
例如:com.osen.app.mod.common. service

全局公用逻辑实现类所在包命名规范:公司名称.开发组名称.项目名称.mod.common. service.impl
例如:com.osen.app.mod.common. service.impl

全局工具类所在包命名规范:公司名称.开发组名称.项目名称.tools
例如:com.osen.app.tools

类命名规范

service接口命名
业务逻辑接口的命名以POJO名称来制定,IPOJO名称Service
命名规范:以大写字母"I"开头,如果有多个单词,每个单词头字母大写
例如:IStudentService

service接口实现类命名:
业务逻辑接口实现类的命名以POJO名称来制定
命名规范:将实现的接口名称的首字母"I"去掉,以"Impl作为结尾",如果有多个单词,每个单词头字母大写。
例如:StudentServiceImpl

Controller类命名:
命名规范:Controller的命名以POJO名称来制定,POJO名称+Controller
例如:
一个POJO名称为User,其对应的Controller为UserController

POJO命名:
与表名一致,如果表名有下划线”_”,则POJO类去掉下划线,首字母大写。(表前缀不需要加入,例如:zz_content表,zz为表前缀,对应的pojo类不需要加zz)
例:User.java,MenuRole.java

Mybatis映射文件命名:
实体类名+Mapper.xml
如:UserMapper.xml

DAO类命名:
实体类名+Mapper.java
如:UserMapper.java

类变量命名:
命名规范:变量名首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母大写,单词与单词之间不要使用"_"做连接,变量名访问控制必须为私有, 可以对其增加setter与getter方法。
例如:private int studentAge;
public int getStudentAge()
{
return studentAge;
}

public void setStudentAge(int studentAge)
{
this.studentAge=studentAge;
}

常量命名:
命名规范:所有字母大写,如果有多个单词组成,单词与单词之间以” _“隔开。而 且该变量必须是公共、静态、final类型
例如:public static final String USER_NAME=”userName“;

方法命名
命名规范:首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母 大写,单词与单词之间不要使用"_"做连接。
例如:public int checkLogin(String name,String pwd){}

注释规范

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/wpdpsg.html