MyBatis全局配置

全局配置中的属性非常多&＃xff0c;主要有如下几方面&＃xff1a;

• properties&＃xff08;属性&＃xff09;
• settings&＃xff08;全局配置参数&＃xff09;
• typeAliases&＃xff08;类型别名&＃xff09;
• typeHandlers&＃xff08;类型处理器&＃xff09;
• objectFactory&＃xff08;对象工厂&＃xff09;
• plugins&＃xff08;插件&＃xff09;
• environments&＃xff08;环境集合属性对象&＃xff09;
• environment&＃xff08;环境子属性对象&＃xff09;
• transactionManager&＃xff08;事务管理&＃xff09;
• dataSource&＃xff08;数据源&＃xff09;
• mappers&＃xff08;映射器&＃xff09;

properties

properties 可以用来引入一个外部配置&＃xff0c;最近常见的例子就是引入数据库的配置文件&＃xff0c;例如我们在 resources 目录下添加一个 db.properties 文件作为数据库的配置文件&＃xff0c;文件内容如下&＃xff1a;

db.username&＃61;root
db.password&＃61;123
db.driver&＃61;com.mysql.cj.jdbc.Driver
db.url&＃61;jdbc:mysql:///test01?serverTimezone&＃61;Asia/Shanghai


然后&＃xff0c;利用 mybatis-config.xml 配置文件中的 properties 属性&＃xff0c;引入这个配置文件&＃xff0c;然后在 DataSource 中使用这个配置文件&＃xff0c;最终配置如下&＃xff1a;

<configuration><properties resource&＃61;"db.properties">properties><environments default&＃61;"development"><environment id&＃61;"development"><transactionManager type&＃61;"JDBC"/><dataSource type&＃61;"POOLED"><property name&＃61;"driver" value&＃61;"${db.driver}"/><property name&＃61;"url" value&＃61;"${db.url}"/><property name&＃61;"username" value&＃61;"${db.username}"/><property name&＃61;"password" value&＃61;"${db.password}"/>dataSource>environment>environments><mappers><package name&＃61;"com.antonio.hello.mybatis.mapper"/>mappers>
configuration>


settings

typeAliases

这个是 MyBatis 中定义的别名&＃xff0c;分两种&＃xff0c;一种是 MyBatis 自带的别名&＃xff0c;另一种是我们自定义的别名。

MyBatis 自带的别名

本来&＃xff0c;我们在 Mapper 中定义数据类型时&＃xff0c;需要写全路径&＃xff0c;如下&＃xff1a;

<select id&＃61;"getUserCount" resultType&＃61;"java.lang.Integer">select count(*) from user ;
select>


但是&＃xff0c;每次写全路径比较麻烦。这种时候&＃xff0c;我们可以用类型的别名来代替&＃xff0c;例如用 int 做 Integer 的别名&＃xff1a;

<select id&＃61;"getUserCount" resultType&＃61;"int">select count(*) from user ;
select>


自定义别名

我们自己的对象&＃xff0c;在 Mapper 中定义的时候&＃xff0c;也是需要写全路径&＃xff1a;

<select id&＃61;"getAllUser" resultType&＃61;"com.antonio.hello.mybatis.entity.User">select * from user;
select>


这种情况下&＃xff0c;写全路径也比较麻烦&＃xff0c;我们可以给我们自己的 User 对象取一个别名&＃xff0c;在 mybatis-config.xml 中添加 typeAliases 节点&＃xff1a;

<configuration><properties resource&＃61;"db.properties">properties><typeAliases><typeAlias type&＃61;"com.antonio.hello.mybatis.entity.User" alias&＃61;"user"/>typeAliases><environments default&＃61;"development"><environment id&＃61;"development"><transactionManager type&＃61;"JDBC"/><dataSource type&＃61;"POOLED"><property name&＃61;"driver" value&＃61;"${db.driver}"/><property name&＃61;"url" value&＃61;"${db.url}"/><property name&＃61;"username" value&＃61;"${db.username}"/><property name&＃61;"password" value&＃61;"${db.password}"/>dataSource>environment>environments><mappers><package name&＃61;"com.antonio.hello.mybatis.mapper"/>mappers>
configuration>


