SpringBoot 结合 MyBatis-Plus 配置多数据源以及结合 p6spy 打印 SQL 日志

约定不等于承诺〃 2023-09-25 14:17 8阅读 0赞

--------------------

title: SpringBoot 结合 MyBatis-Plus 配置多数据源以及结合 p6spy 打印 SQL 日志  
date: 2022-12-23 11:23:16  
tags:

*  SpringBoot
 *  MyBatis-Plus  
    categories:
 *  开发技术及框架  
    cover: https://cover.png  
    feature: false

--------------------

## 1. 配置多数据源 ##

**官网：[多数据源 | MyBatis-Plus (baomidou.com)][_ MyBatis-Plus _baomidou.com]**

### 1.1 引入依赖 ###

<dependency>
      <groupId>com.baomidou</groupId>
      <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
      <version>3.5.2</version>
    </dependency>

### 1.2 配置数据源 ###

在 application.yml 文件或其他同等配置文件中进行配置

spring:
      datasource:
        dynamic:
          primary: master #设置默认的数据源或者数据源组,默认值即为master
          strict: false #严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源
          datasource:
            master:
              url: jdbc:mysql://xx.xx.xx.xx:3306/dynamic
              username: root
              password: 123456
              driver-class-name: com.mysql.jdbc.Driver # 3.2.0开始支持SPI可省略此配置
            slave_1:
              url: jdbc:mysql://xx.xx.xx.xx:3307/dynamic
              username: root
              password: 123456
              driver-class-name: com.mysql.jdbc.Driver
            slave_2:
              url: ENC(xxxxx) # 内置加密,使用请查看详细文档
              username: ENC(xxxxx)
              password: ENC(xxxxx)
              driver-class-name: com.mysql.jdbc.Driver
           #......省略
           #以上会配置一个默认库master，一个组slave下有两个子库slave_1,slave_2

# 多主多从                      纯粹多库（记得设置primary）                   混合配置
    spring:                               spring:                               spring:
      datasource:                           datasource:                           datasource:
        dynamic:                              dynamic:                              dynamic:
          datasource:                           datasource:                           datasource:
            master_1:                             mysql:                                master:
            master_2:                             oracle:                               slave_1:
            slave_1:                              sqlserver:                            slave_2:
            slave_2:                              postgresql:                           oracle_1:
            slave_3:                              h2:                                   oracle_2:

### 1.3 使用 ###

使用 `@DS` 切换数据源，`@DS` 可以注解在方法上或类上，**同时存在就近原则 方法上注解 优先于 类上注解**

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>结果</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>没有@DS</td> 
   <td>默认数据源</td> 
  </tr> 
  <tr> 
   <td>@DS(“dsName”)</td> 
   <td>dsName可以为组名也可以为具体某个库的名称</td> 
  </tr> 
 </tbody> 
</table>

@Service
    @DS("slave")
    public class UserServiceImpl implements UserService {
        
    
      @Autowired
      private JdbcTemplate jdbcTemplate;
    
      public List selectAll() {
        
        return  jdbcTemplate.queryForList("select * from user");
      }
      
      @Override
      @DS("slave_1")
      public List selectByCondition() {
        
        return  jdbcTemplate.queryForList("select * from user where age > 10");
      }
    }

其实直接标注在 DAO 接口上即可

### 1.4 示例 ###

**application-dev.yml 配置，这里用了下面的 p6spy 来打印日志**

spring:
      datasource:
        dynamic:
          primary: common
          strict: false
          datasource:
            common:
              driver-class-name: com.p6spy.engine.spy.P6SpyDriver
              url: jdbc:p6spy:mysql://124.xxx.xxx.90:3306/common?connectTimeout=5000&socketTimeout=10000&autoReconnect=true&failOverReadOnly=false&useSSL=false&useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8
              username: root
              password: xxx
            resNav:
              driver-class-name: com.p6spy.engine.spy.P6SpyDriver
              url: jdbc:p6spy:mysql://124.xxx.xxx.90:3306/resource_nav?connectTimeout=5000&socketTimeout=10000&autoReconnect=true&failOverReadOnly=false&useSSL=false&useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8
              username: root
              password: xxx
          druid:
            # 关闭空闲检测
            # test-while-idle: false
            # 设置空闲检测语句
            validation-query: SELECT 1

## 2. p6spy 打印 SQL 日志 ##

**p6spy GitHub 地址：[p6spy/p6spy (github.com)][p6spy_p6spy _github.com]**

**MyBatis-Plus 结合 p6spy：[MyBatis-Plus (baomidou.com)][MyBatis-Plus _baomidou.com]**

