Mybatis的Dao层实现方案、映射文件(动态SQL)及核心配置文件(typeHandlers、plugins)深入

超、凢脫俗 2022-10-09 03:29 5阅读 0赞

### 文章目录 ###

*   *  一、Mybatis的Dao层实现方式
     *   *  1.1 传统实现方式
         *   *  1.1.1 编写UserDao
             *  1.1.2 编写UserDaoImpl实现
             *  1.1.3 测试
         *  1.2 代理实现方式
         *   *  1.2.1 介绍
             *  1.2.2 编写UserMapper接口和UserMapper.xml
             *  1.2.3 测试
     *  二、Mybatis映射文件深入
     *   *  2.1 动态SQL语句
         *  2.2 动态 SQL 之if
         *  2.3 动态 SQL 之foreach
         *  2.4 SQL片段抽取
         *  2.5 小结
     *  三、Mybatis核心配置文件深入
     *   *  3.1 typeHandlers标签
         *   *  3.1.1 简介
             *  3.1.2 自定义typeHandlers
             *  3.1.2 示例
             *   *  3.1.2.1 定义转换类
                 *  3.1.2.2 注册类型转换器
                 *  3.1.2.3 测试
         *  3.2 plugins标签
         *   *  3.2.1 简介
             *  3.2.1 使用
             *  3.2.1.1 导入坐标
             *  3.2.1.2 注册插件
             *  3.2.1.3 测试
         *  3.3 小结

## 一、Mybatis的Dao层实现方式 ##

### 1.1 传统实现方式 ###

#### 1.1.1 编写UserDao ####

public interface UserDao {     
    	List<User> findAll() throws IOException;
    }

#### 1.1.2 编写UserDaoImpl实现 ####

public class UserDaoImpl implements UserDao {     
    	public List<User> findAll() throws IOException { 
    	        InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
    	        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
    	        SqlSession sqlSession = sqlSessionFactory.openSession();
    	        List<User> userList = sqlSession.selectList("userMapper.findAll");        
    	        sqlSession.close();        
    	        return userList;    
    	}
    }

#### 1.1.3 测试 ####

@Test
    public void testTraditionDao() throws IOException { 
        UserDao userDao = new UserDaoImpl();
        List<User> all = userDao.findAll();    
        System.out.println(all);
    }

### 1.2 代理实现方式 ###

#### 1.2.1 介绍 ####

采用`mybatis`的代理实现方式实现`DAO`层开发，是企业采用的主流方式。

`Mapper`接口开发方法只需要程序员编写`Mapper`接口(相当于`Dao`接口)，由Mybatis框架根据接口定义创建接口的动态代理对象，代理对象的方法体同上面`Dao`接口实现类方法。

`Mapper`接口开发需要遵循以下规范：

1.  `Mapper.xml`文件中的`namespace`与`mapper`接口的全限定名相同
2.  `Mapper`接口方法名和`Mapper.xml`中定义的每个`statement`的`id`相同
3.  `Mapper`接口方法的输入参数类型和`Mapper.xml`中定义的`sql`的`parameterType`类型相同
4.  `Mapper`接口方法的输出参数类型和`Mapper.xml`中定义的`sql`的`resultType`类型相同

#### 1.2.2 编写UserMapper接口和UserMapper.xml ####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzNTgxNjg_size_16_color_FFFFFF_t_70]

#### 1.2.3 测试 ####

@Test
    public void testProxyDao() throws IOException { 
        InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);    
        SqlSession sqlSession = sqlSessionFactory.openSession();    
        //获得MyBatis框架生成的UserMapper接口的实现类 
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);   
        User user = userMapper.findById(1);    
        System.out.println(user);    
        sqlSession.close();
    }

## 二、Mybatis映射文件深入 ##

### 2.1 动态SQL语句 ###

`Mybatis` 的映射文件中，前面我们的 `SQL` 都是比较简单的，有些时候业务逻辑复杂时，我们的 `SQL`是动态变化的，此时在前面的学习中我们的 `SQL`就不能满足要求了。

参考的官方文档，描述如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzNTgxNjg_size_16_color_FFFFFF_t_70 1]

### 2.2 动态 SQL 之if ###

我们根据实体类的不同取值，使用不同的 `SQL`语句来进行查询。比如在`id`如果不为空时可以根据id查询，如果`username` 不同空时还要加入用户名作为条件。这种情况在我们的多条件组合查询中经常会碰到。

<select id="findByCondition" parameterType="user" resultType="user">
        select * from User    
        <where>        
        	<if test="id!=0">
        	      and id=#{id} 
        	</if>        
        	<if test="username!=null">            
        	      and username=#{username}       
           </if>    
        </where>
    </select>

当查询条件`id`和`username`都存在时：

//获得MyBatis框架生成的UserMapper接口的实现类 
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);    
    User condition = new User();    
    condition.setId(1);    
    condition.setUsername("lucy");    
    User user = userMapper.findByCondition(condition);

最终执行的`SQL`如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzNTgxNjg_size_16_color_FFFFFF_t_70 2]  
当查询条件只有`id`存在时：

