MyBatis 中使用 Mapper 簡化代碼的方法
前面文章所寫的增刪改查是存在問題的。每執行一次 SQL,都要開啟一次會話,并且需要提交并關閉,主要問題就是冗余代碼過多,模板化代碼過多。
例如,我想開發一個 UserDao,可能是下面這樣:
簡化前的 UserDao
public class UserDao { private SqlSessionFactory sqlSessionFactory = SqlSessionFactoryUtils.getInstance(); public User getUserById(Integer id) { SqlSession sqlSession = sqlSessionFactory.openSession(); User user = (User) sqlSession.selectOne('com.antonio.hello.mybatis.mapper.UserDao.getUserById', id); sqlSession.close(); return user; } public Integer addUser(User user) { SqlSession sqlSession = sqlSessionFactory.openSession(); int insert = sqlSession.insert('com.antonio.hello.mybatis.mapper.UserDao.addUser', user); sqlSession.commit(); sqlSession.close(); return insert; } public Integer addUser2(User user) { SqlSession sqlSession = sqlSessionFactory.openSession(); int insert = sqlSession.insert('com.antonio.hello.mybatis.mapper.UserDao.addUser2', user); sqlSession.commit(); sqlSession.close(); return insert; } public Integer deleteUserById(Integer id) { SqlSession sqlSession = sqlSessionFactory.openSession(); int delete = sqlSession.delete('com.antonio.hello.mybatis.mapper.UserDao.deleteUserById', id); sqlSession.commit(); sqlSession.close(); return delete; } public Integer updateUser(User user) { SqlSession sqlSession = sqlSessionFactory.openSession(); int delete = sqlSession.delete('com.antonio.hello.mybatis.mapper.UserDao.updateUser', user); sqlSession.commit(); sqlSession.close(); return delete; } public List<User> getAllUser() { SqlSession sqlSession = sqlSessionFactory.openSession(); List<User> users = sqlSession.selectList('com.antonio.hello.mybatis.mapper.UserDao.getAllUser'); sqlSession.close(); return users; }}
對應的 UserMapper.xml
然后,和這個 UserDao 對應的,還有一個 UserMapper.xml:
<?xml version='1.0' encoding='UTF-8' ?><!DOCTYPE mapper PUBLIC '-//mybatis.org//DTD Mapper 3.0//EN' 'http://mybatis.org/dtd/mybatis-3-mapper.dtd'><mapper namespace='com.antonio.hello.mybatis.mapper.UserDao'> <select resultType='com.antonio.hello.mybatis.entity.User'> select * from user where id=#{id}; </select> <insert parameterType='com.antonio.hello.mybatis.entity.User'> insert into user (username,address) values (#{username},#{address}); </insert> <insert parameterType='com.antonio.hello.mybatis.entity.User'> <selectKey resultType='java.lang.String' keyProperty='id' order='BEFORE'> select uuid(); </selectKey> insert into user (id,username,address) values (#{id},#{username},#{address}); </insert> <delete parameterType='java.lang.Integer'> delete from user where id=#{id} </delete> <update parameterType='com.antonio.hello.mybatis.entity.User'> update user set username = #{username} where id=#{id}; </update> <select resultType='com.antonio.hello.mybatis.entity.User'> select * from user; </select></mapper>
此時,我們分析這個 UserDao,發現它有很多可以優化的地方。每個方法中都要獲取 SqlSession,涉及到增刪改的方法,還需要 commit,SqlSession 用完之后,還需要關閉,sqlSession 執行時需要的參數就是方法的參數,sqlSession 要執行的 SQL ,和 XML 中的定義是一一對應的。這是一個模板化程度很高的代碼。
簡化后的 UserDao既然模板化程度很高,我們就要去解決它,原理很簡單,就是前面 Spring 中所說的動態代理。我們可以將 UserDao 簡化成一個接口:
package com.antonio.hello.mybatis.mapper;public interface UserDao { User getUserById(Integer id); Integer addUser(User user); Integer addUser2(User user); Integer deleteUserById(Integer id); Integer updateUser(User user); List<User> getAllUser();}
使用這個接口,完全可以代替上面的 UserDao,為什么呢?因為這個接口提供了 UserDao 所需要的最核心的東西,根據這個接口,就可以自動生成 UserDao:
首先,UserDao 中定義了 SqlSessionFactory,這是一套固定的代碼 UserMapper 所在的包 + UserMapper 類名 + UserMapper 中定義好的方法名,就可以定位到要調用的 SQL 要調用 SqlSession 中的哪個方法,根據定位到的 SQL 節點就能確定配置并使用因此,我們在 MyBatis 開發中,實際上不需要自己提供 UserDao 的實現,我們只需要提供一個 UserMapper 即可。然后,我們在 MyBatis 的全局配置中,配置一下 UserMapper:
<?xml version='1.0' encoding='UTF-8' ?><!DOCTYPE configuration PUBLIC '-//mybatis.org//DTD Config 3.0//EN' 'http://mybatis.org/dtd/mybatis-3-config.dtd'><configuration> <environments default='development'> <environment id='development'> <transactionManager type='JDBC'/> <dataSource type='POOLED'><property name='driver' value='com.mysql.cj.jdbc.Driver'/><property name='url' value='jdbc:mysql:///test01?serverTimezone=Asia/Shanghai'/><property name='username' value='root'/><property name='password' value='123456'/> </dataSource> </environment> </environments> <mappers> <package name='com.antonio.hello.mybatis.mapper'/> </mappers></configuration>
然后,加載配置文件,獲取 UserMapper,并調用它里邊的方法:
public class Main2 { public static void main(String[] args) { SqlSessionFactory instance = SqlSessionFactoryUtils.getInstance(); SqlSession sqlSession = instance.openSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); List<User> allUser = mapper.getAllUser(); System.out.println(allUser); }}
注意,在 Maven 中,默認情況下,Maven 要求我們將 XML 配置、properties 配置等,都放在 resources 目錄下,如果我們強行放在 java 目錄下,默認情況下,打包的時候這個配置文件會被自動忽略掉。對于這兩個問題,我們有兩種解決辦法:
不忽略 XML 配置:
我們可以在 pom.xml 中,添加如下配置,讓 Maven 不要忽略我在 java 目錄下的 XML 配置:
<build> <resources> <resource> <directory>src/main/java</directory> <includes><include>**/*.xml</include> </includes> </resource> <resource> <directory>src/main/resources</directory> </resource> </resources></build>
按照 Maven 的要求來
按照 Maven 的要求來,將 xml 文件放到 resources 目錄下,但是,MyBatis 中默認情況下要求,UserMapper.xml 和 UserMapper 接口,必須放在一起,所以,我們需要手動在 resources 目錄下,創建一個和 UserMapper 接口相同的目錄存放 UserMapper.xml。這樣,我們就不需要在 pom.xml 文件中添加配置了,因為這種寫法同時滿足了 Maven 和 MyBatis 的要求。
到此這篇關于MyBatis 中使用 Mapper 簡化代碼的方法的文章就介紹到這了,更多相關MyBatis 使用 Mapper 簡化代碼內容請搜索好吧啦網以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持好吧啦網!
相關文章:
