阿里Java架构师分享：MyBatis全局配置文件解析、输入与输出映射
本系列连载技术知识共9期，每1-2日更新一篇~
第一期：MyBatis知识、原始Dao开发和mapper代理开发
第二期：MyBatis全局配置文件解析、输入与输出映射，见下文。
一、MyBatis的全局配置文件SqlMapConfig.xml，配置内容和顺序如下：
1.properties（属性）
需求：
将数据库连接参数单独配置在db.properties中，只需要在SqlMapConfig.xml中加载db.properties的属性值。在SqlMapConfig.xml中就不需要对数据库连接参数硬编码。
将数据库连接参数只配置在db.properties中，原因：方便对参数进行统一管理，其它xml可以引用该db.properties。
在classpath下定义db.properties文件：
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc\:mysql\://localhost\:3306/mybatisdemo
jdbc.username=root
jdbc.password=
在SqlMapConfig.xml加载属性文件：
/p>
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
properties特性：
注意：MyBatis将按照下面的顺序来加载属性：
在properties元素体内定义的属性首先被读取。然后会读取properties元素中resourse或url加载的属性，它会覆盖已读取的同名属性。最后读取parameterType传递的属性，它会覆盖已读取的同名属性。
所以这里可能就会存在一个问题：假如UserMapper.xml中的有一个statement的入参名为name，
而db.properties中也有一个参数名叫name。
那最终UserMapper.xml中的select会读取到name=root，而不是用户传入的值。
建议：
不要在properties元素体内添加任何属性值，只将属性值定义在properties文件中。在properties文件中定义属性名要有一定的特殊性，如：xxx.xxx.xxx，jdbc.url，jbdc.username。
2.settings（全局参数配置）
MyBatis框架在运行时可以调整一些运行参数。
比如：开启二级缓存、开启延迟加载......
全局参数将会影响MyBatis的运行行为。
3.typeAliases（别名）
1）需求
在mapper.xml中，定义很多的statement，而statement需要parameterType指定输入参数的类型，需要resultType指定输出结果的映射类型。
如果在指定类型时输入类型全路径，不方便进行开发。可以针对parameterType或resultType指定的类型定义一些别名，在mapper.xml中通过别名定义，方便开发。
2）mybatis默认支持别名
3)、自定义别名
单个别名定义
引用别名
select * from user where id=#{id}
批量定义别名（常用）
4.typeHandlers（类型处理器）
MyBatis中通过typeHandlers完成jbdc类型和java类型的转换。通常情况下，MyBatis提供的类型处理器满足日常需要，不需要自定义。
5.mappers（映射配置）
1)通过resource加载单个文件
2)通过mapper接口加载单个mapper
按照上边的规范，将mapper.java和mapper.xml放在一个目录，且同名。
3)批量加载mapper（推荐使用）
二、MyBatis输入映射与输出映射
1. 输入映射
通过parameterType指定输入参数的类型，类型可以是简单类型、hashmap、pojo的包装类型。
1） #{}与${}
#{}实现的是向prepareStatement中的预处理语句设置参数值，sql语句中#{}表示一个占位符即?
select * from user where id=#{id}
使用占位符#{}可以有效防止sql注入，在使用时不需要关系参数值的类型，mybatis会自动进行java类型和jdbc类型的转换。#{}可以接收简单类型值或pojo属性值，如果parameterType传输单个类型值，#{}括号可以是value或其它名称。
${}和#{}不同，通过${}可以将parameterType传入的内容拼接在sql中且不进行jdbc类型转换，${}可以接收简单类型值或pojo属性值，如果parameterType传输单个简单类型值，${}括号中只能是value。使用${}不能防止sql注入，但是有时用${}会非常方便，如下例子：
select * from user where username LIKE '%${value}%'
如果本例子使用#{}则传入的字符串中必须要有%，而%是人为拼接在参数中，显然有点麻烦，如果采用${}在sql中拼接为%的方式则在调用mapper接口传递参数就方便很多。
//如果使用占位符号则必须人为在传参数中加%
List
//如果使用${}原始符号则不用人为在参数中加%
List
再比如order by排序，如果将列名通过参数传入sql，根据传的列名进行排序，应该写为：ORDER BY ${columnName}，如果使用#{}将无法实现此功能。
2）传递简单类型
参考上边的例子。
3） 传递pojo对象
mybatis使用ognl表达式解析对象字段的值，如下例子：
select * from user where id=#{id} and username like '%${username}%'
sql中红色标注的是user对象中的字段名称。
测试：
@Test
public void findUserByUserTest() throws Exception{
SqlSession sqlSession=sqlSessionFactory.openSession();
UserMapper userMapper=sqlSession.getMapper(UserMapper.class);
User user=new User();
user.setId(10);
user.setUsername("张三");
List
System.out.println(list);
sqlSession.close();
}
4）传递pojo包装对象
开发中通过pojo传递查询条件，查询条件是综合的查询条件，不仅包括用户查询条件，还包括其它的查询条件（比如将用户购买的商品信息也作为查询条件），这时可以使用包装对象传递输入参数。
需求：完成用户信息的综合查询，需要传入查询条件很复杂（可能包括用户信息、其它信息，比如商品、订单等） 定义包装类型pojo：针对上边需求，建议使用自定义的包装类型的pojo，在包装类型的pojo中将复杂的查询条件包装进去。
/**
* 包装类型
* @author Joanna.Yan
*
*/
public class UserQueryVo {
//在这里包装所需要的查询条件
//用户查询条件
private UserCustom userCustom;
public UserCustom getUserCustom() {
return userCustom;
}
public void setUserCustom(UserCustom userCustom) {
this.userCustom = userCustom;
}
//可以包装其它的查询条件，订单、商品
//......
}
mapper.xml：在UserMapper.xml中定义用户信息综合查询（查询条件复杂，通过高级查询进行复杂关联查询）
SELECT * FROM USER WHERE user.sex=#{userCustom.sex} AND user.username LIKE '%${userCustom.username}%'
mapper.java
//用户信息综合查询
public List
测试代码
@Test
public void findUserListTest() throws Exception{
SqlSession sqlSession=sqlSessionFactory.openSession();
UserMapper userMapper=sqlSession.getMapper(UserMapper.class);
//创建包装对象，设置查询条件
UserQueryVo userQueryVo=new UserQueryVo();
UserCustom userCustom=new UserCustom();
userCustom.setSex("1");
userCustom.setUsername("张三丰");
userQueryVo.setUserCustom(userCustom);
List
System.out.println(list);
}
5） 传递hashmap
sql映射文件定义如下：
select * from user where id=#{id} and username like '%${username}%'
sql中红的标注的是hashmap的key。
mapper.java:
//传递hashmap综合查询用户信息
public List
测试：
@Test
public void findUserByHashmapTest() throws Exception{
SqlSession sqlSession=sqlSessionFactory.openSession();
UserMapper userMapper=sqlSession.getMapper(UserMapper.class);
//构造查询条件HashMap对象
HashMap
map.put("id", 10);
map.put("username", "张三");
//传递HashMap对象查询用户列表
List
System.out.println(list);
sqlSession.close();
}
传递的map中的key和sql中解析的key不一致时，不会报错，只是通过key获取的值为空。
2. 输出映射
1）输出简单类型
看下边的例子，输出整型，mapper.xml文件：
select count(*) from user
mapper接口：
public interface UserMapper {
//获取用户列表总数
public int findUserCount(User user) throws Exception;
}
测试：
@Test
public void findUserCountTest() throws Exception{
SqlSession sqlSession=sqlSessionFactory.openSession();
//创建UserMapper对象，mybatis自动生成mapper代理对象
UserMapper userMapper=sqlSession.getMapper(UserMapper.class);
User user=new User();
user.setUsername("yan");
//调用userMapper的方法
int count=userMapper.findUserCount(user);
System.out.println(count);
sqlSession.close();
}
总结：
查询出来的结果集只有一行且一列，可以使用简单类型进行输出映射。
2）输出pojo对象和pojo列表
不管是输出的pojo单个对象还是一个列表（list中包括pojo），在mapper.xml中resultType指定的类型是一样的。
在mapper.java指定的方法返回值类型不一样：
输出单个pojo对象，方法返回值是单个对象类型。
输出pojo对象list，方法返回值是List
生成的动态代理对象中是根据mapper方法的返回值类型确定是调用session.selectOne（返回单个对象调用）还是session.selectList（返回集合对象调用）。
3） resultType总结
使用resultType进行输出映射，只有查询出来的列名和pojo中的属性名一致，该列才可以映射成功。
如果查询出来的列名和pojo中的属性名全部不一致，则不会创建pojo对象。
只要查询出来的列名和pojo中的属性有一个一致，就会创建pojo对象。
4） 输出hashmap
输出pojo对象可以改用hashmap输出类型，将输出的字段名称作为map的key，value为字段值。
5）resultMap
resultType可以指定将查询结果映射为pojo，但需要pojo的属性名和sql查询的列名一致才可映射成功。
如果sql查询字段名和pojo的属性名不一致，可以通过resultMap将字段名和属性名作一个对应关系，resultMap实质上还需要将查询结果映射到pojo对象中。
resultMap可以实现将查询结果映射为复杂类型的pojo，比如在查询结果映射对象中包括pojo和list实现实现一对一查询和一对多查询。
A、resultMap使用方法
如果查询出来的列名和pojo的属性名不一致，通过定义一个resultMap对列名和pojo属性名之间作一个映射关系。
定义resultMap使用resultMap作为statement的输出映射类型。
将下边的sql使用User完成映射
SELECT id id_,username username_ FROM USER WHERE id=#{value}
改sql对查询结果的列名进行了重新命名:
User类中属性名和上边查询列名不一致。
定义resultMap
B、使用resultMap作为statement的输出映射类型
SELECT id id_,username username_ FROM USER WHERE id=#{value}
C、mapper.java
//根据id查询用户信息，使用resultMap输出
public User findUserByIdResultMap(int id) throws Exception;
D、测试
@Test
public void findUserByIdResultMapTest() throws Exception{
SqlSession sqlSession=sqlSessionFactory.openSession();
UserMapper userMapper=sqlSession.getMapper(UserMapper.class);
User user=userMapper.findUserByIdResultMap(1);
System.out.println(user);
sqlSession.close();
}
总结：
查询出来的结果集只有一行且一列，可以使用简单类型进行输出映射。
3、输出pojo对象和pojo列表
1）不管是输出的pojo单个对象还是一个列表（list中包括pojo），在mapper.xml中resultType指定的类型是一样的。
在mapper.java指定的方法返回值类型不一样：
输出单个pojo对象，方法返回值是单个对象类型。
输出pojo对象list，方法返回值是List
生成的动态代理对象中是根据mapper方法的返回值类型确定是调用session.selectOne（返回单个对象调用）还是session.selectList（返回集合对象调用）。
2）resultType总结
使用resultType进行输出映射，只有查询出来的列名和pojo中的属性名一致，该列才可以映射成功。
如果查询出来的列名和pojo中的属性名全部不一致，则不会创建pojo对象。
只要查询出来的列名和pojo中的属性有一个一致，就会创建pojo对象。
3） 输出hashmap
输出pojo对象可以改用hashmap输出类型，将输出的字段名称作为map的key，value为字段值。
4）resultMap
resultType可以指定将查询结果映射为pojo，但需要pojo的属性名和sql查询的列名一致才可映射成功。
如果sql查询字段名和pojo的属性名不一致，可以通过resultMap将字段名和属性名作一个对应关系，resultMap实质上还需要将查询结果映射到pojo对象中。
resultMap可以实现将查询结果映射为复杂类型的pojo，比如在查询结果映射对象中包括pojo和list实现实现一对一查询和一对多查询。
resultMap使用方法
如果查询出来的列名和pojo的属性名不一致，通过定义一个resultMap对列名和pojo属性名之间作一个映射关系。
A、定义resultMap
B、使用resultMap作为statement的输出映射类型。
将下边的sql使用User完成映射
SELECT id id_,username username_ FROM USER WHERE id=#{value}
改sql对查询结果的列名进行了重新命名:
User类中属性名和上边查询列名不一致。
定义resultMap
使用resultMap作为statement的输出映射类型
SELECT id id_,username username_ FROM USER WHERE id=#{value}
mapper.java
//根据id查询用户信息，使用resultMap输出
public User findUserByIdResultMap(int id) throws Exception;
测试
@Test
public void findUserByIdResultMapTest() throws Exception{
SqlSession sqlSession=sqlSessionFactory.openSession();
UserMapper userMapper=sqlSession.getMapper(UserMapper.class);
User user=userMapper.findUserByIdResultMap(1);
System.out.println(user);
sqlSession.close();
}
结束语
感谢您耐心阅读，如果此文对您有帮助，请点个赞或转发~~
查看原文 >>
