Jason
  • 1.7k

05-SpringBoot工程中的MyBatis框架的整合实现及原理分析

整合MyBatis的初步分析

概述

Mybatis是一个优秀的持久层框架,底层基于JDBC实现与数据库的交互。并在JDBC操作的基础上做了封装和优化,它借助灵活的SQL定制,参数及结果集的映射方式,更好的适应了当前互联网技术的发展。Mybatis框架的简单应用架构如图所示:
image.png
在当今的互联网应用中项目,mybatis框架通常会由spring框架进行资源整合,作为数据层技术实现数据交互操作。

准备工作

第一步:创建项目module,例如:

image.png

第二步:添加依赖

mysql 驱动依赖

<dependency>
   <groupId>mysql</groupId>
   <artifactId>mysql-connector-java</artifactId>
   <scope>runtime</scope>
</dependency>

spring jdbc 依赖

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-data-jdbc</artifactId>
</dependency>

mybatis starter依赖

<dependency>
 <groupId>org.mybatis.spring.boot</groupId>
 <artifactId>mybatis-spring-boot-starter</artifactId>
 <version>2.1.1</version>
</dependency>

第二步:application.properties 配置文件中添加简易配置

连接池配置

spring.datasource.url=jdbc:mysql:///dbgoods?serverTimezone=GMT%2B8&characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=root

mybatis配置

mybatis.mapper-locations=classpath:/mapper/*/*.xml

环境测试代码实现

在src/test/java目录中添加测试类,对mybatis框架整合进行基本测试,代码如下:

package com.cy.pj.goods.dao;
import java.sql.Connection;
import org.apache.ibatis.session.SqlSession;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class MyBatisTests {
       @Autowired
       private SqlSession sqlSession;
       @Test
       public void testGetConnection() {
           Connection conn=sqlSession.getConnection();
           System.out.println("connection="+conn);
       }
}

在SpringBoot脚手架工程中,Spring框架会基于MyBatis框架底层配置,创建SqlSessionFactory对象,然后再通过此工厂对象创建SqlSession,最后基于Springku框架为测试类注入SqlSession对象,接下来,我们可以通过SqlSession对象实现与数据库的会话了。

image.png

整合MyBatis业务代码实现及原理分析

业务描述

基于SpringBoot脚手架工程对MyBatis框架的整合,实现对商品库中商品数据的查询业务。

API架构设计

image.png

业务时序图分析

image.png

业务代码设计及实现

第一步:定义商品模块POJO对象类型(基于此对象存储商品数据),代码如下:

package com.cy.pj.goods.pojo;
import java.util.Date;
/**用于存储商品信息的pojo对象*/
public class Goods {
    private Long id;
    private String name;
    private String remark;
    private Date createdTime;
    public Long getId() {
        return id;
    }
    public void setId(Long id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getRemark() {
        return remark;
    }
    public void setRemark(String remark) {
        this.remark = remark;
    }
    public Date getCreatedTime() {
        return createdTime;
    }
    public void setCreatedTime(Date createdTime) {
        this.createdTime = createdTime;
    }
}

第二步:定义商品模块持久层对象GoodsDao接口及方法映射,代码如下

GoodsDao接口及方法定义

package com.cy.pj.goods.dao;
import com.cy.pj.goods.pojo.Goods;
import org.apache.ibatis.annotations.Mapper;
import java.util.List;
/**商品模块持久层对象,基于此对象的实现类操作商品库中的数据
 * @Mapper MyBatis框架中定义,用于描述持久层接口,告诉mybatis
 * 这个接口的实现类由mybatis创建,并且交给spring框架管理.
 * */
@Mapper
public interface GoodsDao {
    List<Goods> findGoods();
}

GoodsDao接口映射文件及SQL映射定义

<?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.cy.pj.goods.dao.GoodsDao">
     <select id="findGoods" resultType="com.cy.pj.goods.pojo.Goods">
         select * from tb_goods
     </select>
</mapper>

测试代码的编写及运行

定义单元测试类,对GoodsDao方法进行单元测试,例如:

package com.cy.pj.goods.dao;
@SpringBootTest
public class GoodsDaoTests {
    @Autowired
 private GoodsDao goodsDao;
    @Test
 void testFindGoods(){
        List<Goods> list=goodsDao.findGoods();
        for(Goods g:list){
            System.out.println(g);
        }
    }
}

测试运行,底层API分析,如图所示:

image.png

测试运行过程中的BUG分析

  • idea中@autowired注解错误提示配置,如图:

image.png

  • BindingException,如图所示:

image.png

  • 单元测试类位置错误,如图所示:

image.png

  • 找不到对应的映射元素,如图所示:

image.png

业务层记录MyBatis底层SQL会话时长

业务描述

现在有一个业务,需要记录数据持久层api方法调用时执行时长,如何实现?
要求:
1)我们不能直接将日志记录写到单元测试类中。
2)我们不能修改数据持久层实现类。

API架构设计

基于日志记录业务进行API设计,如图所示:

image.png

业务时序图分析

商品查询并进行日志记录,其运行时序分析,如图所示:

image.png

业务代码设计及实现

第一步:定义GoodsService接口,代码如下:

package com.cy.pj.goods.service;
import com.cy.pj.goods.pojo.Goods;
import java.util.List;
public interface GoodsService {
      List<Goods> findGoods();
}

第二步:定义GoodsServiceImpl实现类并进行日志记录,代码如下:

package com.cy.pj.goods.service;
import com.cy.pj.goods.dao.GoodsDao;
import com.cy.pj.goods.pojo.Goods;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;
@Service
public class GoodsServiceImpl implements GoodsService{
   private static final Logger log= 
   LoggerFactory.getLogger(GoodsServiceImpl.class);
    @Autowired
 private GoodsDao goodsDao;
    @Override
 public List<Goods> findGoods() {
        long t1=System.currentTimeMillis();
        List<Goods> list=goodsDao.findGoods();
        long t2=System.currentTimeMillis();
        log.info("findGoods()->t2-t1={}",t2-t1);//日志输出
 return list;
    }
}

日志API应用分析,如图所示:

image.png

测试代码的编写及运行

编写单元测试类GoodsServiceTests,对GoodsService对象方法进行单元测试,例如:

package com.cy.pj.goods.service;
import com.cy.pj.goods.pojo.Goods;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.List;
@SpringBootTest
public class GoodsServiceTests {
    @Autowired
 private GoodsService goodsService;
    @Test
 void testFindGoods(){
        List<Goods> list=goodsService.findGoods();
        for(Goods g:list){
            System.out.println(g);
        }
    }
}

测试运行过程中的BUG分析

  • NullPointerException,如图所示:

image.png

  • NoSuchBeanDefinitionException,如图所示:

image.png

总结(Summary)

本小节主要是对MyBatis框架做了一个基本介绍,并且基于springboot工程做了mybatis框架的整合实现,重点掌握其应用架构,代码结构,编写过程、运行过程以及在实现过程中的问题分析和对应的解决方案。

阅读 5.6k

推荐阅读

SpringBoot技术的势、道、术分析与实践。

571 人关注
16 篇文章
专栏主页