【springboot系列】springboot整合獨立模塊Druid + mybatis-plus

時間 2019-12-05

標籤 springboot系列 springboot 整合獨立模塊 druid mybatis 欄目 Spring 简体版

原文原文鏈接

項目github地址：https://github.com/5-Ason/aso...
具體可看 ./db/db-mysql 模塊css

本文主要實現的是對數據操做進行獨立模塊得整合，詳情請看個人另外一篇博文：
【技術雜談】springcloud微服務之數據操做獨立模塊化java

一、本篇目標

獨立部署mysql數據操做模塊，整合 Druid + mybatis-plus ，實現SpringBoot項目中依賴數據模塊進行數據操做，並進行簡單測試。mysql

二、引入依賴

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
    <version>1.5.6.RELEASE</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.36</version>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus</artifactId>
    <version>2.1-gamma</version>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.0.13</version>
</dependency>

三、配置屬性

由於個人項目使用的是springcloud分佈式配置
因此配置文件在 ./config-server/config-repo/data-dev.yml，具體配置以下：git

# ====================mysql====================
connection:
  url: jdbc:mysql://ason-hostname:3306/rms_db?useUnicode=true&characterEncoding=utf8
  username: ason
  password: ason


# ====================druid====================
druid:
  # 初始化時創建物理鏈接的個數。初始化發生在顯示調用init方法，或者第一次getConnection時
  initialSize: 1
  #    最小鏈接池數量
  minIdle: 1
  # 最大鏈接池數量
  maxActive: 10
  #    配置獲取鏈接等待超時的時間
  maxWait: 10000
  #  配置間隔多久才進行一次檢測，檢測須要關閉的空閒鏈接，單位是毫秒
  timeBetweenEvictionRunsMillis: 60000
  #  配置一個鏈接在池中最小生存的時間，單位是毫秒
  minEvictableIdleTimeMillis: 300000
  #  驗證鏈接有效與否的SQL，不一樣的數據配置不一樣
  validationQuery: select 1
  #  建議配置爲true，不影響性能，而且保證安全性。
  #  申請鏈接的時候檢測，若是空閒時間大於
  #  timeBetweenEvictionRunsMillis，
  #  執行validationQuery檢測鏈接是否有效。
  testWhileIdle: true
  #  申請鏈接時執行validationQuery檢測鏈接是否有效，作了這個配置會下降性能。
  #  這裏建議配置爲TRUE，防止取到的鏈接不可用
  testOnBorrow: true
  #  歸還鏈接時執行validationQuery檢測鏈接是否有效，作了這個配置會下降性能
  testOnReturn: false
  #  是否緩存preparedStatement，也就是PSCache。
  #  PSCache對支持遊標的數據庫性能提高巨大，好比說oracle。
  #  在mysql5.5如下的版本中沒有PSCache功能，建議關閉掉。
  #  做者在5.5版本中使用PSCache，經過監控界面發現PSCache有緩存命中率記錄，
  #  該應該是支持PSCache。
  #  打開PSCache，而且指定每一個鏈接上PSCache的大小
  poolPreparedStatements: true
  maxPoolPreparedStatementPerConnectionSize: 20
  #  屬性類型是字符串，經過別名的方式配置擴展插件，
  #  經常使用的插件有：
  #  監控統計用的filter:stat
  #  日誌用的filter:log4j
  #  防護sql注入的filter:wall
  filters: stat
  # 訪問的用戶名
  loginUsername: ason
  # 訪問的密碼
  loginPassword: ason

# ====================MybatisPlus====================
mybatisPlus:
  globalConfig:
    #主鍵類型  0:"數據庫ID自增", 1:"用戶輸入ID",2:"全局惟一ID (數字類型惟一ID)", 3:"全局惟一ID UUID";
    idType: 0
    #字段策略 0:"忽略判斷",1:"非 NULL 判斷"),2:"非空判斷"
    fieldStrategy: 2
    #駝峯下劃線轉換
    dbColumnUnderline: true
    #刷新mapper 調試神器
    isRefresh: true
    #數據庫大寫下劃線轉換
    isCapitalMode: true
    #邏輯刪除配置
    logicDeleteValue: 0
    logicNotDeleteValue: 1

四、DruidConf配置

package com.ason;

import com.alibaba.druid.pool.DruidDataSource;
import com.alibaba.druid.support.http.StatViewServlet;
import com.alibaba.druid.support.http.WebStatFilter;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.beans.factory.annotation.Value;
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;

