devbox
你好赵伟
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

SpringBoot使用AOP进行日志记录

作者：你好赵伟 | 2024-08-09 16:48:10

赞

踩

SpringBoot使用AOP进行日志记录

前言

在Spring Boot中使用AOP（面向切面编程）记录操作日志具有以下好处：

  1. 减少重复代码：利用AOP，可以将日志记录、性能统计、安全控制、事务处理、异常处理等代码从业务逻辑代码中划分出来作为公共部分，从而减少重复代码，降低模块间的耦合度，并有利于未来的可拓展性和可维护性。
  2. 提高开发效率：通过将日志记录等通用功能与核心业务功能分离，开发人员可以专注于业务逻辑的开发，而无需在每个业务逻辑中手动添加日志记录等代码。这有助于提高开发效率。
  3. 方便跟踪和统计：通过AOP记录操作日志，可以方便地跟踪和统计用户对系统的操作情况。例如，通过分析日志记录，可以了解用户常用操作，以便定点推送消息。此外，还可以统计异常出现的次数或发生的时间，方便对系统进行优化和改进。
  4. 符合开闭原则：AOP是面向切面编程的，符合开闭原则。这意味着在不修改原有代码的基础上，可以对代码进行扩展。例如，在不修改原有业务逻辑代码的情况下，可以添加新的日志记录或安全控制功能。
  5. 易于集成和上手：Spring Boot已经集成了AOP功能，使得开发者可以更容易地使用和集成AOP。同时，由于Spring Boot的广泛使用，AOP与Spring Boot的集成也使得开发者可以更容易地找到相关的资源和文档。

总之，在Spring Boot中使用AOP记录操作日志可以提高系统的可维护性、可读性和可扩展性，并降低开发成本 。

1、环境

1.所需依赖

  1.    <!--        lombok-->
  2.         <dependency>
  3.             <groupId>org.projectlombok</groupId>
  4.             <artifactId>lombok</artifactId>
  5.             <scope>provided</scope>
  6.         </dependency>
  7.    <!--        fastjson-->
  8.         <dependency>
  9.             <groupId>com.alibaba</groupId>
  10.             <artifactId>fastjson</artifactId>
  11.             <version>1.2.73</version>
  12.         </dependency>
  13.  
  14.   <!--        获取ip-->
  15.         <dependency>
  16.             <groupId>org.lionsoul</groupId>
  17.             <artifactId>ip2region</artifactId>
  18.             <version>1.7.2</version>
  19.         </dependency>
  20.         <dependency>
  21.             <groupId>eu.bitwalker</groupId>
  22.             <artifactId>UserAgentUtils</artifactId>
  23.             <version>1.20</version>
  24.         </dependency>
  25.     <!--        knife4j-->
  26.         <dependency>
  27.             <groupId>com.github.xiaoymin</groupId>
  28.             <artifactId>knife4j-spring-boot-starter</artifactId>
  29.             <version>2.0.7</version>
  30.         </dependency>
  31.    <!--        aop-->
  32.         <dependency>
  33.             <groupId>org.springframework.boot</groupId>
  34.             <artifactId>spring-boot-starter-aop</artifactId>
  35.         </dependency>

2、注解AOP实现日志记录代码

1.自定义注解

  1. package com.pzg.chat.annotation;
  2.  
  3. import java.lang.annotation.*;
  4.  
  5. /**
  6.  * 获取某些方法执行的method操作(参照包com.example.demo.constant.OptTypeConstant下的常量选择)
  7.  */
  8. @Target(ElementType.METHOD)
  9. @Retention(RetentionPolicy.RUNTIME)
  10. @Documented
  11. public @interface OptLog {
  12.  
  13. 	String optType() default "";  //执行声明操作
  14. }

2.日志实体类

  1.  
  2. //操作日志
  3. @Data
  4. @Builder
  5. @AllArgsConstructor
  6. @NoArgsConstructor
  7. @TableName("sys_operation_log")
  8. public class OperationLog {
  9.  
  10.     @TableId(value = "id", type = IdType.AUTO)
  11.     private Integer id;
  12.  
  13.     private String optModule;
  14.  
  15.     private String optUri;
  16.  
  17.     private String optType;
  18.  
  19.     private String optMethod;
  20.  
  21.     private String optDesc;
  22.  
  23.     private String requestMethod;
  24.  
  25.     private String requestParam;
  26.  
  27.     private String responseData;
  28.  
  29.     private Integer userId;
  30.  
  31.     private String nickname;
  32.  
  33.     private String ipAddress;
  34.  
  35.     private String ipSource;
  36.  
  37.     @TableField(fill = FieldFill.INSERT)
  38.     private LocalDateTime createTime;
  39.  
  40.     @TableField(fill = FieldFill.UPDATE)
  41.     private LocalDateTime updateTime;
  42. }

