SpringBoot 日志框架

日志框架
日志框架就是为了更好的记录日志使用的，记录日志是为了我们在工作中可以更好的查找相对应的问题，也算是以中留痕操作！
以前我们刚开始学习的时候都是用System.out.println()去在控制台记录，怎么说呢？这种方式伴随着我们很长时间，之后我们就遇到了断点调试的方式，逐渐不在使用System.out.println()进行调试，但是你别忘记，那是一种记录不管是否有用，你都应该去记录！
市面上的日志框架；JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j….

日志门面（日志的抽象层）
日志实现

JCL（Jakarta Commons Logging） SLF4j（Simple Logging Facade for Java） jboss-logging

Log4j JUL（java.util.logging） Log4j2 Logback

SpringBoot：底层是Spring框架，Spring框架默认是用JCL；‘ <==SpringBoot选用 SLF4j和logback；==>

1.SLF4j使用
1.1 如何在系统中使用SLF4j
SLF4J的官方网站手册
以后开发的时候，日志记录方法的调用，不应该来直接调用日志的实现类，而是调用日志抽象层里面的方法；
给系统里面导入slf4j的jar和 logback的实现jar
使用方式如下：
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”);
}
}

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

1.2 历史遗留问题
我们接触过的框架使用的日志框架都有所不同，因此，统一日志记录，即使是别的框架和我一起统一使用slf4j进行输出？

1.3 slf4j统一“天下”

将系统中其他日志框架先排除出去；
用中间包来替换原有的日志框架；
我们导入slf4j其他的实现；

2. Spring Boot 日志配置
SpringBoot使用它来做日志功能:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</dependency>

SpringBoot底层也是使用slf4j+logback的方式进行日志记录
SpringBoot也把其他的日志都替换成了slf4j

中间替换包？
@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();

如果我们要引入其他框架？一定要把这个框架的默认日志依赖移除掉
示例：Spring框架用的是commons-logging；
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<exclusions>
<exclusion>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
pringBoot能自动适配所有的日志，而且底层使用slf4j+logback的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉即可；

3. 日志的使用
Spring Boot 默认给我们已经配置好了日志，测试如下：
//记录器
Logger logger = LoggerFactory.getLogger(getClass());
@Test
public void contextLoads() {
//System.out.println();

//日志的级别；
//由低到高 trace<debug<info<warn<error
//可以调整输出的日志级别；日志就只会在这个级别以以后的高级别生效
logger.trace(“这是trace日志…”);
logger.debug(“这是debug日志…”);
//SpringBoot默认给我们使用的是info级别的，没有指定级别的就用SpringBoot默认规定的级别；root级别
logger.info(“这是info日志…”);
logger.warn(“这是warn日志…”);
logger.error(“这是error日志…”);
}
3.1 日志格式说明
日志输出格式：
%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修改日志的默认配置
logging.level.com.hanpang=trace
# com.hanpang是说明的包名

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

# 在当前磁盘的根路径下创建spring文件夹和里面的log文件夹；使用 spring.log 作为默认文件
logging.path=/spring/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.file
logging.path
Example
Description

(none)
(none)

只在控制台输出

指定文件名
(none)
my.log
输出日志到my.log文件

(none)
指定目录
/var/log
输出到指定目录的 spring.log 文件中

3.2 指定配置
给类路径下放上每个日志框架自己的配置文件即可，SpringBoot就不使用他默认配置的了

Logging System
Customization

Logback

logback-spring.xml, logback-spring.groovy, logback.xml or logback.groovy

Log4j2

log4j2-spring.xml or log4j2.xml

JDK (Java Util Logging)
logging.properties

logback.xml：直接就被日志框架识别了；一般情况不推荐

（推荐）logback-spring.xml：日志框架就不直接加载日志的配置项，由SpringBoot解析日志配置，可以使用SpringBoot的高级Profile功能
<springProfile name=”staging”>
<!– configuration to be enabled when the “staging” profile is active –>
可以指定某段配置只在某个环境下生效
</springProfile>
示例代码
<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功能，会有以下错误:
no applicable action for [springProfile]

