广告位联系
返回顶部
分享到

SpringBoot使用AOP记录接口操作日志介绍

java 来源:互联网 作者:佚名 发布时间:2022-08-28 20:47:36 人浏览
摘要

SpringBoot 使用 AOP 记录接口操作日志,供大家参考,具体内容如下 一、AOP简介 1.什么是AOP AOP:Aspect Oriented Programming 面向切面编程 AOP关注不是某一个类或某些方法;控制大量资源,关注

SpringBoot 使用 AOP 记录接口操作日志,供大家参考,具体内容如下

一、AOP简介

1.什么是AOP

AOP:Aspect Oriented Programming 面向切面编程

AOP关注不是某一个类或某些方法;控制大量资源,关注的是大量的类和方法。

2.AOP应用场景以及常用术语

  • 权限控制、缓存控制、事务控制、分布式追踪、异常处理等
  • Target:目标类,即需要被代理的类。例如:UserService
  • Joinpoint(连接点):所谓连接点是指那些可能被拦截到的方法。例如:所有的方法
  • PointCut 切入点:已经被增强的连接点。例如:addUser()
  • Advice 通知/增强,增强代码。例如:after、before
  • Weaving(织入):是指把增强advice应用到目标对象target来创建新的代理对象proxy的过程.
  • Aspect(切面): 是切入点pointcut和通知advice的结合

3.AOP的特点

1)降低模块与模块之间的耦合度,提高业务代码的聚合度。(高内聚低耦合)

2)提高了代码的复用性

3)提高系统的扩展性。(高版本兼容低版本)

4)可以在不影响原有的功能基础上添加新的功能

二、springBoot 使用 AOP 实现流程

1.引入依赖

1

2

3

4

5

<!-- Spring AOP -->

  <dependency>

      <groupId>org.springframework.boot</groupId>

      <artifactId>spring-boot-starter-aop</artifactId>

</dependency>

2.封装记录日志实体类

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

@Getter

@Setter

@ApiModel(value = "Systemlog对象", description = "")

public class Systemlog implements Serializable {

 

    private static final long serialVersionUID = 1L;

 

      @ApiModelProperty("ID")

      @TableId(value = "id", type = IdType.AUTO)

      private Integer id;

 

      @ApiModelProperty("用户名")

      private String userName;

 

      @ApiModelProperty("用户ID")

      private Integer userId;

 

      @ApiModelProperty("操作描述")

      private String operate;

 

      @ApiModelProperty("模块")

      private String module;

 

      @ApiModelProperty("创建日志时间")

      @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")

      private Date createTime;

 

      @ApiModelProperty("操作结果")

      private String result;

 

}

3.编写注解类(自定义日志注解类)

1

2

3

4

5

6

7

8

9

10

11

12

/**

 * controller层切面日志注解

 * @author hsq

 */

@Target(ElementType.METHOD)

@Retention(RetentionPolicy.RUNTIME)

public @interface SystemControllerLog {

    // 操作描述

    String operate();

    // 模块

    String module();

}

4.编写操作日志的切面类

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

**

 * @author hsq

 */

@Aspect

@Component

public class SystemLogAspect {

 

    private static final Logger logger = LoggerFactory.getLogger(SystemLogAspect.class);

 

    @Autowired

    private ISystemlogService iSystemlogService;

 

    @Autowired

    private UserService userService;

 

    /**

     * Controller层切点

     */

    @Pointcut("@annotation(com.hsq.demo.config.SystemControllerLog)")

    public void SystemControllerLog(){

 

    }

     

    

    /**

     * 前置通知 用于拦截Controller层记录用户的操作的开始时间

     * @param joinPoint 切点

     * @throws InterruptedException

     */

    @Before("SystemControllerLog()")

    public void doBefore(JoinPoint joinPoint) throws InterruptedException{

        logger.info("进入日志切面前置通知!");

 

    }

 

    @After("SystemControllerLog()")

    public void doAfter(JoinPoint joinPoint) {

        logger.info("进入日志切面后置通知!");

 

    }

 

    /**value切入点位置

     * returning 自定义的变量,标识目标方法的返回值,自定义变量名必须和通知方法的形参一样

     * 特点:在目标方法之后执行的,能够获取到目标方法的返回值,可以根据这个返回值做不同的处理

     */

    @AfterReturning(value = "SystemControllerLog()", returning = "ret")

    public void doAfterReturning(Object ret) throws Throwable {

    }

 

    /***

     * 异常通知 记录操作报错日志

     * * @param joinPoint

     * * @param e

     * */

    @AfterThrowing(pointcut = "SystemControllerLog()", throwing = "e")

    public void doAfterThrowing(JoinPoint joinPoint, Throwable e) {

        logger.info("进入日志切面异常通知!!");

        logger.info("异常信息:" + e.getMessage());

    }

         

         

    //使用这个方法先注释前面三个方法,留before方法就行

    /**

     * 通知包裹了目标方法,在目标方法调用之前和之后执行自定义的行为

     * ProceedingJoinPoint切入点可以获取切入点方法上的名字、参数、注解和对象

     * @param joinPoint

     */

    @Around("SystemControllerLog() && @annotation(systemControllerLog)")

