MyBatis 学习（四）之 SQL 映射文件

目录

1 SQL 映射文件介绍

2 select 元素

3 insert 元素

4 update 和 delete 元素

5 sql 元素       

6 parameterType 元素

7 resultType 元素

8 resultMap 元素（重要）

9 参考文档

---

1 SQL 映射文件介绍

        映射器是 MyBatis 中最复杂并且是最重要的组件。它由一个接口和 SQL 映射文件（或者注解）组成。在映射器中我们可以配置各类 SQL、动态 SQL、缓存、存储过程、级联等复杂的内容。

以下是 SQL 映射文件的部分元素介绍

2 select 元素

select 元素表示 SQL 的 select 语句，用于查询，以下是 select 元素的部分属性

3 insert 元素

主键回填

        在 MyBatis 中，若表中的主键设置为自增，插入数据时没有插入主键，但是又想获得数据库中该条数据的主键，那么可以通过设置 useGeneratedKeys=”true”，然后再把 keyProperty 设置到目标属性（如 User 类中的 id 属性）上来获得该值。

<insert id="insertUser" parameterType="com.entity.User" useGeneratedKeys="true" keyProperty="id">
        insert into person(name, age, sex)
        values (#{name}, #{age}, #{sex});
insert>

//添加一个用户数据
@Test
public void testInsertUser() {
    String statement = "com.mapper.UserMapper.insertUser";
    User user = new User();
    user.setName("孙尚香");
    user.setAge(24);
    user.setSex("女");
    int i = sqlSession.insert(statement, user);
    System.out.println( (i>0)? "添加成功！":"添加失败！");
    //提交插入的数据
    sqlSession.commit();
    sqlSession.close();
    // 输出返回的主键值
    System.out.println("返回的主键值=" + user.getId());
}

自定义主键并且可以在 Java 中通过属性获得该值

在 MyBatis 中可以通过 selectKey 元素自定义主键，以下是其属性介绍

• keyProperty：selectKey 需要设置的目标属性
• resultType：结果类型
• order：可以设置为 BEFORE 或 AFTER ，表示先设置主键，后执行插入语句或先执行插入语句，后设置主键

<insert id="insertUser" parameterType="com.entity.User" >
    <selectKey keyProperty="id" resultType="int" order="BEFORE">
        select ROUND(RAND()*1000)
    selectKey>
    insert into person(id, name, age, sex)
    values (#{id}, #{name}, #{age}, #{sex});
insert>

@Test
public void testInsertUser() {
    String statement = "com.mapper.UserMapper.insertUser";
    User user = new User();
    user.setName("郑旦");
    user.setAge(24);
    user.setSex("女");
    int i = sqlSession.insert(statement, user);
    System.out.println( (i>0)? "添加成功！":"添加失败！");
    //提交插入的数据
    sqlSession.commit();
    sqlSession.close();
    // 输出返回的主键值
    System.out.println("返回的主键值=" + user.getId());
}

  

4 update 和 delete 元素

        update 和 delete 元素在使用上比较简单，所以这里把它们放在一起论述。它们和 insert 元素的属性差不多，执行完后也会返回一个整数，用来表示该 SQL 语句影响了多少条数据库记录。

<update id="updateUser">
    update person set name = #{name},
                      age = #{age},sex = #{sex} where id = #{id}
update>
<delete id="deleteUser" parameterType="int">
    delete from person where id = #{id}
delete>

5 sql 元素       

        sql 元素是用来定义可重用的 sql 代码片段，这样在字段比较多的时候，以便在其它语句中使用。需要结合 include 元素一起使用，以下是代码示例。

<sql id="userCols">
    id,username,age,sex
sql>
<select id="selectAllUser" resultType="com.entity.User">
    select <include refid="userCols"/> from person
select>

6 parameterType 元素

parameterType 元素可以输入以下类型：

• Java 基本数据类型
• POJO 类型
• Map 类型

<select id="selectUserById" parameterType="int" resultType="com.entity.User">
    select * from person where id = #{id};
select>
 
<insert id="insertUser" parameterType="com.entity.User">
    insert into person(id,username,age,sex) values (#{id},#{username},#{age},#{sex});
insert>
 
<select id="selectUserByUserNameAndAge" parameterType="com.entity.QueryVo" resultType="com.entity.User">
    select * from person where name = #{user.name} and age = #{user.age};
select>
 
<select id="selectUserByMap" parameterType="hashmap" resultType="com.entity.User">
    select * from person where name = #{name} and age = #{age};
select>

7 resultType 元素

resultType 元素和 parameterType 元素用法差不多，一个是输出，一个是输入。resultType 元素可以输出以下类型：

• Java 基本数据类型
• POJO 对象
• POJO 对象列表
• Map 对象列表

<select id="countUsers" resultType="int">
    select count(1) from person
select>
 
<select id="selectUserById" parameterType="int" resultType="com.entity.User">
    select * from personwhere id = #{id};
select>
 
<select id="selectAllUser" resultType="com.entity.User">
    select * from person
select>
 
<select id="selectAllUser" resultType="hashmap">
    select * from person
select>

8 resultMap 元素（重要）

        我们在使用 resultType 的时候，需要保证数据库表中的字段名和表对应实体类的属性名称一致才行（包括驼峰命名规则）。那不一致怎么办，查询的时候可以给列名起个别名，但是一般不建议这样做，而是通过 resultMap 元素进行一个转换。

<resultMap id="userMap" type="com.entity.User">
    
    <id property="userId" column="id"/>
    
    <result property="userName" column="username"/>
    <result property="userAge" column="age"/>
    <result property="userSex" column="sex"/>
resultMap>
 
<select id="selectAllUser" resultMap="userMap">
    select * from person
select>

上述代码是不是很眼熟，在 MyBatis 案例中使用了 @ResultMap 注解来实现上述代码

resultMap 元素的组成

<resultMap id="标识" type="输出类型" extends="继承其他 " autoMapping="自动映射">
    <constructor>
        
        
        <idArg column="id" name="userId" javaType="int"/>
        
        <arg column="username" name="userName" javaType="string"/> 
    constructor>
        
        <id property="userId" column="id"/>
        
        <result property="userName" column="username"/>
    <association/>
    <collection />
    <discriminator>
        <case/>
    discriminator>
resultMap>

9 参考文档

Mybatis3详解（四）----SQL映射文件详解(XxxMapper.xml) - 唐浩荣 - 博客园 (cnblogs.com)