• SpringBoot使用LogAspect的切面日志

    目录

    1、引入依赖

    2、切面方法

    3、Log类

     4、LogAspect类

    5、SysLog实体类

    6、服务类和服务实现类

    7、实际调用

    1、引入依赖

    1. <dependency>
    2.     <groupId>org.aspectjgroupId>
    3.     <artifactId>aspectjweaverartifactId>
    4. dependency>
    5. <dependency>
    6.     <groupId>org.springframework.bootgroupId>
    7.     <artifactId>spring-boot-starter-aopartifactId>
    8.     <scope>testscope>
    9. dependency>
    10. <dependencies>
    11.         <dependency>
    12.             <groupId>org.projectlombokgroupId>
    13.             <artifactId>lombokartifactId>
    14.         dependency>
    15. dependencies>

    2、切面方法

    切面方法说明如下：

    @Aspect 作用是把当前类标识为一个切面供容器读取
    @Pointcut (切入点):就是带有通知的连接点，在程序中主要体现为书写切入点表达式
    @Before 标识一个前置增强方法，相当于BeforeAdvice的功能
    @AfterReturning 后置增强，相当于AfterReturningAdvice，方法退出时执行
    @AfterThrowing 异常抛出增强，相当于ThrowsAdvice
    @After final增强，不管是抛出异常或者正常退出都会执行
    @Around 环绕增强，相当于MethodInterceptor

    3、Log类

    1. package com.shucha.deveiface.biz.aspect;
    2.  
    3. import java.lang.annotation.*;
    4.  
    5. /**
    6.  * @author tqf
    7.  * @Description 自定义拦截日志
    8.  * @Version 1.0
    9.  * @since 2022-08-08 15:28
    10.  */
    11. @Target({ElementType.PARAMETER, ElementType.METHOD})
    12. @Retention(RetentionPolicy.RUNTIME)
    13. @Documented
    14. public @interface Log {
    15.  
    16.     /**
    17.      * 操作描述  查询、新增、修改、删除等
    18.      * @return
    19.      */
    20.     String menu() default "";
    21.  
    22.     /**
    23.      * 接口名称 不需要填写  可以通过request.getRequestURL().toString(); 获取
    24.      * @return
    25.      */
    26.     String operation() default "";
    27.  
    28.     /**
    29.      * 是否记录请求参数数据, 默认true: 记录; false:不记录
    30.      *
    31.      * @return
    32.      */
    33.     boolean isData() default true;
    34. }

     4、LogAspect类

    1. package com.shucha.deveiface.biz.aspect;
    2.  
    3.  
    4.  
    5. import com.alibaba.fastjson.JSON;
    6. import com.alibaba.fastjson.serializer.SerializerFeature;
    7. import com.sdy.common.model.Response;
    8. import com.sdy.mvc.controller.BaseController;
    9. import com.sdy.mvc.utils.HttpUtil;
    10. import com.shucha.deveiface.biz.model.SysLog;
    11. import com.shucha.deveiface.biz.service.SysLogService;
    12. import feign.Request;
    13. import lombok.extern.slf4j.Slf4j;
    14. import org.apache.commons.lang3.ArrayUtils;
    15. import org.aspectj.lang.JoinPoint;
    16. import org.aspectj.lang.ProceedingJoinPoint;
    17. import org.aspectj.lang.Signature;
    18. import org.aspectj.lang.annotation.*;
    19. import org.aspectj.lang.reflect.MethodSignature;
    20. import org.springframework.beans.factory.annotation.Autowired;
    21. import org.springframework.core.annotation.Order;
    22. import org.springframework.stereotype.Component;
    23. import org.springframework.web.context.request.RequestContextHolder;
    24. import org.springframework.web.context.request.ServletRequestAttributes;
    25.  
    26. import javax.servlet.http.HttpServletRequest;
    27. import java.lang.reflect.Method;
    28. import java.lang.reflect.Parameter;
    29. import java.util.Date;
    30. import java.util.Enumeration;
    31. import java.util.HashMap;
    32. import java.util.Map;
    33.  
    34. /**
    35.  * @author tqf
    36.  * @Description 日志切面类
    37.  * @Version 1.0
    38.  * @since 2022-08-08 15:28
    39.  */
    40. @Aspect
    41. @Component
    42. @Slf4j
    43. @Order(1)
    44. public class LogAspect {
    45.  
    46.     @Autowired
    47.     private SysLogService sysLogService;
    48.  
    49.     private final ThreadLocal startTime = new ThreadLocal<>();
    50.  
    51.     // 配置织入点
    52.     @Pointcut("@annotation(Log)")
    53.     public void logPointCut() {
    54.     }
    55.  
    56.     @Before("logPointCut()")
    57.     private void before() {
    58.         startTime.set( System.currentTimeMillis());
    59.     }
    60.  
    61.     /**
    62.      * 处理完请求后执行
    63.      * @param joinPoint
    64.      * @param res
    65.      * @throws Exception
    66.      */
    67.     @AfterReturning(returning = "res", pointcut = "logPointCut()")
    68.     public void afterReturning(JoinPoint joinPoint, Response res) throws Exception {
    69.         long nowTime = System.currentTimeMillis();
    70.         HttpServletRequest request = getRequest();
    71.         handleLog(joinPoint, null, res, nowTime, request);
    72.     }
    73.  
    74.     /**
    75.      * 拦截异常操作
    76.      * @param joinPoint 切点
    77.      * @param e         异常
    78.      */
    79.     @AfterThrowing(value = "logPointCut()", throwing = "e")
    80.     public void doAfterThrowing(JoinPoint joinPoint, Exception e) throws Exception {
    81.         // 从上下文中获取reqeust
    82.         ServletRequestAttributes servletRequestAttributes =
    83.                 (ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
    84.         // HttpServletRequest request = getRequest();
    85.         HttpServletRequest request = servletRequestAttributes.getRequest();
    86.  
    87.         handleLog(joinPoint, e, null, System.currentTimeMillis(), request);
    88.     }
    89.  
    90.     protected void handleLog(final JoinPoint joinPoint, final Exception e, Response jsonResult, Long nowTime, HttpServletRequest request) throws Exception {
    91.         Log controllerLog = getAnnotationLog(joinPoint);
    92.         ProceedingJoinPoint point = (ProceedingJoinPoint)joinPoint;
    93.         if (controllerLog == null) {
    94.             return;
    95.         }
    96.         // 数据库日志
    97.         SysLog sysLog = new SysLog();
    98.         // 接口地址
    99.         String requestUrl = request.getRequestURL().toString();
    100.         // 请求的IP地址
    101.         String ip = HttpUtil.getIpAddr(request);
    102.         sysLog.setIp(ip);
    103.         // 获取操作内容
    104.         String content = controllerLog.menu();
    105.  
    106.         // 获取请求参数
    107.         String requestData = "";
    108.         if(controllerLog.isData()){
    109.             requestData = getRequestParams(point, request);
    110.         }
    111.         if (jsonResult == null) {
    112.             content = content + "--出现服务异常!";
    113.         }
    114.         if (jsonResult != null && !jsonResult.getSuccess()) {
    115.             content = content + "--执行失败!";
    116.         }
    117.         sysLog.setContent(content)
    118.             .setType(content)
    119.             .setCreateTime(new Date())
    120.             .setRequestUrl(requestUrl)
    121.             .setRequestData(requestData);
    122.         // 保存数据库
    123.         sysLogService.save(sysLog);
    124.     }
    125.  
    126.     /**
    127.      * 是否存在注解，如果存在就获取
    128.      */
    129.     private Log getAnnotationLog(JoinPoint joinPoint) {
    130.         Signature signature = joinPoint.getSignature();
    131.         MethodSignature methodSignature = (MethodSignature) signature;
    132.         Method method = methodSignature.getMethod();
    133.         if (method != null) {
    134.             return method.getAnnotation(Log.class);
    135.         }
    136.         return null;
    137.     }
    138.  
    139.     private HttpServletRequest getRequest() {
    140.         ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
    141.         return attributes.getRequest();
    142.     }
    143.  
    144.     /**
    145.      * 获取请求参数 json格式返回
    146.      * @param request
    147.      * @return
    148.      */
    149.     private String getParameterName(HttpServletRequest request){
    150.         // 增加查询日志  获取所有查询的参数名称和值 json格式存储
    151.         Map map = new HashMap();
    152.         Enumeration paramNames = request.getParameterNames();
    153.         while (paramNames.hasMoreElements()) {
    154.             String paramName = (String) paramNames.nextElement();
    155.             String[] paramValues = request.getParameterValues(paramName);
    156.             if (paramValues.length == 1) {
    157.                 String paramValue = paramValues[0];
    158.                 if (paramValue.length() != 0) {
    159.                     map.put(paramName, paramValue);
    160.                 }
    161.             }
    162.         }
    163.         return JSON.toJSONString(map);
    164.     }
    165.  
    166.     /**
    167.      * 获取请求参数
    168.      * @param request
    169.      * @return
    170.      */
    171.     public String getRequestParams(ProceedingJoinPoint point, HttpServletRequest request) {
    172.         MethodSignature methodSignature = (MethodSignature)point.getSignature();
    173.         Method method = methodSignature.getMethod();
    174.         String queryString = null;
    175.         String requestMethod = request.getMethod();
    176.         if (requestMethod.equals(Request.HttpMethod.POST.name())) {
    177.             //参数值
    178.             Object[] args = ArrayUtils.toArray(point.getArgs());
    179.             queryString = JSON.toJSONString(args[0], SerializerFeature.WriteMapNullValue);
    180.         }
    181.         else {
    182.             //参数名
    183.             Parameter[] parameters = method.getParameters();
    184.             //参数值
    185.             Object[] args = ArrayUtils.toArray(point.getArgs());
    186.             Map map = new HashMap<>();
    187.             for (int i = 0; i < parameters.length; i++) {
    188.                 map.put(parameters[i].getName(), args[i]);
    189.             }
    190.             queryString = JSON.toJSONString(map);
    191.         }
    192.         return queryString;
    193.     }
    194.  
    195. }

    5、SysLog实体类

    1. package com.shucha.deveiface.biz.model;
    2.  
    3. import com.baomidou.mybatisplus.annotation.TableId;
    4. import com.fasterxml.jackson.annotation.JsonFormat;
    5. import com.sdy.common.model.BaseModel;
    6. import com.sdy.common.utils.DateUtil;
    7. import io.swagger.annotations.ApiModelProperty;
    8. import lombok.Data;
    9. import lombok.EqualsAndHashCode;
    10. import lombok.experimental.Accessors;
    11.  
    12. import java.util.Date;
    13.  
    14. /**
    15.  * 
    16.  * 用户操作日志
    17.  * 
    18.  *
    19.  * @author tqf
    20.  * @since 2022-08-08 15:25
    21.  */
    22. @Data
    23. @EqualsAndHashCode(callSuper = true)
    24. @Accessors(chain = true)
    25. public class SysLog extends BaseModel {
    26.     private static final long serialVersionUID = 1L;
    27.  
    28.     /**
    29.      * 主键
    30.      */
    31.     @ApiModelProperty(value = "主键")
    32.     @TableId
    33.     private Long id;
    34.  
    35.     /**
    36.      * 操作用户id
    37.      */
    38.     @ApiModelProperty(value = "操作用户id")
    39.     private Long userId;
    40.  
    41.     @ApiModelProperty(value = "请求参数")
    42.     private String requestData;
    43.  
    44.     @ApiModelProperty(value = "请求接口地址")
    45.     private String requestUrl;
    46.  
    47.     /**
    48.      * IP地址
    49.      */
    50.     @ApiModelProperty(value = "IP地址")
    51.     private String ip;
    52.  
    53.     /**
    54.      * 操作内容
    55.      */
    56.     @ApiModelProperty(value = "操作内容")
    57.     private String content;
    58.  
    59.     /**
    60.      * 操作类型
    61.      */
    62.     @ApiModelProperty(value = "操作类型")
    63.     private String type;
    64.  
    65.     /**
    66.      * 创建时间
    67.      */
    68.     @ApiModelProperty(value = "创建时间")
    69.     @JsonFormat(pattern = DateUtil.DATETIME_FORMAT)
    70.     private Date createTime;
    71.  
    72. }

    创建表和插入数据

    1. SET NAMES utf8mb4;
    2. SET FOREIGN_KEY_CHECKS = 0;
    3.  
    4. -- ----------------------------
    5. -- Table structure for sys_log
    6. -- ----------------------------
    7. DROP TABLE IF EXISTS `sys_log`;
    8. CREATE TABLE `sys_log`  (
    9.   `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主键',
    10.   `user_id` int(11) NULL DEFAULT NULL COMMENT '操作用户id',
    11.   `ip` varchar(255) CHARACTER SET utf8 COLLATE utf8_unicode_ci NULL DEFAULT NULL COMMENT 'IP地址',
    12.   `content` varchar(255) CHARACTER SET utf8 COLLATE utf8_unicode_ci NULL DEFAULT NULL COMMENT '操作内容',
    13.   `request_url` varchar(255) CHARACTER SET utf8 COLLATE utf8_unicode_ci NULL DEFAULT NULL COMMENT '请求接口地址',
    14.   `request_data` longtext CHARACTER SET utf8 COLLATE utf8_unicode_ci NULL COMMENT '请求参数',
    15.   `type` varchar(255) CHARACTER SET utf8 COLLATE utf8_unicode_ci NULL DEFAULT NULL COMMENT '操作类型\r\n0：登陆\r\n1：新增用户\r\n2：开户\r\n3：用户基本信息编辑\r\n4：用户资源编辑\r\n5：新增角色\r\n6编辑角色\r\n7:角色权限编辑\r\n8：角色关联用户编辑\r\n9：新增菜单\r\n10：菜单编辑\r\n11：日志查询',
    16.   `create_time` datetime(0) NULL DEFAULT NULL COMMENT '创建时间',
    17.   PRIMARY KEY (`id`) USING BTREE,
    18.   INDEX `idx_user_id`(`user_id`) USING BTREE
    19. ) ENGINE = InnoDB AUTO_INCREMENT = 4 CHARACTER SET = utf8 COLLATE = utf8_unicode_ci COMMENT = '操作日志信息' ROW_FORMAT = Dynamic;
    20.  
    21. -- ----------------------------
    22. -- Records of sys_log
    23. -- ----------------------------
    24. INSERT INTO `sys_log` VALUES (1, NULL, '192.168.0.111', '查询数据', 'http://192.168.0.111:50041/test/getData', '{}', '查询数据', '2022-08-08 17:21:51');
    25. INSERT INTO `sys_log` VALUES (2, NULL, '192.168.0.111', '新增数据发发发', NULL, NULL, NULL, NULL);
    26. INSERT INTO `sys_log` VALUES (3, NULL, '192.168.0.111', '新增数据', 'http://192.168.0.111:50041/test/saveData', '{\"content\":\"新增数据发发发\",\"createTime\":null,\"id\":2,\"ip\":\"192.168.0.111\",\"requestData\":null,\"requestUrl\":null,\"type\":null,\"userId\":null}', '新增数据', '2022-08-08 17:22:12');
    27.  
    28. SET FOREIGN_KEY_CHECKS = 1;

     

    6、服务类和服务实现类

    1. package com.shucha.deveiface.biz.service;
    2.  
    3. import com.sdy.mvc.service.BaseService;
    4. import com.shucha.deveiface.biz.model.SysLog;
    5.  
    6. /**
    7.  * 
    8.  * 用户操作日志 服务类
    9.  * 
    10.  *
    11.  * @author cgj
    12.  * @since 2021-07-13
    13.  */
    14. public interface SysLogService extends BaseService {
    15.  
    16. }
    1. package com.shucha.deveiface.biz.service.impl;
    2.  
    3. import com.sdy.mvc.service.impl.BaseServiceImpl;
    4. import com.shucha.deveiface.biz.mapper.SysLogMapper;
    5. import com.shucha.deveiface.biz.model.SysLog;
    6. import com.shucha.deveiface.biz.service.SysLogService;
    7. import lombok.extern.slf4j.Slf4j;
    8. import org.springframework.beans.factory.annotation.Autowired;
    9. import org.springframework.stereotype.Service;
    10.  
    11. /**
    12.  * 
    13.  * 用户操作日志 服务实现类
    14.  * 
    15.  *
    16.  * @author cgj
    17.  * @since 2021-07-13
    18.  */
    19. @Slf4j
    20. @Service
    21. public class SysLogServiceImpl extends BaseServiceImpl implements SysLogService {
    22.     @Autowired
    23.     private SysLogMapper sysLogMapper;
    24. }

    7、实际调用

    1. package com.shucha.deveiface.web.controller;
    2.  
    3. import com.sdy.common.model.Response;
    4. import com.shucha.deveiface.biz.aspect.Log;
    5. import com.shucha.deveiface.biz.model.SysLog;
    6. import com.shucha.deveiface.biz.service.SysLogService;
    7. import org.springframework.beans.factory.annotation.Autowired;
    8. import org.springframework.web.bind.annotation.*;
    9.  
    10. /**
    11.  * @author tqf
    12.  * @Description
    13.  * @Version 1.0
    14.  * @since 2022-08-08 15:23
    15.  */
    16. @RestController
    17. @RequestMapping("/test")
    18. public class TestController {
    19.  
    20.     @Autowired
    21.     private SysLogService logService;
    22.  
    23.     @Log(menu = "查询数据")
    24.     @GetMapping("/getData")
    25.     public Response test(){
    26.         return Response.success("请求成功");
    27.     }
    28.  
    29.     @Log(menu = "新增数据")
    30.     @PostMapping("/saveData")
    31.     public Response saveData(@RequestBody SysLog sysLog){
    32.         logService.save(sysLog);
    33.         return Response.success();
    34.     }
    35. }
  • 相关阅读:
    双位置继电器XJLS-8G/220
    Windows + Msys 下编译 TensorFlow 2.14
    分享一个项目：go `file_line`，在编译期得到源码行号，减少运行期runtime消耗
    Opencv形态学——腐蚀、膨胀、开运算与闭运算、梯度运算、礼帽、黑帽
    面试阿里、字节全都一面挂，被面试官说我的水平还不如应届生
    Qt之解析HTML
    WebShell 木马免杀过WAF
    【Linux】线程池
    【Hack The Box】windows练习-- Buff
    如何在虚拟机上安装linux操纵系统
  • 原文地址：https://blog.csdn.net/tanqingfu1/article/details/126230286