SpringBoot第五集：整合Druid和MyBatis（2020最新最易懂）

SpringBoot第五集：整合Druid和MyBatis（2020最新最易懂）

1.SpringBoot整合Druid

　　Druid是阿里巴巴的一个开源项目，是一个数据库连接池的实现，结合了C3P0、DBCP、PROXOOL等DB池的优点，整合配置参考地址。Druid不但提供连接池的功能，还提供监控功能，可以实时查看数据库连接池和SQL查询的工作情况（最牛X的地方就在与提供的日志监控功能）。在上一章中（SpringBoot整合JDBC，JPA）讲述到，Spring Boot底层都是采用Spring Data的方式进行统一处理，Spring Data中内置连接池数据源HikariDataSource。SpringBoot整合Druid实现数据源更换，则需要手动配置。

1.新建SpringBoot工程，引入依赖

　　基础依赖：新建SpringBoot工程，建议引入以下基础依赖

　　spring-boot-starter-parent（SpringBoot父工程）——必选

　　spring-boot-starter（SpringBoot启动器）——必选

　　spring-boot-devtools（SpringBoot热部署）——可选

　　spring-boot-starter-web（SpringBoot整合WEB）——必选

　　mysql-connector-java（MySQL驱动）——必选

　　druid-spring-boot-starter（SpringBoot整合Druid）——必选

　　spring-boot-starter-jdbc（SpringBoot整合JDBC）——必选

　　spring-boot-starter-test（SpringBoot整合测试Junit）——默认必选

　　spring-boot-maven-plugin（SpringBoot打包插件）——必选
　　lombok（整合Lombok简化POJO开发）——可选
　　spring-boot-configuration-processor（SpringBoot整合配置文件注入POJO）——可选

<!-- MySQL驱动 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>
        
<!-- SpringBoot整合Druid -->
<dependency>
     <groupId>com.alibaba</groupId>
     <artifactId>druid-spring-boot-starter</artifactId>
     <version>1.1.22</version>
</dependency> 

常见问题：整合如果没有引入spring-boot-starter-jdbc，会报错：.....ClassNotFoundException: org....jdbc....embedded.EmbeddedDatabaseType。

问题原因：Spring Boot底层都是采用Spring Data的方式进行统一处理。EmbeddedDatabaseType类在spring-boot-starter-jdbc依赖中。

依赖说明：SpringBoot属于Spring“全家桶”组件，Druid属于阿里巴巴旗下开发产品，所以SpringBoot整合Druid并不是由Spring组件提供依赖，而是由阿里巴巴提供。

2.修改yml配置文件，整合配置Druid

