前置条件

    • 本地项目已经创建成功,详见 新建项目
    • 数据库创建成功,详见
    • DO 类不需要提供任何实现,所以属于供应方的服务接口层。创建在项目模块的 xxx.infra.dataobject 包下。
    • 每一个DO 类即为一个实体类,对应数据库中的一个具体表。
    • 名称=表具体名称+DO,表名中 _ 替换为驼峰命名法,首字母大写。如:TaskDO 对应表为todo_task
    • @Table(name = "table_name") 指定 DO 对应数据库中表的名称。
    • 每一个 DO 对应数据库中的一个具体表,一般都需要继承 AuditDomain 类。

    属性规范

    • 所有属性均为private属性。
    • 字段名称应根据驼峰命名规则从数据库列名转换过来。例如:数据库列名为 USER_NAME ,则字段名为 UserName,特殊字段名称,可以在字段在添加 @Column(name = "xxx")注解,指定数据库列名。

    属性的的类型与字段的 type 对应

    • 不使用基本类型,全部使用基本类型的包装类,如 Long 对应数据库中的 INTEGER,而不是使用 long
    • 数字类型主键统一采用 Long
    • 金额、数量 等精度严格浮点类型采用 BigDecimal

    所有的主键字段都需要用标注

    • 需要用@Transient标注 javax.persistence.Transient

    UserDO.java 代码

    TaskDO.java 代码

    1. package io.choerodon.todo.infra.dataobject;
    2. // 省略 import
    3. @ModifyAudit
    4. @VersionAudit
    5. @Table(name = "todo_task")
    6. public class TaskDO extends AuditDomain {
    7. @Id
    8. @GeneratedValue
    9. private Long id;
    10. private Long employeeId;
    11. private String state;
    12. private String taskNumber;
    13. private String taskDescription;
    14. // 省略get和set方法
    15. }

    mapper接口类

    • mapper 接口类即为传统意义上的 DAO,但与 interface 不同,mapper 本身就是对数据访问的具体实现,所以属于供应方的服务实现层。创建在 项目模块 的 xxx.infra.mapper 包下。
    • 基础的 CRUD 操作不需要再次实现,通过继承 BaseMapper<T> 类实现。其中 T 为 对应 DO 的泛型。
    • 复杂的数据库操作需要定义具体的接口方法。
    • Mapperxml文件 是数据库的的具体映射,与 接口同级,创建在 项目模块 resources 目录的 xxx.mapper 包下。
    • Mapperxml文件,与 Mapper 接口对应。所以命名 Mapper 接口类相同。
    • Mapperxml文件非必须,由于继承BaseMapper类后基本的 CRUD 不需要进行配置,所以只有CRUD操作时不需要创建对应的 xml 文件。
    • 对于自定义的数据库方法,需要创建对应的 mapper.xml 文件。
    • Mapperxml 中的操作 id 对应 Mapper 接口类的方法名。

    UserMapper.java 代码

    TaskMapper.java 代码

    1. package io.choerodon.todo.infra.mapper;
    2. // 省略 import
    3. public interface TaskMapper extends BaseMapper<TaskDO> {
    4. TaskDO queryByTaskNumber(@Param("taskNumber") String taskNumber);
    5. }

    UserMapper.xml 文件

    1. <?xml version="1.0" encoding="UTF-8" ?>
    2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
    3. <mapper namespace="io.choerodon.todo.infra.mapper.TaskMapper">
    4. <select id="queryByTaskNumber" resultType="io.choerodon.todo.infra.dataobject.TaskDO">
    5. SELECT * FROM TODO_TASK
    6. WHERE
    7. TASH_NUMBER=#{taskNumber} limit 1
    8. </select>