Mybatis系列-4-Mapper动态代理

createh51周前 (03-27)技术教程3

冰冻三尺,非一日之寒。

Mybatis相关源码及文档:

 Mybatis官方技术文档  https://mybatis.org/mybatis-3/zh/index.html
 
 Mybatis源码包下载:https://github.com/mybatis/mybatis-3/releases
 
 所有代码及笔记gitee路径:https://gitee.com/simple-coding/all-demo-code.git

一.Mapper动态代理引入

不引入Mapper动态代理时,如下,我们会定义DAO实现类进行Mybatis的相关操作:

 @Override
 public int save(Student student)  throws Exception{
     try (SqlSession sqlSession = MyBatisUtils.getSqlSession();){
         //mapper.namespace+id
         int updateCount = sqlSession.update("test.save", student);
         sqlSession.commit();
         return updateCount;
     } catch (Exception e) {
         e.printStackTrace();
         throw e;
     }
 }
 
 @Override
 public List findAllStudent()  throws Exception{
     try (  SqlSession sqlSession = MyBatisUtils.getSqlSession();){
         //mapper.namespace+id
         return sqlSession.selectList("test.findAllStudent");
     }catch (Exception e) {
         e.printStackTrace();
         throw e;
     }
 }

上边这段代码也就是仅仅获取SqlSession调用与其相关的API,没有什么实质操作,而且两个方法除了API不同外其它部分几乎一模一样。

什么是Mapper动态代理:Mapper动态代理方式是指程序员在编码过程中只需编写DAO接口而不需要实现Dao接口。接口的实现是由MyBatis结合mapper映射文件自动生成的动态代理实现的。

二、Mapper动态代理演示

1.创建表SQL

 create table student(
   id int not null PRIMARY key auto_increment comment '主键',
   name varchar(20) comment '姓名',
   idNum  varchar(20) COMMENT '学号'
 ) comment '学生表';

2.创建实体类(lombok 插件)

 @Data
 @AllArgsConstructor
 @NoArgsConstructor
 public class Student {
     private Integer id;//主键
     private String name;//姓名
     private String idNum;//学号
 }

3.只定义Dao接口

 /**
  * 描述:Mapper动态代理
  */
 public interface StudentDao {
     /**
      * 保存学生
      * @param student
      * @return
      */
     int save(Student student) throws Exception;
 
     /**
      * 查询所有学生
      * @return
      */
     List findAllStudent() throws Exception;
 
     /**
      * 查询一个学生封装成map
      * @return
      */
     List<Map> findOneMap(Integer id) throws Exception;
 
     /**
      * 查询所有学生封装成map
      * @return
      */
     List<Map> findListMap() throws Exception;
 
     /**
      * 删除所有学生
      * @return
      */
     int deleteById(Integer id) throws Exception;
 
     /**
      * 修改所有学生
      * @return
      */
     int updateStudent(Student student) throws Exception;
 }

4.主配置mapper配置

 
 
  
  
 

