SpringCloud微服务架构搭建--Mybatis-Plus(三)

学而时习之，不亦说乎

前言

具体业务实现离不开与数据库交互，本章重点记录一下SpringBoot集成druid数据源，集成mybatis-plus，为了开发方便，基于mybatis-plus的代码生成器，实现对业务最基本的增删改查操作。

准备工作

1. 在mysql数据库中创建mingx_user库，并创建sys_user表，用于后续查询验证。
   表生成代码如下：

DROP TABLE IF EXISTS `sys_user`;
CREATE TABLE `sys_user` (
  `id` varchar(32) NOT NULL,
  `name` varchar(20) DEFAULT NULL COMMENT ‘姓名‘,
  `sex` tinyint(4) DEFAULT NULL COMMENT ‘性别，0：男性，1：女生‘,
  `birthday` date DEFAULT NULL COMMENT ‘出生日期‘,
  `create_time` datetime DEFAULT NULL COMMENT ‘创建时间‘,
  `create_by` varchar(255) DEFAULT NULL COMMENT ‘创建人‘,
  `update_time` datetime DEFAULT NULL COMMENT ‘更新时间‘,
  `update_by` varchar(255) DEFAULT NULL COMMENT ‘更新人‘,
  `del_flag` tinyint(4) DEFAULT ‘0‘ COMMENT ‘删除标记，0：未删除，1：已删除‘,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

-- ----------------------------
-- Records of sys_user
-- ----------------------------
INSERT INTO `sys_user` VALUES (‘1‘, ‘寻的足迹‘, ‘0‘, ‘2020-02-24‘, ‘2020-02-24 15:32:44‘, ‘1‘, null, null, ‘0‘);

2. 让STS实现对lombok的支持，具体方式可参考这里

Druid数据源

Druid的简介

Druid首先是一个数据库连接池。Druid是目前最好的数据库连接池，在功能、性能、扩展性方面，都超过其他数据库连接池，包括DBCP、C3P0、BoneCP、Proxool、JBoss DataSource。Druid已经在阿里巴巴部署了超过600个应用，经过一年多生产环境大规模部署的严苛考验。Druid是阿里巴巴开发的号称为监控而生的数据库连接池。

集成Druid

1. 在父项目的pom.xml中，增加如下配置，用于版本号的统一配置

<properties>
    <druid.version>1.0.29</druid.version>
</properties>

 <dependencyManagement>
       <dependencies>
        <!-- alibaba druid数据源主版本管理  -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>${druid.version}</version>
        </dependency>
    </dependencies>
</dependencyManagement>

2. 在mingx-user微服务的pom.xml中增加mysql驱动依赖以及druid数据源依赖

<!-- Mysql数据库驱动依赖 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- 阿里巴巴数据源 -->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
</dependency>

3. 登录nacos控制台，编辑mingx-user-dev.yml，增加数据源的相关配置。

spring: 
    datasource:
        #数据源基本配置
        type: com.alibaba.druid.pool.DruidDataSource
        driver-class-name: com.mysql.cj.jdbc.Driver
        url: jdbc:mysql://127.0.0.1:3306/mingx_user?allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
        username: root
        password: root
        #数据源其他配置
        initialSize: 5
        minIdle: 5
        maxActive: 20
        maxWait: 60000
        timeBetweenEvictionRunsMillis: 60000
        minEvictableIdleTimeMillis: 300000
        validationQuery: SELECT 1 FROM DUAL
        testWhileIdle: true
        testOnBorrow: false
        testOnReturn: false
        poolPreparedStatements: true
        #配置监控统计拦截的filters，去掉后监控界面sql无法统计，‘wall‘用于防火墙  
        filters: stat,wall
        maxPoolPreparedStatementPerConnectionSize: 20
        useGlobalDataSourceStat: true  
        connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500

具体druid的的参数配置可以去官网看看

虽然配置了druid连接池的其它属性，但是不会生效。因为默认是使用的java.sql.Datasource的类来获取属性的，有些属性datasource没有。如果我们想让配置生效，需要手动创建Druid的配置文件。

4. 在main/src/java下创建com.mingx.user.config包，创建DruidConfig.java配置类，具体代码如下：

package com.mingx.user.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.alibaba.druid.pool.DruidDataSource;
import com.alibaba.druid.support.http.StatViewServlet;
import com.alibaba.druid.support.http.WebStatFilter;

/**
 * DruidConfig配置类
 * @author Jonas
 *
 */
@Configuration
public class DruidConfig {

    @ConfigurationProperties(prefix = "spring.datasource")
    @Bean
    public DruidDataSource druidDataSource(){
          return new DruidDataSource();
    }

    /**
     * 配置监控服务器
     * @return 返回监控注册的servlet对象
     * @author SimpleWu
     */
    @SuppressWarnings({ "rawtypes", "unchecked" })
    @Bean
    public ServletRegistrationBean statViewServlet() {
        ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean(new StatViewServlet(), "/druid/*");
        // 添加IP白名单
        servletRegistrationBean.addInitParameter("allow", "127.0.0.1");
        // 添加IP黑名单，当白名单和黑名单重复时，黑名单优先级更高
        servletRegistrationBean.addInitParameter("deny", "127.0.0.1");
        // 添加控制台管理用户
        servletRegistrationBean.addInitParameter("loginUsername", "mingx");
        servletRegistrationBean.addInitParameter("loginPassword", "123456");
        // 是否能够重置数据
        servletRegistrationBean.addInitParameter("resetEnable", "false");
        return servletRegistrationBean;
    }

    /**
     * 配置服务过滤器
     *
     * @return 返回过滤器配置对象
     */
    @SuppressWarnings({ "rawtypes", "unchecked" })
    @Bean
    public FilterRegistrationBean statFilter() {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(new WebStatFilter());
        // 添加过滤规则
        filterRegistrationBean.addUrlPatterns("/*");
        // 忽略过滤格式
        filterRegistrationBean.addInitParameter("exclusions", "*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*,");
        return filterRegistrationBean;
    }
}

5. 启动mingx-user微服务成功后，浏览器中访问http://127.0.0.1:7001/druid/index，就可以来到druid控制台的登录页面，使用DuridConfig.java中配置的用户名密码mingx/123456登录，可以在控制台中看到数据库相关状况，如下图：
   

至此集成druid完成

Mybatis-Plus

Mybatis-Plus的介绍

Mybatis-Plus（简称MP）是一个 Mybatis 的增强工具，在 Mybatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

我们的愿景是成为 Mybatis 最好的搭档，就像 魂斗罗 中的1P、2P，基友搭配，效率翻倍。

集成Mybatis-Plus

1. 在父项目的pom.xml中，增加如下配置，用于版本号的统一配置

<properties>
    <mybatis-plus.version>3.0.6</mybatis-plus.version>
</properties>

 <dependencyManagement>
       <dependencies>
        !-- mybatis-plus主版本管理  -->
             <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>${mybatis-plus.version}</version>
            </dependency>
    </dependencies>
</dependencyManagement>

2. 在mingx-user微服务的pom.xml中增加Mybatis-Plus的依赖及码生成器与模板引擎的依赖

<!-- Mybatis-Plus依赖 -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
</dependency>
<!-- mybatis-plus代码生成器与模板引擎的依赖  -->
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
</dependency>

3. 在com.mingx.user.config包下创建MybatisPlusConfig.java配置类，具体代码如下：

package com.mingx.user.config;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;

/**
 * MybatisPlus分页插件
 * @author Admin
 *
 */
@Configuration
@MapperScan("com.mingx.user.mapper")
public class MybatisPlusConfig {

    /**
     *     分页插件
     */
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }
}

