本文簡介
本文將基於Spring官方提供的快速啓動項目模板集成Mybatis、Swagger2框架,並講解mybatis generator一鍵生成代碼插件、logback、一鍵生成文檔以及多環境的配置方法,最後再介紹一下自定義配置的註解獲取、全局異常處理等經常用到的東西。
爲什麼使用SpringBoot
相對於傳統的SSM框架,SpringBoot提供了默認的樣板化配置,簡化了Spring應用的初始搭建過程,如果你不想被衆多xml配置困擾,就可以用SpringBoot來代替。
開發環境
開發工具:IDEA。IDEA默認集成了SpringBoot的快速啓動項目。
PS:SpringBoot2.0以上要求JDK8.0及以上
創建項目
使用IDEA,在新建項目時選擇Spring Initializr,主要配置如圖:
創建完成,結構目錄如下:
集成所需的配置
1.修改.properties爲.yml
yml相對於properties更加精簡而且很多官方給出的Demo都是yml的配置形式,在這裏我們採用yml的形式代替properties,相對於properties形式主要有以下兩點不同:
- 對於鍵的描述由原有的 “.” 分割變成了樹的形狀;
- 對於所有的鍵的後面一個要跟一個空格,不然啓動項目會報配置解析錯誤。
spring:
datasource:
# 如果存在多個數據源,監控的時候可以通過名字來區分開來
name: mysql
# 連接數據庫的url
url: jdbc:mysql://localhost:3306/springdemo?characterEncoding=UTF8&serverTimezone=Asia/Shanghai
# 連接數據庫的賬號
username: root
# 連接數據庫的密碼
password: root
# 使用druid數據源
type: com.alibaba.druid.pool.DruidDataSource
# 擴展插件
# 監控統計用的filter:stat 日誌用的filter:log4j 防禦sql注入的filter:wall
filters: stat
# 最大連接池數量
maxActive: 20
# 初始化時建立物理連接的個數。初始化發生在顯示調用init方法,或者第一次getConnection時
initialSize: 1
# 獲取連接時最大等待時間,單位毫秒
maxWait: 60000
# 最小連接池數量
minIdle: 1
timeBetweenEvictionRunsMillis: 60000
# 連接保持空閒而不被驅逐的最長時間
minEvictableIdleTimeMillis: 300000
# 用來檢測連接是否有效的sql,要求是一個查詢語句
# 如果validationQuery爲null,testOnBorrow、testOnReturn、testWhileIdle都不會其作用
validationQuery: select count(1) from 'table'
# 申請連接的時候檢測,如果空閒時間大於timeBetweenEvictionRunsMillis,執行validationQuery檢測連接是否有效
testWhileIdle: true
# 申請連接時執行validationQuery檢測連接是否有效,做了這個配置會降低性能
testOnBorrow: false
# 歸還連接時執行validationQuery檢測連接是否有效,做了這個配置會降低性能
testOnReturn: false
# 是否緩存preparedStatement,即PSCache
poolPreparedStatements: false
# 要啓用PSCache,必須配置大於0,當大於0時,poolPreparedStatements自動觸發修改爲true
maxOpenPreparedStatements: -1
# pagehelper分頁插件
pagehelper:
# 數據庫的方言
helperDialect: mysql
# 啓用合理化,如果pageNum < 1會查詢第一頁,如果pageNum > pages會查詢最後一頁
reasonable: true
2.配置所需依賴
快速啓動項目創建成功後我們觀察其pom.xml文件中的依賴如下圖,包含了我們選擇的Web、Mybatis以及Mysql
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.1</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
除此之外,使用ORM框架一般還會配合數據庫連接池以及分頁插件來使用,阿里的druid、pagehelper分頁插件,整合swagger2文檔自動化構建框架,生成逆向代碼的mybatis-generator-core,所以增加了以下五個依賴項:
<!-- 分頁插件 -->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.2.3</version>
</dependency>
<!-- alibaba的druid數據庫連接池 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.1.1</version>
</dependency>
<!-- alibaba的json格式化對象 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.31</version>
</dependency>
<!-- 自動生成API文檔 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.5.0</version>
</dependency>
<!--官方給出的ui界面-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
</dependency>
<!-- mybatis-generator-core 反向生成java代碼-->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.5</version>
</dependency>
<!-- Lombok插件 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.8</version>
</dependency>
PS:配合pagehelper使用的配置項,在前面的yml配置中已經配了
3.集成Mybatis
Mybatis的配置主要包括了druid數據庫連接池、pagehelper分頁插件、mybatis-generator代碼逆向生成插件以及mapper、pojo掃描配置
前兩項已經在yml配置文件中配置好了。
mybatis-generator插件的使用主要分爲以下三步
- pom.xml中添加mybatis-generator插件
<!-- 將Spring Boot應用打包爲可執行的jar或war文件 -->
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
<!-- mybatis generator 自動生成代碼插件 -->
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.2</version>
<configuration>
<!-- 掃描resources/generator目錄下的generatorConfig.xml配置 -->
<configurationFile>
${basedir}/src/main/resources/generator/generatorConfig.xml
</configurationFile>
<overwrite>true</overwrite>
<verbose>true</verbose>
</configuration>
</plugin>
- 創建逆向代碼生成配置文件generatorConfig.xml
參照pom.xml插件配置中的掃描位置,在resources目錄下創建generator文件夾,在新建的文件夾中創建generatorConfig.xml配置文件,文件的詳細配置信息如下:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
<!-- 運行方式:mvaen運行命令 mybatis-generator:generate -e -->
<!-- 數據庫驅動:選擇你的本地硬盤上面的數據庫驅動包-->
<properties resource="generator/generator.properties"/>
<classPathEntry location="${classPathEntry}"/>
<context id="DB2Tables" targetRuntime="MyBatis3">
<!--數據庫鏈接URL,用戶名、密碼 -->
<jdbcConnection
driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/${db}?characterEncoding=UTF8&serverTimezone=Asia/Shanghai"
userId="${userId}"
password="${password}">
</jdbcConnection>
<javaTypeResolver>
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>
<javaModelGenerator targetPackage="${pojoTargetPackage}" targetProject="src/main/java">
<property name="enableSubPackages" value="true"/>
<property name="trimStrings" value="true"/>
</javaModelGenerator>
<!-- 生成映射文件的包名和位置-->
<sqlMapGenerator targetPackage="${mapperTargetPackage}" targetProject="src/main/resources">
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
<!-- 生成DAO的包名和位置-->
<javaClientGenerator type="XMLMAPPER" targetPackage="${daoTargetPackage}" targetProject="src/main/java">
<property name="enableSubPackages" value="true"/>
</javaClientGenerator>
<!-- 要生成的表 tableName是數據庫中的表名或視圖名,%表示數據庫下的所有表 schema是數據庫名稱-->
<table tableName="%" schema="${db}"/>
</context>
</generatorConfiguration>
爲了將generatorConfig.xml配置模板化,在這裏將變動性較大的配置項單獨提取出來作爲一個generatorConfig.xml的配置文件,然後通過properties標籤讀取此文件的配置,這樣做的好處是當需要多處複用此xml時只需要關注少量的配置項。
做法如下:在generatorConfig.xml同級創建generator.properties文件,只需要配置generator.properties文件即可,配置內容如下:
# 請手動配置以下選項
# 數據庫驅動:選擇數據庫驅動包,版本對應你連接的mysql版本
classPathEntry = D:/Java/mysql-connector-java-5.1.47.jar
# 數據庫名稱、用戶名、密碼
db = springdemo
userId = root
password = root
# 生成pojo的包名位置 在src/main/java目錄下
pojoTargetPackage = com.spring.demo.springbootexample.mybatis.po
# 生成DAO的包名位置 在src/main/java目錄下
daoTargetPackage = com.spring.demo.springbootexample.mybatis.mapper
# 生成Mapper的包名位置 位於src/main/resources目錄下
mapperTargetPackage = mapper
- 運行mybatis-generator插件生成dao、pojo、mapper
打開命令行cd到項目pom.xml同級目錄運行以下命令,
或者在pom.xml文件夾處按住Shift並右鍵,選擇“在此處打開PowerShell窗口”執行以下命令
執行:mvn mybatis-generator:generate -e
以上,在項目工程中即可自動生成逆向代碼:
繼續配置Mybatis,
4. mybatis掃描包配置
4.1、在application.yml配置mapper.xml以及pojo的包地址
mybatis:
# mapper.xml包地址
mapper-locations: classpath:mapper/*.xml
# pojo生成包地址
type-aliases-package: com.spring.demo.springbootexample.mybatis.po
4.2、在SpringBootExampleApplication.java中開啓Mapper掃描註解
package com.spring.demo.springbootexample;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@MapperScan("com.spring.demo.springbootexample.mybatis.mapper")
public class SpringBootExampleApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootExampleApplication.class, args);
}
}
至此,Springboot+Mybatis+逆向代碼已經集成完畢。
集成Swagger2
Swagger2是一個文檔快速構建工具,能夠通過註解自動生成一個Restful風格json形式的接口文檔,並可以通過如swagger-ui等工具生成html網頁形式的接口文檔,swagger2的集成比較簡單,集成、註解與使用分爲四步
1、配置SwaggerConfig文件
package com.spring.demo.springbootexample.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
/**
* 集成Swagger2配置
* @author: chengsw
* @date: 2019/11/26
*/
@Configuration
public class SwaggerConfig {
// 接口版本號
private final String version = "1.0";
// 接口大標題
private final String title = "SpringBoot示例工程";
// 具體的描述
private final String description = "API文檔自動生成示例";
// 服務說明url
private final String termsOfServiceUrl = "http://www.chengsw.top";
// licence
private final String license = "CSW";
// licnce url
private final String licenseUrl = "https://csw-license.org/";
// 接口作者聯繫方式
private final Contact contact = new Contact("chengsw", "https://www.baidu.com", "[email protected]");
@Bean
public Docket buildDocket() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(buildApiInf())
.select()
.apis(RequestHandlerSelectors.basePackage("com.spring.demo.springbootexample.controller"))
.paths(PathSelectors.any())//配置需要解析的請求位置
.build();
}
private ApiInfo buildApiInf() {
return new ApiInfoBuilder().title(title).termsOfServiceUrl(termsOfServiceUrl).description(description)
.version(version).license(license).licenseUrl(licenseUrl).contact(contact).build();
}
}
2、在SpringBoot項目啓動類加入@EnableSwagger2註解
3、常用註解使用示例
/**
* Swagger在Contorller中的註解示例
* @author: chengsw
* @date: 2019/11/26
*/
@RestController
@RequestMapping("/v1/com")
@Api(value = "SwaggerTestController", tags = {"restful api示例"}) // 表示標識這個類是swagger的資源
public class SwaggerTestController {
Logger logger = LoggerFactory.getLogger(SwaggerTestController.class);
@Autowired
private SwaggerTestService swaggerTestService;
@GetMapping("/{id}")
//表示一個http請求的操作
@ApiOperation(value = "根據id查詢企業信息", httpMethod = "GET")
//@ApiImplicitParams用於方法,包含多個@ApiImplicitParam表示單獨的請求參數
@ApiImplicitParams({@ApiImplicitParam(name = "id", value = "企業id", required = true, paramType = "path"),
@ApiImplicitParam(name = "id2", value = "測試參數", required = false, paramType = "path")})
public BaseResponse selectComInfoById(@PathVariable("id") String id) {
if (StringHelper.isNullOrEmptyString(id)) {
logger.error(">> 根據id查詢企業信息-請求參數異常 id->{}", id);
return BaseResponse.error();
}
ComBasicInfo basicInfo = swaggerTestService.selectComInfoById(id);
logger.info(">> 根據id查詢企業信息完成 id->{}", id);
return BaseResponse.success(basicInfo);
}
}
4、啓動項目,進入頁面查看
http://localhost:8080/swagger-ui.html#/
logback-spring日誌配置
在application.yml的同級目錄創建logback-spring.xml,springboot推薦使用logback-spring.xml,logback-spring.xml的配置內容如下:
<?xml version="1.0" encoding="UTF-8"?>
<!-- 日誌級別從低到高分爲TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果設置爲WARN,則低於WARN的信息都不會輸出 -->
<!-- scan:當此屬性設置爲true時,配置文檔如果發生改變,將會被重新加載,默認值爲true -->
<!-- scanPeriod:設置監測配置文檔是否有修改的時間間隔,如果沒有給出時間單位,默認單位是毫秒。
當scan爲true時,此屬性生效。默認的時間間隔爲1分鐘。 -->
<!-- debug:當此屬性設置爲true時,將打印出logback內部日誌信息,實時查看logback運行狀態。默認值爲false。 -->
<configuration scan="true" scanPeriod="60 seconds">
<contextName>logback</contextName>
<!-- name的值是變量的名稱,value的值時變量定義的值。通過定義的值會被插入到logger上下文中。定義後,可以使“${}”來使用變量。 -->
<property name="log.path" value="./logs" />
<!--0. 日誌格式和顏色渲染 -->
<!-- 彩色日誌依賴的渲染類 -->
<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
<conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
<conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
<!-- 彩色日誌格式 -->
<property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
<!--1. 輸出到控制檯-->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<!--此日誌appender是爲開發使用,只配置最底級別,控制檯輸出的日誌級別是大於或等於此級別的日誌信息-->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>debug</level>
</filter>
<encoder>
<Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
<!-- 設置字符集 -->
<charset>UTF-8</charset>
</encoder>
</appender>
<!--2. 輸出到文檔-->
<!-- 2.1 level爲 DEBUG 日誌,時間滾動輸出 -->
<appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在記錄的日誌文檔的路徑及文檔名 -->
<file>${log.path}/web_debug.log</file>
<!--日誌文檔輸出格式-->
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset> <!-- 設置字符集 -->
</encoder>
<!-- 日誌記錄器的滾動策略,按日期,按大小記錄 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 日誌歸檔 -->
<fileNamePattern>${log.path}/web-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日誌文檔保留天數-->
<maxHistory>30</maxHistory>
</rollingPolicy>
<!-- 此日誌文檔只記錄debug級別的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>debug</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 2.2 level爲 INFO 日誌,時間滾動輸出 -->
<appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在記錄的日誌文檔的路徑及文檔名 -->
<file>${log.path}/web_info.log</file>
<!--日誌文檔輸出格式-->
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<!-- 日誌記錄器的滾動策略,按日期,按大小記錄 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 每天日誌歸檔路徑以及格式 -->
<fileNamePattern>${log.path}/web-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日誌文檔保留天數-->
<maxHistory>30</maxHistory>
</rollingPolicy>
<!-- 此日誌文檔只記錄info級別的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>info</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 2.3 level爲 WARN 日誌,時間滾動輸出 -->
<appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 追加方式記錄日誌 -->
<append>true</append>
<!-- 正在記錄的日誌文檔的路徑及文檔名 -->
<file>${log.path}/web_warn.log</file>
<!--日誌文檔輸出格式-->
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset> <!-- 此處設置字符集 -->
</encoder>
<!-- 日誌記錄器的滾動策略,按日期,按大小記錄 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log.path}/web-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日誌文檔保留天數-->
<maxHistory>30</maxHistory>
</rollingPolicy>
<!-- 此日誌文檔只記錄warn級別的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>warn</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 2.4 level爲 ERROR 日誌,時間滾動輸出 -->
<appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 追加方式記錄日誌 -->
<append>true</append>
<!-- 正在記錄的日誌文檔的路徑及文檔名 -->
<file>${log.path}/web_error.log</file>
<!--日誌文檔輸出格式-->
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset> <!-- 此處設置字符集 -->
</encoder>
<!-- 日誌記錄器的滾動策略,按日期,按大小記錄 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log.path}/web-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日誌文檔保留天數-->
<maxHistory>30</maxHistory>
</rollingPolicy>
<!-- 此日誌文檔只記錄ERROR級別的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!--
<logger>用來設置某一個包或者具體的某一個類的日誌打印級別、以及指定<appender>。
<logger>僅有一個name屬性,一個可選的level和一個可選的addtivity屬性。
name:用來指定受此logger約束的某一個包或者具體的某一個類。
level:用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
還有一個特俗值INHERITED或者同義詞NULL,代表強制執行上級的級別。
如果未設置此屬性,那麼當前logger將會繼承上級的級別。
addtivity:是否向上級logger傳遞打印信息。默認是true。
<logger name="org.springframework.web" level="info"/>
<logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>
-->
<!--
使用mybatis的時候,sql語句是debug下才會打印,而這裏我們只配置了info,所以想要查看sql語句的話,有以下兩種操作:
第一種把<root level="info">改成<root level="DEBUG">這樣就會打印sql,不過這樣日誌那邊會出現很多其他消息
第二種就是單獨給dao下目錄配置debug模式,代碼如下,這樣配置sql語句會打印,其他還是正常info級別:
【logging.level.org.mybatis=debug logging.level.dao=debug】
-->
<!--
root節點是必選節點,用來指定最基礎的日誌輸出級別,只有一個level屬性
level:用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
不能設置爲INHERITED或者同義詞NULL。默認是DEBUG
可以包含零個或多個元素,標識這個appender將會添加到這個logger。
-->
<!-- 4. 最終的策略 -->
<!-- 4.1 開發環境:打印控制檯-->
<springProfile name="dev">
<logger name="com.spring.demo.springbootexample" level="warn"/><!--console控制檯日誌級別-->
<root level="info"><!--日誌保存文件級別-->
<appender-ref ref="CONSOLE" />
<appender-ref ref="DEBUG_FILE" />
<appender-ref ref="INFO_FILE" />
<appender-ref ref="WARN_FILE" />
<appender-ref ref="ERROR_FILE" />
</root>
</springProfile>
<!-- 4.2 生產環境:輸出到文檔
<springProfile name="prod">
<logger name="com.spring.demo.springbootexample" level="error"/>
<root level="info">
<appender-ref ref="CONSOLE" />
<appender-ref ref="DEBUG_FILE" />
<appender-ref ref="INFO_FILE" />
<appender-ref ref="ERROR_FILE" />
<appender-ref ref="WARN_FILE" />
</root>
</springProfile> -->
<!-- 5. 將日誌寫入數據庫 -->
<appender name="DB" class="ch.qos.logback.classic.db.DBAppender">
<!--日誌異步到數據庫-->
<connectionSource class="ch.qos.logback.core.db.DriverManagerConnectionSource">
<driverClass>com.mysql.cj.jdbc.Driver</driverClass>
<url>jdbc:mysql://localhost:3306/springdemo?useSSL=false&useUnicode=true&characterEncoding=UTF8&serverTimezone=Asia/Shanghai</url>
<user>root</user>
<password>root</password>
</connectionSource>
<!--這裏設置日誌級別過濾器-->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>error</level>
<onMatch>ACCEPT</onMatch><!--匹配時的操作:接收(記錄)-->
<onMismatch>DENY</onMismatch><!--不匹配時的操作:拒絕(不記錄)-->
</filter>
</appender>
<!-- 記錄日誌掃描的包,console打印的日誌級別 -->
<logger name="com.spring.demo.springbootexample" level="info">
<appender-ref ref="DB"/>
</logger>
<!-- 基於info處理日誌:具體控制檯或者文件對日誌級別的處理還要看所在appender配置的filter,如果沒有配置filter,則使用root配置 -->
<root level="error">
<appender-ref ref="DB"/>
</root>
</configuration>
補充
- @Api(value = “SwaggerTestController”, tags = {“restful api示例”})
該註解tags如果存在中文,會導致swagger2 UI界面接口點擊無法展開問題,可以通過去掉中文解決,或者頁面點擊Expand Operations(不足:該類下所有接口同時展開或收縮)。 - Java驅動包下載地址:
https://mvnrepository.com/artifact/mysql/mysql-connector-java
下載對應版本,不對應可能會出現報錯或者數據庫連接下所有表執行逆向代碼(>8.0)。
- 說一下日誌打印和存儲數據庫的配置關係
根據上圖:
- console控制檯打印的日誌爲logger設置的,打印範圍爲name屬性的包範圍;
- 如果1配置了onMatch、onMismatch配置如圖,則打印日誌最多隻可能打印warn,如果2的配置級別高於1,則日誌數據庫不保存數據;如果1沒有配置onMatch、onMismatch配置如圖(註釋掉),則數據庫日誌和2級別一致;
- 3不論是否存在時,都不影響上面的結論,看了一下資料,root也是logger,是根logger。意義可能是在配置多個logger是,使用< appender-ref ref=“DB”/>來標記這些日誌保存的位置是DB所指向的數據庫。
- 這種配置數據庫是默認的,數據庫sql見附件。
歡迎補充和指出錯誤~
代碼鏈接
鏈接:https://pan.baidu.com/s/1K1JBsFBhfpHwFZM9IUqG7g
提取碼:yfr5