这里&＃xff0c;我们给 User 对象取了一个别名叫 user&＃xff0c;然后&＃xff0c;我们就可以在 Mapper 中直接使用 user 来代替 User 对象了&＃xff1a;

<select id&＃61;"getAllUser" resultType&＃61;"user">select * from user;
select>


但是&＃xff0c;这种一个一个去枚举对象的过程非常麻烦&＃xff0c;我们还可以批量给对象定义别名&＃xff0c;批量定义主要是利用包扫描来做&＃xff0c;批量定义默认的类的别名&＃xff0c;是类名首字母小写&＃xff0c;例如如下配置&＃xff1a;

<typeAliases><package name&＃61;"com.antonio.hello.mybatis.entity"/>
typeAliases>


这个配置就表示给 com.antonio.hello.mybatis.entity 包下的所有类取别名&＃xff0c;默认的别名就是类名首字母小写。这个时候&＃xff0c;我们在 Mapper 中&＃xff0c;就可以利用 user 代替 User 全路径了&＃xff1a;

<select id&＃61;"getAllUser" resultType&＃61;"user">select * from user;
select>


在最新版中&＃xff0c;批量定义的别名&＃xff0c;类名首字母也可以不用小写&＃xff0c;在实际开发中&＃xff0c;我们一般使用第二种方式&＃xff08;批量定义的方式&＃xff09;

typeHandlers

在 MyBatis 映射中&＃xff0c;能够自动将 Jdbc 类型映射为 Java 类型。默认的映射规则&＃xff0c;如下&＃xff1a;

前面案例中&＃xff0c;之所以数据能够接收成功&＃xff0c;是因为有上面这些默认的类型处理器&＃xff0c;处理基本数据类型&＃xff0c;这些够用了&＃xff0c;特殊类型&＃xff0c;需要我们自定义类型处理器。

比如&＃xff0c;我有一个用户爱好的字段&＃xff0c;这个字段&＃xff0c;在对象中&＃xff0c;是一个 List 集合&＃xff0c;在数据库中&＃xff0c;是一个 VARCHAR 字段&＃xff0c;这种情况下&＃xff0c;就需要我们自定义类型转换器&＃xff0c;自定义的类型转换器提供两个功能&＃xff1a;

1. 数据存储时&＃xff0c;自动将 List 集合&＃xff0c;转为字符串&＃xff08;格式自定义&＃xff09;
2. 数据查询时&＃xff0c;将查到的字符串再转为 List 集合

首先&＃xff0c;在数据表中添加一个 favorites 字段。然后&＃xff0c;在 User 对象中&＃xff0c;添加相应的属性&＃xff1a;

public class User {private Integer id;private String username;private String address;private List<String> favorites;// 省略 setter/getter
}


为了能够将 List 集合中的数据存入到 VARCHAR 中&＃xff0c;我们需要自定义一个类型转换器&＃xff1a;

&＃64;MappedJdbcTypes(JdbcType.VARCHAR)
&＃64;MappedTypes(List.class)
public class List2VarcharHandler implements TypeHandler<List<String>> {public void setParameter(PreparedStatement ps, int i, List<String> parameter, JdbcType jdbcType) throws SQLException {StringBuffer sb &＃61; new StringBuffer();for (String s : parameter) {sb.append(s).append(",");}ps.setString(i, sb.toString());}public List<String> getResult(ResultSet rs, String columnName) throws SQLException {String favs &＃61; rs.getString(columnName);if (favs !&＃61; null) {return Arrays.asList(favs.split(","));}return null;}public List<String> getResult(ResultSet rs, int columnIndex) throws SQLException {String favs &＃61; rs.getString(columnIndex);if (favs !&＃61; null) {return Arrays.asList(favs.split(","));}return null;}public List<String> getResult(CallableStatement cs, int columnIndex) throws SQLException {String favs &＃61; cs.getString(columnIndex);if (favs !&＃61; null) {return Arrays.asList(favs.split(","));}return null;}
}