spring:
  datasource:
    # 数据库访问配置, 使用druid数据源(默认数据源是HikariDataSource)
    type: com.alibaba.druid.pool.DruidDataSource
    #链接池配置
    druid:
      driver-class-name: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql://localhost:3306/springboot?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=GMT%2B8
      username: root
      password: xsge
      
      # 连接池配置：大小，最小，最大
      initial-size: 5
      min-idle: 5
      max-active: 20
      
      # 连接等待超时时间
      max-wait: 30000
      
      # 配置检测可以关闭的空闲连接，间隔时间
      time-between-eviction-runs-millis: 60000
      
      # 配置连接在池中的最小生存时间
      min-evictable-idle-time-millis: 300000
      # 检测连接是否有，有效得select语句
      validation-query: select '1' from dual
      # 申请连接的时候检测，如果空闲时间大于time-between-eviction-runs-millis，执行validationQuery检测连接是否有效，建议配置为true，不影响性能，并且保证安全性。
      test-while-idle: true
      # 申请连接时执行validationQuery检测连接是否有效，建议设置为false，不然会会降低性能
      test-on-borrow: false
      # 归还连接时执行validationQuery检测连接是否有效，建议设置为false，不然会会降低性能
      test-on-return: false
      
      # 是否缓存preparedStatement，也就是PSCache  官方建议MySQL下建议关闭   个人建议如果想用SQL防火墙 建议打开
      # 打开PSCache，并且指定每个连接上PSCache的大小
      pool-prepared-statements: true
      max-open-prepared-statements: 20
      max-pool-prepared-statement-per-connection-size: 20
      
      # 配置监控统计拦截的filters, 去掉后监控界面sql无法统计, 'wall'用于防火墙防御sql注入，stat监控统计,logback日志    
      filters: stat,wall
      # Spring监控AOP切入点，如x.y.z.service.*,配置多个英文逗号分隔
      #aop-patterns: com.springboot.servie.*
      # lowSqlMillis用来配置SQL慢的标准，执行时间超过slowSqlMillis的就是慢
      connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500
      
      # WebStatFilter监控配置
      web-stat-filter:
        enabled: true
        # 添加过滤规则：那些访问拦截统计
        url-pattern: /*
        # 忽略过滤的格式：哪些不拦截，不统计
        exclusions: '*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*'
      
      # StatViewServlet配置（Druid监控后台的Servlet映射配置，因为SpringBoot项目没有web.xml所在在这里使用配置文件设置） 
      stat-view-servlet:
        enabled: true 
        # 配置Servlet的访问路径：访问路径为/druid/**时，跳转到StatViewServlet，会自动转到Druid监控后台
        url-pattern: /druid/*
        # 是否能够重置数据
        reset-enable: false
        # 设置监控后台的访问账户及密码
        login-username: xsge
        login-password: xsge
        # IP白名单：允许哪些主机访问，默认为“”任何主机
        # allow: 127.0.0.1
        # IP黑名单：禁止IP访问，（共同存在时，deny优先于allow）
        # deny: 192.168.1.218
      
      # 配置StatFilter
      filter: 
        stat: 
          log-slow-sql: true

上述配置不但配置了Druid作为连接池，而且还开启了Druid的监控功能。 其他配置可参考官方网站。

3.启动项目运行测试

　　启动SpringBoot主程序，启动后访问：http://localhost:8080/druid 会自动跳转至Druid后台监控登录页，输入自定义配置的账户/密码（xsge,xsge）即可登录查看详情。

　　更多Druid问题需求说明，请参照Druid官网常见问题。

2.SpringBoot整合MyBatis

1.概述

　　实际项目中，在对数据库访问层对数据库进行操作时，大部分时候我们都用的MyBatis/Hibernate，所以SpringBoot整合MyBatis怎么说也算是必修课了！！！

2.准备工作

1. 创建数据库。
   
2. 新增对应数据库实体类。
   

   @Data
   @AllArgsConstructor
   @NoArgsConstructor
   public class Person {
       private Integer id;
       private String name;
       private String password;
   }

3. 修改pom.xml引入依赖。
   　　以下依赖文件，并非整个项目中所有已包含的依赖，例如：热部署，Lombok等，由于代码长度问题，一些基本引用的依赖，我并没有写入，请另行参考博主其他SpringBoot整合文档，自行参考导入更多所需依赖。
   
   　　Spring家族的使命就是为了简化而生，但是随着Spring的发展壮大，有点事与愿违了。为了坚持初心，Spring家族祭出了一大杀器---Spring Boot。Spring Boot的核心理念是：不建议使用xml文件配置。但是，这对MyBatis来说进退两难，因为MyBatis离不开xml，需要xml来配置sql语句。为了迎合Spring Boot的发展理念，MyBatis官方开发了mybatis-spring-boot-starter

   <!-- MySQL驱动 -->
   <dependency>
       <groupId>mysql</groupId>
       <artifactId>mysql-connector-java</artifactId>
       <scope>runtime</scope>
   </dependency>
   <!-- SpringBoot整合MyBatis -->
   <dependency>
       <groupId>org.mybatis.spring.boot</groupId>
       <artifactId>mybatis-spring-boot-starter</artifactId>
       <version>2.0.1</version>
   </dependency>
   <!-- SpringBoot整合druid-spring-boot-starter -->
   <dependency>
       <groupId>com.alibaba</groupId>
       <artifactId>druid-spring-boot-starter</artifactId>
       <version>1.1.22</version>
   </dependency>
   <!-- SpringBoot整合JDBC -->
   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-jdbc</artifactId>
   </dependency>

   注意：SpringBoot引入MySQL驱动默认版本为8.x，可以手动配置版本。
   依赖说明：MyBatis属于独立框架，不属于Sprng组件，因此SpringBoot整合MyBatis的依赖由MyBatis提供。

   MyBatis整合SpringBoot的依赖版本，参考mybatis-spring-boot-starter官方说明文档

4. 创建一个包含基本CRUD的PersonMapper
   

   public interface PersonMapper {
       int add(Person person);// 添加
       int update(Person person);// 修改
       int deleteById(Integer id);// 删除
       Person queryPersonById(Integer id);// 查询一个
       Person queryListPerson();// 查询所有
   }

3.SpringBoot整合MyBatis实现CURD

　　整合MyBatis实现CURD，Mapper接口可以基于注解方式或XML方式。注解方式：代码更加精简，方便。XML配置方式：隔离sql和业务代码，清晰表达sql，尤其对于较长的sql而言。（Spring Boot不建议使用XML文件配置）

　　1.Mapper接口基于注解方式实现CURD

1. 修改Mapper接口，添加SQL注解
   此处仅列举两个案例，如需学习更多SQL注解，请关注博主MyBatis文章。
   

   public interface PersonMapper {
       @Insert("INSERT INTO person(name,password) values(#{name},#{password})")
       int add(Person person);// 添加
       @Select("SELECT * FROM person WHERE id=#{id}")
       Person queryPersonById(Integer id);// 查询一个
       
       // 下面的两个将用于练习基于XML配置文件方式
       int update(Person person);// 修改
       List<Person> queryListPerson();// 查询所有
   }

2. 新增Service接口
   

   public interface PersonService {
       int add(Person person);// 添加
       Person queryPersonById(Integer id);// 查询一个
       
       int update(Person person);// 修改
       List<Person> queryListPerson();// 查询所有
   }

3. 新增Service实现
   

   @Service
   public class PersonServiceImpl implements PersonService{
       
       @Autowired   // 注入DAO层Mapper
       private PersonMapper personMapper;
       
       @Override
       public int add(Person person) {
           return personMapper.add(person);
       }
   
       @Override
       public Person queryPersonById(Integer id) {
           return personMapper.queryPersonById(id);
       }
   
       @Override
       public int update(Person person) {
           return personMapper.update(person);
       }
   
       @Override
       public List<Person> queryListPerson() {
           return personMapper.queryListPerson();
       }
   
   }

4. 新增控制器PersonController

   @RestController
   public class PersonController {
       
       @Autowired
       private PersonService personService;
       /**
        * 测试接口：http://localhost:8080/queryPersonById/1
        * 请求方式：get    入参：查询id        返回值：查询的一行数据Person（JSON格式）
        */
       @GetMapping("/queryPersonById/{id}")
       public Person queryPersonById(@PathVariable Integer id) {
           return personService.queryPersonById(id);
       }
       
       /**
        * 测试接口：http://localhost:8080/addPerson
        * 请求方式：put       入参：JSON数据      返回值：添加成功影响行数
        */
       @RequestMapping(value = "/addPerson",method = RequestMethod.PUT)
       public int addPerson(@RequestBody Person person) {
           return personService.add(person);
       }
       
   }

