【Java】SpringBoot使用AOP进行日志解析打印+系统异常全局处理配置

╰半夏微凉° 2023-09-30 23:31 123阅读 0赞

文章目录

  • 前言
  • 一、导入Lombok
  • 二、创建日志打印Model
  • 三、创建日志切面工具类
  • 四、需要用到的一些常量类
  • 五、创建接口请求切面
  • 六、系统异常全局配置
  • 总结

前言

为了方便项目部署在服务器之后，当出现BUG以及某些特殊需求时，会因为无法看到日志或者出现异常无法快速及时处理的情况的时候，那么AOP日志拦截打印的作用就体现出来了。同时加上作者日志生成到服务器的工具，将会更加方便处理问题；

提示：以下是本篇文章正文内容，下面案例可供参考

一、导入Lombok

代码如下

  1. <!--Lombok-->
  2.             <dependency>
  3.                 <groupId>org.projectlombok</groupId>
  4.                 <artifactId>lombok</artifactId>
  5.                 <version>1.18.24</version>
  6.             </dependency>

二、创建日志打印Model

代码如下：

  1. import lombok.Data;
  3. /**
  4.  * @author 孤巷.
  5.  * @description 日志打印model
  6.  * @date 2021/3/13 11:44
  7.  */
  8. @Data
  9. public class SystemRequestLogModel {
  11.   private String ip;
  12.   private String url;
  13.   private String httpMethod;
  14.   private String classMethod;
  15.   private Object requestParams;
  16.   private Object result;
  17.   private Long timeCost;
  18. }

三、创建日志切面工具类

代码如下：

  1. import com.alibaba.fastjson.JSONObject;
  2. import lombok.extern.slf4j.Slf4j;
  3. import org.apache.commons.lang3.StringUtils;
  4. import org.aspectj.lang.JoinPoint;
  5. import org.aspectj.lang.reflect.MethodSignature;
  6. import org.springframework.beans.factory.annotation.Autowired;
  7. import org.springframework.stereotype.Component;
  8. import org.springframework.web.context.request.RequestAttributes;
  9. import org.springframework.web.context.request.RequestContextHolder;
  10. import org.springframework.web.multipart.MultipartFile;
  12. import javax.servlet.http.HttpServletRequest;
  13. import javax.servlet.http.HttpServletResponse;
  14. import java.util.HashMap;
  15. import java.util.Iterator;
  16. import java.util.Map;
  18. /**
  19.  * @author 孤巷.
  20.  * @description 方法级日志切面
  21.  * @date 2021/3/22 11:36
  22.  */
  23. @Slf4j
  24. @Component
  25. public class RequestUtil {
  28.     @Autowired(required = false)
  29.     protected HttpServletRequest request; // 自动注入request
  31.     /**
  32.      * reqContext对象中的key: 转换好的json对象
  33.      */
  34.     private static final String REQ_CONTEXT_KEY_PARAMJSON = "REQ_CONTEXT_KEY_PARAMJSON";
  36.     /**
  37.      * 获取客户端ip地址 *
  38.      */
  39.     public String getClientIp() {
  41.         String ipAddress = null;
  42.         ipAddress = request.getHeader("x-forwarded-for");
  43.         if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
  45.             ipAddress = request.getHeader("Proxy-Client-IP");
  46.         }
  47.         if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
  49.             ipAddress = request.getHeader("WL-Proxy-Client-IP");
  50.         }
  51.         if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
  53.             ipAddress = request.getRemoteAddr();
  54.         }
  56.         // 对于通过多个代理的情况，第一个IP为客户端真实IP,多个IP按照','分割
  57.         if (ipAddress != null && ipAddress.length() > 15) {
  59.             if (ipAddress.indexOf(",") > 0) {
  61.                 ipAddress = ipAddress.substring(0, ipAddress.indexOf(","));
  62.             }
  63.         }
  64.         if ("0:0:0:0:0:0:0:1".equals(ipAddress)) {
  66.             ipAddress = "127.0.0.1";
  67.         }
  68.         return ipAddress;
  69.     }
  71.     public String getRequestParams(JoinPoint proceedingJoinPoint) {
  73.         // 参数名
  74.         String[] paramNames =
  75.                 ((MethodSignature) proceedingJoinPoint.getSignature()).getParameterNames();
  76.         // 参数值
  77.         Object[] paramValues = proceedingJoinPoint.getArgs();
  78.         return buildRequestParam(paramNames, paramValues);
  79.     }
  81.     private String buildRequestParam(String[] paramNames, Object[] paramValues) {
  83.         Map<String, Object> requestParams = new HashMap<>();
  84.         for (int i = 0; i < paramNames.length; i++) {
  86.             Object value = paramValues[i];
  87.             if (value instanceof HttpServletRequest || value instanceof HttpServletResponse) {
  89.                 continue;
  90.             }
  91.             // 如果是文件对象
  92.             if (value instanceof MultipartFile) {
  94.                 MultipartFile file = (MultipartFile) value;
  95.                 value = file.getOriginalFilename(); // 获取文件名
  96.             }
  97.             requestParams.put(paramNames[i], value);
  98.         }
  100.         JSONObject json = new JSONObject(requestParams);
  101.         return json.toJSONString();
  102.     }
  103. }

