MyBatis系列第3篇:MyBatis映射文件和参数处理

前言

映射文件指导着MyBatis如何进行数据库增删改查，有着非常重要的意义

一、增删改查

1.mybatis允许增删改查直接定义以下类型返回值

直接定义以下类型返回值：Integer、Long、Boolean
如果dao接口要有返回值直接定义即可,会自动封装。不用在mapper.xml中定义resultType，也定义不了

2.mappers将SQL映射注册到全局配置中

    <mappers>
        <!--mapper注册一个sql映射文件
        注册配置文件的：
        resource:引用类路径下的sql映射文件
        url:网络路径或磁盘下的sql映射文件
        注册接口
         class：引用注册接口
         1.有sql映射文件，映射文件必须和接口同名，并且放在与接口同一目录下
         2.没有sql映射文件，所有的sql都是利用注解写在接口上
        -->
        <!-- <mapper resource="EmployeeMapper.xml"/>-->
        <!--<mapper class="com.ming.dao.EmployeeMapper"/>-->
        <!--  package 批量注册的
          映射文件必须和接口同名，并且放在与接口同一目录下-->
        <package name="com.ming.dao"/>
        <!-- <mapper url="file:///E:/javacode/idea_workspace/mybatispro/config/EmployeeMapper.xml"/>-->
    </mappers>

3.mybatis获取自增主键

mysql支持自增主键，自增主键值的获取

	<!-- parameterType：参数类型，可以省略， 
	获取自增主键的值：
		mysql支持自增主键，自增主键值的获取，mybatis也是利用statement.getGenreatedKeys()；
		useGeneratedKeys="true"；使用自增主键获取主键值策略
		keyProperty；指定对应的主键属性，也就是mybatis获取到主键值以后，将这个值封装给javaBean的哪个属性
	-->
	<insert id="addEmp" parameterType="com.atguigu.mybatis.bean.Employee"
		useGeneratedKeys="true" keyProperty="id" databaseId="mysql">
		insert into tbl_employee(last_name,email,gender) 
		values(#{lastName},#{email},#{gender})
	</insert>

Oracle获取自增主键
而对于不支持自增型主键的数据库（例如Oracle），则可以使用 y selectKey 子元素： selectKey 元素将会首先运行， id 会被设置， 然后插入语句会被调用

<!-- 
	获取非自增主键的值：
		Oracle不支持自增；Oracle使用序列来模拟自增；
		每次插入的数据的主键是从序列中拿到的值；如何获取到这个值；
	 -->
	<insert id="addEmp" databaseId="oracle">
		<!-- 
		keyProperty:查出的主键值封装给javaBean的哪个属性
		order="BEFORE":当前sql在插入sql之前运行
			   AFTER：当前sql在插入sql之后运行
		resultType:查出的数据的返回值类型
		
		BEFORE运行顺序：
			先运行selectKey查询id的sql；查出id值封装给javaBean的id属性
			在运行插入的sql；就可以取出id属性对应的值
		AFTER运行顺序：
			先运行插入的sql（从序列中取出新值作为id）；
			再运行selectKey查询id的sql；
		 -->
		<selectKey keyProperty="id" order="BEFORE" resultType="Integer">
			<!-- 编写查询主键的sql语句 -->
			<!-- BEFORE-->
			select EMPLOYEES_SEQ.nextval from dual 
			<!-- AFTER：
			 select EMPLOYEES_SEQ.currval from dual -->
		</selectKey>
		
		<!-- 插入时的主键是从序列中拿到的 -->
		<!-- BEFORE:-->
		insert into employees(EMPLOYEE_ID,LAST_NAME,EMAIL) 
		values(#{id},#{lastName},#{email<!-- ,jdbcType=NULL -->}) 
		<!-- AFTER：
		insert into employees(EMPLOYEE_ID,LAST_NAME,EMAIL) 
		values(employees_seq.nextval,#{lastName},#{email}) -->
	</insert>

二、参数处理

1.单个参数

mybatis不会做特殊处理，#{参数名/任意名}：取出参数值。

2.多个参数

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

异常：org.apache.ibatis.binding.BindingException: Parameter 'id' not found. Available parameters are [1, 0, param1, param2]
方法：public Employee getEmpByIdAndLastName(Integer id,String lastName);
取值：#{id},#{lastName}
多个参数取值推荐使用命名参数

3.命名参数

明确指定封装参数时map的key；@Param(“id”)多个参数会被封装成 一个map，
key：使用@Param注解指定的值
value：参数值
#{指定的key}取出对应的参数值,#{id}

4.POJO

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

5.Map

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

6.TO

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

7.思考

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 ids);
取值：取出第一个id的值：#{list[0]}

8.参数处理封装Map的过程

结合源码，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;
    }
  }

9.#{}和${}的区别

#{}：可以获取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语句中，用？代替；相当于JDBC中单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不支持
两种解决办法
第一种：#{email,jdbcType=NULL}
第二种：在全局配置文件mybatis-config中设置jdbcTypeForNull=NULL

<setting name="jdbcTypeForNull" value="NULL"/>