5.Dao接口同目录下定义mapper.xml

 
 
 
    
    
           insert into student(name,idNum) values(#{name},#{idNum})
    
 
     
 
     
 
     
 
     
         delete from student where id = #{id}
     
 
     
         update student set name=#{name},idNum=#{idNum} where id = #{id}
     
 

6.测试类

使用getMapper获取代理实例。

 /**
  * 描述:日志配置及入门案例讲解示例
  */
 public class MybatisTest {
     private StudentDao studentDao;
     private SqlSession sqlSession;
     private Logger logger = LoggerFactory.getLogger(MybatisTest.class);
     @Before
     public void initStudentDao() throws Exception {
         sqlSession = MyBatisUtils.getSqlSession();
         studentDao = sqlSession.getMapper(StudentDao.class);
     }
     @After
     public void close() throws Exception {
         sqlSession.close();
     }
     /**
      * 保存学生
      * @return
      */
     @Test
     public void save() throws Exception{
         Student student = new Student("法外狂徒2","002");
         logger.info("更新前student:{}",student);
         int saveCount = studentDao.save(student);
         sqlSession.commit();
         logger.info("更新条数:{}",saveCount);
         logger.info("更新后student:{}",student);
     }
 
     /**
      * 查询所有学生
      * @return
      */
     @Test
     public void findAllStudent() throws Exception{
         studentDao.findAllStudent().forEach(System.out::println);
     }
 
     /**
      * 查询一个学生封装成map
      * @return
      */
     @Test
     public void findOneMap() throws Exception{
         studentDao.findOneMap(1).forEach(System.out::println);
     }
 
     /**
      * 查询所有学生封装成map
      * @return
      */
     @Test
     public void findListMap() throws Exception{
         studentDao.findListMap().forEach(System.out::println);
     }
 
     /**
      * 删除所有学生
      * @return
      */
     @Test
     public void deleteById() throws Exception{
         int deleteCount = studentDao.deleteById(4);
         sqlSession.commit();
         logger.info("删除条数:{}",deleteCount);
     }
 
     /**
      * 修改所有学生
      * @return
      */
     @Test
     public void updateStudent() throws Exception{
         Student student = new Student(4,"法外狂徒666","666");
         int updateCount = studentDao.updateStudent(student);
         sqlSession.commit();
         logger.info("修改条数:{}",updateCount);
     }
 }

框架在更新,技术在进步,之前的Mybatis的动态代理不支持Map查询,现在已经支持了。

三、Mybatis的Maven项目

前面已经说到使用Mapper动态代理,Mapper接口和xml配置文件,文件名一致且要放到同一个目录下。同一个目录说白了classpath相同。

也就是说你可以单独在resource类路径下创建同名包只存放xml。

如果使用maven创建项目,且源文件在同一个目录,这时就需要在pom中添加如下代码:

 
     
     
         
             src/main/java
             
                 **/*.xml
             
             true
         
     
 

否则,报错如图

报错图


四、总结

单独使用Mybatis时,使用Mapper动态代理步骤

  • 主配置使用

 
  
 


 
  
  • 只定义Dao接口
  • mapper的namespace与Dao全限定类名一致,statement的id为dao接口方法名
  • mapper与dao接口同名且同包
  • 使用SqlSession.getMapper(StudentDao.class);获取代理类
  • 操作dao接口方法

小伙伴有啥疑问,可以留言指教!!!

相关文章

100个Java工具类之69:提供HTTP实体处理功能的EntityUtils

在Java开发中,org.apache.http.util.EntityUtils是一个非常实用的工具类,尤其在进行HTTP请求和响应处理时。它是Apache HttpClient库的一部分,提供了一...

java编程语言中实体类属性自动生成lombok插件_v1

大家好,欢迎来到人工智复,我们的使命是互相勉励,坚定信念,认准自己的方向,坚持到底。//1. 依赖 org.projectlombok lombok 1.14.8 //2....

JPA实体类注解,看这篇就全会了

基本注解@Entity标注于实体类声明语句之前,指出该 Java 类为实体类,将映射到指定的数据库表。name(可选):实体名称。 缺省为实体类的非限定名称。该名称用于引用查询中的实体。不与 @Tab...

mybatis根据表逆向自动化生成代码:自动生成实体类、mapper文件

若采用mybatis框架,数据库新建表,手动编写的话,需要编写大量的实体类、mapper文件、mapper.xml文件,都是一些重复且有规律的工作。我们可以引用插件,然后做配置,自动生成这些文件,提供...

Java 实体映射工具 MapStruct

简介: 让你的DO(业务实体对象),DTO(数据传输对象)数据转换更简单强大前言 在软件架构中,分层式结构是最常见,各层之间有其独立且隔离的业务逻辑,也因而各层有自己的输入输出对象,也就是代码中见到各...

Java的抽象类与举例说明

#暑期创作大赛#1.抽象类我们知道类是产生对象的模板;那么我们可以将抽象类理解为是产生 实体类的模板。在 Java 中可以专门创建一种父类,它的子类必须遵循父类设定的规则,但父类又不能 直接创建对象,...