四、映射文件Mapper.xml

2024-03-14 12:19:04

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

一、parameterType(输入类型)

1.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}

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

1.2、传递简单类型

　　参考上边的例子。

1.3、传递pojo对象

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

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

id、username 是user对象中的字段名称。

1.4、传递pojo包装对象

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

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

public class QueryVo {
    
    private User user;
    
    //自定义用户扩展类
    private UserCustom userCustom;

<select id="findUser" parameterType="queryVo" resultType="user">
        select * from user where id = #{user.id } and username =#{user.username}
</select>

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

1.5、传递hashmap

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

上边id、username是hashmap的key。

二、resultType(输出类型)

输出pojo对象和输出pojo列表在sql中定义的resultType是一样的。
返回单个pojo对象要保证sql查询出来的结果集为单条，内部使用session.selectOne方法调用，mapper接口使用pojo对象作为方法返回值。
返回pojo列表表示查询出来的结果集可能为多条，内部使用session.selectList方法，mapper接口使用List<pojo>对象作为方法返回值。

2.1、输出HashMap

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

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

<!-- 定义resultMap
    将 USER表 和User类中的属性作一个映射关系
    type：resultMap最终映射的java对象类型,可以使用别名
    id：对resultMap的唯一标识
     -->    
<resultMap type="com.jdy.mybaties2020.bean.User" id="userMap">
    <!-- 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" />
        <result column="sex" property="sex" />
        <result column="birthday" property="birthday" />
        <result column="address" property="address" />
    </resultMap>

三、动态sql

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

3.1、If

<!-- 更新用户 -->
    <update id="updateUser" parameterType="com.jdy.mybaties2020.bean.User">
        update user
        <set>
            <if test="username != null">
                username = #{username},
            </if>
            <if test="birthday != null">
                birthday = #{birthday},
            </if>
            <if test="sex != null">
                sex = #{sex},
            </if>
            <if test="address != null">
                address = #{address},
            </if>
        </set>
        where id=#{id}
    </update>

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

3.2、foreach

(1)、通过pojo传递list

　　需求：传入多个id查询用户信息，用下边两个sql实现

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

<select id="findUserList" parameterType="hashmap" resultMap="userResultMap">
        select * from user
        <where>
            <if test="ids!=null and ids.size>0">
                <foreach collection="ids" item="id" open="id in(" close=")" separator=",">
                    #{id}
                </foreach>
            </if>
        </where>
    </select>

　　入参是一个map

- ids：是map的key，对应的value是一个list集合
- conllection:map的key,对应的是map的value,是list集合
- item: 集合中每个元素的名称，自定义就行
- open：循环开始
- close：循环结束
- separator：中间分隔输出

　　测试

List<Integer> ids = new ArrayList<>();
        ids.add(10);
        ids.add(16);
        ids.add(24);
        Map<String, Object> maps = new HashMap<>();
        maps.put("ids",ids);
        List<User> result = mapper.findUserList(maps);
        sqlSession.close();

(2)、传递单个List

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

　　测试

Public void testselectUserByList()throws Exception{
        //获取session
        SqlSession session = sqlSessionFactory.openSession();
        //获限mapper接口实例
        UserMapper userMapper = session.getMapper(UserMapper.class);
        //构造查询条件List
        List<User> userlist = new ArrayList<User>();
        User user = new User();
        user.setId(1);
        userlist.add(user);
        user = new User();
        user.setId(2);
        userlist.add(user); 
        //传递userlist列表查询用户列表
        List<User>list = userMapper.selectUserByList(userlist);
        //关闭session
        session.close();
    }

(3)、传递单个数组（数组中是pojo）

<!-- 传递数组综合查询用户信息 -->
    <select id="selectUserByArray" parameterType="Object[]" resultType="user">
        select * from user 
        <where>
        <!-- 传递数组 -->
        <if test="array!=null">
        <foreach collection="array" index="index" item="item" open="and id in("separator=","close=")">
            #{item.id} 
        </foreach>
        </if>
        </where>
    </select>

　　sql只接收一个数组参数，这时sql解析参数的名称mybatis固定为array，如果数组是通过一个pojo传递到sql则参数的名称为pojo中的属性名。

- index：为数组的下标。
- item：为数组每个元素的名称，名称随意定义
- open：循环开始
- close：循环结束
- separator：中间分隔输出

Public void testselectUserByArray()throws Exception{
        //获取session
        SqlSession session = sqlSessionFactory.openSession();
        //获限mapper接口实例
        UserMapper userMapper = session.getMapper(UserMapper.class);
        //构造查询条件List
        Object[] userlist = new Object[2];
        User user = new User();
        user.setId(1);
        userlist[0]=user;
        user = new User();
        user.setId(2);
        userlist[1]=user;
        //传递user对象查询用户列表
        List<User>list = userMapper.selectUserByArray(userlist);
        //关闭session
        session.close();
    }

(4)、传递单个数组（数组中是字符串类型）

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

　　如果数组中是简单类型则写为#{item}，不用再通过ognl获取对象属性值了。

Public void testselectUserByArray()throws Exception{
        //获取session
        SqlSession session = sqlSessionFactory.openSession();
        //获限mapper接口实例
        UserMapper userMapper = session.getMapper(UserMapper.class);
        //构造查询条件List
        Object[] userlist = new Object[2];
        userlist[0]=”1”;
        userlist[1]=”2”;
        //传递user对象查询用户列表
        List<User>list = userMapper.selectUserByArray(userlist);
        //关闭session
        session.close();
    }

码农公寓