Java是一门面向对象编程语言。

Java分层相关命名规范

Java分层是为了让各层只需关注自己功能的实现,可以分工协作,提高质量,代码复用,更方便日后Java程序的扩展。

Java分层相关命名规范

Java分层相关命名规范

1)   获取单个对象的方法用get做前缀。

2)   获取多个对象的方法用list做前缀。

3)   获取统计值的方法用count做前缀。

4)   插入的方法用save/insert做前缀。

5)   删除的方法用remove/delete做前缀。

6)   修改的方法用update做前缀。

7)   分页查找:listXXXPage

service的接口层的出入参数统一为DTO。

限制规则:所有的入参与出参必须实现 序列化与clone接口,并生成:’serialVersionUID’。

方法是:在idea中创建类时启用’serialVersionUID’

设置如下:Setting->Inspections->java->Serialization issues->Serializable class without ’serialVersionUID’。

1.1    各层类、方法名命名

Service/Dao/controller

Service的类

接口命名: 模块IxxxService,模块Ixxxfacade

实现命名: 模块xxxServiceImpl,模块xxxFacadeImpl

Dao

类命名:模块xxxDaoImp

具体的Dao层*命名规则参考spring-data 语法,如图:


Mapper层(数据库连接层)

(1)    实体命名均采用实体类名称 + Entity

如:com.example.service.模块.dao.entity.UserEntity

(2)    每个Mapper需继承BaseMapper,此类采用的泛型。

如:public interface UserMapper extends BaseMapper<UserEntity>;

(3)    xml统一存放于与mapper相同的包结构目录。

如:com.example.service.模块.dao.mapper.userMapper.xml

(4)    mapper命名均采用实体类名称(第一个字母小写) + Mapper。

如:com.example.service.模块.dao.mapper.userMapper.java;

(5)    每个Xml在生成的时候会存在一个“BaseResultMap”,此ResultMap为基础Map,禁止在其加入其它和数据库表字段不对应的属性。

如:

<resultMap id="BaseResultMap" type="map">
       <result column="user" property="income" jdbcType="DECIMAL" />
</resultMap>

(6) mapper所有更新接口必须返回long类型

(7) dao 类统一采用 模块+daoImpl 命名放在impl包下。

如:com.example.模块.dao.impl.UserDaoImpl.java;


当前位置:Java教程网 »
本文地址:http://www.javajcw.com/76.html
喜欢 or
默认图片
发表我的评论
取消评论