/**
 * Created by Ason on 2017/9/26.
 */
@Configuration
public class DruidConf {
    private static final Log log = LogFactory.getLog(DruidConf.class);

    @Value("${connection.url}")
    private String connectionUrl;
    @Value("${connection.username}")
    private String username;
    @Value("${connection.password}")
    private String password;
    @Value("${druid.initialSize}")
    private Integer initialSize;
    @Value("${druid.minIdle}")
    private Integer minIdle;
    @Value("${druid.maxActive}")
    private Integer maxActive;
    @Value("${druid.maxWait}")
    private Integer maxWait;
    @Value("${druid.timeBetweenEvictionRunsMillis}")
    private Integer timeBetweenEvictionRunsMillis;
    @Value("${druid.minEvictableIdleTimeMillis}")
    private Integer minEvictableIdleTimeMillis;
    @Value("${druid.validationQuery}")
    private String validationQuery;
    @Value("${druid.testWhileIdle}")
    private Boolean testWhileIdle;
    @Value("${druid.testOnBorrow}")
    private Boolean testOnBorrow;
    @Value("${druid.testOnReturn}")
    private Boolean testOnReturn;
    @Value("${druid.poolPreparedStatements}")
    private Boolean poolPreparedStatements;
    @Value("${druid.maxPoolPreparedStatementPerConnectionSize}")
    private Integer maxPoolPreparedStatementPerConnectionSize;
    @Value("${druid.filters}")
    private String filters;

    @Value("${druid.loginUsername}")
    private String loginUsername;
    @Value("${druid.loginPassword}")
    private String loginPassword;

    //    配置數據源
    @Bean(name = "basisDataSource", initMethod = "init", destroyMethod = "close")
    public DruidDataSource initDataSource() {
        log.info("初始化DruidDataSource");
        DruidDataSource dds = new DruidDataSource();
        dds.setDriverClassName("com.mysql.jdbc.Driver");
        dds.setUrl(connectionUrl);
        dds.setUsername(username);
        dds.setPassword(password);
        dds.setInitialSize(initialSize);
        dds.setMinIdle(minIdle);
        dds.setMaxActive(maxActive);
        dds.setMaxWait(maxWait);
        dds.setTimeBetweenEvictionRunsMillis(timeBetweenEvictionRunsMillis);
        dds.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis);
        dds.setValidationQuery(validationQuery);
        dds.setTestWhileIdle(testWhileIdle);
        dds.setTestOnBorrow(testOnBorrow);
        dds.setTestOnReturn(testOnReturn);
        dds.setPoolPreparedStatements(poolPreparedStatements);
        dds.setMaxPoolPreparedStatementPerConnectionSize(maxPoolPreparedStatementPerConnectionSize);
        try {
            dds.setFilters(filters);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return dds;
    }

    @Bean
    public ServletRegistrationBean druidServlet() {
        ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean(new StatViewServlet(), "/druid/*");
        //設置登陸查看信息的帳號密碼.
        servletRegistrationBean.addInitParameter("loginUsername",loginUsername);
        servletRegistrationBean.addInitParameter("loginPassword",loginPassword);
        return servletRegistrationBean;
    }

    @Bean
    public FilterRegistrationBean filterRegistrationBean() {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        filterRegistrationBean.setFilter(new WebStatFilter());
        filterRegistrationBean.addUrlPatterns("/*");
        filterRegistrationBean.addInitParameter("exclusions", "*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*");
        return filterRegistrationBean;
    }
}

五、MybatisPlusConf

package com.ason;

import com.alibaba.druid.pool.DruidDataSource;
import com.ason.utils.BlankUtil;
import com.baomidou.mybatisplus.entity.GlobalConfiguration;
import com.baomidou.mybatisplus.plugins.PaginationInterceptor;
import com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.mapper.MapperScannerConfigurer;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;

/**
 * Created by Ason on 2017/8/15.
 */
@Configuration
public class MybatisPlusConf {

    private static final Log log = LogFactory.getLog(DruidConf.class);

