SpringBoot 之基本配置知识总结(由于网页解析存在问题,无法上传笔记)

一、日志

1、日志框架

市面上的日志框架:JUL、JCL、Jbooss-loggin、logback、log4j、log4j2、slf4j….

日志门面(日志的抽象层)日志实现
JCL(jakarta Commons Loggin) SLF4j(Simple Loggin Facade For Java) jboss logginLog4j JUL(java.util.logging) Log4j2 Logback

左边选一个门面(抽象层)、右边来选一个实现;

  • 日志门面: SLF4J;
  • 日志实现:Logback

SpringBoot: 底层是 Spring 框架,Spring 框架默认是用JCL;

==SpringBoot 选用 SLF4j 和 Logback;==

2、使用 SLF4j 使用

① 如何在系统中使用 SLF4j https://www.slf4j.org

​ 以后开发时候,日志记录方法调用,不应该来直接调用日志实现类,而是调用日志抽象层里面的方法;

​ 给系统里面导入 slf4j 的 jar 和 logback 的实现 jar

1
2
3
4
5
6
7
8
9
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class HelloWorld {
public static void main(String[] args) {
Logger logger = LoggerFactory.getLogger(HelloWorld.class);
logger.info("Hello World");
}
}

图示:

image-20200827114336528

每一个日志的实现框架都有自己的配置文件。使用 slf4j 以后,配置文件还是做成日志实现框架自己本身的配置文件;

② 遗留问题

a(slf4j + logback): Spring(commons-loggin)、Hibernate(Jboss-logging)、Mybatis…..

统一日志记录,即使是别的框架和我一起使用 slf4j 进行输出:

image-20200827115306076

==让系统中所有的日志都统一到 slf4j:==

  1. 将系统中的其他日志框架先排除出去;
  2. 用中间包啦替换原有的日志框架
  3. 导入 slf4j 其他的实现

3、SpringBoot 日志关系

1
2
3
4
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter</artifactId>
</dependency>

SpringBoot 使用它来做日志功能

1
2
3
4
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</dependency>

底层依赖关系

image-20200827121844114

总结

1. SpringBoot底层也是使用slf4j+ logback的方式进行日志记录;
  1. SpringBoot 也是其他的日志都替换成 slf4j;
  2. 中间替换包
1
2
3
4
5
6
@SuppressWarnings("rawtypes")
public abstract class LogFactory {

static String UNSUPPORTED_OPERATION_IN_JCL_OVER_SLF4J = "http://www.slf4j.org/codes.html#unsupported_operation_in_jcl_over_slf4j";

static LogFactory logFactory = new SLF4JLogFactory();

image-20200827122734567

  1. 如果我们引入其他框架,一定要把这个框架的默认日志依赖移除掉

    Spring 框架用的是 commons-logging;

1
2
3
4
5
6
7
8
9
10
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring‐core</artifactId>
<exclusions>
<exclusion>
<groupId>commons‐logging</groupId>
<artifactId>commons‐logging</artifactId>
</exclusion>
</exclusions>
</dependency>

==SpringBoot 能自动依赖所有的日志,而且底层使用 slf4j + logback 的方式记录日志,引入其他框架的时候,只需要把这个框架依赖的日志框架排除掉即可;==

4、日志的使用

① SpringBoot 默认帮我们配置好了日志

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// 记录器
Logger logger = LoggerFactory.getLogger(getClass());

@Test
void contextLoads() {

// 日志级别
// 由低到高 trace<debug<info<warn<error
// 可以调整输出日志的级别;日志的只会在这个级别
logger.trace("这是trace日志.....");
logger.debug("这是debug日志.....");
// springBoot默认给我们使用的是info基本的,没有用指定级别就用SpringBoot莫人规定的级别是; root级别
logger.info("这是info日志.......");
logger.warn("这里warn日志.......");
logger.error("这里error日志.....");

}
1
2
3
4
5
6
7
8
9
日志输出格式:
%d表示日期时间,
%thread表示线程名,
%‐5level:级别从左显示5个字符宽度
%logger{50} 表示logger名字最长50个字符,否则按照句点分割。
%msg:日志消息,
%n是换行符
‐‐>
%d{yyyy‐MM‐dd HH:mm:ss.SSS} [%thread] %‐5level %logger{50} ‐ %msg%n

SpringBoot 修改日志的默认配置

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
logging.level.com.oy=trace

#loggin.path=
# 不指定;路径在当前项目下生成spring.log日志
# 可以指定完整的路径
#loggin.file=E:/springboot.log

#在当前磁盘的根路径上创建spring文件夹里面log文件;使用 spring.log作为默文件

logging.path=/springboot.log

# 在控制台输出的日志的格式
logging.pattern.console=%d{yyyy‐MM‐dd} [%thread] %‐5level %logger{50} ‐ %msg%n
# 指定文件日志输出的格式
logging.pattern.file=%d{yyyy‐MM‐dd} === [%thread] === %‐5level === %logger{50} ==== %msg%n
logging.filelogging.pathExampleDescription
(none)(none)只在控制台输出
指定文件名(none)my.log输出日志到 my.log 文件
(none)指定目录/var/log输出到指定目录的 spring.log 文件中

② 指定配置

​ 给类路径下放上每个日志框架自己的配置文件即可;SpringBoot 就不使用其他默认的配置了。

Logging SystemCustomization
Logbacklogback-spring.xml , logback-spring.groovy , logback.xml or logback.groovy
Log4j2log4j2-spring.xml or log4j2.xml
JDK (Java Util Logging)logging.properties

​ lohback.xml: 直接就被日志框架识别了;

logback-spring.xml: 日志框架就不直接加载日志的配置项,由 SpringBoot 解析日志配置,可以使用 SpringBoot 的高级 Profile 功能

1
2
3
4
<springProfile name="staging">
<!‐‐ configuration to be enabled when the "staging" profile is active ‐‐>
可以指定某段配置只在某个环境下生效
</springProfile>

如:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<!‐‐
日志输出格式:
%d表示日期时间,
%thread表示线程名,
%‐5level:级别从左显示5个字符宽度
%logger{50} 表示logger名字最长50个字符,否则按照句点分割。
%msg:日志消息,
%n是换行符
‐‐>
<layout class="ch.qos.logback.classic.PatternLayout">
<springProfile name="dev">
<pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ‐‐‐‐> [%thread] ‐‐‐> %‐5level
%logger{50} ‐ %msg%n</pattern>
</springProfile>
<springProfile name="!dev">
<pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ==== [%thread] ==== %‐5level
%logger{50} ‐ %msg%n</pattern>
</springProfile>
</layout>
</appender>

==如果使用 logback.xml 作为日志配置文件,还要使用 profile 功能,会有以下错误==

image-20200827174350351

5、切换日志框架

可以按照 slf4j 的日志适配图,进行相关的切换;

slf4j+log4j 的方式

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐web</artifactId>
<exclusions>
<exclusion>
<artifactId>logback‐classic</artifactId>
<groupId>ch.qos.logback</groupId>
</exclusion>
<exclusion>
<artifactId>log4j‐over‐slf4j</artifactId>
<groupId>org.slf4j</groupId>
</exclusion>
</exclusions>
</dependency>

<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j‐log4j12</artifactId>
</dependency>

切换为 log4j2

1
2
3
4
5
6
7
8
9
10
11
12
13
14
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐web</artifactId>
<exclusions>
<exclusion>
<artifactId>spring‐boot‐starter‐logging</artifactId>
<groupId>org.springframework.boot</groupId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐log4j2</artifactId>
</dependency>