四、需要用到的一些常量类

代码如下：

  1. /**
  2.  * @author 孤巷.
  3.  * @description 常量
  4.  * @date 2021/3/13 11:44
  5.  */
  6. public class Constant {
  8.     public static final String NULL_POINTER_EXCEPTION = "空指针异常";
  9.     public static final String PARSE_EXCEPTION = "格式解析异常";
  10.     public static final String ARRAY_INDEX_OUT_OF_BOUNDS_EXCEPTION = "超出索引异常";
  11.     public static final String SQL_EXCEPTION = "SQL异常";
  12.     public static final String INTERNAL_SERVER_ERROR = "内部服务器异常";
  13.     public static final String NETWORK_BUSY = "网络繁忙，请稍后重试";
  14.     public static final String SQL_EXCEPTION_MESSAGE = "数据库执行异常：";
  15.     public static final String DATE_FORMAT_ERROR = "时间格式异常";
  16.     public static final String DATABASE_CONNECT_OUT_TIME = "数据库连接超时";
  17. }

五、创建接口请求切面

重点来了哈！代码如下：

  1. import cn.hutool.core.io.IORuntimeException;
  2. import cn.hutool.crypto.CryptoException;
  3. import cn.hutool.http.HttpException;
  4. import com.alibaba.fastjson.JSONException;
  5. import com.alibaba.fastjson.JSONObject;
  6. import com.whxx.common.constant.Constant;
  7. import com.whxx.common.exception.IllegalTokenException;
  8. import com.whxx.common.exception.NetworkBusyException;
  9. import com.whxx.common.exception.PayException;
  10. import com.whxx.common.exception.SysConfigException;
  11. import com.whxx.common.model.SystemRequestLogModel;
  12. import com.whxx.common.util.RequestUtil;
  13. import com.whxx.common.util.ResultUtil;
  14. import lombok.extern.slf4j.Slf4j;
  15. import org.aspectj.lang.ProceedingJoinPoint;
  16. import org.aspectj.lang.annotation.Around;
  17. import org.aspectj.lang.annotation.Aspect;
  18. import org.aspectj.lang.annotation.Pointcut;
  19. import org.springframework.dao.DuplicateKeyException;
  20. import org.springframework.jdbc.BadSqlGrammarException;
  21. import org.springframework.jdbc.CannotGetJdbcConnectionException;
  22. import org.springframework.stereotype.Component;
  23. import org.springframework.web.context.request.RequestContextHolder;
  24. import org.springframework.web.context.request.ServletRequestAttributes;
  26. import javax.annotation.Resource;
  27. import javax.servlet.http.HttpServletRequest;
  28. import java.io.UnsupportedEncodingException;
  29. import java.net.URLDecoder;
  30. import java.sql.SQLException;
  31. import java.text.ParseException;
  32. import java.time.format.DateTimeParseException;
  34. /**
  35.  * @author 孤巷.
  36.  * @description 接口请求切面
  37.  * @date 2020/11/17 9:44
  38.  */
  39. @Aspect
  40. @Component
  41. @Slf4j
  42. public class ControllerRequestAspect {
  45.     @Resource
  46.     private RequestUtil requestUtil;
  48.     /**
  49.      * 扫描所有Controller
  50.      */
  51.     @Pointcut("execution(public * com.whxx.exchange.controller.*.*(..))")
  52.     public void request() {
  54.     }
  56.     @Around("request()")
  57.     public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
  59.         long start = System.currentTimeMillis();
  60.         ServletRequestAttributes attributes =
  61.                 (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
  62.         if (attributes == null) {
  64.             throw new Exception("ServletRequestAttributes is null");
  65.         }
  66.         HttpServletRequest request = attributes.getRequest();
  67.         SystemRequestLogModel systemRequestLogModel = new SystemRequestLogModel();
  68.         systemRequestLogModel.setIp(request.getRemoteAddr());
  69.         systemRequestLogModel.setUrl(request.getRequestURL().toString());
  70.         systemRequestLogModel.setHttpMethod(request.getMethod());
  71.         if ("get".equalsIgnoreCase(request.getMethod())) {
  73.             // 处理GET请求中文参数乱码
  74.             String decodeParams = "";
  75.             if (request.getQueryString() != null) {
  77.                 try {
  79.                     decodeParams = URLDecoder.decode(request.getQueryString(), "utf-8"); // 将中文转码
  80.                 } catch (UnsupportedEncodingException e) {
  82.                     e.printStackTrace();
  83.                 }
  84.             }
  85.             systemRequestLogModel.setRequestParams(decodeParams);
  86.         } else {
  88.             systemRequestLogModel.setRequestParams(
  89.                     requestUtil.getRequestParams(proceedingJoinPoint));
  90.         }
  91.         systemRequestLogModel.setClassMethod(
  92.                 String.format(
  93.                         "%s.%s",
  94.                         proceedingJoinPoint.getSignature().getDeclaringTypeName(),
  95.                         proceedingJoinPoint.getSignature().getName()));
  96.         Object result;
  97.         try {
  99.             result = proceedingJoinPoint.proceed();
  100.             systemRequestLogModel.setResult(result);
  101.             systemRequestLogModel.setTimeCost(System.currentTimeMillis() - start);
  102.             log.info("请求信息 == {}", systemRequestLogModel);
  103.         } catch (Exception e) {
  105.             result = exceptionGet(e, systemRequestLogModel);
  106.         }
  107.         return result;
  108.     }
  110.     private JSONObject exceptionGet(Exception e, SystemRequestLogModel systemRequestLogModel) {
  112.         systemRequestLogModel.setResult(e);
  113.         log.error(e.getMessage(), e);
  114.         log.error("异常信息 == {}", systemRequestLogModel);
  115.         if (e instanceof NetworkBusyException) {
  116.      // 自定义异常：对外接口调用异常，失败/或对外接口自身报错
  117.             return ResultUtil.error(Constant.NETWORK_BUSY);
  118.         } else if (e instanceof PayException) {
  119.      //自定义异常：支付异常
  120.             return ResultUtil.fail(e.getMessage());
  121.         } else if (e instanceof SysConfigException) {
  122.      //自定义异常：系统配置异常
  123.             return ResultUtil.fail(e.getMessage());
  124.         } else if (e instanceof IllegalTokenException) {
  125.     //自定义异常：非法token
  126.             return ResultUtil.fail(e.getMessage());
  127.         } else if (e instanceof NullPointerException) {
  128.      // 空指针异常
  129.             return ResultUtil.error(Constant.NULL_POINTER_EXCEPTION);
  130.         } else if (e instanceof DuplicateKeyException) {
  131.      // 唯一键冲突
  132.             return ResultUtil.error(Constant.DUPLICATE_KEY);
  133.         } else if (e instanceof ParseException) {
  134.      // 时间格式解析异常
  135.             return ResultUtil.error(Constant.PARSE_EXCEPTION);
  136.         } else if (e instanceof ArrayIndexOutOfBoundsException) {
  137.      // 超出索引异常
  138.             return ResultUtil.error(Constant.ARRAY_INDEX_OUT_OF_BOUNDS_EXCEPTION);
  139.         } else if (e instanceof SQLException) {
  140.      // sql异常
  141.             return ResultUtil.error(Constant.SQL_EXCEPTION);
  142.         } else if (e instanceof DateTimeParseException) {
  143.      // 时间格式解析异常
  144.             return ResultUtil.error(Constant.DATE_FORMAT_ERROR);
  145.         } else if (e instanceof CannotGetJdbcConnectionException) {
  146.      // 数据库连接超时
  147.             return ResultUtil.error(Constant.DATABASE_CONNECT_OUT_TIME);
  148.         }  else if (e instanceof CryptoException) {
  149.      // 二维码无效
  150.             return ResultUtil.fail(Constant.CRYPTO_ERROR);
  151.         } else if (e instanceof IORuntimeException) {
  152.       //请求被拒绝，服务器未开启
  153.             return ResultUtil.fail(e.getMessage());
  154.         } else if (e instanceof HttpException) {
  155.      //hutool http请求超时
  156.             return ResultUtil.fail(e.getMessage());
  157.         } else if (e instanceof BadSqlGrammarException) {
  158.     //数据库执行异常
  159.             return ResultUtil.error(Constant.SQL_EXCEPTION_MESSAGE + ((BadSqlGrammarException) e).getSQLException().getMessage());
  160.         } else if (e instanceof JSONException) {
  161.      //JSON相关异常
  162.             return ResultUtil.fail(e.getMessage());
  163.         } else if (e instanceof RuntimeException) {
  165.             return ResultUtil.error(e.getMessage());
  166.         } else {
  167.      // 其他未知异常
  168.             return ResultUtil.error(Constant.INTERNAL_SERVER_ERROR);
  169.         }
  170.     }
  171. }

