Springmvc中切面打印请求响应日志，捕获异常

leizhou

Springmvc中切面打印请求响应日志，捕获异常

------------------------------------------------------
目的：
        通常不允许直接将异常堆栈信息显示在前端，而必须经过转义为通用性异常描述，以示友好，且避免安全漏洞问题。
        利用Springmvc中切面，打印请求响应日志，捕获异常并转义为通用性异常描述。

------------------------------------------------------
1）常见做法
注：只能拦截controller请求，无法拦截soap请求。注：仅捕获异常并转义为通用性异常描述。

1. @ControllerAdvice
   
2. public class GlobalControllerAdvice {
   
3. 
   
4.         private LoggerDecorate LOGGER = LoggerDecorateFactory.getLogger(this.getClass());
   
5. 
   
6.     /**
   
7.      * 异常控制
   
8.      *
   
9.      */
   
10.     @ExceptionHandler(Exception.class)
    
11.     public ModelAndView defaultErrorHandler(HttpServletResponse resp, Exception e) throws Exception {
    
12.         LOGGER.error("执行异常:", e);
    
13.         String logId = MDC.get("logId");// 这里建议应该输出logId，以便到日志文件中定义异常
    
14.         if (HttpUtil.isAjaxRequest()) {
    
15.             Map<String, Object> model = new HashMap<>();
    
16.             model.put("logId", logId);
    
17.             model.put("msg", e instanceof MyException ? e.getMessage() : "系统异常");
    
18.             return new ModelAndView(new MappingJackson2JsonView(), model);
    
19.         }
    
20.         ModelAndView mav = new ModelAndView();
    
21.         mav.addObject("logId", logId);
    
22.         mav.addObject("msg", e instanceof MyException ? e.getMessage() : "系统异常");
    
23.         //mav.addObject("err", e);// 若输出异常堆栈信息，则页面显示不友好，且可能暴露安全漏洞
    
24.         mav.setViewName("error");// 自定义error页面，显示logId和msg
    
25.         return mav;
    
26.     }

复制代码

1.     /**
   
2.      * 判断是否ajax请求
   
3.      */
   
4.     public static boolean isAjaxRequest() throws Exception {
   
5.         return "XMLHttpRequest".equals(getRequest().getHeader("X-Requested-With"));
   
6.     }

复制代码

------------------------------------------------------
1）统一做法

注：利用自定义切面，拦截controller请求，和拦截webservice请求。
注：接口返回类型只支持JavaBean对象、Integer和String，不能为void.若是某些特殊类型，如Map，也需修改下面的代码进行非常简单的特殊处理。
注：使用springmvc自带的校验参数的注解@Valid，不支持webservice接口。建议自定义注解进行参数校验，见下面代码中的validBaseReq(arguments);

1. /**
   
2. * <pre>
   
3. * 描述：切面记录请求日志，拦截各种接口。
   
4. * </pre>
   
5. * @author 01116253
   
6. * @since 1.0
   
7. */
   
8. @Aspect
   
9. @Component
   
10. public class LogAspect {
    
11.     private static LoggerDecorate logger = LoggerDecorateFactory.getLogger(LogAspect.class);
    
12.     private static final String REQ = "REQ";
    
13.     private static final String RSP = "RSP";
    
14. 
    
15.     @Pointcut("execution(* com.wisedu.api.message.controller..*Controller.*(..))"
    
16.             + "|| execution(* com.wisedu.api.app.controller..*Controller.*(..))"
    
17.             + "|| execution(* com.wisedu.api.transfer.controller..*Controller.*(..))")
    
18.     public void api() {
    
19.     }
    
20. 
    
21.     @Around("api()")
    
22.     public Object invoke(ProceedingJoinPoint pjp) throws Throwable {
    
23.         long begin = System.currentTimeMillis();
    
24. 
    
25.         Class<?> clazz = pjp.getSignature().getDeclaringType();
    
26.         String className = clazz.getName();
    
27.         String methodName = pjp.getSignature().getName();
    
28.         Object[] arguments = pjp.getArgs();
    
29. 
    
30.         try {
    
31.             // 打印请求日志
    
32.             logger.info(LogUtil.getMsg(REQ, className, methodName, arguments));
    
33.         } catch (MyException e) {
    
34.             logger.error("切面打印请求失败", e);
    
35.         } catch (Exception e) {
    
36.             logger.error("切面打印请求失败", e);
    
37.         }
    
38.         try {
    
39.             validBaseReq(arguments);
    
40.             // GlobalExceptionHandler统一异常处理类，无法拦截soap的顶层异常，因此在这里处理
    
41.             Object rsp = pjp.proceed();
    
42.             logger.info(className + " | " + methodName + " cost time:{}", (System.currentTimeMillis() - begin));
    
43.             return rsp;
    
44.         } catch (MyException e) {
    
45.             return getErrorResult(e.getStatus(), e.getMsg(), begin, clazz, className, methodName, arguments, e);
    
46.         } catch (Exception e) {
    
47.             return getErrorResult(ResultCode.OTHER_ERROR, "内部异常", begin, clazz, className, methodName, arguments, e);
    
48.         }
    
49. 
    
50.     }
    
51. 
    
52.     // 当接口调用失败后，返回一个异常对象
    
53.     private Object getErrorResult(int code, String msg, long begin, Class<?> clazz, String className, String methodName,
    
54.             Object[] arguments, Throwable t) {
    
55.         Object obj = null;
    
56.         Method[] allMethods = clazz.getDeclaredMethods();
    
57.         Method method = null;
    
58.         for (Method tmpMethod : allMethods) {
    
59.             if (methodName.equals(tmpMethod.getName())) {
    
60.                 method = tmpMethod;
    
61.                 break;
    
62.             }
    
63.         }
    
64.         if (null == method) {
    
65.             logger.info("the method [{}] has no return type", new Object[] { methodName });
    
66.             obj = new BaseResult();
    
67.         } else {
    
68.             Class<?> rt = method.getReturnType();
    
69.             if (null == rt) {
    
70.                 logger.info("the method [{}] has no return type", new Object[] { methodName });
    
71.                 obj = new BaseResult();
    
72.             } else {
    
73.                 String rtName = StringUtils.trimToEmpty(rt.getName());
    
74.                 if (rtName.endsWith("Integer")) {
    
75.                     obj = Integer.valueOf(0);
    
76.                 } else if (rtName.endsWith("String")) {
    
77.                     obj = "error";
    
78.                 } else {// TODO 返回类型的特殊处理
    
79.                     try {
    
80.                         obj = rt.newInstance();
    
81.                     } catch (Exception e) {
    
82.                         logger.error("the method [{}] return type newInstance err", new Object[] { methodName, e });
    
83.                         obj = new BaseResult();
    
84.                     }
    
85.                 }
    
86.             }
    
87.         }
    
88.         if (((obj instanceof Integer)) || ((obj instanceof String))) {
    
89.             long space = System.currentTimeMillis() - begin;
    
90.             logger.error(LogUtil.getMsg(new Object[] { RSP, className, methodName, obj, Long.valueOf(space) }),
    
91.                     new Object[] { t });
    
92.             return obj;
    
93.         }
    
94.         BaseResult rsp = (BaseResult) obj;
    
95.         rsp.setCode(code);
    
96.         rsp.setMsg(msg);
    
97. 
    
98.         long space = System.currentTimeMillis() - begin;
    
99.         logger.error(LogUtil.getMsg(new Object[] { RSP, className, methodName, rsp, Long.valueOf(space) }),
    
100.                 new Object[] { t });
     
101.         return rsp;
     
102.     }
     
103. 
     
104.     public void validBaseReq(Object... params) throws IllegalArgumentException, IllegalAccessException {
     
105.         if (ArrayUtils.isEmpty(params)) {
     
106.             return;
     
107.         }
     
108.         for (Object object : params) {
     
109.             if (null == object) {
     
110.                 throw new MyException(ResultCode.PARAM_ERROR, "Bean参数不能为null");
     
111.             }
     
112.             if (object.getClass().isArray()) {
     
113.                 Object[] objectArr = (Object[]) object;
     
114.                 if (ArrayUtils.isNotEmpty(objectArr)) {
     
115.                     for (Object item : objectArr) {
     
116.                         validBaseReq(new Object[] { item });
     
117.                     }
     
118.                 }
     
119.             } else if ((object instanceof IBaseReq)) {
     
120.                 ((IBaseReq) object).verify();
     
121.                 BaseBeanValid.validField(object);
     
122.             }
     
123.         }
     
124.     }
     
125.    
     
126. }

复制代码