MyBatis 源码学习笔记(二)- MyBatis 进阶(Part B)

·  阅读 830
MyBatis 源码学习笔记(二)- MyBatis 进阶(Part B)

持续创作,加速成长!这是我参与「掘金日新计划 · 6 月更文挑战」的第23天,点击查看活动详情

三、MyBatis Mapper XML 文件

resultMap 标签使用

resultMap 是MyBatis中最重要最强大的标签,它可以让你从90%的JDBC ResultSets代码中解脱,对复杂语句进行联合映射时,会非常方便

resultMap的设计思想是简单的语句不需要明确的结果映射,复杂的语句只需要描述属性和字段的关系即可

在UserMapper.xml中增加resultMap配置,定义t_user表中的字段和User实体类属性之间的映射关系

<resultMap id="BaseResultMap" type="com.lilith.entity.User">
    <id column="id" property="id" />
    <result column="user_name" property="userName" />
    <result column="real_name" property="realName" />
    <result column="sex" property="sex" />
    <result column="mobile" property="mobile" />
    <result column="email" property="email" />
    <result column="note" property="note" />
    <result column="position_id" property="positionId" />
</resultMap>

id和result都是将一个字段的值映射到一个简单数据类型(字符串、整型、浮点等)的属性或者字段 不同的是id表示的结果是对象的标识属性,可以提高整体性能 两个标签包含了以下属性

属性属性表述
propertyEntity中的属性,如果Entity的属性匹配的字段是存在的,就会自动映射
column表字段名
javaType配置的Java的类
jdbcType配置的数据库的类型
property类型处理器,使用这个属性会覆盖默认的类型处理器,要求填写一个全类名或者是别名

如果是枚举类型,需要自定义类型转换器。常用类型不用书写jdbctype和javatype属性

resultMap的属性:

  • id:当前命名空间中的一个唯一表示,用于标识一个resultMap
  • type:类的全限定名或者是一个类的别名
  • autoMapping:如果设置这个属性,MyBatis会为这个resultMap开启或者关闭自动映射,这个属性会覆盖全局的autoMappingBehavior,默认为unset,一般不用做设置,保持默认即可

修改selectByPrimaryKey方法对应的SQL语句

<select id="selectByPrimaryKey" resultMap="BaseResultMap">
    SELECT
    <include refid="userColumns"></include>
    FROM t_user where id = #{id}
</select>

执行测试类中的selectByPrimaryKey方法

image.png

除了id和result子标签外,resultMap还有以下这些子标签:

  • constructor:用于实例化类时,注入结果到构造方法中,当类不包含无参构造方法时使用
  • association:一个复杂类型的关联,嵌套结果映射,多用于一对一查询
  • collection:复杂类型的集合,嵌套结果映射,多用于一对多查询或者多对多查询
  • discriminator:使用结果值来决定使用哪个resultMap
    • case:基于某些值得结果映射

在联合查询时association和collection标签使用较多

resultType 和 resultMap 的区别

resultType,将结果集映射到一个类上,一个类的全路径类名或者类的别名,按照类属性名和数据库字段名称是否相同进行映射,相同就将字段值赋值给属性,还可以设置开启驼峰命名

resultMap,将结果集映射到一个Map上,就是定义转换规则。

select 标签

属性描述备注
id在命名空间中唯一的标识符,可以被用来引用这条语句。如果命名空间和id组合起来不唯一,会抛出异常
parameterType传入参数的类型;可以给出类全名,也可以给出类别名,使用别名必须是MyBatis内部定义或自定义的;基本数据类型:int、String、long、date(不知是sql.date 还是 util.date) 复杂数据类型:类 和 Map可以选择JavaBean,Map等复杂的参数类型传递给SQL
parameterMap用于引用外部 parameterMap 的属性,目前已被废弃。请使用行内参数映射和 parameterType 属性。
resultType从这条语句中返回的期望类型的类的完全限定名或别名。 注意如果是集合情形,那应该是集合可以包含的类型,而不能是集合本身;使用 resultType 或 resultMap,但不能同时使用 定义类的全路径,在允许自动匹配的情况下,结果集将通过JavaBean的规范映射; 或者定义为int,double,float等参数...,也可以使用别名,但是要符合别名规范,不能和resultMap同时使用。它是我们常用的参数之一,比如我们总计总条数,就可以把它的值设为int
resultMap对外部 resultMap 的命名引用。使用 resultMap 或 resultType,但不能同时使用; 它是映射集的引用,将执行强大的映射功能,我们可以使用resultType或者resultMap其 中的一个,resultMap可以给予我们自定义映射规则的机会它是MyBatis最复杂的元素,可以配置映射 规则,级联,typeHandler等
flushCache将它的作用是在调用SQL后,是否要求MyBatis清空之前查询的本地缓存和二级缓存true/false,默认为false
useCache启动二级缓存开关,是否要求MyBatis将此次结果缓存true/false,默认为false
timeout设置超时时间,超时之后抛出异常,秒默认值为数据库厂商提供的JDBC驱动所设置的秒数
fetchSize获取记录的总条数设定默认值是数据库厂商提供的JDBC驱动所设的条数
statementType可选 STATEMENT,PREPARED 或 CALLABLE。这会让 MyBatis 分别使用 Statement,PreparedStatement 或 CallableStatement,默认值:PREPARED。
resultSetTypeFORWARD_ONLY,SCROLL_SENSITIVE, SCROLL_INSENSITIVE 或 DEFAULT(等价于 unset) 中的一个,默认值为 unset (依赖数据库驱动)。
databaseId如果配置了数据库厂商标识(databaseIdProvider),MyBatis 会加载所有不带 databaseId 或匹配当前 databaseId 的语句;如果带和不带的语句都有,则不带的会被忽略。
resultOrdered这个设置仅针对嵌套结果 select 语句:如果为 true,将会假设包含了嵌套结果集或是分组,当返回一个主结果行时,就不会产生对前面结果集的引用。 这就使得在获取嵌套结果集的时候不至于内存不够用。默认值:false
resultSets这个设置仅适用于多结果集的情况。它将列出语句执行后返回的结果集并赋予每个结果集一个名称,多个名称之间以逗号分隔。