5. 建议修改yml文件，添加别名和驼峰命名配置
   
   
6. 在启动类上添加注解@MapperScan(...)
   

   　　默认情况下，MyBatis-Spring-Boot-Starter会查找以@Mapper注解标记的映射器。你需要给每个MyBatis映射器标识上@Mapper注解，但是这样非常的麻烦，这时可以使用@MapperScan注解来扫描包。@MapperScan注解的作用：指定要变成实现类的接口所在的包，包下面的所有接口在编译之后都会代理生成相应的实现类。添加位置：是在Springboot启动类上面添加。

   @SpringBootApplication
   @MapperScan("com.xsge.app.mapper")
   public class SpringbootMybatisApplication {
   
       public static void main(String[] args) {
           SpringApplication.run(SpringbootMybatisApplication.class, args);
       }
   
   }

   除了在启动类上使用注解@MapperScan实现扫描Mapper接口生成代理对象外，还可以使用@Mapper注解，接口类上添加了@Mapper，在编译之后也会生成相应的接口实现类。两者选择其一即可，但使用@Mapper则要求每个接口类上都需要添加，通过使用@MapperScan注解，可以让我们不用为每个Mapper类都添加@Mapper注解。详情参考MyBatis中文网

7. 运行SpringBoot启动类测试
   
   