4. 切换日志框架
可以按照slf4j的日志适配图，进行相关的切换；
slf4j+log4j的方式，pom.xml配置如下:
<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，pom.xml配置如下：
log4j2配置的参考文章
log4j2的配置说明
<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>
5.“坑”

logging.path和logging.file不可以同时配置,同时配置也只有logging.file起效
配置logging.path将会在指定文件夹下面生成spring.log文件,文件名字无法控制
配置logging.file,如果只是文件名如:demo.log只会在项目的根目录下生成指定文件名的日志文件,,如果想控制日志路径,可以选择完整路径，如:E:\demo\demo.log

接下来看看自定义配置文件,这个就要方便很多了,还是喜欢自定义配置文件的方式
在src/main/resources下面新建文件logback.xml这个也是spring boot默认的配置文件名,
如果需要自定义文件名,如:logback-test.xml需要在application.properties添加配置
================但是，我们习惯使用logback-spring.xml==========================
logging.config=classpath:logback-test.xml
spring boot默认载入的相关配置文件,详见jar包;spring-boot-1.*.*.RELEASE.jar下面
org/springframework/boot/logging/logback/
详细文件:

base.xml      //基础包,引用了下面所有的配置文件
console-appender.xml    //控制台输出配置
defaults.xml            //默认的日志文件配置
file-appender.xml       //文件输出配置

附录
logback-spring.xml 配置说明
<?xml version=”1.0″ encoding=”UTF-8″?>
<configuration>

<!–定义日志文件的存储地址勿在 LogBack的配置中使用相对路径 –>
<property name=”LOG_HOME” value=”/tmp/log” />

<!– 控制台输出 –>
<appender name=”STDOUT” class=”ch.qos.logback.core.ConsoleAppender”>
<encoder class=”ch.qos.logback.classic.encoder.PatternLayoutEncoder”>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{30} – %msg%n</pattern>
</encoder>
</appender>

<!– 按照每天生成日志文件 –>
<appender name=”FILE”
class=”ch.qos.logback.core.rolling.RollingFileAppender”>
<rollingPolicy class=”ch.qos.logback.core.rolling.TimeBasedRollingPolicy”>
<FileNamePattern>${LOG_HOME}/logs/smsismp.log.%d{yyyy-MM-dd}.log</FileNamePattern>
<!–日志文件保留天数 –>
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder class=”ch.qos.logback.classic.encoder.PatternLayoutEncoder”>
<!–格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符 –>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{30} – %msg%n</pattern>
</encoder>
<!–日志文件最大的大小 –>
<triggeringPolicy class=”ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy”>
<MaxFileSize>10MB</MaxFileSize>
</triggeringPolicy>
</appender>

<!– 日志输出级别 –>
<root level=”INFO”>
<appender-ref ref=”STDOUT” />
<appender-ref ref=”FILE” />
</root>

<!– 定义各个包的详细路径，继承root宝的值 –>
<logger name=”com.hry.spring.log” level=”INFO” />
<logger name=”com.hry.spring” level=”TRACE” />

<!– 此值由 application.properties的spring.profiles.active=dev指定–>
<springProfile name=”dev”>
<!–定义日志文件的存储地址勿在 LogBack 的配置中使用相对路径 –>
<property name=”LOG_HOME” value=”/tmp/log” />
<logger name=”org.springboot.sample” level=”DEBUG” />
</springProfile>

</configuration>

部分说明
appender name=”STDOUT”: 日志打印到控制台

appender name=”FILE”：日志按日打印到文件中，最多保留MaxHistory天，每个文件大水为MaxFileSize

encoder：定义输出格式

<root level=”INFO”>：定义根logger，通过appender-ref指定前方定义的appender

<logger name=”com.hry.spring.log” level=”INFO” />：在继承root的logger上对com.hry.spring.log包日志作特殊处理

<springProfile name=”dev”>：定义profile的值，只有特定profile的情况下，此间定义的内容才启作用
application.properties 启动dev配置信息
server.port=8080
spring.profiles.active=dev
spring.profiles.active指定本次启动的active的值是什么。本次是dev，则logback-spring.xml里<springProfile name=”dev”>的内容启作用
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class LogApplication {
private static final Logger log = LoggerFactory.getLogger(LogApplication.class);
public static void main(String[] args) {
String str1 = “string1”;
String str2 = “string2”;
log.info(“Begin Start {}…{}”, str1, str2);
SpringApplication.run(LogApplication.class, args);
log.info(“Stop …”);
}
}
logback-spring.xml 其他的写法