4. 登录nacos控制台，编辑mingx-user-dev.yml，增加Mybatis-Plus的相关配置。

#主键生成策略
mybatis-plus:
    global-config:
        db-config:
            id-type: uuid
    mapper-locations: classpath:/mapper/*.xml

5. 在com.mingx包下创建CodeGenerator.java文件，利用代码生成工具类，将需要的mapper、service、controller进行自动生成。代码如下,注意根据实际情况进行代码中数据源信息的配置

package com.mingx;

import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;

import org.apache.commons.lang.StringUtils;

import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.FileOutConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.TemplateConfig;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

/**
 *     代码生成工具，执行前先确认对应的数据库连接信息
 *     执行main方法控制台输入模块表名回车自动生成对应项目目录中
 * @author Jonas
 *
 */
public class CodeGenerator {

 /**
  * <p>
  * 读取控制台内容
  * </p>
  */
 @SuppressWarnings("resource")
public static String scanner(String tip) {
     Scanner scanner = new Scanner(System.in);
     StringBuilder help = new StringBuilder();
     help.append("请输入" + tip + "：");
     System.out.println(help.toString());
     if (scanner.hasNext()) {
         String ipt = scanner.next();
         if (StringUtils.isNotEmpty(ipt)) {
             return ipt;
         }
     }
     throw new MybatisPlusException("请输入正确的" + tip + "！");
 }

