MyBatis_MyBatis之参数传递

1.引入

   我们通过上一节课实现了对一个实体对象的基本的增删查改操作,其中,我们在映射文件和测试的代码中添加了一下参数。那么接下来我们就一起来看看MyBatis中参数是如何传递的。

2.参数的分类以及参数是传递

(1).单个参数:可以接受基本类型,对象类型,集合类型的值。这种情况MyBatis可直接使用这个参数,不需要经过任何处理。

          规则:#{参数名/任意名}:取出参数值。

          示例:如:

//方法:
public Employee getEmpById(Integer id);


//调用时候参数的传递:
EmployeeMapperAnnotation mapper = openSession.getMapper(EmployeeMapperAnnotation.class);
Employee empById = mapper.getEmpById(1);


//参数传递给SQL
<select id="getEmpById" resultType="com.atguigu.mybatis.bean.Employee">
		select * from tbl_employee where id = #{id}
</select>

//这里直接使用:#{参数名/任意名}:取出参数值。

(2).多个参数:

         按照我们上面所写的单个参数,我们照着单个参数的形式尝试着写了一下多个参数的形式,发现结果如下:

//方法
public Employee getEmpByIdAndLastName(Integer id,String lastName);

//调用测试:
EmployeeMapper mapper = openSession.getMapper(EmployeeMapper.class);
Employee employee = mapper.getEmpByIdAndLastName(1, "tom");
System.out.println(employee);


//传递给的SQL
<select id="getEmpByIdAndLastName" resultType="com.atguigu.mybatis.bean.Employee">
 		select * from tbl_employee where id = #{id} and last_name=#{lastName}
 </select>


//结果报错:org.apache.ibatis.binding.BindingException: Parameter 'id' not found. 
	      Available parameters are [1, 0, param1, param2]

通过上面的操作,也就是说MyBatis对于多个参数的传递是做了比较特殊的操作,那么是什么样子的特殊操作呢?

       任意多个参数,都会被MyBatis重新包装成一个Map传入。Map的key是param1,param2,0,1…,值就是参数的值。也就是说:多个参数会被封装成 一个map,其中
         key:param1...paramN,或者参数的索引也可以,即0,1
         value:传入的参数值
         #{}就是从map中获取指定的key的值;但是实际上我们应该获取的是key所对应的值。

我们进行一下修改:

//方法
public Employee getEmpByIdAndLastName(Integer id,String lastName);

//调用测试:
EmployeeMapper mapper = openSession.getMapper(EmployeeMapper.class);
Employee employee = mapper.getEmpByIdAndLastName(1, "tom");
System.out.println(employee);


//传递给的SQL
<select id="getEmpByIdAndLastName" resultType="com.atguigu.mybatis.bean.Employee">
 		select * from tbl_employee where id = #{param1} and last_name=#{param2}
 </select>


但是,通过这样的修改以后参数是可以取出来了。但是我们发现当参数比较多的时候,每一个都写param或者是1,2,3这样没有见名知意的效果。MyBatis提供了一个叫做命名参数的来解决这一个问题。(推荐使用)

【命名参数】:明确指定封装参数时map的key;@Param("id")
                         多个参数会被封装成 一个map,
                         key:使用@Param注解指定的值
                        value:参数值
                       #{指定的key}取出对应的参数值

如下:

//方法
public Employee getEmpByIdAndLastName(@Param("id")Integer id,@Param("lastName")String lastName);

//调用测试:
EmployeeMapper mapper = openSession.getMapper(EmployeeMapper.class);
Employee employee = mapper.getEmpByIdAndLastName(1, "tom");
System.out.println(employee);


//传递给的SQL
<select id="getEmpByIdAndLastName" resultType="com.atguigu.mybatis.bean.Employee">
 		select * from tbl_employee where id = #{id} and last_name=#{lastName}
 </select>


(3).传递实体对象以及Map传递参数

         如果多个参数正好是我们业务逻辑的数据模型,我们就可以直接传入pojo;
          规则:#{属性名}:取出传入的pojo的属性值    

        Map:
        如果多个参数不是业务模型中的数据,没有对应的pojo,不经常使用,为了方便,我们也可以传入map。
        规则:  #{key}:取出map中对应的值。

       TO:
       如果多个参数不是业务模型中的数据,但是经常要使用,推荐来编写一个TO(Transfer Object)数据传输对象
       Page{
       int index;
       int size;
       }

       如:使用一个map作为多参数传递使用

//方法
public Employee getEmpByMap(Map<String, Object> map);

//方法测试
EmployeeMapper mapper = openSession.getMapper(EmployeeMapper.class);			
Map<String, Object> map = new HashMap<>();
map.put("id", 2);
map.put("lastName", "Tom");
map.put("tableName", "tbl_employee");
Employee employee = mapper.getEmpByMap(map);


//SQL
<select id="getEmpByMap" resultType="com.atguigu.mybatis.bean.Employee">
 		select * from ${tableName} where id=${id} and last_name=#{lastName}
</select>
 

3.如何选择使用什么作为参数传递:

针对不同的使用场景,应该如何选择使用的参数?

public Employee getEmp(@Param("id")Integer id,String lastName);
	取值:id==>#{id/param1}   lastName==>#{param2}


public Employee getEmp(Integer id,@Param("e")Employee emp);
	取值:id==>#{param1}    lastName===>#{param2.lastName/e.lastName}


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

public Employee getEmpById(List<Integer> ids);
	取值:取出第一个id的值:   #{list[0]}
	

4.MyBatis是如何处理参数的

MyBatis是如何处理参数的?

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

(@Param("id")Integer id,@Param("lastName")String lastName);
ParamNameResolver解析参数封装map的;
//1、names:{0=id, 1=lastName};构造器的时候就确定好了

	确定流程:
	1.获取每个标了param注解的参数的@Param的值:id,lastName;  赋值给name;
	2.每次解析一个参数给map中保存信息:(key:参数索引,value:name的值)
		name的值:
			标注了param注解:注解的值
			没有标注:
				1.全局配置:useActualParamName(jdk1.8):name=参数名
				2.name=map.size();相当于当前元素的索引
	{0=id, 1=lastName,2=2}
				

args【1,"Tom",'hello'】:

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=lastName,2=2}
      for (Map.Entry<Integer, String> entry : names.entrySet()) {
      
      	//names集合的value作为key;  names集合的key又作为取值的参考args[0]:args【1,"Tom"】:
      	//eg:{id=args[0]:1,lastName=args[1]:Tom,2=args[2]}
        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;
    }
  }
}

5.参数获取中#和$的区别

#{}:可以获取map中的值或者pojo对象属性的值;
${}:可以获取map中的值或者pojo对象属性的值;


select * from tbl_employee where id=${id} and last_name=#{lastName}
Preparing:

select * from tbl_employee where id=2 and last_name=?


区别:
        #{}:是以预编译的形式,将参数设置到sql语句中;PreparedStatement;防止sql注入
        ${}:取出的值直接拼装在sql语句中;会有安全问题;
        大多情况下,我们取参数的值都应该去使用#{};
        
        原生jdbc不支持占位符的地方我们就可以使用${}进行取值
        比如分表、排序。。。;按照年份分表拆分
            select * from ${year}_salary where xxx;
            select * from tbl_employee 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不支持;两种办法
        1、#{email,jdbcType=OTHER};
        2、jdbcTypeForNull=NULL
            <setting name="jdbcTypeForNull" value="NULL"/>
            
        

猜你喜欢

转载自blog.csdn.net/u013185175/article/details/107650071