Mybatis 映射器与XML配置职责分离

之前我们介绍了使用XML配置方式完成对数据的增删改查操作，使用此方式在实际调用时需要使用【命名空间.标签编号】的方式执行，此方式在编写SQL语句时很方便，而在执行SQL语句环节就显得不太优雅；另外我们也介绍了使用映射器完成对数据的增删改查操作，使用此方式在实际调用时可以直接调用接口中的方法来执行，但在编写SQL语句时则显得不太友好，尤其是在编写动态SQL语句时显得很麻烦；如果能把两种方式结合，XML配置动态SQL后使用映射器调用则会更加的优雅，本篇我们以此目的介绍映射器与XML配置职责分离。

如果您对在Mybatis映射器、XML配置不太了解，建议您先进行了解后再阅读本篇，可以参考：

Mybatis 使用映射器进行查询(@Select)、新增(@Insert)、修改(@Update)、删除(@Delete)https://blog.csdn.net/m1729339749/article/details/132831561Mybatis查询数据https://blog.csdn.net/m1729339749/article/details/132469672Mybatis 插入、修改、删除https://blog.csdn.net/m1729339749/article/details/132601345

一、数据准备

这里我们直接使用脚本初始化数据库中的数据

-- 如果数据库不存在则创建数据库
CREATE DATABASE IF NOT EXISTS demo DEFAULT CHARSET utf8;
-- 切换数据库
USE demo;
-- 创建用户表
CREATE TABLE IF NOT EXISTS T_USER(ID INT PRIMARY KEY,USERNAME VARCHAR(32) NOT NULL,AGE INT NOT NULL 
);
-- 插入用户数据
INSERT INTO T_USER(ID, USERNAME, AGE)
VALUES(1, '张三', 20),(2, '李四', 22),(3, '王五', 24);

创建了一个名称为demo的数据库；并在库里创建了名称为T_USER的用户表并向表中插入了数据

二、创建实体类

在cn.horse.demo下创建UserInfo、UserInfoQuery类

UserInfo类：

package cn.horse.demo;public class UserInfo {private Integer id;private String name;private Integer age;public void setId(Integer id) {this.id = id;}public Integer getId() {return id;}public void setName(String name) {this.name = name;}public String getName() {return name;}public void setAge(Integer age) {this.age = age;}public Integer getAge() {return age;}@Overridepublic String toString() {StringBuilder stringBuilder = new StringBuilder();stringBuilder.append('{');stringBuilder.append("id: " + this.id);stringBuilder.append(", ");stringBuilder.append("name: " + this.name);stringBuilder.append(", ");stringBuilder.append("age: " + this.age);stringBuilder.append('}');return stringBuilder.toString();}
}

UserInfoQuery类：

package cn.horse.demo;public class UserInfoQuery {private Integer startAge;private Integer endAge;public void setStartAge(Integer startAge) {this.startAge = startAge;}public Integer getStartAge() {return startAge;}public void setEndAge(Integer endAge) {this.endAge = endAge;}public Integer getEndAge() {return endAge;}
}

三、创建映射器、Mapper配置

在cn.horse.demo下创建UserInfoMapper接口

UserInfoMapper接口：

package cn.horse.demo;import org.apache.ibatis.annotations.*;import java.util.List;public interface UserInfoMapper {List<UserInfo> find(@Param("query") UserInfoQuery query);Integer insert(@Param("userInfoList") List<UserInfo> userInfoList);Integer update(@Param("userInfoList") List<UserInfo> userInfoList);Integer delete(@Param("idList") List<Integer> idList);
}

在resources下创建cn/horse/demo目录，并在此目录下创建UserInfoMapper.xml配置文件

UserInfoMapper.xml配置：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="cn.horse.demo.UserInfoMapper"><resultMap id="userInfoMap" type="cn.horse.demo.UserInfo"><result column="ID" property="id" /><result column="USERNAME" property="name"/><result column="AGE" property="age"/></resultMap><select id="find" parameterType="cn.horse.demo.UserInfoQuery" resultMap="userInfoMap">SELECTID,USERNAME,AGEFROM T_USER<where><if test="null != query.startAge">AND AGE &gt;= #{query.startAge}</if><if test="null != query.endAge">AND AGE &lt;= #{query.endAge}</if></where></select><insert id="insert">INSERT INTO T_USER(ID,USERNAME,AGE)VALUES<foreach collection="userInfoList" item="userInfo" separator=",">(#{userInfo.id}, #{userInfo.name}, #{userInfo.age})</foreach></insert><update id="update"><foreach collection="userInfoList" item="userInfo" separator=";" close=";">UPDATE T_USER<set><if test="null != userInfo.name and '' != userInfo.name">USERNAME = #{userInfo.name},</if><if test="null != userInfo.age">AGE = #{userInfo.age},</if></set>WHERE ID = #{userInfo.id}</foreach></update><delete id="delete">DELETE FROM T_USER<where>ID IN<foreach collection="idList" item="id" open="(" separator="," close=")">#{id}</foreach></where></delete>
</mapper>

注意：

1. UserInfoMapper.xml配置文件需要与UserInfoMapper接口所在目录保持一致，因为在UserInfoMapper接口加载时会加载同目录下的UserInfoMapper.xml配置文件，如果目录不一致，则UserInfoMapper.xml配置文件将不会被加载。
2. UserInfoMapper.xml配置文件中的命名空间必须是UserInfoMapper接口的全限类名，另外UserInfoMapper.xml配置文件中的标签编号需要与UserInfoMapper接口中的方法名一致。

