Mapper.xml映射文件---Mybatis学习笔记（八）

Mapper.xml映射文件中定义了操作数据库的sql，每个sql是一个statement，映射文件是mybatis的核心。

parameterType(输入类型)

1.#{}与${}

#{}实现的是向prepareStatement中的预处理语句中设置参数值，sql语句中#{}表示一个占位符即?。

<!-- 根据id查询用户信息 -->
    <select id="findUserById" parameterType="int" resultType="user">
        select * from user where id = #{id}
    </select>

使用占位符#{}可以有效防止sql注入，在使用时不需要关心参数值的类型，mybatis会自动进行java类型和jdbc类型的转换。
#{}可以接收简单类型值或pojo属性值，如果parameterType传输单个简单类型值，#{}括号中可以是value或其它名称。

${}和#{}不同，通过${}可以将parameterType 传入的内容拼接在sql中且不进行jdbc类型转换。
${}可以接收简单类型值或pojo属性值，如果parameterType传输单个简单类型值，${}括号中只能是value。使用${}不能防止sql注入，但是有时用${}会非常方便，如下的例子：

<!-- 根据名称模糊查询用户信息 -->
    <select id="selectUserByName" parameterType="string" resultType="user">
       select * from user where username like '%${value}%'
    </select>

如果本例子使用#{}则传入的字符串中必须有%号，而%是人为拼接在参数中，显然有点麻烦，如果采用${}在sql中拼接为%的方式则在调用mapper接口传递参数就方便很多。

//如果使用占位符号则必须人为在传参数中加%
List<User> list = userMapper.selectUserByName("%管理员%");

//如果使用${}原始符号则不用人为在参数中加%
List<User>list = userMapper.selectUserByName("管理员");

再比如order by排序，如果将列名通过参数传入sql，根据传的列名进行排序，应该写为：

ORDER BY ${columnName}

如果使用#{}将无法实现此功能。

2.传递简单类型

<select id="findUserById" parameterType="int" resultType="user">
    select * from user where id=#{id}
</select>

3.传递pojo对象

Mybatis使用ognl表达式解析对象字段的值，如下例子：

<!—传递pojo对象综合查询用户信息 -->
    <select id="findUserByUser" parameterType="user" resultType="user">
       select * from user where id=#{id} and username like '%${username}%'
    </select>

上边sql语句中的id和username是user对象中的字段名称。
注意：parameterType中的user是事先在sqlMapConfig.xml文件中配置了别名的，如下：

<typeAliases>
        <!-- 针对单个别名的定义 -->
        <typeAlias alias="user" type="com.huihui.pojo.User"/>
    </typeAliases>

4.传递pojo包装对象

需求：
开发中通过pojo传递查询条件 ，查询条件是综合的查询条件，不仅包括用户查询条件还包括其它的查询条件（比如将用户购买商品信息也作为查询条件），这时可以使用包装对象传递输入参数。

1.自定义包装对象：
定义包装对象将查询条件(pojo)以类组合的方式包装起来。

package com.huihui.pojo;

/** * 用户的包装类型 * @author 62347 * */
public class UserQueryVo {

    //用户查询条件
    private User user;
    //用到的其它类条件
    //......

    public User getUser() {
        return user;
    }

    public void setUser(User user) {
        this.user = user;
    }


}

2.映射文件：

<select id="findUserList" parameterType="com.huihui.pojo.UserQueryVo" resultType="user">
    select * from user where username=#{user.username} and sex=#{user.sex}
</select>

说明：mybatis底层通过ognl从pojo中获取属性值：#{user.username}，user即是传入的包装对象的属性。com.huihui.pojo.UserQueryVo是定义的包装对象类型。

3.Mapper接口

public interface UserMapper {
    public List<User> findUserList(UserQueryVo queryVo) throws Exception;

}

5.传递hashmap

映射文件：

<!-- 传递hashmap综合查询用户信息 -->
    <select id="findUserByHashmap" parameterType="hashmap" resultType="user">
       select * from user where id=#{id} and username like '%${username}%'
    </select>

注意：
1.sql语句中的id和username是hashmap的key。
2.parameterType中的hashmap是别名

Mapper接口：

