SpringBoot-整合MyBatis框架

整合MyBatis的初步分析

概述

Mybatis是一个优秀的持久层框架，底层基于JDBC实现与数据库的交互。并在JDBC操作的基础上做了封装和优化，它借助灵活的SQL定制，参数及结果集的映射方式，更好的适应了当前互联网技术的发展。Mybatis框架的简单应用架构如图所示：

在当今的互联网应用中项目，mybatis框架通常会由spring框架进行资源整合，作为数据层技术实现数据交互操作。

初步实现

第一步：创建项目module

第二步：添加依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>2.3.4.RELEASE</version>
      <relativePath/> <!-- lookup parent from repository -->
 </parent>
   <groupId>com.cy</groupId>
   <artifactId>08-springboot-mybatis</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <name>08-springboot-mybatis</name>
   <description>Demo project for Spring Boot</description>
   <properties>
      <java.version>1.8</java.version>
   </properties>
   <dependencies>
   <!--添加jdbc依赖-->
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-data-jdbc</artifactId>
      </dependency>
      <!--添加mybatis依赖-->
      <dependency>
         <groupId>org.mybatis.spring.boot</groupId>
         <artifactId>mybatis-spring-boot-starter</artifactId>
         <version>2.1.3</version>
      </dependency>
      <!--添加mysql依赖-->
      <dependency>
         <groupId>mysql</groupId>
         <artifactId>mysql-connector-java</artifactId>
         <scope>runtime</scope>
      </dependency>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-test</artifactId>
         <scope>test</scope>
         <exclusions>
            <exclusion>
               <groupId>org.junit.vintage</groupId>
               <artifactId>junit-vintage-engine</artifactId>
            </exclusion>
         </exclusions>
      </dependency>
   </dependencies>
   <build>
      <plugins>
         <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
         </plugin>
      </plugins>
   </build>
</project>

第三步：配置application.properties配置文件

#spring datasource
spring.datasource.url=jdbc:mysql:///dbgoods?serverTimezone=GMT%2B8&characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=1234
#spring mybatis
mybatis.mapper-locations=classpath:/mapper/*/*.xml
#spring logs
logging.file.path=d:/logs/
logging.level.com.cy=debug

第四步：创建测试类MyBatisTests进行测试

package com.cy.pj.goods.dao;
import org.apache.ibatis.session.SqlSession;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.sql.Connection;
@SpringBootTest
public class MyBatisTests {
    /**
 * 此对象为mybatis框架中实现与数据库进行会话的一个对象
 */
 @Autowired
 private SqlSession sqlSession;
 @Test
 void testGetConnection(){
        Connection conn=sqlSession.getConnection();//从哪里去取得连接？
 System.out.println("conn="+conn);
 //conn=HikariProxyConnection@2078741622 wrapping com.zaxxer.hikari.pool.ProxyConnection.ClosedConnection
 //断言测试：判断Conn对象是否部位null，不为空则测试通过
 Assertions.assertNotNull(conn);
 }
}

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

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

业务描述

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

API架构设计

业务时序图分析

代码实现

第一步：创建pojo实体类Goods

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

第二步：创建持久层接口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();
}

第三步：创建接口映射文件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.cy.pj.goods.dao.GoodsDao">
 <select id="findGoods" resultType="com.cy.pj.goods.pojo.Goods">
 select * from tb_goods
    </select>
</mapper>

第四步：编辑测试类GoodsDaoTests进行测试

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

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

业务描述

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

API架构设计

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

业务时序图分析

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

业务代码实现

第一步：定义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;
    }
}

第三步：编写单元测试类GoodsServiceTests

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);
        }
    }
}