//获得MyBatis框架生成的UserMapper接口的实现类 
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);    
    User condition = new User();    
    condition.setId(1);    
    User user = userMapper.findByCondition(condition);

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzNTgxNjg_size_16_color_FFFFFF_t_70 3]

### 2.3 动态 SQL 之foreach ###

循环执行sql的拼接操作，例如：`SELECT * FROM USER WHERE id IN (1,2,5)`

`<foreach>`标签用于遍历集合，它的属性如下：

*  `collection`：代表要遍历的集合元素，注意编写时不要写\#\{\}
 *  `open`：代表语句的开始部分
 *  `close`：代表结束部分
 *  `item`：代表遍历集合的每个元素，生成的变量名
 *  `sperator`：代表分隔符

<select id="findByIds" parameterType="list" resultType="user">    
    	select * from User    
    	<where>       
    		<foreach collection="array" open="id in(" close=")" item="id" separator=",">            
    		#{id}        
    	    </foreach>    
    	</where>
    </select>

测试代码：

//获得MyBatis框架生成的UserMapper接口的实现类 
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);    
    int[] ids = new int[]{ 2,5};    
    List<User> userList = userMapper.findByIds(ids); 
    System.out.println(userList);

最终执行的SQL如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzNTgxNjg_size_16_color_FFFFFF_t_70 4]

### 2.4 SQL片段抽取 ###

将重复的 `sql`提取出来，使用时用 `include` 引用即可，最终达到`sql`重用的目的  
主要使用`<sql>`和`<include>`标签，示例如下：

<sql id="selectUser" select * from User</sql>
    <select id="findById" parameterType="int" resultType="user">    
    	<include refid="selectUser"></include> 
    	where id=#{id}
    </select>
    <select id="findByIds" parameterType="list" resultType="user">    
    	<include refid="selectUser"></include>    
    	<where>        
    		<foreach collection="array" open="id in(" close=")" item="id" separator=",">            
    			#{id}        
    		</foreach>    
    	</where>
    </select>

### 2.5 小结 ###

`Mybatis`映射文件配置：

*  `<select>`：查询
 *  `<insert>`：插入
 *  `<update>`：修改
 *  `<delete>`：删除
 *  `<where>`：`where`条件
 *  `<if>`：`if`判断
 *  `<foreach>`：循环
 *  `<sql>`：`sql`片段抽取

## 三、Mybatis核心配置文件深入 ##

### 3.1 typeHandlers标签 ###

#### 3.1.1 简介 ####

无论是 `MyBatis` 在预处理语句`（PreparedStatement）`中设置一个参数时，还是从结果集中取出一个值时， 都会用类型处理器将获取的值以合适的方式转换成 `Java`类型。下表描述了一些默认的类型处理器（截取部分）  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzNTgxNjg_size_16_color_FFFFFF_t_70 5]

#### 3.1.2 自定义typeHandlers ####

我们可以重写类型处理器或创建自己的类型处理器来处理不支持的或非标准的类型。

具体实现方案有以下两种形式：

*  实现 `org.apache.ibatis.type.TypeHandler` 接口
 *  继承一个很便利的类 `org.apache.ibatis.type.BaseTypeHandler`， 选择性地将它映射到一个`JDBC`类型

#### 3.1.2 示例 ####

需求：一个`Java`中的`Date`数据类型，想将之存到数据库的时候存成一个1970年至今的毫秒数，取出来时转换成`java`的`Date`，即`java`的`Date`与数据库的`varchar`毫秒值之间转换

##### 3.1.2.1 定义转换类 #####

在`handler`包下新建`DateTypeHandler`类，继承类`BaseTypeHandler`，覆盖4个未实现的方法，其中`setNonNullParameter`为`java`程序设置数据到数据库的回调方法，`getNullableResult`为查询时 `mysql`的字符串类型转换成 `java`的`Type`类型的方法，如下：

public class DateTypeHandler extends BaseTypeHandler<Date> { 
        //将java类型 转换成 数据库需要的类型
        public void setNonNullParameter(PreparedStatement preparedStatement, int i, Date date, JdbcType jdbcType) throws SQLException { 
            long time = date.getTime();
            preparedStatement.setLong(i,time);
        }
    
        //将数据库中类型 转换成java类型
        //String参数 要转换的字段名称
        //ResultSet 查询出的结果集
        public Date getNullableResult(ResultSet resultSet, String s) throws SQLException { 
            //获得结果集中需要的数据(long) 转换成Date类型 返回
            long aLong = resultSet.getLong(s);
            Date date = new Date(aLong);
            return date;
        }
    
        //将数据库中类型 转换成java类型
        public Date getNullableResult(ResultSet resultSet, int i) throws SQLException { 
            long aLong = resultSet.getLong(i);
            Date date = new Date(aLong);
            return date;
        }
    
        //将数据库中类型 转换成java类型
        public Date getNullableResult(CallableStatement callableStatement, int i) throws SQLException { 
            long aLong = callableStatement.getLong(i);
            Date date = new Date(aLong);
            return date;
        }
    }