SQL 语句传递多个参数

select语句传递多个参数有三种方式:

  • 使用Map传递参数,可读性差、可扩展性和可维护性差
  • 使用注解传递参数,直观明了,建议传递参数小于5个时使用
  • 使用Java Bean传递参数,当参数个数大于5个时使用
Map传参

UserMapper中新增方法,使用Map传递参数

List<User> selectByUserNameAndSex(Map<String, Object> map);

在xml中定义对应的SQL语句

<select id="selectByUserNameAndSex" resultType="user">
    SELECT
    <include refid="userColumns"></include>
    FROM t_user where user_name = #{userName} AND sex = #{sex}
</select>

在测试类中新增测试方法,这里必须要使用Map构造查询条件

@Test
public void selectByUserNameAndSex() {
    SqlSession sqlSession = sqlSessionFactory.openSession();
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    // 构造查询条件
    Map<String, Object> map = new HashMap<>();
    map.put("userName","loki");
    map.put("sex",1);
    List<User> userList =  mapper.selectByUserNameAndSex(map);
    System.out.println("查询到的数据为:" + userList);
}

执行该测试方法 image.png 成功查询出数据

注解传参

UserMapper中新增方法selectByRealNameAndSexAndSex,这里使用@Param注解标注了参数的名字。

List<User> selectByRealNameAndSexAndSex(@Param("realName") String realName, @Param("sex") Integer sex);

UserMapper.xml中增加对应的SQL语句

<select id="selectByRealNameAndSexAndSex" resultType="user">
    SELECT
    <include refid="userColumns"></include>
    FROM t_user where real_name = #{realName} AND sex = #{sex}
</select>

新增测试方法,调用selectByRealNameAndSexAndSex方法时传参就不需要再构造Map查询条件,直接插入对应的参数即可

@Test
public void selectByRealNameAndSexAndSex() {
    SqlSession sqlSession = sqlSessionFactory.openSession();
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);

    List<User> userList =  mapper.selectByRealNameAndSexAndSex("Thor Odin", 1);
    System.out.println("查询到的数据为:" + userList);
}

执行该测试方法 image.png

Java Bean 传参

当查询条件比较多时,建议将所有查询条件封装到Java Bean中,直接将Java Bean作为入参传到方法中。

User selectOneByEntity(User user);

增加selectOneByEntity对应的SQL语句

<select id="selectOneByEntity" resultType="user">
    SELECT
    <include refid="userColumns"></include>
    FROM t_user
    WHERE id = #{id}
    AND user_name = #{userName}
    AND real_name = #{realName}
</select>

在UserMapperTest中增加测试方法

@Test
public void selectOneByEntity() {
    SqlSession sqlSession = sqlSessionFactory.openSession();
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    User user = new User();
    user.setId(1);
    user.setUserName("stark");
    user.setRealName("Tony Stark");

    User dbUser =  mapper.selectOneByEntity(user);
    System.out.println("查询到的数据为:" + dbUser);
}

执行该测试方法 image.png 查询方法中设置了Value的属性都出现在SQL语句的查询条件中。

insert、update、delete 标签

insert、update、delete 标签包含的属性如下:

属性描述备注
id在命名空间中唯一的标识符,可以被用来引用这条语句。如果命名空间和id组合起来不唯一,会抛出异常
useGeneratedKeys仅对insert和update有用,这会使MyBatis使用JDBC的generatedKeys方法取出生成的主键,作为插入数据的主键,插入时传参就不需要设置id的值了。默认值:false
keyProperty标记一个属性,与主键字段对应的实体类属性,MyBatis会将生成的主键的值赋值给该属性,当有多个主键属性时,使用逗号隔开
keyColumn标记一个主键字段,与keyProperty设置的主键属性一一对应,有多个可以使用逗号隔开
parameterType传入参数的类型;可以给出类全名,也可以给出类别名,使用别名必须是MyBatis内部定义或自定义的;基本数据类型:int、String、long、date(不知是sql.date 还是 util.date) 复杂数据类型:类 和 Map可以选择JavaBean,Map等复杂的参数类型传递给SQL
flushCache将它的作用是在调用SQL后,是否要求MyBatis清空之前查询的本地缓存和二级缓存true/false,默认为false
timeout设置超时时间,超时之后抛出异常,秒默认值为数据库厂商提供的JDBC驱动所设置的秒数
statementType可选 STATEMENT,PREPARED 或 CALLABLE。这会让 MyBatis 分别使用 Statement,PreparedStatement 或 CallableStatement,默认值:PREPARED。
databaseId如果配置了数据库厂商标识(databaseIdProvider),MyBatis 会加载所有不带 databaseId 或匹配当前 databaseId 的语句;如果带和不带的语句都有,则不带的会被忽略。
分类:
后端
标签:
分类:
后端
标签:
收藏成功!
已添加到「」, 点击更改