public interface UserMapper {
    public User findUserByHashMap(Map map) throws Exception;
}

测试类：

@Test
    public void testFindUserByHashMap() throws Exception{
        SqlSession sqlSession = sqlSessionFactory.openSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        Map<String,Object> map = new HashMap<String,Object>();
        map.put("id",26);
        map.put("username","王五");
        User user = userMapper.findUserByHashMap(map);
        System.out.println(user);
    }

1.resultType(输出类型)

使用resultType进行输出映射，只有查询出来的列名和pojo中的属性名一致，该列才可以映射成功。
如果查询出来的列名和pojo中的属性名全部不一致，那么就不会创建pojo对象。
只要查询出来的列名和pojo中的属性有一个一致，就会创建pojo对象。

输出简单类型：

映射文件：

<!-- 获取用户列表总数 -->
<select id="findUserCount" resultType="int">
    select count(*) from user
</select>

Mapper接口：

public int findUserCount() throws Exception;

测试类：

Public void testFindUserCount() throws Exception{
        //获取session
        SqlSession session = sqlSessionFactory.openSession();
        //获取mapper接口实例
        UserMapper userMapper = session.getMapper(UserMapper.class);

        int count = userMapper.findUserCount();

        //关闭session
        session.close();
    }

总结：
输出简单类型必须查询出来的结果集有一条记录，最终将第一个字段的值转换为输出类型。
使用session的selectOne可查询单条记录。

输出pojo对象：

映射文件：

<!-- 根据id查询用户信息 -->
    <select id="findUserById" parameterType="int" resultType="user">
        select * from user where id = #{id}
    </select>

mapper接口：

public User findUserById(int id) throws Exception;

测试：

Public void testFindUserById() throws Exception {
        //获取session
        SqlSession session = sqlSessionFactory.openSession();
        //获限mapper接口实例
        UserMapper userMapper = session.getMapper(UserMapper.class);
        //通过mapper接口调用statement
        User user = userMapper.findUserById(1);
        System.out.println(user);
        //关闭session
        session.close();
    }

这里使用session调用selectOne查询单条记录。

输出pojo列表：

映射文件：

<!-- 根据名称模糊查询用户信息 -->
    <select id="findUserByUsername" parameterType="string" resultType="user">
       select * from user where username like '%${value}%'
    </select>

mapper接口：

public List<User> findUserByUsername(String username) throws Exception;

测试：

Public void testFindUserByUsername()throws Exception{
        //获取session
        SqlSession session = sqlSessionFactory.openSession();
        //获限mapper接口实例
        UserMapper userMapper = session.getMapper(UserMapper.class);
        //如果使用占位符号则必须人为在传参数中加%
        //List<User> list = userMapper.selectUserByName("%管理员%");
        //如果使用${}原始符号则不用人为在参数中加%
        List<User> list = userMapper.findUserByUsername("管理员");
        //关闭session
        session.close();
    }

这里使用session的selectList方法获取pojo列表。

输出hashmap：

输出pojo对象可以改用hashmap输出类型，将输出的字段名称作为map的key，value为字段值。

resultType总结：

输出pojo对象和输出pojo列表在sql中定义的resultType是一样的。

返回单个pojo对象要保证sql查询出来的结果集为单条，内部使用session.selectOne方法调用，mapper接口使用pojo对象作为方法返回值。

返回pojo列表表示查询出来的结果集可能为多条，内部使用session.selectList方法，mapper接口使用List对象作为方法返回值。

2.resultMap(输出类型)

resultType可以指定pojo将查询结果映射为pojo，但需要pojo的属性名和sql查询的列名一致方可映射成功。
如果sql查询字段名和pojo的属性名不一致，可以通过resultMap将字段名和属性名作一个对应关系 ，resultMap实质上还需要将查询结果映射到pojo对象中。
resultMap可以实现将查询结果映射为复杂类型的pojo，比如在查询结果映射对象中包括pojo和list实现一对一查询和一对多查询。
1.映射文件：