3.AOP类

        负责指定切点、切面、逻辑处理，对操作日志进行收集，通过反射获取方法上的注解，并对注解进行解析，获取注解字段信息，并封装，然后通过SpringBoot的监听器功能实现异步记录

  1.  
  2.  
  3.  
  4. @Aspect
  5. @Component
  6. @SuppressWarnings("all")
  7. public class OperationLogAspect {
  8.  
  9. 	@Autowired
  10. 	private ApplicationContext applicationContext;
  11.  
  12.  
  13. 	@Pointcut("@annotation(com.pzg.chat.annotation.OptLog)")
  14. 	public void operationLogPointCut(){
  15.  
  16. 	}
  17.  
  18. 	@AfterReturning(value = "operationLogPointCut()", returning = "keys")
  19. 	@SuppressWarnings("unchecked")
  20. 	public void saveOperationLog(JoinPoint joinPoint, Object keys) {
  21. 		RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
  22. 		HttpServletRequest request = (HttpServletRequest) Objects.requireNonNull(requestAttributes).resolveReference(RequestAttributes.REFERENCE_REQUEST);
  23. 		OperationLog operationLog = new OperationLog();
  24. 		MethodSignature signature = (MethodSignature) joinPoint.getSignature();
  25. 		Method method = signature.getMethod();
  26. 		Api api = (Api) signature.getDeclaringType().getAnnotation(Api.class);
  27. 		ApiOperation apiOperation = method.getAnnotation(ApiOperation.class);
  28. 		OptLog optLog = method.getAnnotation(OptLog.class);
  29. 		operationLog.setOptModule(api.tags()[0]);
  30. 		operationLog.setOptType(optLog.optType());
  31. 		operationLog.setOptDesc(apiOperation.value());
  32. 		String className = joinPoint.getTarget().getClass().getName();
  33. 		String methodName = method.getName();
  34. 		methodName = className + "." + methodName;
  35. 		operationLog.setRequestMethod(Objects.requireNonNull(request).getMethod());
  36. 		operationLog.setOptMethod(methodName);
  37. 		if (joinPoint.getArgs().length > 0) {
  38. 			if (joinPoint.getArgs()[0] instanceof MultipartFile) {
  39. 				operationLog.setRequestParam("file");
  40. 			} else {
  41. 				operationLog.setRequestParam(JSON.toJSONString(joinPoint.getArgs()));
  42. 			}
  43. 		}
  44. 		operationLog.setResponseData(JSON.toJSONString(keys));
  45. 		operationLog.setUserId(Optional.ofNullable(UserUtil.getUserDetailsDTO().getId()).orElse(0));
  46. 		operationLog.setNickname(Optional.ofNullable(UserUtil.getUserDetailsDTO().getNickName()).orElse("anonymous"));
  47. 		String ipAddress = IpUtil.getIpAddress(request);
  48. 		operationLog.setIpAddress(ipAddress);
  49. 		operationLog.setIpSource(IpUtil.getIpSource(ipAddress));
  50. 		operationLog.setOptUri(request.getRequestURI());
  51. 		applicationContext.publishEvent(new OperationLogEvent(operationLog));
  52. 	}
  53. }

4.事件类

        负责接收日志数据

  1.  
  2. public class ExceptionLogEvent extends ApplicationEvent {
  3.     public ExceptionLogEvent(ExceptionLog exceptionLog) {
  4.         super(exceptionLog);
  5.     }
  6. }

5.监听事件类

        通过在监听类中监听事件的变化，最后将数据通过mybatis plus插入到数据库当中

  1.  
  2. @Component
  3. public class EventListeners {
  4.  
  5. 	@Resource
  6. 	private OperationLogMapper operationLogMapper;
  7.  
  8. 	@Autowired
  9. 	private ExceptionLogMapper exceptionLogMapper;
  10.  
  11. 	@Async
  12. 	@EventListener(OperationLogEvent.class)
  13. 	public void operationLogEvent(OperationLogEvent operationLogEvent){
  14. 		operationLogMapper.insert((OperationLog)operationLogEvent.getSource());
  15. 	}
  16.  
  17. }

