【Java从0到架构师】MyBatis - dao

灰太狼 2022-09-02 05:27 206阅读 0赞

### dao ###

*  使用 MyBatis 实现 dao 层的几种方式
 *  自定义实现类，XML 实现 dao 层
 *  只定义接口类，getMapper + XML 实现 dao 层
 *  只定义接口类，getMapper + 注解实现 dao 层
 *   *  @Select、@Insert、@Update、@Delete - 执行 DML 语句
     *  @Param、@Options、@SelectKey、@CacheNamespace
     *  @Results、@ResultMap、@One、@Many - 多表懒加载
     *  @ConstructorArgs、@Arg - 指定构造方法
     *  script

> Java 从 0 到架构师目录：[【Java从0到架构师】学习记录][Java_0]

Gitee 代码：[dao][]

参考资料：[https://mybatis.org/mybatis-3/zh/java-api.html][https_mybatis.org_mybatis-3_zh_java-api.html]

# 使用 MyBatis 实现 dao 层的几种方式 #

方法1：自定义 dao 实现类，在实现中调用 SqlSession 的相关方法（使用 **XML**）

方法2：只定义 dao 接口类，SqlSession 的 getMapper 方法生成 **dao 的代理对象**（使用 **XML**）

方法3：只定义 dao 接口类，SqlSession 的 getMapper 方法生成 **dao 的代理对象**（使用 **注解**）

> 目前注解的功能并没有 XML 强大，所以也可以 XML + 注解混合使用

# 自定义实现类，XML 实现 dao 层 #

示例项目：[MyBatis\_dao\_01][MyBatis_dao_01]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70]  
这种做法十分冗余，会有大量的重复代码，不推荐

# 只定义接口类，getMapper + XML 实现 dao 层 #

示例项目：[MyBatis\_dao\_02][MyBatis_dao_02]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 1]  
有 2 个配置要求：

*  mapper 的 namespace 必须是 dao 接口类的 **全类名**  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 2]
 *  mapper 中 select、update、insert、delete 的 **id 值必须和 dao 的方法名一致**  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 3]

--------------------

如果 update、insert、delete 方法的返回值是 Boolean 类型

*  代理对象内部是影响记录数大于 0 就返回 true
 *  参考源码：`org.apache.ibatis.binding.MapperMethod.rowCountResult` 方法

# 只定义接口类，getMapper + 注解实现 dao 层 #

示例项目：[MyBatis\_dao\_03][MyBatis_dao_03]

首先要在 mybatis-config.xml 中配置 dao 的位置

*  方法 1：需要将所有 dao 的类一个一个引入
    
        <mapper class="dao的全类名" />
 *  方法 2：可以引入一个包下所有的 dao 类
    
        <package name="dao所在的包" />

## @Select、@Insert、@Update、@Delete - 执行 DML 语句 ##

`@Select`、`@Insert`、`@Update`、`@Delete`、`@SelectKey`：用于传入 SQL 语句执行 DML 操作

@Insert("INSERT INTO skill(name, level) VALUES (#{name}, #{level})")
    boolean save(Skill skill);
    
    @Update("UPDATE skill SET name = #{name}, level = #{level} WHERE id = #{id}")
    boolean update(Skill skill);
    
    @Delete("DELETE FROM skill WHERE id = #{id}")
    boolean remove(Integer id);
    
    @Select("SELECT * FROM skill WHERE id = #{id}")
    Skill get(Integer id);

[完整示例代码][Link 1]

## @Param、@Options、@SelectKey、@CacheNamespace ##

`@Param`：设置参数名

@Select("SELECT * FROM skill LIMIT #{start}, #{size}")
    List<Skill> listByStartAndSize(@Param("start") int start,
                                   @Param("size") int size);

`@Options`：设置其他属性值

@SelectKey(statement = "SELECT LAST_INSERT_ID()",
    		   keyProperty = "id", before = false, resultType = Integer.class)
    @Options(useGeneratedKeys = true, keyProperty = "id")
    @Insert("INSERT INTO skill(name, level) VALUES (#{name}, #{level})")
    boolean save(Skill skill);

`@CacheNamespace`：对应 mapper 文件中设置 `<cache>`

@CacheNamespace(flushInterval = 600000, size = 512, readWrite = true)
    public interface SkillDao { 
    	// code...
    }

[完整示例代码][Link 1]

--------------------

## @Results、@ResultMap、@One、@Many - 多表懒加载 ##