<!--将select id id_,username username_ from user查询结果与User类中的属性做一个映射关系 -->
<!-- type:resultMap最终映射的java对象类型 id:对resultMap的唯一标识 -->
<resultMap type="user" id="userResultMap">
<!-- id表示对查询结果集中唯一列的标识 column:查询出来的列名 property:上面type所指定的pojo中的属性名 最终resultMap对column和property做一个映射关系（对应关系） -->
    <id column="id_" property="id"/>
<!-- result表示对查询结果集中普通列的标识 column:查询出来的列名 property:上面type所指定的pojo中的属性名 最终resultMap对column和property做一个映射关系（对应关系） -->
    <result column="username_" property="username"/>
</resultMap>

<!-- resultMap中填写上面的<resultMap>标签的id 注意：如果这个resultMap在其它的<mapper>标签中，前边需要加<mapper>标签的namespace，eg:<mapper>标签的namespace+<resultMap>标签的id -->
<select id="findUserInfo" parameterType="int" resultMap="userResultMap">
    select id id_,username username_ from user where id=#{value}
</select>

说明：
<id />：此属性表示查询结果集的唯一标识，非常重要。如果是多个字段为复合唯一约束则定义多个<id />。
Property：表示person类的属性。
Column：表示sql查询出来的字段名。
Column和property放在一块儿表示将sql查询出来的字段映射到指定的pojo类属性上。

：普通结果，即pojo的属性。

2.Mapper接口

public User findUserInfo(int id) throws Exception;

3.测试：

@Test
    public void testFindUserInfo() throws Exception{
        SqlSession sqlSession = sqlSessionFactory.openSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        User user = userMapper.findUserInfo(24);
        System.out.println(user);
        sqlSession.close();
    }

动态sql

通过mybatis提供的各种标签方法实现动态拼接sql。

if

<!-- 传递pojo综合查询用户信息 -->
    <select id="findUserList" parameterType="user" resultType="user">
        select * from user 
        where 1=1 
        <if test="id!=null and id!=''">
        and id=#{id}
        </if>
        <if test="username!=null and username!=''">
        and username like '%${username}%'
        </if>
    </select>

注意要做不等于空字符串校验。

where

上边的sql也可以改为：

<select id="findUserList" parameterType="user" resultType="user">
        select * from user 
        <where>
        <if test="id!=null and id!=''">
        and id=#{id}
        </if>
        <if test="username!=null and username!=''">
        and username like '%${username}%'
        </if>
        </where>
    </select>

可以自动处理第一个and。

sql片段

Sql中可将重复的sql提取出来，使用时用include引用即可，最终达到sql重用的目的，如下：

<!-- 传递pojo综合查询用户信息 -->
    <select id="findUserList" parameterType="user" resultType="user">
        select * from user 
        <where>
        <if test="id!=null and id!=''">
        and id=#{id}
        </if>
        <if test="username!=null and username!=''">
        and username like '%${username}%'
        </if>
        </where>
    </select>

将where条件抽取出来：

<sql id="query_user_where">
    <if test="id!=null and id!=''">
        and id=#{id}
    </if>
    <if test="username!=null and username!=''">
        and username like '%${username}%'
    </if>
</sql>

使用include引用：

<select id="findUserList" parameterType="user" resultType="user">
        select * from user 
        <where>
        <include refid="query_user_where"/>
        </where>
    </select>

注意：如果引用其它mapper.xml的sql片段，则在引用时需要加上namespace，如下：

<include refid="namespace.sql片段”/>

经验：

1. 一个sql片段中最好是基于一张表，这样的话sql片段的可重用性才高。
2. 在sql片段中不要包括where

foreach

向sql传递数组或List，mybatis使用foreach解析，如下：
1. 通过pojo传递list
需求：
传入多个id查询用户信息，用下边两个sql实现：

SELECT * FROM USERS WHERE username LIKE '%张%' AND (id =10 OR id =89 OR id=16) SELECT * FROM USERS WHERE username LIKE '%张%' id IN (10,89,16)

在pojo中定义list属性ids存储多个用户id，并添加getter/setter方法

public class UserQueryIds {

    //传递多个用户id
    private List<Integer> ids;

    public List<Integer> getIds() {
        return ids;
    }

    public void setIds(List<Integer> ids) {
        this.ids = ids;
    }

}

