您的位置：首页 > 编程语言 > Java开发

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

2017-12-05 13:52 1261 查看

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

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

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

logback当前分成三个模块：

logback-core
logback- classic
logback-access

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

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

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

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

[b]三、本篇重点，logback-boot.xml内容解说
[/b]（1）主要看注释

<configuration>
<!-- %m输出的信息,%p日志级别,%t线程名,%d日期,%c类的全名,%i索引【从数字0开始递增】,,, -->
<!-- appender是configuration的子节点，是负责写日志的组件。 -->
<!-- ConsoleAppender：把日志输出到控制台 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d %p (%file:%line\)- %m%n</pattern>
<!-- 控制台也要使用UTF-8，不要使用GBK，否则会中文乱码 -->
<charset>UTF-8</charset>
</encoder>
</appender>
<!-- RollingFileAppender：滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->
<!-- 以下的大概意思是：1.先按日期存日志，日期变了，将前一天的日志文件名重命名为XXX%日期%索引，新的日志仍然是sys.log -->
<!--             2.如果日期没有发生变化，但是当前日志的文件大小超过1KB时，对当前日志进行分割 重命名-->
<appender name="syslog"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<File>log/sys.log</File>
<!-- rollingPolicy:当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名。 -->
<!-- TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 活动文件的名字会根据fileNamePattern的值，每隔一段时间改变一次 -->
<!-- 文件名：log/sys.2017-12-05.0.log -->
<fileNamePattern>log/sys.%d.%i.log</fileNamePattern>
<!-- 每产生一个日志文件，该日志文件的保存期限为30天 -->
<maxHistory>30</maxHistory>
<timeBasedFileNamingAndTriggeringPolicy  class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<!-- maxFileSize:这是活动文件的大小，默认值是10MB,本篇设置为1KB，只是为了演示 -->
<maxFileSize>1KB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<encoder>
<!-- pattern节点，用来设置日志的输入格式 -->
<pattern>
%d %p (%file:%line\)- %m%n
</pattern>
<!-- 记录日志的编码 -->
<charset>UTF-8</charset> <!-- 此处设置字符集 -->
</encoder>
</appender>
<!-- 控制台输出日志级别 -->
<root level="info">
<appender-ref ref="STDOUT" />
</root>
<!-- 指定项目中某个包，当有日志操作行为时的日志记录级别 -->
<!-- com.appley为根包，也就是只要是发生在这个根包下面的所有日志操作行为的权限都是DEBUG -->
<!-- 级别依次为【从高到低】：FATAL > ERROR > WARN > INFO > DEBUG > TRACE  -->
<logger name="com.appleyk" level="DEBUG">
<appender-ref ref="syslog" />
</logger>
</configuration>

[b]（2）application.properties中初始化[b]logback-boot.xml
[/b][/b][b][/b][b][/b][b][/b]

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

[b]

[/b]

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

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

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

（1）GlobalExceptionHandler.java

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.dao.DuplicateKeyException;
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) {

if (ex instanceof MissingServletRequestParameterException) {
return new ResponseResult(400, ex);
}
if (ex instanceof NoPermissions) {

LOGGER.error("=======" + ex.getMessage() + "=======");
return new ResponseResult(401, "sorry，无权限！");

}

if (ex instanceof DuplicateKeyException) {
LOGGER.error("=======违反主键约束：主键重复插入=======");
return new ResponseResult(400, "主键重复插入！");
}

/**
* 未知异常
*/
LOGGER.error(ex.toString());
return new ResponseResult(500, ex.getMessage());

}

}

（2）注意

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

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

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

五、创建测试Controller

(1)LogTestController.java

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);
}

}

}

（2）注意