Mybatis之参数篇

参数传递符号

#{}
${}

select * from tbl_employee where id=${id} and last_name=#{userName} Preparing: select * from tbl_employee where id=‘admin’ and last_name=?

区别：
#{}:是以预编译的形式，将参数设置到sql语句中。通过PreparedStatement可防止sql注入。
大多情况下，取参数的值都应该使用#{}。

${}:取出的值直接拼装在sql语句中；会有安全问题；
原生jdbc不支持占位符的地方我们就可以使用${}进行取值，比如分表、排序；按照年份分表拆分

select * from ${year}_salary where xxx;
select * from tb_sys_user order by ${f_name} ${order}

#{}更丰富的用法

规定参数的一些规则： javaType、 jdbcType、 mode（存储过程）、 numericScale、resultMap、 typeHandler、 jdbcTypeName、 expression（未来准备支持的功能）；

jdbcType通常需要在某种特定的条件下被设置：在我们数据为null的时候，有些数据库可能不能识别mybatis对null的默认处理。比如Oracle（报错）； JdbcType OTHER：无效的类型；因为mybatis对所有的null都映射的是原生Jdbc的OTHER类型，oracle不能正确处理;

由于全局配置中：jdbcTypeForNull=OTHER；oracle不支持；有以下两种办法解决：

#{email,jdbcType=OTHER}
jdbcTypeForNull=NULL

参数传递

单个参数

#{参数名/任意名}：取出参数值。

<!-- TbSysUser getUserById(String id); -->
<!-- parameterType="java.lang.String" 可不加 -->
<select id="getUserById" resultType="com.wm.demo.mybatis.model.TbSysUser">
    select * from tb_sys_user where user_id = #{id}
</select>

多个参数

mybatis会做特殊处理。多个参数会被封装成一个map。
key：param1…paramN,或者参数的索引也可以
value：传入的参数值
#{}就是从map中获取指定的key的值。

<!-- TbSysUser getUserByIdAndName(String id, String userName); -->
<select id="getUserByIdAndName" resultType="com.wm.demo.mybatis.model.TbSysUser">
    select * from tb_sys_user where user_id = #{0} and user_name like #{1}
</select>

Map封装多个参数

#{key}：取出map中对应的值

<!-- TbSysUser getUserByMap(Map<String, Object> map); -->
<select id="getUserByMap" resultType="com.wm.demo.mybatis.model.TbSysUser">
    select * from tb_sys_user where user_id = #{userId} and user_name like #{userName}
</select>

POJO作为参数

#{属性名}：取出传入的pojo的属性值

<!-- boolean updateUser(TbSysUser user); -->
<update id="updateUser">
    update tb_sys_user 
    set password=#{password},status=#{status}
    where user_id=#{userId}
</update>

TO作为参数

如果多个参数不是业务模型中的数据，但是经常要使用，推荐来编写一个TO（Transfer Object）数据传输对象

Page{
    int index;
    int size;
}

注解方式

<!-- TbSysUser getUserAnnoationByIdAndName(@Param("id") String id, @Param("userName") String userName); -->
<select id="getUserAnnoationByIdAndName" resultType="com.wm.demo.mybatis.model.TbSysUser">
    select * from tb_sys_user where user_id = #{id} and user_name like #{userName}
</select>

List封装数据集合（涉及动态SQL）

<!-- List<TbSysUser> getUsersByConditionForeach(@Param("ids")List<String> ids); -->
<select id="getUsersByConditionForeach" resultType="com.wm.demo.mybatis.model.TbSysUser">
    select * from tb_sys_user
    <!--
        collection：指定要遍历的集合：
            list类型的参数会特殊处理封装在map中，map的key就叫list
        item：将当前遍历出的元素赋值给指定的变量
        separator:每个元素之间的分隔符
        open：遍历出所有结果拼接一个开始的字符
        close:遍历出所有结果拼接一个结束的字符
        index:索引。遍历list的时候是index就是索引，item就是当前值
                      遍历map的时候index表示的就是map的key，item就是map的值
 		
        #{变量名}就能取出变量的值也就是当前遍历出的元素
      -->
    <foreach collection="ids" item="user_id" separator="," open="where user_id in(" close=")">
        #{user_id}
    </foreach>
</select>

复杂情况

public TbSysUser getUser(@Param("id")Integer id,String userName);
取值：id==>#{id/param1}   userName==>#{param2}

public TbSysUser getUser(Integer id,@Param("u")TbSysUser user);
取值：id==>#{param1}    userName===>#{param2.userName/u.userName}

如果是Collection（List、Set）类型或者是数组，也会特殊处理。也是把传入的list或者数组封装在map中。
key：Collection（collection）,如果是List还可以使用这个key(list) 数组(array)

List<TbSysUser> getUsersByConditionForeach(@Param("ids")List<String> ids);
取值：取出第一个id的值：   #{list[0]}

处理参数源码

总结：参数多时会封装map，为了不混乱，我们可以使用@Param来指定封装时使用的key；#{key}就可以取出map中的值；

TbSysUser getUserAnnoationByIdAndName(@Param("id") String id, @Param("userName") String userName);

ParamNameResolver解析参数封装map的； //1、names：{0=id, 1=userName}；构造器的时候就确定好了

确定流程：

获取每个标了param注解的参数的@Param的值：id，userName赋值给name;
每次解析一个参数给map中保存信息：（key：参数索引，value：name的值）

name的值：

标注了param注解：注解的值
没有标注：
全局配置：useActualParamName（jdk1.8）：name=参数名
name=map.size()；相当于当前元素的索引

测试数据：args[ ‘admin’，“测试%"]

public Object getNamedParams(Object[] args) {
    final int paramCount = names.size();
    //1、参数为null直接返回
    if (args == null || paramCount == 0) {
      return null;
	 
    //2、如果只有一个元素，并且没有Param注解；args[0]：单个参数直接返回
    } else if (!hasParamAnnotation && paramCount == 1) {
      return args[names.firstKey()];
	  
    //3、多个元素或者有Param标注
    } else {
      final Map<String, Object> param = new ParamMap<Object>();
      int i = 0;
	  
      //4、遍历names集合；{0=id, 1=userName}
      for (Map.Entry<Integer, String> entry : names.entrySet()) {
	  
        //names集合的value作为key;  names集合的key又作为取值的参考args[0]
        //eg:{id=args[0]:admin,lastName=args[1]:测试%}
        param.put(entry.getValue(), args[entry.getKey()]);
		
		
        // add generic param names (param1, param2, ...)param
        //额外的将每一个参数也保存到map中，使用新的key：param1...paramN
        //效果：有Param注解可以#{指定的key}，或者#{param1}
        final String genericParamName = GENERIC_NAME_PREFIX + String.valueOf(i + 1);
        // ensure not to overwrite parameter named with @Param
        if (!names.containsValue(genericParamName)) {
          param.put(genericParamName, args[entry.getKey()]);
        }
        i++;
      }
      return param;
    }
  }
}