springboot aop + logback + 统一异常处理打印日志

1.src/resources路径下新建logback.xml

控制台彩色日志打印
info日志和异常日志分不同文件存储
每天自动生成日志
结合myibatis方便日志打印（debug模式）

<?xml version="1.0" encoding="UTF-8"?>

<configuration debug="false">

    <!--定义日志文件的存储地址 可以在LogBack 的配置中使用相对路径-->

    <property name="LOG_HOME" value="logs" />

    <!-- 彩色日志 -->

    <!-- 彩色日志依赖的渲染类 -->

    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />

    <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />

    <conversionRule conversionWord="wEx"

                    converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />

    <!-- 彩色日志格式 -->

    <property name="CONSOLE_LOG_PATTERN"

              value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}" />

    <!-- Console 输出设置 -->

    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">

        <encoder>

            <pattern>${CONSOLE_LOG_PATTERN}</pattern>

            <charset>utf8</charset>

        </encoder>

    </appender>

    <!-- 按照每天生成日志文件 -->

    <appender name="FILE"  class="ch.qos.logback.core.rolling.RollingFileAppender">

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

            <!--日志文件输出的文件名-->

            <FileNamePattern>${LOG_HOME}/category-server-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{50} - %msg%n</pattern>

        </encoder>

        <!--日志文件最大的大小

        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">

            <MaxFileSize>10MB</MaxFileSize>

        </triggeringPolicy>-->

        <filter class="ch.qos.logback.classic.filter.LevelFilter">

            <level>WARN</level>

            <onMatch>DENY</onMatch>

            <onMismatch>NEUTRAL</onMismatch>

        </filter>

        <filter class="ch.qos.logback.classic.filter.LevelFilter">

            <level>ERROR</level>

            <onMatch>DENY</onMatch>

            <onMismatch>NEUTRAL</onMismatch>

        </filter>

    </appender>

    <!-- 出错日志 appender  -->

    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

            <!-- 按天回滚 daily -->

            <!-- log.dir 在maven profile里配置 -->

            <FileNamePattern>${LOG_HOME}/category-server-error-log.%d{yyyy-MM-dd}.log</FileNamePattern>

            <!-- 日志最大的历史 60天 -->

            <maxHistory>60</maxHistory>

        </rollingPolicy>

        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">

            <level>WARN</level>

        </filter>

        <encoder>

            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</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"/>

    <!-- 日志输出级别 -->

    <root level="INFO">

        <appender-ref ref="CONSOLE" />

        <appender-ref ref="FILE" />

        <appender-ref ref="ERROR_FILE" />

    </root>

</configuration>

2.定义一个log实体方便维护和后续的扩展

package com.wdcloud.categoryserver.log;

import com.wdcloud.categoryserver.common.entity.User;

/**

 * @describe: 日志打印实体

 * @author: zhuchunwang

 * @date: 2018/5/29 17:40

 * @version: 1.0

 */

public class LogEntity {

    private long id;

    /**

     * 请求地址

     */

    private String url;

    /**

     * 请求IP

     */

    private String ip;

    /**

     * 请求方式

     */

    private String httpMethod;

    /**

     * 请求类，方法

     */

    private String classMethod;

    /**

     * 方法参数

     */

    private String args;

    /**

     * 请求参数

     */

    private String reqParams;

    /**

     * 响应参数

     */

    private String respParams;

    /**

     * 响应时间

     */

    private long spendTime;

    /**

     * 日志类型（web、service）

     */

    private String logType;

    /**

     * 用户信息

     */

    private User user;

    public long getId() {

        return id;

    }

    public void setId(long id) {

        this.id = id;

    }

    public String getUrl() {

        return url;

    }

    public void setUrl(String url) {

        this.url = url;

    }

    public String getIp() {

        return ip;

    }

    public void setIp(String ip) {

        this.ip = ip;

    }

    public String getHttpMethod() {

        return httpMethod;

    }

    public void setHttpMethod(String httpMethod) {

        this.httpMethod = httpMethod;

    }

    public String getClassMethod() {

        return classMethod;

    }

    public void setClassMethod(String classMethod) {

        this.classMethod = classMethod;

    }

    public String getArgs() {

        return args;

    }