<?xml version=”1.0″ encoding=”UTF-8″?>
<configuration>
<include resource=”org/springframework/boot/logging/logback/base.xml” />
<logger name=”org.springframework.web” level=”INFO”/>
<logger name=”org.springboot.sample” level=”TRACE” />

<!– 测试环境+开发环境. 多个使用逗号隔开. –>
<springProfile name=”test,dev”>
<logger name=”org.springframework.web” level=”DEBUG”/>
<logger name=”org.springboot.sample” level=”DEBUG” />
<logger name=”com.example” level=”DEBUG” />
</springProfile>

<!– 生产环境. –>
<springProfile name=”prod”>
<logger name=”org.springframework.web” level=”ERROR”/>
<logger name=”org.springboot.sample” level=”ERROR” />
<logger name=”com.example” level=”ERROR” />
</springProfile>
</configuration>
这里说明一下：1) 引入的base.xml是Spring Boot的日志系统预先定义了一些系统变量的基础配置文件
2) 在application.properties中设置环境为prod，则只会打印error级别日志
3) 如果在application.properties中定义了相同的配置，则application.properties的日志优先级更高
可以在内部进行引用
<?xml version=”1.0″ encoding=”utf-8″?>
<configuration scan=”true” scanPeriod=”10 seconds”>

<!– 文件输出格式 –>
<property name=”pattern” value=”%d{yyyy-MM-dd HH:mm:ss.SSS} -%5p ${PID:-} [%15.15t] %-40.40logger{39} : %m%n” />
<property name=”charsetEncoding” value=”UTF-8″ />
<!–<PatternLayout pattern=”%d{HH:mm:ss.SSS} %-5level %class{36} %L %M – %msg%xEx%n”/>–>

<!–控制台日志–>
<appender name=”console” class=”ch.qos.logback.core.ConsoleAppender”>
<encoder>
<pattern>${pattern}</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>

<appender name=”file” class=”ch.qos.logback.core.FileAppender”>
<file>./logback/logfile.log</file>
<append>true</append>
<encoder>
<pattern>${pattern}</pattern>
<charset>${charsetEncoding}</charset>
</encoder>
</appender>

<appender name=”dailyRollingFileAppender” class=”ch.qos.logback.core.rolling.RollingFileAppender”>
<File>./logback/log.log</File>
<rollingPolicy class=”ch.qos.logback.core.rolling.TimeBasedRollingPolicy”>
<!– daily rollover –>
<FileNamePattern>logback.%d{yyyy-MM-dd_HH}.log</FileNamePattern>
<!– keep 30 days’ worth of history –>
<maxHistory>7</maxHistory>
</rollingPolicy>
<encoder>
<Pattern>${pattern}</Pattern>
</encoder>
</appender>

<!–myibatis log configure–>
<logger name=”com.apache.ibatis” level=”TRACE”/>
<logger name=”java.sql.Connection” level=”DEBUG”/>
<logger name=”java.sql.Statement” level=”DEBUG”/>
<logger name=”java.sql.PreparedStatement” level=”DEBUG”/>

SpringBoot 日志框架

评论

发表回复取消回复

更多文章

苹果iOS打包的ipa应用无法安装？一篇文章带你了解可能的原因及排查方法

图解Golang：从零开始实现简易版过期LRU缓存

深入解析：基于Delta的线性数据结构模型，打造高效富文本编辑器

轻松管理社交媒体：使用Automa插件实现一键拉黑功能

SpringBoot 日志框架

评论

发表回复 取消回复

更多文章

苹果iOS打包的ipa应用无法安装？一篇文章带你了解可能的原因及排查方法

图解Golang：从零开始实现简易版过期LRU缓存

深入解析：基于Delta的线性数据结构模型，打造高效富文本编辑器

轻松管理社交媒体：使用Automa插件实现一键拉黑功能

发表回复取消回复