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操作，特別是查詢，需要你去官網進一步的了解，在實際的業務開發中肯定是會用到的。

下一章介紹統一入參校驗，統一的響應，統一異常處理，對於一個對外提供服務的接口來說，這是必不可少的要求。

點關注，不迷路

微信搜索【尋的足跡】關注公眾號，第一時間收到最新文章