### 2.1 引入依赖 ###

### 2.2 配置 ###

将 Driver 替换为 p6spy，同时 url 在 jdbc 后加上 p6spy 即可。然后设置日志文件

spring:
      datasource:
        druid:
          driver-class-name: com.p6spy.engine.spy.P6SpyDriver
          url: jdbc:p6spy:mysql://124.xxx.xxx.90:3306/fan_blog?connectTimeout=5000&socketTimeout=10000&autoReconnect=true&failOverReadOnly=false&useSSL=false&useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8
          username: root
          password: root
          # 关闭空闲检测
          # test-while-idle: false
          # 设置空闲检测语句
          validation-query: SELECT 1
    
    logging:
      level:
        # 指定整个项目的日志级别
        root: info
        # 对某个包指定单独的日志级别
        # fan.config: warn
      # 日志文件, 默认路径为项目根目录下
      file:
        name: all.log

### 2.3 spy.properties 配置 ###

在 resource 目录下创建 spy.properties，即可对 p6spy 进行自定义配置。其中，结合 MyBatis-Plus 的配置如下：

# 3.2.1以上使用
    modulelist=com.baomidou.mybatisplus.extension.p6spy.MybatisPlusLogFactory,com.p6spy.engine.outage.P6OutageFactory
    # 3.2.1以下使用或者不配置
    #modulelist=com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory
    # 自定义日志打印
    logMessageFormat=com.baomidou.mybatisplus.extension.p6spy.P6SpyLogger
    # 日志输出到控制台, 红色日志
    #appender=com.baomidou.mybatisplus.extension.p6spy.StdoutLogger
    # 使用日志系统记录 sql
    appender=com.p6spy.engine.spy.appender.Slf4JLogger
    # 设置 p6spy driver 代理
    deregisterdrivers=true
    # 取消JDBC URL前缀
    useprefix=true
    # 配置记录 Log 例外,可去掉的结果集有error,info,batch,debug,statement,commit,rollback,result,resultset.
    excludecategories=info,debug,result,commit,resultset
    # 日期格式
    dateformat=yyyy-MM-dd HH:mm:ss
    # 实际驱动可多个
    #driverlist=org.h2.Driver
    # 是否开启慢SQL记录
    outagedetection=true
    # 慢SQL记录标准 2 秒
    outagedetectioninterval=2

p6spy 完整配置如下，详细可见：**[Configuration and Usage — p6spy documentation][Configuration and Usage _ p6spy documentation]**