最后只需要把下方的controller路径修改为实际的项目路径即可

@Pointcut(“execution(public * com.whxx.exchange.controller..(…))”)

六、系统异常全局配置

代码如下：

  1. import com.alibaba.fastjson.JSONObject;
  2. import com.fasterxml.jackson.databind.JsonMappingException;
  3. import com.fasterxml.jackson.databind.exc.InvalidFormatException;
  4. import com.whxx.common.util.ResultUtil;
  5. import lombok.extern.slf4j.Slf4j;
  6. import org.springframework.http.converter.HttpMessageConversionException;
  7. import org.springframework.validation.BindException;
  8. import org.springframework.validation.BindingResult;
  9. import org.springframework.validation.ObjectError;
  10. import org.springframework.web.bind.MethodArgumentNotValidException;
  11. import org.springframework.web.bind.MissingServletRequestParameterException;
  12. import org.springframework.web.bind.annotation.ExceptionHandler;
  13. import org.springframework.web.bind.annotation.RestControllerAdvice;
  15. import javax.validation.UnexpectedTypeException;
  16. import java.util.List;
  17. import java.util.Objects;
  19. /**
  20.  * @author 孤巷.
  21.  * @description 异常全局处理配置
  22.  * @date 2020/11/17 9:44
  23.  */
  24. @RestControllerAdvice
  25. @Slf4j
  26. public class ExceptionControllerAdvice {
  29.     @ExceptionHandler(MethodArgumentNotValidException.class)
  30.     public JSONObject methodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) {
  32.         BindingResult result = e.getBindingResult();
  33.         List<ObjectError> errorList = result.getAllErrors();
  34.         String defaultMessage = errorList.get(0).getDefaultMessage();
  35.         log.error(String.format("参数校验异常1 == {}%s", result.getAllErrors()));
  36.         return ResultUtil.failIllegalParameter(
  37.                 "参数【"
  38.                         + Objects.requireNonNull(e.getFieldError()).getField()
  39.                         + "】校验异常："
  40.                         + defaultMessage);
  41.     }
  43.     /**
  44.      * 参数校验注解错误导致的异常
  45.      */
  46.     @ExceptionHandler(UnexpectedTypeException.class)
  47.     public JSONObject unexpectedTypeException(UnexpectedTypeException e) {
  49.         return ResultUtil.error(e.getMessage());
  50.     }
  52.     @ExceptionHandler(BindException.class)
  53.     public JSONObject bindExceptionHandler(BindException e) {
  55.         BindingResult result = e.getBindingResult();
  56.         List<ObjectError> errorList = result.getAllErrors();
  57.         String defaultMessage = errorList.get(0).getDefaultMessage();
  58.         log.error(String.format("参数校验异常2 == {}%s", result.getAllErrors()));
  59.         return ResultUtil.failIllegalParameter(
  60.                 "参数【"
  61.                         + Objects.requireNonNull(e.getFieldError()).getField()
  62.                         + "】异常："
  63.                         + defaultMessage);
  64.     }
  66.     @ExceptionHandler(InvalidFormatException.class)
  67.     public JSONObject handHttpConverterException(InvalidFormatException e) {
  69.         StringBuilder errors = new StringBuilder();
  70.         List<JsonMappingException.Reference> path = e.getPath();
  71.         for (JsonMappingException.Reference reference : path) {
  73.             errors.append("参数【")
  74.                     .append(reference.getFieldName())
  75.                     .append("】输入不合法，需要的是 ")
  76.                     .append(e.getTargetType().getName())
  77.                     .append(" 类型，")
  78.                     .append("提交的值是：")
  79.                     .append(e.getValue().toString());
  80.         }
  81.         log.error("参数校验异常3 == {}", errors);
  82.         return ResultUtil.failIllegalParameter(errors.toString());
  83.     }
  85.     @ExceptionHandler(MissingServletRequestParameterException.class)
  86.     public JSONObject handleMissingServletRequestParameterException(
  87.             MissingServletRequestParameterException e) {
  89.         StringBuilder errors = new StringBuilder();
  90.         errors.append("参数【").append(e.getParameterName()).append("】为必传字段：").append(e.getMessage());
  91.         log.error("参数校验异常4 == {}", errors);
  92.         return ResultUtil.failIllegalParameter(errors.toString());
  93.     }
  95.     @ExceptionHandler(HttpMessageConversionException.class)
  96.     public JSONObject handleConversionException(HttpMessageConversionException e) {
  98.         StringBuilder errors = new StringBuilder();
  99.         errors.append("参数校验异常5：").append(e.getMessage());
  100.         log.error("参数校验异常 == {}", errors);
  101.         return ResultUtil.failIllegalParameter(errors.toString());
  102.     }
  103. }

总结

以上就是今天要讲的内容，本文仅仅简单介绍了AOP的使用，AOP不止是可以实现日志打印的效果，还能实现很多好用的方法，后续我们都会讲到，请持续关注。谢谢！

发表评论

表情：
评论列表 （有 0 条评论，123人围观）

还没有评论，来说两句吧...

相关阅读