在SpringBoot中已经集成了log的starter,在pom里可以看到:
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-logging</artifactId><version>2.4.5</version></dependency>
默认是logback。
我们可以把默认的jar包排除掉:
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-logging</artifactId><exclusions><exclusion><groupId>*</groupId><artifactId>*</artifactId></exclusion></exclusions></dependency>
启动会发现报错找不到默认的log实现
现在我们手动引入log4j2来集成到SpringBoot中:
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-log4j2</artifactId></dependency>
再去看jar包依赖关系,可以看到log4j2的依赖包就是如下几个:
接下来我们新建xml配置文件来自定义日志打印。
提示1:关于这个配置文件的名称以及在项目中的存放位置
log4j 2.x版本不再支持像1.x中的.properties后缀的文件配置方式,2.x版本配置文件后缀名只能为".xml",".json"或者".jsn"。
项目中配置文件的优先级(从先到后)如下:
classpath下的名为log4j2-test.json 或者log4j2-test.jsn的文件.
classpath下的名为log4j2-test.xml的文件.
classpath下名为log4j2.json 或者log4j2.jsn的文件.
classpath下名为log4j2.xml的文件.
提示2:java项目中Classpath路径
WEB-INF/classes:存放src目录java文件编译之后的class文件,xml、properties等资源配置文件
WEB-INF/lib: 依赖的jar包
lib和classes同属classpath,两者的访问优先级为: lib>classes。
在SpringBoot中,我们直接新建log4j2.xml文件放到src/main/resources下即可。
新建log4j2.xml:
<?xmlversion="1.0"encoding="UTF-8"?><Configurationstatus="info"><Properties><Propertyname="log_root"value="D:\logs"/><Propertyname="today"value="${date:yyyy-MM-dd}"/><Propertyname="app_name"value="studyBoot"/><propertyname="log_level">INFO</property><propertyname="log_interval">3600</property><propertyname="log_size">50MB</property><propertyname="log_del_time">7d</property><Propertyname="log_pattern">[%d{MM:ddHH:mm:ss.SSS}] [%level] [%logger{36}] -%msg%n</Property><propertyname="log_pattern2">%d{yyyy-MM-ddHH:mm:ss.SSS},%X{SOFA-TraceId},%X{SOFA-SpanId},%t,%r,%-5p,%logger{50} -%m%n%throwable</property></Properties><Appenders><Consolename="console_out"target="SYSTEM_OUT"><!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)--><ThresholdFilterlevel="info"onMatch="ACCEPT"onMismatch="DENY"/><PatternLayoutpattern="${log_pattern}"/></Console><Consolename="console_err"target="SYSTEM_ERR"><ThresholdFilterlevel="error"onMatch="ACCEPT"onMismatch="DENY"/><PatternLayoutpattern="${log_pattern}"/></Console><!--debug(包含)到error(不含)级别日志文件输出,1天或者满200M覆盖一次--><RollingFilename="debug_appender"fileName="${log_root}/${app_name}/${today}/debug.log"filePattern="${log_root}/${app_name}/${today}/debug_%i.log.%d{yyyy-MM-dd}"><!--过滤器--><Filters><!--限制日志级别在debug及以上在error以下注释掉了顶点限制,打印debug及以上所有--><ThresholdFilterlevel="debug"/><!--<ThresholdFilterlevel="error"onMatch="DENY"onMismatch="NEUTRAL"/>--></Filters><!--日志格式--><PatternLayoutpattern="${log_pattern}"/><!--策略--><Policies><!--TimeBasedTriggeringPolicy基于时间的滚动策略,interval属性用来指定多久滚动一次,默认是1hour。modulate=true用来调整时间:比如现在是早上3am,interval是4,那么第一次滚动是在4am,接着是8am,12am...而不是7am.--><TimeBasedTriggeringPolicyinterval="24"modulate="true"/><!--文件大小SizeBasedTriggeringPolicy基于指定文件大小的滚动策略,size属性用来定义每个日志文件的大小.--><SizeBasedTriggeringPolicysize="200 MB"/></Policies></RollingFile><!--error(包含)级别以上日志文件输出--><RollingFilename="error_appender"fileName="${log_root}/${app_name}/${today}/error.log"filePattern="${log_root}/${app_name}/${today}/error_%i.log.%d{yyyy-MM-dd}"><!--过滤器--><Filters><!--限制日志级别在error及以上--><ThresholdFilterlevel="error"/></Filters><!--日志格式--><PatternLayoutpattern="${log_pattern}"/><Policies><!--每隔一天转存--><TimeBasedTriggeringPolicyinterval="24"modulate="true"/><!--文件大小--><SizeBasedTriggeringPolicysize="200 MB"/></Policies></RollingFile><!--业务日常节点日志--><RollingRandomAccessFilename="all_appender"fileName="${log_root}/${app_name}/all/all.log"filePattern="${log_root}/${app_name}/all/all.log.%d{yyyy-MM-dd_HH-mm-ss}.%i"append="true"><PatternLayoutpattern="${log_pattern2}"charset="UTF-8"/><Policies><TimeBasedTriggeringPolicyinterval="${log_interval}"/><SizeBasedTriggeringPolicysize="${log_size}"/></Policies><DefaultRolloverStrategy><DeletebasePath="${log_root}/${app_name}/all"maxDepth="1"><IfFileNameglob="*.log"/><IfLastModifiedage="${log_del_time}"/></Delete></DefaultRolloverStrategy></RollingRandomAccessFile><!--业务error节点日志--><RollingRandomAccessFilename="all_error_appender"fileName="${log_root}/${app_name}/all/all_error.log"filePattern="${log_root}/${app_name}/all/all_error.log.%d{yyyy-MM-dd_HH-mm-ss}.%i"append="true"><PatternLayoutpattern="${log_pattern2}"charset="UTF-8"/><ThresholdFilterlevel="error"/><Policies><TimeBasedTriggeringPolicyinterval="${log_interval}"/><SizeBasedTriggeringPolicysize="${log_size}"/></Policies><DefaultRolloverStrategy><DeletebasePath="${log_root}/${app_name}/all"maxDepth="1"><IfFileNameglob="*.log"/><IfLastModifiedage="${log_del_time}"/></Delete></DefaultRolloverStrategy></RollingRandomAccessFile><!--打印节点定义:交互外部系统日志--><RollingRandomAccessFilename="external_apperder"fileName="${log_root}/${app_name}/all/external.log"filePattern="${log_root}/${app_name}/all/external.log.%d{yyyy-MM-dd_HH-mm-ss}.%i"append="true"><PatternLayoutpattern="${log_pattern2}"charset="UTF-8"/><Policies><TimeBasedTriggeringPolicyinterval="${log_interval}"/><SizeBasedTriggeringPolicysize="${log_size}"/></Policies><DefaultRolloverStrategy><DeletebasePath="${log_root}/${app_name}/all"maxDepth="1"><IfFileNameglob="${app_name}-integration.log.*"/><IfLastModifiedage="${log_del_time}"/></Delete></DefaultRolloverStrategy></RollingRandomAccessFile></Appenders><Loggers><Rootlevel="info"><AppenderRefref="console_out"/><AppenderRefref="console_err"/><AppenderRefref="debug_appender"/><AppenderRefref="error_appender"/><AppenderRefref="all_appender"/><AppenderRefref="all_error_appender"/><AppenderRefref="external_apperder"/></Root><!--只输出错误的日志--><Loggername="log_error"additivity="false"level="error"><AppenderRefref="console_out"/><AppenderRefref="error_appender"/><AppenderRefref="all_error_appender"/></Logger><!--只输出交互外部的日志--><Loggername="log_error"additivity="false"level="info"><AppenderRefref="external_apperder"/></Logger><!--异步输出到文件--><AsyncLoggername="com.xing"includeLocation="false"additivity="false"level="debug"><AppenderRefref="all_appender"/><AppenderRefref="all_error_appender"/></AsyncLogger></Loggers></Configuration>
使用了异步AsyncLogger,发现报错如下:
这是因为我们前面只引入了log4j2的包,引入异步包:
<dependency><groupId>com.lmax</groupId><artifactId>disruptor</artifactId><version>3.4.2</version></dependency>
完美解决!
在代码中使用的时候,我们一般不通过像log4j2、logback等等这些实现来打印,而是统一使用一个日志门面:SLF4J,它是一个简单日志门面(Simple Logging Facade for Java),不是具体的日志解决方案,它只是服务于各种各样的日志系统。
如果使用具体的实现,代码的侵入性太强了,成千上万个日志输出点修改起来不太靠谱,但是使用了slf4j,就可以方便我们在不动代码的前提下随意切换我们的日志框架。在部署的时候,选择不同的日志系统包,就可自动转换到不同的日志系统上。
在代码中使用,默认使用注解即可:
importlombok.extern.slf4j.Slf4j; publicclassxxx{ publicvoidxxxx(){ log.info("hello {}", "you"); } }
也可以获取不同的logger实例来将日志输出到不同的文件:
privatefinalstaticLoggerlog=LoggerFactory.getLogger("com.xing"); privatefinalstaticLoggerlogErr=LoggerFactory.getLogger("log_error");
总结:
在SpringBoot中已经集成了lovback和log4j2,直接使用就可以!
END