　　2.Mapper接口基于XML方式实现CURD

　　　　使用xml方式需要在application.yml中进行一些额外的配置。（通常即使在注解方式中，也会添加公共的配置）

1. 修改yml文件，新增配置
   

   # MyBatis配置
   mybatis:
     # 配置别名
     type-aliases-package: com.xsge.app.entity
     # 配置XML扫描地址
     mapper-locations:
     - classpath:mapper/*.xml
     # 配置启用驼峰命名方式
     configuration:
       map-underscore-to-camel-case: true
   # 设置日志显示：在控制台打印SQL
   logging:
     level:
       # 以包名前置，表示指定包下的操作指定日志级别。
       com.xsge.app.mapper: DEBUG 

2. 在根目录下增子mapper包，并添加mapper映射配置（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.xsge.app.mapper.PersonMapper">
       
       <update id="update" parameterType="com.xsge.app.entity.Person">
           UPDATE person SET name=#{name},password=#{password} WHERE id=#{id}
       </update>
       
       <select id = "queryListPerson" resultType = "com.xsge.app.entity.Person">
         SELECT * FROM person
       </select>
       
   </mapper>

3. 修改控制器PersonController添加测试接口
   

   /**
    * 测试接口：http://localhost:8080/queryListPerson
    * 请求方式：GET      返回值：查询结果集
    */
   @RequestMapping(value = "/queryListPerson",method = RequestMethod.GET)
   public List<Person> queryListPerson() {
       return personService.queryListPerson();
   }
   
   /**
    * 测试接口：http://localhost:8080/update
    * 请求方式：POST      返回值：更新影响行数
    */
   @RequestMapping(value = "/update",method = RequestMethod.POST)
   public int update(@RequestBody Person person) {
       return personService.update(person);
   }

4. 运行SpringBoot启动类，测试
   

4.SpringBoot整合MyBatis分页助手

1. 引入分页助手依赖
   

   <!-- SpringBoot整合MyBatis分页助手 -->
   <dependency>
       <groupId>com.github.pagehelper</groupId>
       <artifactId>pagehelper-spring-boot-starter</artifactId>
       <version>1.2.12</version>
   </dependency>

2. 查询前设置分页，最后将将查询结果封装为PageInfo即可
   

   /**
    * 测试接口：http://localhost:8080/queryListPersonPage
    * 请求方式：GET      返回值：查询结果集，分页查询
    */
   @RequestMapping(value = "/queryListPersonPage",method = RequestMethod.GET)
   public PageInfo<Person> queryListPersonPage() {
       //1.执行分页
       PageHelper.startPage( 1, 2) ;
       //2.执行查询
       List<Person> list = personService.queryListPersonPage();
       //3.封装PageInfo对象
       PageInfo<Person> pageInfo = new PageInfo<Person> (list);
   
       return pageInfo;
   }

3. 启动项目访问接口测试
   略

5.访问Druid监控后台

　　访问Druid监控后台，查看SQL监控信息：访问：http://localhost:8080/druid 会自动跳转至Druid后台监控登录页，输入自定义配置的账户/密码（xsge,xsge）即可登录查看详情。

 说明：博主的每一篇文档都是承上启下的，因此如果看不懂，或者缺少配置导致无法执行，请参考上一集SpringBoot内容。