企业实战之切面编程《统一打印日志》

前言

面向切面编程是spring里一种很不错的编程思想，简单来讲就是可以将一段功能代码在程序运行时，动态地将该段代码切入到目标方法前或后插入去执行，这种方式可以实现代码的可插拔性，之前我们在拦截器实战篇中说过的拦截器其实就是切面编程的一种实现。

本篇文章我们将带你使用spring的@Aspect注解来实现controller层方法的请求参数、响应体的日志打印功能，这在企业开发中也是很有必要的哦，可以减少我们浪费在日志打印上的一些时间，也可以统一日志的打印格式，以后在使用ELK这种日志搜索服务时，你也将会得到很不错的使用体验。

思路

我们使用@Aspect标识一个切面类，使用@Around注解标识在你打印日志的方法里，主要捕捉@RestController带这个注解的类方法，也就是我们的reset controller下的方法，这样就可以在joinPoint.proceed() 程序的处理前后打印上日志信息，我们目前打印的主要信息有，请求者、请求的类.方法名字、请求的参数（参数敏感信息需要用 “******”替换）、请求者IP、调用源、App版本号、Api版本号、客户端的userAgent信息、响应的结果（敏感词过滤）、最后请求结束后所花费的时间。

好了，说了这么多接下来我们看下源码吧。

package com.zhuma.demo.aspect;

import java.lang.reflect.Method;
import java.util.List;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.springframework.web.multipart.MultipartFile;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.google.common.collect.Lists;
import com.zhuma.demo.constant.HeaderConstants;
import com.zhuma.demo.handler.GlobalExceptionHandler;
import com.zhuma.demo.helper.LoginHelper;
import com.zhuma.demo.model.po.User;
import com.zhuma.demo.util.IpUtil;

/**
 * @desc 请求参数、响应体统一日志打印
 * 
 * @author zhumaer
 * @since 10/10/2017 9:54 AM
 */
@Aspect
@Component
public class RestControllerAspect {
   

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