②【MyBatis】 Mapper代理方式开发( 常用 )

梦里梦外; 2024-04-17 10:20 62阅读 0赞

![在这里插入图片描述][8d8e0d8a542946af858489a536162608.gif_pic_center]

> 个人简介：Java领域新星创作者；阿里云技术博主、星级博主、专家博主；正在Java学习的路上摸爬滚打，记录学习的过程~  
> 个人主页：[.29.的博客][.29.]  
> 学习社区：[进去逛一逛~][Link 1]

> [![在这里插入图片描述][bc2f2b834d174541872b677cc2c36960.png_pic_center]][bc2f2b834d174541872b677cc2c36960.png_pic_center 1]

#### ②【MyBatis】 Mapper代理方式 ####

*  
 *   *  ⚪使用Mapper代理方式开发
     *   *  1. Mapper接口与SQL映射文件
         *  2. 设置映射文件namespace属性
         *  3. 定义接口方法，方法名、返回值类型与映射文件id、resultType保持一致
         *  4. 通过SqlSession对象getMapper方法获取代理对象并执行SQL

--------------------

##  ##

*  **使用Mapper代理的`目的`：**
 *   *  解决原生方式中的**硬编码** ；
     *  **简化** 后期SQL语句的**执行** ；
 *  **Mapper代理方式的`优势`：**
 *   *  代码不仅**更清晰**，类型**更加安全**，还不用担心可能出错的字符串字面值以及强制类型转换。

### ⚪使用Mapper代理方式开发 ###

`步骤`：

1.  定义Mapper接口（与SQL映射文件同名），并将Mapper接口与SQL映射文件放置在同一目录下；
2.  将SQL映射文件的`namespace`属性设置为Mapper接口全限定名（如"com.java.mapper.UserMapper"）；
3.  在Mapper接口中定义方法，**方法名**就是SQL映射文件中sql语句的`id`，并保持方法返回值类型与SQL映射文件一致；
4.  编码(Coding)：使用`SqlSession对象`的`getMapper方法`获取Mapper接口代理对象，并`调用对应方法`完成SQL的执行；

> ![在这里插入图片描述][d709c76ebbde4fa78c3dee30d486c630.png]

#### 1. Mapper接口与SQL映射文件 ####

`资源包下创建一个目录，存放SQL映射文件`：

> 注意，创建时使用"\\“，不能使用”." !!!
> 
> ![在这里插入图片描述][00814e2df7fa447b93aeb833df87904a.png]
> 
> ![在这里插入图片描述][002b308c58b84741aa95fc7519b7be68.png]
> 
> SQL映射文件位置改动后，需要在MyBatis核心配置文件中重新配置SQL映射文件位置哦！`"com/java/mapper/UserMapper.xml`
> 
> 若Mapper接口名称与SQL配置文件名称一致且在同一目录下，可以简化MyBatis配置文件中配置映射文件的操作。
> 
> ![在这里插入图片描述][6b61bf59ff294e8a8c973ca08ee0adf4.png]

`设置同名接口，目录名称保持一致`：

> 虽然现在接口与映射文件仅目录同名而位置不同，但在编译后会因为目录同名的关系被放置在同一位置；
> 
> ![在这里插入图片描述][8c1519897606426692dc8e4754b6da1b.png]

#### 2. 设置映射文件namespace属性 ####

`将namespace属性设置为Mapper接口的全限定名`：

<?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.java.mapper.UserMapper">
        <select id="selectAll" resultType="com.java.pojo.User">
            select * from tb_user;
        </select>
    </mapper>

#### 3. 定义接口方法，方法名、返回值类型与映射文件id、resultType保持一致 ####

public interface UserMapper {
        
        //方法名、返回值类型与映射文件id、resultType保持一致
        public List<User> selectAll();
    }

#### 4. 通过SqlSession对象getMapper方法获取代理对象并执行SQL ####

`测试`：

public class mybatisDemo {
        
        public static void main(String[] args) throws IOException {
        
            //1. 加载mybatis配置文件，获取SqlSessionFactory对象
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    //
    //        //2. 获取SqlSession对象去执行SQL
    //        SqlSession sqlSession = sqlSessionFactory.openSession();
    //
    //        //3. 执行SQL语句
    //        //传入Mapper映射文件中SQL语句的 "命名空间+id"
    //        List<User> users = sqlSession.selectList("test.selectAll");
    //
    //        System.out.println(users);
    //
    //        //释放资源
    //        sqlSession.close();
    
            //2. Mapper代理方式，简洁、安全、避免硬编码
            //try()中创建资源，无需手动释放
            try(SqlSession sqlSession = sqlSessionFactory.openSession()){
        
                UserMapper mapper = sqlSession.getMapper(UserMapper.class);
                List<User> users = mapper.selectAll();
                System.out.println(users);
            }
        }
    }

`输出结果`：

> \[User\{id=1, username=‘张三’, password=‘123’, gender=‘男’, addr=‘北京’\}, User\{id=2, username=‘李四’, password=‘456’, gender=‘男’, addr=‘上海’\}, User\{id=3, username=‘王麻子’, password=‘789’, gender=‘女’, addr=‘广州’\}\]

--------------------

[![在这里插入图片描述][20a7f1b58dfb4660b75d7f021c157d57.png_pic_center]][20a7f1b58dfb4660b75d7f021c157d57.png_pic_center 1]

[8d8e0d8a542946af858489a536162608.gif_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/14/7e369bd0baf1418eb293f5fc12c249e5.gif
[.29.]: https://blog.csdn.net/ebb29bbe?spm=1018.2226.3001.5343
[Link 1]: https://bbs.csdn.net/forums/185241f773fb401b8ca7994dc3d02333?joinKey=cyru4ex9o7wq-mz6v1koj5x-1-add3ae8dc3827dbbd4360c79af92bbbe
[bc2f2b834d174541872b677cc2c36960.png_pic_center]: https://img-blog.csdnimg.cn/direct/bc2f2b834d174541872b677cc2c36960.png#pic_center
[bc2f2b834d174541872b677cc2c36960.png_pic_center 1]: https://blog.csdn.net/ebb29bbe/category_12007200.html?spm=1001.2014.3001.5482
[d709c76ebbde4fa78c3dee30d486c630.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/14/332f1eb741ea4bf8bd7afd6da63c77c5.png
[00814e2df7fa447b93aeb833df87904a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/14/18c32cdffe6c4d09ae8a24614c519861.png
[002b308c58b84741aa95fc7519b7be68.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/14/5e7f7699ce4f446a87a8f42c433e71ac.png
[6b61bf59ff294e8a8c973ca08ee0adf4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/14/547c0ec6c8204bf1af13d5308e9d4e48.png
[8c1519897606426692dc8e4754b6da1b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/14/d702fbb922404395864b677aa596264c.png
[20a7f1b58dfb4660b75d7f021c157d57.png_pic_center]: https://img-blog.csdnimg.cn/20a7f1b58dfb4660b75d7f021c157d57.png#pic_center
[20a7f1b58dfb4660b75d7f021c157d57.png_pic_center 1]: https://blog.csdn.net/ebb29bbe?type=blog