    //    mybatisPlus全局配置
    @Bean(name = "globalConfig")
    public GlobalConfiguration globalConfig(
            @Value("${mybatisPlus.globalConfig.idType}") Integer idType, //主鍵類型  0:"數據庫ID自增", 1:"用戶輸入ID",2:"全局惟一ID (數字類型惟一ID)", 3:"全局惟一ID UUID";
            @Value("${mybatisPlus.globalConfig.fieldStrategy}") Integer fieldStrategy, //字段策略 0:"忽略判斷",1:"非 NULL 判斷"),2:"非空判斷"
            @Value("${mybatisPlus.globalConfig.dbColumnUnderline}") Boolean dbColumnUnderline, //駝峯下劃線轉換
            @Value("${mybatisPlus.globalConfig.isRefresh}") Boolean isRefresh, //刷新mapper 調試神器
            @Value("${mybatisPlus.globalConfig.isCapitalMode}") Boolean isCapitalMode, //數據庫大寫下劃線轉換
            @Value("${mybatisPlus.globalConfig.logicDeleteValue}") String logicDeleteValue, //邏輯刪除配置
            @Value("${mybatisPlus.globalConfig.logicNotDeleteValue}") String logicNotDeleteValue //邏輯刪除配置
    ) {
        log.info("初始化GlobalConfiguration");
        GlobalConfiguration globalConfig = new GlobalConfiguration();
        if ( !BlankUtil.isBlank(idType)) {
            globalConfig.setIdType(idType);  //主鍵類型
        }
        if ( !BlankUtil.isBlank(fieldStrategy)) {
            //        globalConfig.setFieldStrategy(fieldStrategy); //字段策略
        }
        if ( !BlankUtil.isBlank(dbColumnUnderline)) {
            globalConfig.setDbColumnUnderline(dbColumnUnderline);  //駝峯下劃線轉換
        }
        if ( !BlankUtil.isBlank(isRefresh)) {
            //        globalConfig.setRefresh(isRefresh); //刷新mapper 調試神器
        }
        if ( !BlankUtil.isBlank(isCapitalMode)) {
            globalConfig.setCapitalMode(isCapitalMode); //數據庫大寫下劃線轉換
        }
        if ( !BlankUtil.isBlank(logicDeleteValue)) {
            //        globalConfig.setLogicDeleteValue(logicDeleteValue);  //邏輯刪除配置
        }
        if ( !BlankUtil.isBlank(logicNotDeleteValue)) {
            //        globalConfig.setLogicNotDeleteValue(logicNotDeleteValue);  //邏輯刪除配置
        }
        return globalConfig;
    }

    @Bean(name = "sqlSessionFactory")
    public SqlSessionFactory sqlSessionFactory(@Qualifier(value = "globalConfig")GlobalConfiguration globalConfig,
                                               @Qualifier(value = "basisDataSource")DruidDataSource dataSource) throws Exception {
        log.info("初始化SqlSessionFactory");
        String mapperLocations = "classpath:db-ason/sql/**/*.xml";
        String configLocation = "classpath:db-ason/mybatis/mybatis-sqlconfig.xml";
        String typeAliasesPackage = "com.ason.entity.**";
        MybatisSqlSessionFactoryBean sqlSessionFactory = new MybatisSqlSessionFactoryBean();
        sqlSessionFactory.setDataSource(dataSource); //數據源
        sqlSessionFactory.setGlobalConfig(globalConfig); //全局配置
        Interceptor[] interceptor = {new PaginationInterceptor()};
        sqlSessionFactory.setPlugins(interceptor); //分頁插件
        ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
        try {
            //自動掃描Mapping.xml文件
            sqlSessionFactory.setMapperLocations(resolver.getResources(mapperLocations));
            sqlSessionFactory.setConfigLocation(resolver.getResource(configLocation));
            sqlSessionFactory.setTypeAliasesPackage(typeAliasesPackage);
            return sqlSessionFactory.getObject();
        } catch (Exception e) {
            e.printStackTrace();
            throw e;
        }
    }

    //    MyBatis 動態掃描
    @Bean
    public MapperScannerConfigurer mapperScannerConfigurer() {
        log.info("初始化MapperScannerConfigurer");
        MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
        String basePackage = "com.ason.db.mapper";
        mapperScannerConfigurer.setBasePackage(basePackage);
        return mapperScannerConfigurer;
    }

    //    配置事務管理
    @Bean(name = "transactionManager")
    public DataSourceTransactionManager transactionManager(@Qualifier(value = "basisDataSource")DruidDataSource dataSource) {
        log.info("初始化DataSourceTransactionManager");
        return new DataSourceTransactionManager(dataSource);
    }
}