`@Results`、`@ResultMap`：对应 `<resultMap>`  
`@Result`：对应 `<id>`、`<result>`  
`@One` 对应 `<association>`、`@Many` 对应 `<collection>`

@Select("SELECT * FROM person WHERE id = #{id}")
    @Results(id = "get", value = { 
        @Result(property = "id", column = "id", id = true),
        @Result(property = "name", column = "name"),
        /* 身份证 */
        @Result(
            property = "idCard",
            column = "id",
            one = @One(fetchType = FetchType.LAZY, select = "com.mj.dao.IdCardDao.getByPerson")
        ),
        /* 银行卡 */
        @Result(
            property = "bankCards",
            column = "id",
            many = @Many(fetchType = FetchType.LAZY, select = "com.mj.dao.BankCardDao.listByPerson")
        ),
        /* 工作 */
        @Result(
            property = "jobs",
            column = "id",
            many = @Many(fetchType = FetchType.LAZY, select = "com.mj.dao.JobDao.listByPerson")
        )
    })
    Person get(Integer id);
    
    @Select("SELECT * FROM person")
    /* 引用id为get的@Results */
    @ResultMap("get")
    List<Person> list();
    
    Person testGet();

IdCardDao.java 中定义 getByPerson：

public interface IdCardDao { 
        @Select("SELECT * FROM id_card WHERE person_id = #{personId}")
        IdCard getByPerson(Integer personId);
    }

BankCardDao.java 中定义 listByPerson：

public interface BankCardDao { 
        @Select("SELECT * FROM bank_card WHERE person_id = #{personId}")
        List<BankCard> listByPerson(Integer personId);
    }

JobDao.java 中定义 listByPerson：

public interface JobDao { 
        @Select(
                "SELECT j.* FROM job j "
              + "JOIN person_job pj ON j.id = pj.job_id AND pj.person_id = #{personId}"
        )
        List<Job> listByPerson(Integer personId);
    }

> 延迟加载的 XML 写法：  
> ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 4]

[注解使用延迟加载完整代码][Link 2]

--------------------

## @ConstructorArgs、@Arg - 指定构造方法 ##

`@ConstructorArgs`：对应 `<constructor>`  
`@Arg`：对应 `<idArg>`、`<arg>`

@Select("SELECT * FROM skill WHERE id = #{id}")
    @ConstructorArgs({ 
            @Arg(column = "name", javaType = String.class),
            @Arg(column = "level", javaType = Integer.class)
    })
    Skill get(Integer id);

以上注解使用 Skill 类的如下构造器：  
![在这里插入图片描述][0e4ffc8c2f7742cea2cdfb55bc63b6eb.png]

[@ConstructorArgs 示例代码][Link 1]

## script ##

可以使用 `<script>` 嵌套其他 XML 标签中的内容

[Java_0]: https://blog.csdn.net/weixin_43734095/article/details/119067034
[dao]: https://gitee.com/szluyu99/mj_java_frame/tree/master/01_MyBatis
[https_mybatis.org_mybatis-3_zh_java-api.html]: https://mybatis.org/mybatis-3/zh/java-api.html
[MyBatis_dao_01]: https://gitee.com/szluyu99/mj_java_frame/tree/master/01_MyBatis/05_MyBatis05_dao01
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70]: /images/20220829/e03068091131408f9d882dd650058076.png
[MyBatis_dao_02]: https://gitee.com/szluyu99/mj_java_frame/tree/master/01_MyBatis/06_MyBatis06_dao02
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 1]: /images/20220829/2b404ba3ad3e4bdab467c47ad4eccfc8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 2]: /images/20220829/e85c56b45a4143e2b92b435a467780ae.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 3]: /images/20220829/d1c3ab02042f4d92907e18d57bd20098.png
[MyBatis_dao_03]: https://gitee.com/szluyu99/mj_java_frame/tree/master/01_MyBatis/07_MyBatis07_dao03
[Link 1]: https://gitee.com/szluyu99/mj_java_frame/blob/master/01_MyBatis/07_MyBatis07_dao03/src/main/java/com/mj/dao/SkillDao.java
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_1_color_FFFFFF_t_70 4]: /images/20220829/acf8f8449c294ac1b78d3509d03322d0.png
[Link 2]: https://gitee.com/szluyu99/mj_java_frame/blob/master/01_MyBatis/07_MyBatis07_dao03/src/main/java/com/mj/dao/PersonDao.java
[0e4ffc8c2f7742cea2cdfb55bc63b6eb.png]: /images/20220829/8bf41cc4b973477bb1c9669d480bc316.png