##### 3.1.2.2 注册类型转换器 #####

在`Mybatis`核心配置文件`sqlMapConfig.xml`中注册类型转换器，如下：

<typeHandlers>
        <typeHandler handler="com.happy.handler.DateTypeHandler"></typeHandler>
    </typeHandlers>

##### 3.1.2.3 测试 #####

插入：执行测试代码，如下：

@Test
    public void test1() throws IOException { 
        InputStream resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml");
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
        SqlSession sqlSession = sqlSessionFactory.openSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    
        //创建user
        User user = new User();
        user.setUsername("ceshi");
        user.setPassword("abc");
        user.setBirthday(new Date());
        //执行保存造作
        mapper.save(user);
    
        sqlSession.commit();
        sqlSession.close();
    }

最终存储数据如下：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzNTgxNjg_size_16_color_FFFFFF_t_70 6]  
查询：执行代码，如下：

@Test
    public void test2() throws IOException { 
        InputStream resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml");
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
        SqlSession sqlSession = sqlSessionFactory.openSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    
        User user = mapper.findById(15);
        System.out.println("user中的birthday："+user.getBirthday());
    
        sqlSession.commit();
        sqlSession.close();
    }

输出日志如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzNTgxNjg_size_16_color_FFFFFF_t_70 7]

### 3.2 plugins标签 ###

#### 3.2.1 简介 ####

`MyBatis`可以使用第三方的插件来对功能进行扩展，分页助手`PageHelper`是将分页的复杂操作进行封装，使用简单的方式即可获得分页的相关数据.

#### 3.2.1 使用 ####

#### 3.2.1.1 导入坐标 ####

在`pom.xml`中导入分页插件坐标，如下：

<dependency>
        <groupId>com.github.pagehelper</groupId>    		 
        <artifactId>pagehelper</artifactId>    
        <version>3.7.5</version>
    </dependency>
    <dependency>    
        <groupId>com.github.jsqlparser</groupId>    
        <artifactId>jsqlparser</artifactId>    
        <version>0.9.1</version>
    </dependency>

#### 3.2.1.2 注册插件 ####

在`Mybatis`核心配置文件`sqlMapConfig.xml`中注册分页插件，如下：

<plugins>
        <plugin interceptor="com.github.pagehelper.PageHelper">
            <property name="dialect" value="mysql"></property>
        </plugin>
    </plugins>

#### 3.2.1.3 测试 ####

执行测试代码，如下：

@Test
    public void test3() throws IOException { 
        InputStream resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml");
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
        SqlSession sqlSession = sqlSessionFactory.openSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    
        //设置分页相关参数 当前页+每页显示的条数
        PageHelper.startPage(3,3);
    
        List<User> userList = mapper.findAll();
        for (User user : userList) { 
            System.out.println(user);
        }
    
        //获得与分页相关参数
        PageInfo<User> pageInfo = new PageInfo<User>(userList);
        System.out.println("当前页："+pageInfo.getPageNum());
        System.out.println("每页显示条数："+pageInfo.getPageSize());
        System.out.println("总条数："+pageInfo.getTotal());
        System.out.println("总页数："+pageInfo.getPages());
        System.out.println("上一页："+pageInfo.getPrePage());
        System.out.println("下一页："+pageInfo.getNextPage());
        System.out.println("是否是第一个："+pageInfo.isIsFirstPage());
        System.out.println("是否是最后一个："+pageInfo.isIsLastPage());
    
        sqlSession.close();
    }

如上，就完成了插件的集成使用。

### 3.3 小结 ###

`MyBatis`核心配置文件常用标签：

*  `properties`标签：该标签可以加载外部的`properties`文件
 *  `typeAliases`标签：设置类型别名
 *  `environments`标签：数据源环境配置标签
 *  `typeHandlers`标签：配置自定义类型处理器
 *  `plugins`标签：配置`MyBatis`的插件

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzNTgxNjg_size_16_color_FFFFFF_t_70]: /images/20221005/4883171f57c0445c8f01df2cd36cf48b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzNTgxNjg_size_16_color_FFFFFF_t_70 1]: /images/20221005/91faef15fd9e4842a6b2de9f9844a6e4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzNTgxNjg_size_16_color_FFFFFF_t_70 2]: /images/20221005/b32bc00aa62d4a92adcfe95342bfc114.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzNTgxNjg_size_16_color_FFFFFF_t_70 3]: /images/20221005/a80f01dc975543e182afa9dc85bdf9f9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzNTgxNjg_size_16_color_FFFFFF_t_70 4]: /images/20221005/0a89f1b5bff44c7da80a5ee5c6ab932b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzNTgxNjg_size_16_color_FFFFFF_t_70 5]: /images/20221005/7137c76c986243fd908e5f56d161e1be.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzNTgxNjg_size_16_color_FFFFFF_t_70 6]: /images/20221005/4ea5186b41a843c7a551e3e20485379f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzNTgxNjg_size_16_color_FFFFFF_t_70 7]: /images/20221005/2a67b72006be49768e31a695b71faa8d.png