6.IP工具类

  1. package com.aurora.util;
  2.  
  3. import eu.bitwalker.useragentutils.UserAgent;
  4. import lombok.extern.slf4j.Slf4j;
  5. import org.apache.commons.lang3.StringUtils;
  6. import org.lionsoul.ip2region.DataBlock;
  7. import org.lionsoul.ip2region.DbConfig;
  8. import org.lionsoul.ip2region.DbSearcher;
  9. import org.lionsoul.ip2region.Util;
  10. import org.springframework.core.io.ClassPathResource;
  11. import org.springframework.stereotype.Component;
  12. import org.springframework.util.FileCopyUtils;
  13.  
  14. import javax.annotation.PostConstruct;
  15. import javax.servlet.http.HttpServletRequest;
  16. import java.io.InputStream;
  17. import java.lang.reflect.Method;
  18. import java.net.InetAddress;
  19. import java.net.UnknownHostException;
  20.  
  21. @Slf4j
  22. @Component
  23. public class IpUtil {
  24.  
  25.     private static DbSearcher searcher;
  26.  
  27.     private static Method method;
  28.  
  29.     public static String getIpAddress(HttpServletRequest request) {
  30.         String ipAddress = request.getHeader("X-Real-IP");
  31.         if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
  32.             ipAddress = request.getHeader("x-forwarded-for");
  33.         }
  34.         if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
  35.             ipAddress = request.getHeader("Proxy-Client-IP");
  36.         }
  37.         if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
  38.             ipAddress = request.getHeader("WL-Proxy-Client-IP");
  39.         }
  40.         if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
  41.             ipAddress = request.getHeader("HTTP_CLIENT_IP");
  42.         }
  43.         if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
  44.             ipAddress = request.getHeader("HTTP_X_FORWARDED_FOR");
  45.         }
  46.         if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
  47.             ipAddress = request.getRemoteAddr();
  48.             if ("127.0.0.1".equals(ipAddress) || "0:0:0:0:0:0:0:1".equals(ipAddress)) {
  49.                 //根据网卡取本机配置的IP
  50.                 InetAddress inet = null;
  51.                 try {
  52.                     inet = InetAddress.getLocalHost();
  53.                 } catch (UnknownHostException e) {
  54.                     log.error("getIpAddress exception:", e);
  55.                 }
  56.                 assert inet != null;
  57.                 ipAddress = inet.getHostAddress();
  58.             }
  59.         }
  60.         return StringUtils.substringBefore(ipAddress, ",");
  61.     }
  62.  
  63.     @PostConstruct
  64.     private void initIp2regionResource() throws Exception {
  65.         InputStream inputStream = new ClassPathResource("/ip/ip2region.db").getInputStream();
  66.         byte[] dbBinStr = FileCopyUtils.copyToByteArray(inputStream);
  67.         DbConfig dbConfig = new DbConfig();
  68.         searcher = new DbSearcher(dbConfig, dbBinStr);
  69.         method = searcher.getClass().getMethod("memorySearch", String.class);
  70.     }
  71.  
  72.     public static String getIpSource(String ipAddress) {
  73.         if (ipAddress == null || !Util.isIpAddress(ipAddress)) {
  74.             log.error("Error: Invalid ip address");
  75.             return "";
  76.         }
  77.         try {
  78.             DataBlock dataBlock = (DataBlock) method.invoke(searcher, ipAddress);
  79.             String ipInfo = dataBlock.getRegion();
  80.             if (!StringUtils.isEmpty(ipInfo)) {
  81.                 ipInfo = ipInfo.replace("|0", "");
  82.                 ipInfo = ipInfo.replace("0|", "");
  83.                 return ipInfo;
  84.             }
  85.         } catch (Exception e) {
  86.             log.error("getCityInfo exception:", e);
  87.         }
  88.         return "";
  89.     }
  90.  
  91.     public static String getIpProvince(String ipSource) {
  92.         String[] strings = ipSource.split("\\|");
  93.         if (strings[1].endsWith("省")) {
  94.             return StringUtils.substringBefore(strings[1], "省");
  95.         }
  96.         return strings[1];
  97.     }
  98.  
  99.     public static UserAgent getUserAgent(HttpServletRequest request) {
  100.         return UserAgent.parseUserAgentString(request.getHeader("User-Agent"));
  101.     }
  102.  
  103. }

3、使用示例

  1. @Api(tags = "操作日志模块")
  2. @RestController
  3. public class OperationLogController {
  4.  
  5.     @Autowired
  6.     private OperationLogService operationLogService;
  7.  
  8.     @ApiOperation(value = "查看操作日志")
  9.     @GetMapping("/admin/operation/logs")
  10.     public ResultVO<PageVO<OperationLogDTO>> listOperationLogs(ConditionVO conditionVO) {
  11.         return ResultVO.ok(operationLogService.listOperationLogs(conditionVO));
  12.     }
  13.  
  14.     @OptLog(optType = DELETE)
  15.     @ApiOperation(value = "删除操作日志")
  16.     @DeleteMapping("/admin/operation/logs")
  17.     public ResultVO<?> deleteOperationLogs(@RequestBody List<Integer> operationLogIds) {
  18.         operationLogService.removeByIds(operationLogIds);
  19.         return ResultVO.ok();
  20.     }
  21.  
  22. }

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/你好赵伟/article/detail/954242
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号