映射文件（mapper.xml）：

<select id="findUserByIds" parameterType="com.huihui.pojo.UserQueryIds" resultType="user">
    select * from user
    <where>
        <if test="ids!=null and ids.size>0">
            <foreach collection="ids" item="id" open="and id in (" close=")" separator=",">
                #{id}
            </foreach>
        </if>
    </where>
</select>

说明：
collection：指定输入对象中集合属性名（也就是上面pojo中定义的属性名）
item：定义每次遍历后生成的对象的对象名
open：开始遍历时要拼接的字符串
close：结束遍历时要拼接的字符串
separator：定义遍历后产生的每个对象之间的字符串
<foreach></foreach>之间的内容：表示每次遍历需要拼接的字符串

mapper接口：

public List<User> findUserByIds(UserQueryIds ids) throws Exception;

测试：

@Test
    public void testFindUserByIds() throws Exception{
        SqlSession sqlSession = sqlSessionFactory.openSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        UserQueryIds ids = new UserQueryIds();
        List<Integer> list = new ArrayList<Integer>();
        list.add(1);
        list.add(10);
        list.add(28);
        ids.setIds(list);
        List<User> users = userMapper.findUserByIds(ids);
        System.out.println(users.size());

        sqlSession.close();
    }

2.传递单个List
传递List类型在编写mapper.xml没有区别，唯一不同的是只有一个List参数时它的参数名为list。
映射文件：

<select id="findUserBymIds" parameterType="java.util.List" resultType="user">
    select * from user
    <where>
        <if test="list!=null">
            <foreach collection="list" item="id" open="and id in(" close=")" separator="," >
                #{id}
            </foreach>
        </if>
    </where>
</select>

mapper接口：

public List<User> findUserBymIds(List<Integer> list) throws Exception;

测试：

@Test
    public void testFindUserBymIds() throws Exception{
        SqlSession sqlSession = sqlSessionFactory.openSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        List<Integer> list = new ArrayList<Integer>();
        list.add(1);
        list.add(10);
        list.add(28);
        List<User> users = userMapper.findUserBymIds(list);
        System.out.println(users.size());
        sqlSession.close();
    }

3.传递单个数组（数组中时pojo）
映射文件：

<select id="findUserByArray" parameterType="Object[]" resultType="user">
    select * from user
    <where>
        <if test="array!=null">
            <foreach collection="array" index="index" item="item" open="and id in(" close=")" separator=",">
                #{item.id}
            </foreach>
        </if>
    </where>
</select>

说明：
sql只接收一个数组参数，这时sql解析参数的名称mybatis固定为array，如果数组是通过一个pojo传递到sql则参数的名称为pojo中的属性名。
index：为数组的下标。
item：为遍历后生成的数组每个元素的名称，名称随意定义
open：循环开始需要拼接的字符串
close：循环结束需要拼接的字符串
separator：定义遍历后产生的每个对象之间的字符串

mapper接口：

public List<User> findUserByArray(Object[] objs) throws Exception;

测试：

@Test
    public void testFindUserByArray() throws Exception{
        SqlSession sqlSession = sqlSessionFactory.openSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        User user1 = new User();
        user1.setId(1);
        User user2 = new User();
        user2.setId(10);
        User user3 = new User();
        user3.setId(28);

        User[] users = {user1,user2,user3};
        List<User> list = userMapper.findUserByArray(users);
        System.out.println(list.size());
        sqlSession.close();
    }

4.传递单个数组（数组中是字符串类型）
映射文件：

<select id="findUserByArray1" parameterType="Object[]" resultType="user">
    select * from user
    <where>
        <if test="array!=null">
            <foreach collection="array" index="index" item="item" open="and id in(" close=")" separator=",">
                #{item}
            </foreach>
        </if>
    </where>
</select>

mapper接口：

public List<User> findUserByArray1(Object[] objs) throws Exception;

测试：

@Test
    public void testFindUserByArray1() throws Exception{
        SqlSession sqlSession = sqlSessionFactory.openSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        String[] ids = {"1","10","28"};
        List<User> users = userMapper.findUserByArray1(ids);
        System.out.println(users.size());
        sqlSession.close();
    }