 public static void main(String[] args) {
     // 代码生成器
     AutoGenerator mpg = new AutoGenerator();

     // 全局配置
     GlobalConfig gc = new GlobalConfig();
     String projectPath = System.getProperty("user.dir");
     gc.setOutputDir(projectPath + "/src/main/java");
     gc.setAuthor("Jonas");
     gc.setOpen(false);
     mpg.setGlobalConfig(gc);

     // 数据源配置
     DataSourceConfig dsc = new DataSourceConfig();
     dsc.setUrl("jdbc:mysql://127.0.0.1:3306/mingx_user?characterEncoding=utf8&useSSL=false&serverTimezone=UTC&rewriteBatchedStatements=true");//oa为我自己的数据库
     dsc.setDriverName("com.mysql.cj.jdbc.Driver"); //设置数据库驱动,因为我的数据库版本是mysql5.7,所以使用该驱动
     dsc.setUsername("root"); //数据库名称
     dsc.setPassword("root"); //数据库密码
     mpg.setDataSource(dsc);

     // 包配置
     PackageConfig pc = new PackageConfig();
     pc.setModuleName(scanner("模块名"));
     pc.setParent("com.mingx");
     mpg.setPackageInfo(pc);

     // 自定义配置
     InjectionConfig cfg = new InjectionConfig() {
         @Override
         public void initMap() {
             // to do nothing
         }
     };

     // 如果模板引擎是 freemarker
     String templatePath = "/templates/mapper.xml.ftl";
     // 如果模板引擎是 velocity
     // String templatePath = "/templates/dao.xml.vm";

     // 自定义输出配置
     List<FileOutConfig> focList = new ArrayList<>();
     // 自定义配置会被优先输出
     focList.add(new FileOutConfig(templatePath) {
         @Override
         public String outputFile(TableInfo tableInfo) {
             // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
             return projectPath + "/src/main/resources/mapper/"
                      + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
         }
     });
     cfg.setFileOutConfigList(focList);
     mpg.setCfg(cfg);

     // 配置模板
     TemplateConfig templateConfig = new TemplateConfig();

     // 配置自定义输出模板
     //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
     // templateConfig.setEntity("templates/entity2.java");
     // templateConfig.setService();
     // templateConfig.setController();

     templateConfig.setXml(null);
     mpg.setTemplate(templateConfig);

     // 策略配置
     StrategyConfig strategy = new StrategyConfig();
     strategy.setNaming(NamingStrategy.underline_to_camel);
     strategy.setColumnNaming(NamingStrategy.underline_to_camel);
     //strategy.setSuperEntityClass("com.baomidou.ant.common.BaseEntity");
     strategy.setEntityLombokModel(true);
     strategy.setRestControllerStyle(true);
     // 公共父类
     //strategy.setSuperControllerClass("com.mingx.common.controller.BaseController");
     // 写于父类中的公共字段
     //strategy.setSuperEntityColumns("id");
     strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
     strategy.setControllerMappingHyphenStyle(true);
     strategy.setTablePrefix(pc.getModuleName() + "_");
     mpg.setStrategy(strategy);
     mpg.setTemplateEngine(new FreemarkerTemplateEngine());
     mpg.execute();
 }

}

6. 在CodeGenerator.java中右击--run as --Java Application执行，在控制台输入模块名称user，输入生成代码对应的数据库表名sys_user,回车执行代码生成操作。

   

7. 刷新项目，可以发现包下生成了相应代码，之前提到的mingx-user-pojo微服务是专为用于放pojo类的，所以可以将com.mingx.user.entity下生成的实体类抽离出来。
   创建mingx-user-pojo微服务项目，按照之前创建mingx-user步骤一样，修改pojo项目下的pom.xml文件，进行如下设置：

<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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>com.mingx</groupId>
    <artifactId>mingx-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
  </parent>
  <groupId>com.mingx.user</groupId>
  <artifactId>mingx-user-pojo</artifactId>
  <packaging>jar</packaging>


  <dependencies>
         <!-- lombok依赖  -->
       <dependency>
           <groupId>org.projectlombok</groupId>
           <artifactId>lombok</artifactId>
           <optional>true</optional>
       </dependency>
  </dependencies>

</project>

8. 在mingx-user-pojo微服务src/main/java目录下创建com.mingx.entity包，将生成的实体类放入该包下。
   在mingx-user项目中删除com.mingx.entity包，并在pom.xml文件中需要将mingx-user-pojo引入。
   在标签下增加：

<dependency>
   <groupId>com.mingx.user</groupId>
     <artifactId>mingx-user-pojo</artifactId>
   <version>0.0.1-SNAPSHOT</version>
</dependency>

9. 在mingx-user微服务中，在生成的SysUserController.java控制类中，增加查询数据库用户的方法，进行数据库查询操作，来验证是否正常与数据库建立联系。

@RestController
@RequestMapping("/user")
public class SysUserController {

    @Autowired
    private ISysUserService sysUserService;

    @GetMapping("/queryUserById")
    public String queryUserById(String userId) {

        return sysUserService.getById(userId).toString();

    }
}

10. 启动mingx-user微服务，在浏览器中访http://127.0.0.1:7001/user/queryUserById?userId=1，查看响应结果。

至此整合Mybatis-Plus以及代码生成功能已经实现。

结束语

本章主要介绍Springboot整合Mybatis-Plus，以及代码生成工具的使用，少了一些理论相关的内容，更多的是代码上的实际操作，实用性比较多一些。

其实对于Mybatis-Plus实际的运用，CURD操作，特别是查询，需要你去官网进一步的了解，在实际的业务开发中肯定是会用到的。

下一章介绍统一入参校验，统一的响应，统一异常处理，对于一个对外提供服务的接口来说，这是必不可少的要求。

点关注，不迷路

微信搜索【寻的足迹】关注公众号，第一时间收到最新文章