SpringBoot | 第二十四章：日志管理之AOP统一日志

友情提示：熟悉Spring常用注解类的朋友，对@AliasFor应该不陌生。它是Spring提供的一个注解，主要是给注解的属性起名别的。让使用注解时，更加的容易理解（比如给value属性起别名）。一般上是配对别名。由于是Spring框架提供的，所以要使其生效，可以使用AnnotationUtils.synthesizeAnnotation或者AnnotationUtils.getAnnotation方法调用获取注解，以下代码中会有个简单示例。

2.编写切面类。

//加入@Aspect 申明一个切面
@Aspect
@Component
@Slf4j
public class LogAspect {

    //设置切入点：这里直接拦截被@RestController注解的类
    @Pointcut("within(@org.springframework.web.bind.annotation.RestController *)")
    public void pointcut() {

    }

    
    @Around("pointcut()")
    public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
 long beginTime = System.currentTimeMillis();//1、开始时间 
 //利用RequestContextHolder获取requst对象
 ServletRequestAttributes requestAttr = (ServletRequestAttributes)RequestContextHolder.currentRequestAttributes();
 String uri = requestAttr.getRequest().getRequestURI();
 log.info("开始计时: {}  URI: {}", new Date(),uri);
 //访问目标方法的参数 可动态改变参数值
 Object[] args = joinPoint.getArgs();
 //方法名获取
 String methodName = joinPoint.getSignature().getName();
 log.info("请求方法：{}, 请求参数: {}", methodName, Arrays.toString(args));
 //可能在反向代理请求进来时，获取的IP存在不正确行 这里直接摘抄一段来自网上获取ip的代码
 log.info("请求ip：{}", getIpAddr(requestAttr.getRequest()));

 Signature signature = joinPoint.getSignature();
 if(!(signature instanceof MethodSignature)) {
     throw new IllegalArgumentException("暂不支持非方法注解");
 }
 //调用实际方法
 Object object = joinPoint.proceed();
 //获取执行的方法
 MethodSignature methodSign = (MethodSignature) signature;
 Method method = methodSign.getMethod();
 //判断是否包含了 无需记录日志的方法
 Log logAnno = AnnotationUtils.getAnnotation(method, Log.class);
 if(logAnno != null && logAnno.ignore()) {
     return object;
 } 
 log.info("log注解描述：{}", logAnno.desc());
 long endTime = System.currentTimeMillis();
 log.info("结束计时: {},  URI: {},耗时：{}", new Date(),uri,endTime - beginTime);
 //模拟异常
 //System.out.println(1/0);
 return object;
    }

    
    @AfterThrowing(pointcut="pointcut()",throwing="e")
    public void afterThrowable(Throwable e) {
 log.error("切面发生了异常：", e);
 //这里可以做个统一异常处理
 //自定义一个异常 包装后排除
 //throw new AopException("xxx);
    }

    
    public static String getIpAddr(HttpServletRequest request) {
 String ipAddress = null;
 try {
     ipAddress = request.getHeader("x-forwarded-for");
     if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
  ipAddress = request.getHeader("Proxy-Client-IP");
     }
     if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
  ipAddress = request.getHeader("WL-Proxy-Client-IP");
     }
     if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
  ipAddress = request.getRemoteAddr();
  if (ipAddress.equals("127.0.0.1")) {
      // 根据网卡取本机配置的IP
      InetAddress inet = null;
      try {
   inet = InetAddress.getLocalHost();
      } catch (UnknownHostException e) {
   log.error("获取ip异常：{}" ,e.getMessage());
   e.printStackTrace();
      }
      ipAddress = inet.getHostAddress();
  }
     }
     // 对于通过多个代理的情况，第一个IP为客户端真实IP,多个IP按照','分割
     if (ipAddress != null && ipAddress.length() > 15) { // "***.***.***.***".length()
 // = 15
  if (ipAddress.indexOf(",") > 0) {
      ipAddress = ipAddress.substring(0, ipAddress.indexOf(","));
  }
     }
 } catch (Exception e) {
     ipAddress = "";
 }
 // ipAddress = this.getRequest().getRemoteAddr();

 return ipAddress;
    }    
}

@SpringBootApplication
@EnableAspectJAutoProxy
@Slf4j
public class Chapter24Application {

    public static void main(String[] args) {
 SpringApplication.run(Chapter24Application.class, args);
 log.info("Chapter24启动!");
    }
}

@RestController
public class DemoController {
    
    @RequestMapping("/aop")
    @Log(value="请求了aopDemo方法")
    public String aopDemo(String hello) {
 return "请求参数为：" + hello;
    }

    
    @RequestMapping("/notaop")
    @Log(ignore=true)
    public String notAopDemo(String hello) {
 return "此方法不记录日志，请求参数为：" + hello;
    }
}

2018-08-23 22:54:59.003  INFO 12928 --- [nio-8080-exec-3] c.l.l.s.chapter24.config.LogAspect: 开始计时: Fri Aug 23 22:54:59 CST 2018  URI: /aop
2018-08-23 22:54:59.004  INFO 12928 --- [nio-8080-exec-3] c.l.l.s.chapter24.config.LogAspect: 请求方法：aopDemo, 请求参数: [oKong]
2018-08-23 22:54:59.005  INFO 12928 --- [nio-8080-exec-3] c.l.l.s.chapter24.config.LogAspect: 请求ip：192.168.2.107
2018-08-23 22:54:59.005  INFO 12928 --- [nio-8080-exec-3] c.l.l.s.chapter24.config.LogAspect: log注解描述：请求了aopDemo方法
2018-08-23 22:54:59.005  INFO 12928 --- [nio-8080-exec-3] c.l.l.s.chapter24.config.LogAspect: 结束计时: Fri Aug 23 22:54:59 CST 2018,  URI: /aop,耗时：2