    public void setArgs(String args) {

        this.args = args;

    }

    public String getReqParams() {

        return reqParams;

    }

    public void setReqParams(String reqParams) {

        this.reqParams = reqParams;

    }

    public String getRespParams() {

        return respParams;

    }

    public void setRespParams(String respParams) {

        this.respParams = respParams;

    }

    public long getSpendTime() {

        return spendTime;

    }

    public void setSpendTime(long spendTime) {

        this.spendTime = spendTime;

    }

    public String getLogType() {

        return logType;

    }

    public void setLogType(String logType) {

        this.logType = logType;

    }

    public User getUser() {

        return user;

    }

    public void setUser(User user) {

        this.user = user;

    }

}

3.定义一个controller 的切面

package com.wdcloud.categoryserver.log;

import com.fasterxml.jackson.core.JsonProcessingException;

import com.fasterxml.jackson.databind.ObjectMapper;

import com.wdcloud.categoryserver.common.constant.AppConstants;

import com.wdcloud.categoryserver.utils.AppUtil;

import com.wdcloud.categoryserver.utils.JsonUtil;

import org.aspectj.lang.JoinPoint;

import org.aspectj.lang.annotation.*;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.core.annotation.Order;

import org.springframework.stereotype.Component;

import org.springframework.web.context.request.RequestContextHolder;

import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;

/**

 * @describe: 实现controller的日志切面

 * @author: zhuchunwang

 * @date: 2018/5/29 17:40

 * @version: 1.0

 */

@Aspect

@Component

@Order(1)

public class ControllerLogAspect {

    private Logger logger = LoggerFactory.getLogger(this.getClass());

    ThreadLocal<Long> startTime = new ThreadLocal<>();

    ThreadLocal<LogEntity> webLogThreadLocal = new ThreadLocal<>();

    /**

     * 定义一个切入点.

     * 解释下：

     * <p>

     * ~ 第一个 * 代表任意修饰符及任意返回值.

     * ~ 第二个 * 任意包名

     * ~ 第三个 * 代表任意方法.

     * ~ 第四个 * 定义在web包或者子包

     * ~ 第五个 * 任意方法

     * ~ .. 匹配任意数量的参数.

     */

    @Pointcut("execution(* com.wdcloud.categoryserver.business.*.controller.*.*(..))")

    public void serviceAspect() {

    }

    @Before("serviceAspect()")

    public void doBefore(JoinPoint joinPoint) {

        // 接收到请求，记录请求内容

        startTime.set(System.currentTimeMillis());

        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();

        HttpServletRequest request = attributes.getRequest();

        webLogThreadLocal.set(new LogEntity());

        webLogThreadLocal.get().setHttpMethod(request.getMethod());

        webLogThreadLocal.get().setClassMethod(joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());

        webLogThreadLocal.get().setUrl(request.getRequestURL().toString());

        webLogThreadLocal.get().setIp(request.getRemoteAddr());

        webLogThreadLocal.get().setArgs(AppUtil.getArgs(joinPoint));

        webLogThreadLocal.get().setLogType(AppConstants.LOG_TYPE_HTTP);

        webLogThreadLocal.get().setReqParams(JsonUtil.objectToJson(request.getParameterMap()));

        webLogThreadLocal.get().setUser(AppUtil.getUser(request));

    }

    /**

     * 异常通知 用于拦截service层记录异常日志

     *

     * @param

     * @param

     */

    @AfterReturning(returning = "result", pointcut = "serviceAspect()")

    public void doAfterReturning(Object result) {

        // 处理完请求，返回内容

        ObjectMapper mapper = new ObjectMapper();

        try {

            webLogThreadLocal.get().setRespParams(mapper.writeValueAsString(result));

        } catch (JsonProcessingException e) {

            logger.error(AppUtil.getExceptionDetail(e));

        }

        webLogThreadLocal.get().setSpendTime(System.currentTimeMillis() - startTime.get());

        try {

            logger.info(">>>"+mapper.writeValueAsString(webLogThreadLocal.get()));

        } catch (JsonProcessingException e) {

	        logger.error(AppUtil.getExceptionDetail(e));

        }

    }

}

4.定义一个供dubbo调用的service切面

package com.wdcloud.categoryserver.log;

