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

引言

看到一篇blog,感觉写的角度非常好,因此引用过来消化一番。

原文地址:http://blog.csdn.net/appleyk/article/details/78717388

正文

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

一、日志记录相关依赖,首选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)主要看注释

<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>  

(2)application.properties中初始化logback-boot.xml

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

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.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

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)注意

(3)我们来看一下自定义异常枚举里面的消息

六、测试Controller,测试日志记录功能

(1)测试前

(2)再看一下,logback-boot.xml中,配置的日志输出路径是什么

(3)启动Spring-boot项目

(4)浏览器中测试

A. 先测试成功的: http://localhost:8080/test?role=100

1.浏览器返回数据json解析效果


2.控制台日志info级别的输出

3.文件日志info级别的写入

4.由于日志文件的大小在logback-boot.xml中配置了超过1KB就产生新的日志文件,命名规则见配置文件,因此多次刷新浏览器,我们会发现如下:【注意,得多刷几十次,才能出来效果,因为1KB的内容还是不少的】


5:注意

A.控制台日志输出级别:INFO


B.日志记录到文件级别:DEBUG


(5)Insomnia专业API测试工具测试

B. 再测试异常的: http://localhost:8080/test?role=-1

1.为了演示最佳效果,先停掉当前项目,再清空log文件夹下面的所有日志

2.启动项目

日志记录文件立竿见影【牢记日志记录文件的级别是DEBUG】


3.测试API【显然role=-1的时候,对应的Controller抛出自定义异常】

4.观察下日志

按照级别,大于DEBUG的都会出现在日志记录文件里,所以,我们的ERROR出现了

5.多Send一下,观察日志文件变化

这个是今天的日志,假设我改下系统日期操作如下

6.本篇的创作时间是2017年12月5日13:37:35【周二】,改为2017年12月6日13:37:49【周三】


然后我们在多Send几次观察下日志文件的变化


最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,530评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 86,403评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,120评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,770评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,758评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,649评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,021评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,675评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,931评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,659评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,751评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,410评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,004评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,969评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,042评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,493评论 2 343

推荐阅读更多精彩内容