#################################################################
    # P6Spy Options File                                            #
    # See documentation for detailed instructions                   #
    # http://p6spy.github.io/p6spy/2.0/configandusage.html          #
    #################################################################
    
    #################################################################
    # MODULES                                                       #
    #                                                               #
    # Module list adapts the modular functionality of P6Spy.        #
    # Only modules listed are active.                               #
    # (default is com.p6spy.engine.logging.P6LogFactory and         #
    # com.p6spy.engine.spy.P6SpyFactory)                            #
    # Please note that the core module (P6SpyFactory) can't be      #
    # deactivated.                                                  #
    # Unlike the other properties, activation of the changes on     #
    # this one requires reload.                                     #
    #################################################################
    #modulelist=com.p6spy.engine.spy.P6SpyFactory,com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory
    
    ################################################################
    # CORE (P6SPY) PROPERTIES                                      #
    ################################################################
    
    # A comma separated list of JDBC drivers to load and register.
    # (default is empty)
    #
    # Note: This is normally only needed when using P6Spy in an
    # application server environment with a JNDI data source or when
    # using a JDBC driver that does not implement the JDBC 4.0 API
    # (specifically automatic registration).
    #driverlist=
    
    # for flushing per statement
    # (default is false)
    #autoflush=false
    
    # sets the date format using Java's SimpleDateFormat routine.
    # In case property is not set, milliseconds since 1.1.1970 (unix time) is used (default is empty)
    #dateformat=
    
    # prints a stack trace for every statement logged
    #stacktrace=false
    # if stacktrace=true, specifies the stack trace to print
    #stacktraceclass=
    
    # determines if property file should be reloaded
    # Please note: reload means forgetting all the previously set
    # settings (even those set during runtime - via JMX)
    # and starting with the clean table
    # (default is false)
    #reloadproperties=false
    
    # determines how often should be reloaded in seconds
    # (default is 60)
    #reloadpropertiesinterval=60
    
    # specifies the appender to use for logging
    # Please note: reload means forgetting all the previously set
    # settings (even those set during runtime - via JMX)
    # and starting with the clean table
    # (only the properties read from the configuration file)
    # (default is com.p6spy.engine.spy.appender.FileLogger)
    #appender=com.p6spy.engine.spy.appender.Slf4JLogger
    #appender=com.p6spy.engine.spy.appender.StdoutLogger
    #appender=com.p6spy.engine.spy.appender.FileLogger
    
    # name of logfile to use, note Windows users should make sure to use forward slashes in their pathname (e:/test/spy.log)
    # (used for com.p6spy.engine.spy.appender.FileLogger only)
    # (default is spy.log)
    #logfile=spy.log
    
    # append to the p6spy log file. if this is set to false the
    # log file is truncated every time. (file logger only)
    # (default is true)
    #append=true
    
    # class to use for formatting log messages (default is: com.p6spy.engine.spy.appender.SingleLineFormat)
    #logMessageFormat=com.p6spy.engine.spy.appender.SingleLineFormat
    
    # Custom log message format used ONLY IF logMessageFormat is set to com.p6spy.engine.spy.appender.CustomLineFormat
    # default is %(currentTime)|%(executionTime)|%(category)|connection%(connectionId)|%(sqlSingleLine)
    # Available placeholders are:
    #   %(connectionId)            the id of the connection
    #   %(currentTime)             the current time expressing in milliseconds
    #   %(executionTime)           the time in milliseconds that the operation took to complete
    #   %(category)                the category of the operation
    #   %(effectiveSql)            the SQL statement as submitted to the driver
    #   %(effectiveSqlSingleLine)  the SQL statement as submitted to the driver, with all new lines removed
    #   %(sql)                     the SQL statement with all bind variables replaced with actual values
    #   %(sqlSingleLine)           the SQL statement with all bind variables replaced with actual values, with all new lines removed
    #customLogMessageFormat=%(currentTime)|%(executionTime)|%(category)|connection%(connectionId)|%(sqlSingleLine)
    
    # format that is used for logging of the java.util.Date implementations (has to be compatible with java.text.SimpleDateFormat)
    # (default is yyyy-MM-dd'T'HH:mm:ss.SSSZ)
    #databaseDialectDateFormat=yyyy-MM-dd'T'HH:mm:ss.SSSZ
    
    # format that is used for logging of the java.sql.Timestamp implementations (has to be compatible with java.text.SimpleDateFormat)
    # (default is yyyy-MM-dd'T'HH:mm:ss.SSSZ)
    #databaseDialectTimestampFormat=yyyy-MM-dd'T'HH:mm:ss.SSSZ
    
    # format that is used for logging booleans, possible values: boolean, numeric
    # (default is boolean)
    #databaseDialectBooleanFormat=boolean
    
    # Specifies the format for logging binary data. Not applicable if excludebinary is true.
    # (default is com.p6spy.engine.logging.format.HexEncodedBinaryFormat)
    #databaseDialectBinaryFormat=com.p6spy.engine.logging.format.PostgreSQLBinaryFormat
    #databaseDialectBinaryFormat=com.p6spy.engine.logging.format.MySQLBinaryFormat
    #databaseDialectBinaryFormat=com.p6spy.engine.logging.format.HexEncodedBinaryFormat
    
    # whether to expose options via JMX or not
    # (default is true)
    #jmx=true
    
    # if exposing options via jmx (see option: jmx), what should be the prefix used?
    # jmx naming pattern constructed is: com.p6spy(.<jmxPrefix>)?:name=<optionsClassName>
    # please note, if there is already such a name in use it would be unregistered first (the last registered wins)
    # (default is none)
    #jmxPrefix=
    
    # if set to true, the execution time will be measured in nanoseconds as opposed to milliseconds
    # (default is false)
    #useNanoTime=false
    
    #################################################################
    # DataSource replacement                                        #
    #                                                               #
    # Replace the real DataSource class in your application server  #
    # configuration with the name com.p6spy.engine.spy.P6DataSource #
    # (that provides also connection pooling and xa support).       #
    # then add the JNDI name and class name of the real             #
    # DataSource here                                               #
    #                                                               #
    # Values set in this item cannot be reloaded using the          #
    # reloadproperties variable. Once it is loaded, it remains      #
    # in memory until the application is restarted.                 #
    #                                                               #
    #################################################################
    #realdatasource=/RealMySqlDS
    #realdatasourceclass=com.mysql.jdbc.jdbc2.optional.MysqlDataSource
    
    #################################################################
    # DataSource properties                                         #
    #                                                               #
    # If you are using the DataSource support to intercept calls    #
    # to a DataSource that requires properties for proper setup,    #
    # define those properties here. Use name value pairs, separate  #
    # the name and value with a semicolon, and separate the         #
    # pairs with commas.                                            #
    #                                                               #
    # The example shown here is for mysql                           #
    #                                                               #
    #################################################################
    #realdatasourceproperties=port;3306,serverName;myhost,databaseName;jbossdb,foo;bar
    
    #################################################################
    # JNDI DataSource lookup                                        #
    #                                                               #
    # If you are using the DataSource support outside of an app     #
    # server, you will probably need to define the JNDI Context     #
    # environment.                                                  #
    #                                                               #
    # If the P6Spy code will be executing inside an app server then #
    # do not use these properties, and the DataSource lookup will   #
    # use the naming context defined by the app server.             #
    #                                                               #
    # The two standard elements of the naming environment are       #
    # jndicontextfactory and jndicontextproviderurl. If you need    #
    # additional elements, use the jndicontextcustom property.      #
    # You can define multiple properties in jndicontextcustom,      #
    # in name value pairs. Separate the name and value with a       #
    # semicolon, and separate the pairs with commas.                #
    #                                                               #
    # The example shown here is for a standalone program running on #
    # a machine that is also running JBoss, so the JNDI context     #
    # is configured for JBoss (3.0.4).                              #
    #                                                               #
    # (by default all these are empty)                              #
    #################################################################
    #jndicontextfactory=org.jnp.interfaces.NamingContextFactory
    #jndicontextproviderurl=localhost:1099
    #jndicontextcustom=java.naming.factory.url.pkgs;org.jboss.naming:org.jnp.interfaces
    
    #jndicontextfactory=com.ibm.websphere.naming.WsnInitialContextFactory
    #jndicontextproviderurl=iiop://localhost:900
    
    ################################################################
    # P6 LOGGING SPECIFIC PROPERTIES                               #
    ################################################################
    
    # filter what is logged
    # please note this is a precondition for usage of: include/exclude/sqlexpression
    # (default is false)
    #filter=false
    
    # comma separated list of strings to include
    # please note that special characters escaping (used in java) has to be done for the provided regular expression
    # (default is empty)
    #include=
    # comma separated list of strings to exclude
    # (default is empty)
    #exclude=
    
    # sql expression to evaluate if using regex
    # please note that special characters escaping (used in java) has to be done for the provided regular expression
    # (default is empty)
    #sqlexpression=
    
    #list of categories to exclude: error, info, batch, debug, statement,
    #commit, rollback, result and resultset are valid values
    # (default is info,debug,result,resultset,batch)
    #excludecategories=info,debug,result,resultset,batch
    
    #whether the binary values (passed to DB or retrieved ones) should be logged with placeholder: [binary] or not.
    # (default is false)
    #excludebinary=false
    
    # Execution threshold applies to the standard logging of P6Spy.
    # While the standard logging logs out every statement
    # regardless of its execution time, this feature puts a time
    # condition on that logging. Only statements that have taken
    # longer than the time specified (in milliseconds) will be
    # logged. This way it is possible to see only statements that
    # have exceeded some high water mark.
    # This time is reloadable.
    #
    # executionThreshold=integer time (milliseconds)
    # (default is 0)
    #executionThreshold=
    
    ################################################################
    # P6 OUTAGE SPECIFIC PROPERTIES                                #
    ################################################################
    # Outage Detection
    #
    # This feature detects long-running statements that may be indicative of
    # a database outage problem. If this feature is turned on, it will log any
    # statement that surpasses the configurable time boundary during its execution.
    # When this feature is enabled, no other statements are logged except the long
    # running statements. The interval property is the boundary time set in seconds.
    # For example, if this is set to 2, then any statement requiring at least 2
    # seconds will be logged. Note that the same statement will continue to be logged
    # for as long as it executes. So if the interval is set to 2, and the query takes
    # 11 seconds, it will be logged 5 times (at the 2, 4, 6, 8, 10 second intervals).
    #
    # outagedetection=true|false
    # outagedetectioninterval=integer time (seconds)
    #
    # (default is false)
    #outagedetection=false
    # (default is 60)
    #outagedetectioninterval=30

[_ MyBatis-Plus _baomidou.com]: https://baomidou.com/pages/a61e1b/#%E6%96%87%E6%A1%A3-documentation
[p6spy_p6spy _github.com]: https://github.com/p6spy/p6spy
[MyBatis-Plus _baomidou.com]: https://baomidou.com/pages/833fab/
[Configuration and Usage _ p6spy documentation]: https://p6spy.readthedocs.io/en/latest/configandusage.html