import com.fasterxml.jackson.core.JsonProcessingException;

import com.fasterxml.jackson.databind.ObjectMapper;

import com.wdcloud.categoryserver.common.constant.AppConstants;

import com.wdcloud.categoryserver.utils.AppUtil;

import com.wdcloud.categoryserver.utils.JsonUtil;

import org.aspectj.lang.JoinPoint;

import org.aspectj.lang.annotation.AfterReturning;

import org.aspectj.lang.annotation.Aspect;

import org.aspectj.lang.annotation.Before;

import org.aspectj.lang.annotation.Pointcut;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.core.annotation.Order;

import org.springframework.stereotype.Component;

import org.springframework.web.context.request.RequestContextHolder;

import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;

/**

 * @describe: 实现controller的日志切面

 * @author: zhuchunwang

 * @date: 2018/5/29 17:40

 * @version: 1.0

 */

@Aspect

@Component

@Order(1)

public class ServiceLogAspect {

    private Logger logger = LoggerFactory.getLogger(this.getClass());

    ThreadLocal<Long> startTime = new ThreadLocal<>();

    ThreadLocal<LogEntity> webLogThreadLocal = new ThreadLocal<>();

    /**

     * 定义一个切入点.

     * 解释下：

     * <p>

     * ~ 第一个 * 代表任意修饰符及任意返回值.

     * ~ 第二个 * 任意包名

     * ~ 第三个 * 代表任意方法.

     * ~ 第四个 * 定义在web包或者子包

     * ~ 第五个 * 任意方法

     * ~ .. 匹配任意数量的参数.

     */

    @Pointcut("execution(* com.wdcloud.categoryserver.front.*.service.*.*(..))")

    public void serviceAspect() {

    }

    @Before("serviceAspect()")

    public void doBefore(JoinPoint joinPoint) {

        // 接收到请求，记录请求内容

        startTime.set(System.currentTimeMillis());

        webLogThreadLocal.set(new LogEntity());

        webLogThreadLocal.get().setClassMethod(joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());

        webLogThreadLocal.get().setArgs(AppUtil.getArgs(joinPoint));

        webLogThreadLocal.get().setLogType(AppConstants.LOG_TYPE_DUBBO);

    }

    /**

     * 异常通知 用于拦截service层记录异常日志

     *

     * @param

     * @param

     */

    @AfterReturning(returning = "result", pointcut = "serviceAspect()")

    public void doAfterReturning(Object result) {

        // 处理完请求，返回内容

        ObjectMapper mapper = new ObjectMapper();

        try {

            webLogThreadLocal.get().setRespParams(mapper.writeValueAsString(result));

        } catch (JsonProcessingException e) {

            logger.error(AppUtil.getExceptionDetail(e));

        }

        webLogThreadLocal.get().setSpendTime(System.currentTimeMillis() - startTime.get());

        try {

            logger.info(">>>"+mapper.writeValueAsString(webLogThreadLocal.get()));

        } catch (JsonProcessingException e) {

            logger.error(AppUtil.getExceptionDetail(e));

        }

    }

}

5.统一异常处理

package com.wdcloud.categoryserver.common.exception;

import com.wdcloud.categoryserver.common.constant.AppConstants;

import com.wdcloud.categoryserver.common.constant.CodeConstants;

import com.wdcloud.categoryserver.common.entity.BaseView;

import com.wdcloud.categoryserver.log.LogEntity;

import com.wdcloud.categoryserver.utils.AppUtil;

import com.wdcloud.categoryserver.utils.JsonUtil;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.http.converter.HttpMessageNotReadableException;

import org.springframework.web.HttpMediaTypeNotSupportedException;

import org.springframework.web.bind.MissingServletRequestParameterException;

import org.springframework.web.bind.annotation.ControllerAdvice;

import org.springframework.web.bind.annotation.ExceptionHandler;

import org.springframework.web.bind.annotation.ResponseBody;

import org.springframework.web.bind.annotation.RestController;

import org.springframework.web.multipart.MultipartException;

import org.springframework.web.multipart.support.MissingServletRequestPartException;

import javax.servlet.http.HttpServletRequest;

/**

 * @describe: 全局异常处理

 * @author: zhuchunwang

 * @date: 2018/5/29 17:40

 * @version: 1.0

 */