  public Result doAfterReturning(ProceedingJoinPoint joinPoint, SystemControllerLog systemControllerLog) throws Throwable {

        logger.info("设置日志信息存储到表中!");

        //joinPoint.proceed() 结果集

        //参数数组

        Object[] args = joinPoint.getArgs();

        //请求参数数据

        String requestJson = JSONUtil.toJsonStr(args);

        //方法名

        String methodName = joinPoint.getSignature().getName();

        //得到request

        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();

        //得到token

        String token = request.getHeader("token");

        String userId = JWT.decode(token).getAudience().get(0);

        User user = userService.getById(userId);

        logger.info("得到用户信息:"+user.toString());

        //写入数据库操作日志

        Systemlog systemlog = new Systemlog();

        systemlog.setUserId(user.getUid());

        systemlog.setUserName(user.getUname());

        systemlog.setOperate(systemControllerLog.operate());

        systemlog.setModule(systemControllerLog.module());

        systemlog.setCreateTime(new Date());

        //存入返回的结果集 joinPoint.proceed()

        Result proceed = (Result) joinPoint.proceed();

        systemlog.setResult(JSONUtil.toJsonStr(joinPoint.proceed()));

        //保存

       saveSystemLog(systemlog);

 

       return proceed;

 

    }

 

}

5.controller使用

1

2

3

4

5

6

7

8

9

10

 @GetMapping("/userListPage")

 @SystemControllerLog(operate = "用户查询",module = "用户管理")

 public Result findUserList( @RequestParam Integer pageNum,

                                @RequestParam Integer pageSize,

                                @RequestParam String username,

                                @RequestParam String loveValue,

                                @RequestParam String address) {}

  @PostMapping("/addOrUpdate")

  @SystemControllerLog(operate = "用户修改或者添加",module = "用户管理")

  public Result addOrUpdateUser(@RequestBody User user){}

6.数据库记录


版权声明 : 本文内容来源于互联网或用户自行发布贡献,该文观点仅代表原作者本人。本站仅提供信息存储空间服务和不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权, 违法违规的内容, 请发送邮件至2530232025#qq.cn(#换@)举报,一经查实,本站将立刻删除。
原文链接 : https://blog.csdn.net/qq_41128049/article/details/124304960
相关文章
  • SpringBoot自定义错误处理逻辑介绍

    SpringBoot自定义错误处理逻辑介绍
    1. 自定义错误页面 将自定义错误页面放在 templates 的 error 文件夹下,SpringBoot 精确匹配错误信息,使用 4xx.html 或者 5xx.html 页面可以打印错误
  • Java实现手写一个线程池的代码

    Java实现手写一个线程池的代码
    线程池技术想必大家都不陌生把,相信在平时的工作中没有少用,而且这也是面试频率非常高的一个知识点,那么大家知道它的实现原理和
  • Java实现断点续传功能的代码

    Java实现断点续传功能的代码
    题目实现:网络资源的断点续传功能。 二、解题思路 获取要下载的资源网址 显示网络资源的大小 上次读取到的字节位置以及未读取的字节
  • 你可知HashMap为什么是线程不安全的
    HashMap 的线程不安全 HashMap 的线程不安全主要体现在下面两个方面 在 jdk 1.7 中,当并发执行扩容操作时会造成环形链和数据丢失的情况 在
  • ArrayList的动态扩容机制的介绍

    ArrayList的动态扩容机制的介绍
    对于 ArrayList 的动态扩容机制想必大家都听说过,之前的文章中也谈到过,不过由于时间久远,早已忘却。 所以利用这篇文章做做笔记,加
  • JVM基础之字节码的增强技术介绍

    JVM基础之字节码的增强技术介绍
    字节码增强技术 在上文中,着重介绍了字节码的结构,这为我们了解字节码增强技术的实现打下了基础。字节码增强技术就是一类对现有字
  • Java中的字节码增强技术

    Java中的字节码增强技术
    1.字节码增强技术 字节码增强技术就是一类对现有字节码进行修改或者动态生成全新字节码文件的技术。 参考地址 2.常见技术 技术分类 类
  • Redis BloomFilter布隆过滤器原理与实现

    Redis BloomFilter布隆过滤器原理与实现
    Bloom Filter 概念 布隆过滤器(英语:Bloom Filter)是1970年由一个叫布隆的小伙子提出的。它实际上是一个很长的二进制向量和一系列随机映射
  • Java C++算法题解leetcode801使序列递增的最小交换次

    Java C++算法题解leetcode801使序列递增的最小交换次
    题目要求 思路:状态机DP 实现一:状态机 Java 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 class Solution { public int minSwap(int[] nums1, int[] nums2) { int n
  • Mybatis结果集映射与生命周期介绍

    Mybatis结果集映射与生命周期介绍
    一、ResultMap结果集映射 1、设计思想 对简单的语句做到零配置,对于复杂一点的语句,只需要描述语句之间的关系就行了 2、resultMap的应用场
  • 本站所有内容来源于互联网或用户自行发布,本站仅提供信息存储空间服务,不拥有版权,不承担法律责任。如有侵犯您的权益,请您联系站长处理!
  • Copyright © 2017-2022 F11.CN All Rights Reserved. F11站长开发者网 版权所有 | 苏ICP备2022031554号-1 | 51LA统计