• 首先在这个自定义的类型转换器上添加 &＃64;MappedJdbcTypes 注解指定要处理的 Jdbc 数据类型&＃xff0c;另外还有一个注解是 &＃64;MappedTypes 指定要处理的 Java 类型&＃xff0c;这两个注解结合起来&＃xff0c;就可以锁定要处理的字段是 favorites 了。
• setParameter 方法看名字就知道是设置参数的&＃xff0c;这个设置过程由我们手动实现&＃xff0c;我们在这里&＃xff0c;将 List 集合中的每一项&＃xff0c;用一个 , 串起来&＃xff0c;组成一个字符串。
• getResult 方法&＃xff0c;有三个重载方法&＃xff0c;其实都是处理查询的。

接下来&＃xff0c;修改插入的 Mapper&＃xff1a;

<insert id&＃61;"addUser" parameterType&＃61;"com.antonio.hello.mybatis.entity.User">insert into user (username,address,favorites) values (#{username},#{address},#{favorites,typeHandler&＃61;com.antonio.hello.mybatis.typehandler.List2VarcharHandler});
insert>


然后&＃xff0c;在 Java 代码中&＃xff0c;调用该方法&＃xff1a;

public class Main2 {public static void main(String[] args) {SqlSessionFactory instance &＃61; SqlSessionFactoryUtils.getInstance();SqlSession sqlSession &＃61; instance.openSession();UserMapper mapper &＃61; sqlSession.getMapper(UserMapper.class);User user &＃61; new User();user.setUsername("风气");user.setAddress("上海");List<String> favorites &＃61; new ArrayList<String>();favorites.add("足球");favorites.add("篮球");favorites.add("乒乓球");user.setFavorites(favorites);mapper.addUser(user);sqlSession.commit();}
}


这样&＃xff0c;List 集合存入到数据库中之后&＃xff0c;就变成一个字符串了。读取的配置&＃xff0c;有两个地方&＃xff0c;一个可以在 ResultMap 中做局部配置&＃xff0c;也可以在全局配置中进行过配置&＃xff0c;全局配置方式如下&＃xff1a;

<configuration><properties resource&＃61;"db.properties">properties><typeAliases><package name&＃61;"com.antonio.hello.mybatis.entity"/>typeAliases><typeHandlers><package name&＃61;"com.antonio.hello.mybatis.typehandler"/>typeHandlers><environments default&＃61;"development"><environment id&＃61;"development"><transactionManager type&＃61;"JDBC"/><dataSource type&＃61;"POOLED"><property name&＃61;"driver" value&＃61;"${db.driver}"/><property name&＃61;"url" value&＃61;"${db.url}"/><property name&＃61;"username" value&＃61;"${db.username}"/><property name&＃61;"password" value&＃61;"${db.password}"/>dataSource>environment>environments><mappers><package name&＃61;"com.antonio.hello.mybatis.mapper"/>mappers>
configuration>


接下来去查询&＃xff0c;查询过程中&＃xff0c;就会自动将字符串转为 List 集合了。

Mapper

Mapper 配置的几种方法&＃xff1a;

使用相对于类路径的资源&＃xff0c;即 XML 的定位&＃xff0c;从 classpath 开始写。如&＃xff1a;

<mapper resource&＃61;"mapping/User.xml" />


使用完全限定路径&＃xff0c;相当于使用绝对路径&＃xff0c;这种方式使用非常少。如&＃xff1a;

<mapper url&＃61;"file:///D:\demo\xxx\User.xml" />


使用 mapper 接口类路径&＃xff0c;注意&＃xff1a;此种方法要求 mapper 接口名称和 mapper 映射文件名称相同&＃xff0c;且放在同一个目录中。如&＃xff1a;

<mapper class&＃61;"com.antonio.hello.mybatis.mapper.UserMapper"/>


注册指定包下的所有 mapper 接口。如&＃xff1a;

<package name&＃61;"com.antonio.hello.mybatis.mapper"/>


注意&＃xff1a;此种方法要求 mapper 接口名称和 mapper 映射文件名称相同&＃xff0c;且放在同一个目录中。实际项目中&＃xff0c;多采用这种方式。

更多干货请移步&＃xff1a;https://antoniopeng.com