spring boot slf4j日记记录配置详解

Posted 2020-12-04 maohuidong

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了spring boot slf4j日记记录配置详解相关的知识，希望对你有一定的参考价值。

转

spring boot slf4j日记记录配置详解

2017年12月26日 12:03:34

阅读数：1219

Spring-Boot--日志操作【全局异常捕获消息处理?日志控制台输出+日志文件记录】

最好的演示说明，不是上来就贴配置文件和代码，而是，先来一波配置文件的注释，再来一波代码的测试过程，最后再出个技术在项目中的应用效果，这样的循序渐进的方式，才会让读者更加清楚的理解一项技术是如何运用在项目中的，虽然本篇很简单，几乎不用手写什么代码，但是，比起网上其他人写的同类型的文章来说，我只能说，我很认真，认真的有点帅，哈哈哈哈。

一、日志记录相关依赖，首选Spring-Boot"原生态"的logback

Logback是由 log4j创始人设计的又一个开源日志组件

logback当前分成三个模块：

logback-core

logback- classic

logback-access

logback-core是其它两个模块的基础模块

如果在你的pom.xml中，依赖了如下内容

技术分享图片

恭喜你，本篇你可以不用再添加日志组件的依赖了，为什么呢，我们看下spring-boot-starter-web的依赖树

技术分享图片

二、当前Spring-Boot项目的目录结构

说明：如果只是为了贴代码，而不结合项目演示的话，我写本篇的初衷也就没什么意义了

三、本篇重点，logback-boot.xml内容解说

（1）主要看注释

[html] view plain copy

<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d %p (%file:%line)- %m%n</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<appender name="syslog"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<File>log/sys.log</File>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>log/sys.%d.%i.log</fileNamePattern>
<maxHistory>30</maxHistory>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>1KB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<encoder>
<pattern>
%d %p (%file:%line)- %m%n
</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<root level="info">
<appender-ref ref="STDOUT" />
</root>
<logger name="com.appleyk" level="DEBUG">
<appender-ref ref="syslog" />
</logger>
</configuration>

（2）application.properties中初始化logback-boot.xml

[plain] view plain copy

#在application.properties文件中引入日志配置文件
#===================================== log =============================
logging.config=classpath:logback-boot.xml

logback日志的配置我们已经弄完了，接下来就是演示了

四、定义全局异常捕获类【含异常消息的日志辅助记录】

主要看内容，内容看懂了，就知道logback日志记录在什么时候发挥作用了

（1）GlobalExceptionHandler.java

[java] view plain copy

package com.appleyk.exception;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import com.appleyk.result.ResponseResult;
@CrossOrigin
@RestControllerAdvice
public class GlobalExceptionHandler {
private static Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandler.class);
@ExceptionHandler
public ResponseResult processException(Exception ex, HttpServletRequest request, HttpServletResponse response){
ex.printStackTrace();
if(ex instanceof MissingServletRequestParameterException){
return new ResponseResult(400, ex);
}
if(ex instanceof NoPermissions){
LOGGER.error("======="+ex.getMessage()+"=======");
return new ResponseResult(401, "sorry，无权限！");
}
return new ResponseResult(500, ex.getMessage());
}
}

（2）注意

技术分享图片

（3）我们看下这个自定义异常类NoPermissions长什么样

技术分享图片

（4）NoPermissions这个异常我们在哪里抛出呢？

本篇，日志功能的测试是放在Controller中进行的，因此，这个自定义异常，也是放在Controller中抛出By手动

五、创建测试Controller

(1)LogTestController.java

[java] view plain copy

package com.appleyk.controller;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import com.appleyk.exception.NoPermissions;
import com.appleyk.result.ExceptionEnum;
import com.appleyk.result.ResponseMessage;
import com.appleyk.result.ResponseResult;
@RestController
public class LogTestController {
protected static Logger logger=LoggerFactory.getLogger(HelloController.class);
@RequestMapping("/test")
public ResponseResult Test(@RequestParam(value="role") Integer role) throws Exception{
logger.info("访问Controller");
int i = role;
if(i<0){
throw new NoPermissions(ExceptionEnum.WRONG_PERMISSONS.toString());
}
else{
return new ResponseResult(ResponseMessage.OK);
}
}
}