四、引入配置文件

在resources下新建mybatis-config.xml配置文件，并引入UserInfoMapper映射器。

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration><settings><setting name="logImpl" value="JDK_LOGGING"/></settings><environments default="development"><environment id="development"><transactionManager type="JDBC"/><dataSource type="POOLED"><property name="driver" value="org.gjt.mm.mysql.Driver"/><property name="url" value="jdbc:mysql://localhost:3306/demo?useUnicode=true&amp;useSSL=false&amp;characterEncoding=utf8&amp;allowMultiQueries=true"/><property name="username" value="root"/><property name="password" value="horse"/></dataSource></environment></environments><mappers><mapper class="cn.horse.demo.UserInfoMapper" /></mappers>
</configuration>

这里我们使用mapper引入映射器，只需要设置class属性为UserInfoMapper接口的全限类名。

五、启动程序配置

1、会话工具类

在cn.horse.demo包下新建SqlSessionUtils工具类

package cn.horse.demo;import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;import java.io.InputStream;
import java.util.Objects;public class SqlSessionUtils {private static final SqlSessionFactory sqlSessionFactory;static {// 读取mybatis配置文件InputStream inputStream = ClassLoader.getSystemClassLoader().getResourceAsStream("mybatis-config.xml");// 根据配置创建SqlSession工厂sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);}/*** 开启会话* @return*/public static SqlSession openSession() {return sqlSessionFactory.openSession();}/*** 关闭会话* @param sqlSession*/public static void closeSession(SqlSession sqlSession) {if(Objects.nonNull(sqlSession)) {sqlSession.close();}}
}

2、JDK 日志系统配置

在resources的目录下新建logging.properties配置文件

handlers=java.util.logging.ConsoleHandler
.level=INFOcn.horse.demo.UserInfoMapper.level=FINER
java.util.logging.ConsoleHandler.level=ALL
java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter
java.util.logging.SimpleFormatter.format=%1$tY-%1$tm-%1$td %1$tT.%1$tL %4$s %3$s - %5$s%6$s%n

在cn.horse.demo下创建JdkLogConfig类

JdkLogConfig类：

package cn.horse.demo;import java.io.IOException;
import java.io.InputStream;
import java.util.logging.LogManager;public class JdkLogConfig {public JdkLogConfig() {try {InputStream inputStream = ClassLoader.getSystemClassLoader().getResourceAsStream("logging.properties");LogManager.getLogManager().readConfiguration(inputStream);} catch (IOException e) {throw new RuntimeException(e);}}
}

3、启动程序配置

package cn.horse.demo;import org.apache.ibatis.session.SqlSession;import java.util.List;
import java.util.function.Consumer;public class Main {public static void main(String[] args) {// 引入JDK日志配置System.setProperty("java.util.logging.config.class", "cn.horse.demo.JdkLogConfig");}private static void execute(Consumer<UserInfoMapper> function) {SqlSession sqlSession = null;try {sqlSession = SqlSessionUtils.openSession();function.accept(sqlSession.getMapper(UserInfoMapper.class));sqlSession.commit();} finally {SqlSessionUtils.closeSession(sqlSession);}}
}

execute方法用于执行操作，方法中使用sqlSession.getMapper方法获取映射器对象，然后将映射器对象具体的执行操作委托给了Consumer对象。

六、查询数据

// 引入JDK日志配置
System.setProperty("java.util.logging.config.class", "cn.horse.demo.JdkLogConfig");// 查询
execute((UserInfoMapper userInfoMapper) -> {UserInfoQuery query = new UserInfoQuery();query.setStartAge(20);List<UserInfo> userInfoList = userInfoMapper.find(query);for (UserInfo userInfo: userInfoList) {System.out.println(userInfo);}
});

执行后的结果如下：

七、批量新增数据

// 引入JDK日志配置
System.setProperty("java.util.logging.config.class", "cn.horse.demo.JdkLogConfig");// 插入
execute((UserInfoMapper userInfoMapper) -> {List<UserInfo> userInfoList = new ArrayList<>();UserInfo userInfo1 = new UserInfo();userInfo1.setId(5);userInfo1.setName("王五1");userInfo1.setAge(5);userInfoList.add(userInfo1);UserInfo userInfo2 = new UserInfo();userInfo2.setId(6);userInfo2.setName("王五2");userInfo2.setAge(6);userInfoList.add(userInfo2);Integer total = userInfoMapper.insert(userInfoList);System.out.println("插入条数: " + total);
});

执行后的结果如下：

八、批量修改数据

// 引入JDK日志配置
System.setProperty("java.util.logging.config.class", "cn.horse.demo.JdkLogConfig");// 更新
execute((UserInfoMapper userInfoMapper) -> {List<UserInfo> userInfoList = new ArrayList<>();UserInfo userInfo1 = new UserInfo();userInfo1.setId(5);userInfo1.setName("王五11");userInfoList.add(userInfo1);UserInfo userInfo2 = new UserInfo();userInfo2.setId(6);userInfo2.setAge(26);userInfoList.add(userInfo2);Integer total = userInfoMapper.update(userInfoList);System.out.println("更新条数: " + total);
});

执行后的结果如下：

九、批量删除数据

// 引入JDK日志配置
System.setProperty("java.util.logging.config.class", "cn.horse.demo.JdkLogConfig");// 删除
execute((UserInfoMapper userInfoMapper) -> {Integer total = userInfoMapper.delete(Arrays.asList(5, 6));System.out.println("删除条数: " + total);
});

执行后的结果如下：