@ControllerAdvice(annotations = {RestController.class})

public class GlobalExceptionHandler {

	private Logger logger = LoggerFactory.getLogger(this.getClass());

	/**

	 * 默认未知异常

	 * @param request

	 * @param e

	 * @return

	 * @throws Exception

	 */

	@ExceptionHandler(value = Exception.class)

	@ResponseBody

	public BaseView defaultErrorHandler(HttpServletRequest request, Exception e) throws Exception {

		BaseView baseView = new BaseView(CodeConstants.SYSTEM_EXCEPTION,CodeConstants.SYSTEM_EXCEPTION_MSG);

		printLog(request,e,baseView);

		return baseView;

	}

	/**

	 * 参数异常

	 * @param request

	 * @param e

	 * @return

	 * @throws Exception

	 */

	@ExceptionHandler(value = {HttpMessageNotReadableException.class, MissingServletRequestPartException.class ,MissingServletRequestParameterException.class, MultipartException.class})

	@ResponseBody

	public BaseView httpMessageNotReadableExceptionErrorHandler(HttpServletRequest request, Exception e) throws Exception {

		BaseView baseView = new BaseView(CodeConstants.PARAMETER_ERROR,CodeConstants.PARAMETER_ERROR_MSG);

		printLog(request,e,baseView);

		return baseView;

	}

	/**

	 * contentType异常

	 * @param request

	 * @param e

	 * @return

	 * @throws Exception

	 */

	@ExceptionHandler(value = {HttpMediaTypeNotSupportedException.class})

	@ResponseBody

	public BaseView httpMediaTypeNotSupportedExceptionHandler(HttpServletRequest request, Exception e) throws Exception {

		BaseView baseView =  new BaseView(CodeConstants.CONTENTTYPE_ERROR,CodeConstants.CONTENTTYPE_ERROR_MSG);

		printLog(request,e,baseView);

		return baseView;

	}

	/**

	 * 异常信息打印日志

	 * @param request

	 * @param e

	 * @param baseView

	 */

	private void printLog(HttpServletRequest request,Exception e,BaseView baseView){

		logger.error(AppUtil.getExceptionDetail(e));

		LogEntity logEntity = new LogEntity();

		logEntity.setHttpMethod(request.getMethod());

		logEntity.setUrl(request.getRequestURL().toString());

		logEntity.setIp(request.getRemoteAddr());

		logEntity.setArgs(AppUtil.getRequestBody(request));

		logEntity.setLogType(AppConstants.LOG_TYPE_HTTP);

		logEntity.setReqParams(JsonUtil.objectToJson(request.getParameterMap()));

		logEntity.setRespParams(JsonUtil.objectToJson(baseView));

		logger.error(">>>"+JsonUtil.objectToJson(logEntity));

	}

}

springboot aop + logback + 统一异常处理打印日志的更多相关文章

SpringBoot系列——自定义统一异常处理
前言 springboot内置的/error错误页面并不一定适用我们的项目,这时候就需要进行自定义统一异常处理,本文记录springboot进行自定义统一异常处理. 1.使用@ControllerAd ...
关于spring 事务和 AOP 管理事务和打印日志问题
关于spring 事务和 AOP 管理事务和打印日志问题 1. 就是支持事务注解的(@Transactional) . 可以在server层总使用@Transactional,进行方法内的事务管 ...
springboot 整合logback(有全套的日志配置文件)
logback介绍:基于Log4j基础上大量改良,不能单独使用,推荐配合日志框架SLF4J来使用,可以和springboot很好的整合,也是springboot默认推荐的. 1.在resources ...
springboot整合logback集成elk实现日志的汇总、分析、统计和检索功能
在Spring Boot当中,默认使用logback进行log操作.logback支持将日志数据通过提供IP地址.端口号,以Socket的方式远程发送.在Spring Boot中,通常使用logbac ...
SpringBoot(七)_统一异常处理
我感觉看了这节课,给我的思考还是很多的,感觉受益良多.废话不多说,一起学习. 统一的外层结构返回这样利于代码看着也规范,前端处理也统一 # 错误返回 { "code": 1, ...
SpringBoot | 第二十四章：日志管理之AOP统一日志
前言上一章节,介绍了目前开发中常见的log4j2及logback日志框架的整合知识.在很多时候,我们在开发一个系统时,不管出于何种考虑,比如是审计要求,或者防抵赖,还是保留操作痕迹的角度,一般都会有 ...
Spring Boot 2.0 教程 | AOP 切面统一打印请求日志
欢迎关注微信公众号: 小哈学Java 文章首发于个人网站 https://www.exception.site/springboot/spring-boot-aop-web-request 本节中,您 ...
SpringBoot整合Logback日志框架配置全解析
目录本篇要点一.Logback日志框架介绍二.SpringBoot与Logback 1.默认日志格式 2.控制台输出 3.文件输出 4.日志级别 5.日志组 6.自定义log配置三.logba ...
SpringBoot统一异常处理后TX-LCN分布式事务无法捕获异常进行回滚
通常我们使用SpringBoot都会进行统一异常处理,例如写一个BaseController,在BaseController里进行统一异常处理,然后其他的Controller都继承BaseContro ...

