Skip to content

项目设计规范

tangtaiming edited this page Oct 9, 2016 · 7 revisions

【数据库表定义规范】-by sj

  1. 数据库表名以dk_开头,采用全小写字母。
  2. 当表名里由多个单词组成时,每个单词以下划线连接。
  3. 字段名称采用全小写形式。
  4. 当字段里由多个单词组成时,每个单词以下划线连接。

【映射文件及SQL语句说明】-by sj

  1. 所有映射文件全部放在resources\com\dekequan\mybatis\mapper文件夹下。
  2. 所有映射文件名字采用大驼峰式命名法,并且以Mapper.xml结尾(UserMapper.xml)。
  3. 所有的对应的SQL语句统一写在对应的映射文件里。

【基础类的使用】-by ttm

实体类建立要求

  1. 表名默认使用类名,驼峰转下划线(只对大写字母进行处理),如UserInfo默认对应的表名为user_info。
  2. 表名可以使用@Table(name = "tableName")进行指定,对不符合第一条默认规则的可以通过这种方式指定表名.
  3. 字段默认和@Column一样,都会作为表字段,表字段默认为Java对象的Field名字驼峰转下划线形式.
  4. 可以使用@Column(name = "fieldName")指定不符合第3条规则的字段名
  5. 使用@Transient注解可以忽略字段,添加该注解的字段不会作为表字段使用.
  6. 建议一定是有一个@Id注解作为主键的字段,可以有多个@Id注解的字段作为联合主键.
  7. 默认情况下,实体类中如果不存在包含@Id注解的字段,所有的字段都会作为主键字段进行使用(这种效率极低).
  8. 实体类可以继承使用,可以参考测试代码中的com.dekequan.orm.smart.Demo类.
  9. 由于基本类型,如int作为实体类字段时会有默认值0,而且无法消除,所以实体类中建议不要使用基本类型.

Dao层建立要求

  1. 对应Dao接口必须继承 com.dekequan.library.dao.AbstractDao 接口此接口是所有Dao基类

Service层建立要求

(介绍):com.dekequan.service.base.BaseService是Service层基础功能接口,com.dekequan.service.base.AbstractService 抽象类 继承 BaseService类, 其中AbstractService实现了基础类中的功能。

  1. Service实现类如果想使用基本操作 需要继承 AbstractService.