六、mybatis-sqlconfig.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">

<!--
 |   plugins在配置文件中的位置必須符合要求，不然會報錯，順序以下:
 |   properties?, settings?,
 |   typeAliases?, typeHandlers?,
 |   objectFactory?,objectWrapperFactory?,
 |   plugins?,
 |   environments?, databaseIdProvider?, mappers?
 |-->
<configuration>
    <!--
     | 全局配置設置
     |
     | 可配置選項                   默認值,     描述
     |
     | aggressiveLazyLoading       true,     當設置爲‘true’的時候，懶加載的對象可能被任何懶屬性所有加載。不然，每一個屬性都按需加載。
     | multipleResultSetsEnabled   true,     容許和不容許單條語句返回多個數據集（取決於驅動需求）
     | useColumnLabel              true,     使用列標籤代替列名稱。不一樣的驅動器有不一樣的做法。參考一下驅動器文檔，或者用這兩個不一樣的選項進行測試一下。
     | useGeneratedKeys            false,    容許JDBC 生成主鍵。須要驅動器支持。若是設爲了true，這個設置將強制使用被生成的主鍵，有一些驅動器不兼容不過仍然能夠執行。
     | autoMappingBehavior         PARTIAL,  指定MyBatis 是否而且如何來自動映射數據表字段與對象的屬性。PARTIAL將只自動映射簡單的，沒有嵌套的結果。FULL 將自動映射全部複雜的結果。
     | defaultExecutorType         SIMPLE,   配置和設定執行器，SIMPLE 執行器執行其它語句。REUSE 執行器可能重複使用prepared statements 語句，BATCH執行器能夠重複執行語句和批量更新。
     | defaultStatementTimeout     null,     設置一個時限，以決定讓驅動器等待數據庫迴應的多長時間爲超時
     | -->
    <settings>
        <!-- 這個配置使全局的映射器啓用或禁用緩存 -->
        <setting name="cacheEnabled" value="true"/>
        <!-- 全局啓用或禁用延遲加載。當禁用時，全部關聯對象都會即時加載 -->
        <setting name="lazyLoadingEnabled" value="true"/>
        <setting name="multipleResultSetsEnabled" value="true"/>
        <setting name="useColumnLabel" value="true"/>
        <setting name="defaultExecutorType" value="REUSE"/>
        <setting name="defaultStatementTimeout" value="25000"/>
        <setting name="safeRowBoundsEnabled" value="false"/>
        <!--是否開啓自動駝峯命名規則（camel case）映射，即從經典數據庫列名 A_COLUMN 到經典 Java 屬性名 aColumn 的相似映射。 -->
        <setting name="mapUnderscoreToCamelCase" value="true"/>
        <setting name="localCacheScope" value="SESSION"/>
        <setting name="jdbcTypeForNull" value="OTHER"/>
        <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>
        <!--打印sql語句-->
        <setting name="logPrefix" value="dao."/>
    </settings>

</configuration>

七、具體使用

由於是將數據庫的配置單獨做爲一個模塊的，因此個人rms-service微服務想進行數據操做，需依賴db-mysql模塊：github

<dependency>
    <groupId>com.ason</groupId>
    <artifactId>db-mysql</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

同時，還須要讀取數據配置的屬性，上面個人配置是放在 ./config-server/config-repo/data-dev.yml 下，因此在rms-service微服務下的 bootstrap.yml 配置文件中，須要指定配置中心服務的地址以及配置文件的name和profile:web

spring:
  # 配置中心服務的地址
  cloud:
    config:
      name: data
      profile: ${spring.profiles.active} # 要讀取的配置文件profile屬性
#      uri: http://127.0.0.1:7001
      #label: ${spring.profiles.active}
      discovery:
        enabled: true                                 # 默認false，設爲true表示使用註冊中心中的configserver配置而不本身配置configserver的uri
        serviceId: config-server
  profiles:
    active: dev

在 rms-service 的 RmsUserController 下，添加：redis

/**
 * 查詢單個用戶
 */
@GetMapping(value = "/{id}", produces = "application/json;charset=UTF-8")
public String findUserById(@PathVariable("id") Integer id) throws Exception {
    return ResultBody.success(rmsUserService.selectUserById(id));
}

啓動項目，訪問 http://localhost:8888/rms/user/6 spring