随机推荐

在Ubuntu上搭建kindle gtk开发环境
某个角度上说,kindle很类似android,同样的Linux内核,同样的Java用户层.不过kindle更注重简单.节能.稳定.Amazon一向认为,功能过多会分散人们阅读时候的注意力. Kind ...
Chapter 5 Blood Type——12
I blinked, my mind going blank. Holy crow, how did he do that? 我眨着眼睛,心里一片空白.天哪,他是怎么做到的? "Er, wh ...
MHA非root用户搭建测试
最近一直在瞎搬砖,最大的感触是运维工作难做.不过废话不多说,最近被分配了一项比较有意思的task,尝试着非root用户搭建MHA并测试下能否成功漂移,以下是两天测试和文档编写的成果,分享给各位看客,欢 ...
web前端安全
之前对web前端安全进行了总结,想给大家分享一下,有不对的地方,大家多多交流,由于写在了PPT上,只好给大家一张一张粘上来,希望大家不要在意,了解知识为主
采用config方式灵活配置我们的Quarz.net中的Job,Trigger
经常在项目中遇到定时任务的时候,通常第一个想到的是Timer定时器,但是这玩意功能太弱鸡,实际上通常采用的是专业化的第三方调度框架,比如说 Quartz,它具有功能强大和应用的灵活性,我想使用过的人都 ...
Runloop详解
RunLoop是iOS和OSX开发中非常基础的一个概念,这篇文章将从源码以及应用入手,介绍RunLoop的概念以及底层实现原理.本人看了一下RunLoop的英语源码,以及借鉴部分优秀博客,感谢!读完这 ...
第30章部署 - Identity Server 4 中文文档(v1.0.0)
您的身份服务器只是一个标准的ASP.NET Core应用程序,包括IdentityServer中间件.首先阅读有关发布和部署的官方Microsoft 文档(尤其是有关负载平衡器和代理的部分). 30. ...
MEF 基础简介四
前言前面讲解了MEF的引用方法,接口的导入导出,类属性的导入导出和集合的导出用法其实大家可以看到基本上大同小异的. MEF的延迟加载我们知道当装配一个组件的时候,当前组件里面的所有的Import的 ...
Win10系统简单开启热点
介绍笔记本电脑使用的都是无线网卡,我们可以通过这网卡来开启热点供手机使用,说起开热点,大家都是想到的使用360随身wifi或者是猎豹wifi来开启热点吧,我个人不太喜欢使用这些软件,原因因为有DNS ...
java-初识引用分类及Map实现类WeakHashMap
1.同样的,话不多讲直接上代码 (1)认识了解下引用分类及其作用 package com.otherMapProduce; import java.lang.ref.WeakReference; /* ...

springboot aop + logback + 统一异常处理 打印日志

1.src/resources路径下新建logback.xml

2.定义一个log实体 方便维护和后续的扩展

3.定义一个controller 的切面

4.定义一个供dubbo调用的service切面

5.统一异常处理

springboot aop + logback + 统一异常处理 打印日志的更多相关文章

随机推荐

热门专题

springboot aop + logback + 统一异常处理打印日志

2.定义一个log实体方便维护和后续的扩展

springboot aop + logback + 统一异常处理打印日志的更多相关文章