AI 助理
备案控制台
开发者社区 物联网 文章 正文

SpringBoot项目使用AOP及自定义注解保存操作日志

2024-11-05 95
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： SpringBoot项目使用AOP及自定义注解保存操作日志

image.png

@[toc]

概述：

该SpringBoot项目使用AOP的环绕@Around注解及自定义注解保存操作日志到数据库，自定义注解中会配置日志模板类型logModelType字段，通过该字段去匹配是创建、删除、修改...等等功能，本案例就是为了模拟现实项目中通过AOP及自定义注解如何保存操作详情日志功能。

特色

form表单除了input输入框，也会有一些按钮【Disable/Enable】，这些按钮就需要转换数字值然后动态拼接详情日志参数，日志操作类LogAopAction中拼接参数不只是简单的一堆get、set、if else去拼接，而是根据类型logModelType字段 =》 去找枚举LogDetailEnums =》通过枚举值找常量类LogDetailConstants，常量类中定义了各种类型操作的占位符，动态拼接参数使用MessageFormat.format()，这样使用更加简单、看起来更加优雅、实现可扩展性不用写一堆代码。
image.png

使用方式

  1. 第一步：pom引入AOP
  2. 第二步：创建自定义注解、Bean实体、枚举、常量类
  3. 第三步：Controller层方法使用自定义注解标识
  4. 第四步：新建一个日志操作类LogAopAction，专门用来处理操作保存日志
  5. 第五步：postman模拟调用接口，输出AOP中ProceedingJoinPoint获取目标方法，参数，注解

注意点

  • 注意点1：日志操作类LogAopAction必须加两个注解@Aspect和@Component，其中@Aspect注解代表该类为切面，而@Component为了使该类能让spring容器扫描到
  • 注意点2：@Around注解中配置@annotation注解用来指定生效的自定义注解名字
  • 注意点3：该案例描述AOP中ProceedingJoinPoint获取目标方法，参数，注解
  • 注意点4：接收实体Bean要重新toString方法，不然无法转成json，因为未重写toString方法中用的是等号 "=" 而不是冒号 "："
  • 注意点5：格式化常量类定义好的占位符请使用MessageFormat.format()，拼接起来更加方便

代码

第一步：pom引入AOP

<!--aop相关的依赖引入-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.78</version>
</dependency>

第二步：创建自定义注解、Bean实体、枚举、常量类

自定义注解LogAnnotation

package com.example.demo.config;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface LogAnnotation {
   

    //日志模板类型
    String logModelType();
}

实体类

package com.example.demo.bean;

import lombok.Data;

/**
 * @Author 211145187
 * @Date 2022/2/23 09:32
 **/
@Data
public class OperateTeacherReq {
   
    //id
    private Integer id;
    //姓名
    private String name;
    //开关【0:Disable、1：Enable】
    private Integer pstnFlag;

    @Override
    public String toString() {
   
        return "{" +
                "id:" + id +
                ", name:'" + name + '\'' +
                ", pstnFlag:" + pstnFlag +
                '}';
    }
}

枚举类LogDetailEnums

package com.example.demo.enums;

public enum LogDetailEnums {
   
    /**
     * 开户
     */
    CREATE_ACCOUNT("CREATE_ACCOUNT", LogDetailConstants.CREATE_ACCOUNT),
    /**
     * PSTN Flag值转换
     */
    PSTN_ENABLE_FLAG("pstnFlag_1","Enable"),
    PSTN_DISABLE_FLAG("pstnFlag_0","Disable");

    private String code;

    private String message;

    LogDetailEnums(String code, String message) {
   
        this.code = code;
        this.message = message;
    }

    public String getCode() {
   
        return code;
    }

    public void setCode(String code) {
   
        this.code = code;
    }

    public String getMessage() {
   
        return message;
    }

    public void setMessage(String message) {
   
        this.message = message;
    }

    public static String getDetailByCode(String messageCode){
   
        try {
   
            for (LogDetailEnums value : LogDetailEnums.values()) {
   
                if (value.code.equals(messageCode)){
   
                    return value.message;
                }
            }
        } catch (Exception e) {
   
            e.printStackTrace();
        }
        return "";
    }

    public static LogDetailEnums getLogDetailEnum(String code){
   
        if (code==null){
   
            return null;
        }
        for (LogDetailEnums value : LogDetailEnums.values()) {
   
            if (code.equals(value.code)){
   
                return value;
            }
        }
        return null;
    }
}

常量类LogDetailConstants

package com.example.demo.enums;

public class LogDetailConstants {
   
    public static final String CREATE_ACCOUNT = "【Add Account】id:[{0}], User Name:[{1}],pstnFlag:[{2}]";
}

第三步：Controller层方法使用自定义注解标识

package com.example.demo.controller;

import com.example.demo.bean.TeacherReq;
import com.example.demo.config.LogAnnotation;
import com.example.demo.mapper.TeacherMapper;
import com.example.demo.response.Response;
import org.apache.commons.codec.binary.Base64;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

import java.io.File;
import java.io.IOException;

/**
 * @Author 211145187
 * @Date 2022/5/7 11:34
 **/
@RestController
public class Controller {
   
@RequestMapping(value = "/operateLog", method = RequestMethod.POST)
    @LogAnnotation(logModelType = "CREATE_ACCOUNT")
    public Response operateLog(@RequestBody OperateTeacherReq req) {
   
        return Response.success(req);
    }
}

第四步：新建一个日志操作类LogAopAction，专门用来处理操作保存日志

package com.example.demo.config;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.example.demo.bean.OperateTeacherReq;
import com.example.demo.enums.LogDetailEnums;
import com.example.demo.response.Response;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;

import java.lang.reflect.Method;
import java.text.MessageFormat;

@Aspect
@Component
public class LogAopAction {
   

    /**
     * AOP切面保存操作日志
     * @Author 211145187
     * @Around 注解描述的方法为一个环绕通知方法，在此方法中可以添加扩展业务逻辑，可以调用下一个切面对象或目标方法
     * @param point 连接点(此连接点只应用@Around描述的方法)
     * @Date 2022/5/16 14:38
     * @param point
     * @Return Response
     **/
    @Around("@annotation(com.example.demo.config.LogAnnotation) && execution(* com.example.demo.controller.*.*(..))")
    public Response logOperate(ProceedingJoinPoint point) throws NoSuchMethodException {
   
        //获取类的字节码对象，通过字节码对象获取方法信息
        Class<?> targetCls=point.getTarget().getClass();
        //获取方法签名(通过此签名获取目标方法信息)
        MethodSignature signature = (MethodSignature) point.getSignature();
        Method method = signature.getMethod();
        //获取目标方法上的注解指定的操作名称
        Method targetMethod=
                targetCls.getDeclaredMethod(
                        signature.getName(),
                        signature.getParameterTypes());
        System.out.println("获取目标方法上的注解指定的操作名称："+targetMethod);
        LogAnnotation logAnnotation = method.getAnnotation(LogAnnotation.class);
        String logModelType=logAnnotation.logModelType();
        System.out.println("获取自定义注解参数值logModelType：" + logModelType);
        //获取目标方法名(目标类型+方法名)
        String targetClsName=targetCls.getName();
        String targetObjectMethodName=targetClsName+"."+method.getName();
        System.out.println("获取目标方法名：" + targetObjectMethodName);
        //获取请求参数
        Object[] args = point.getArgs();
        //TODO 操作日志保存到数据库中
        String logDetailInfo = LogDetailEnums.getDetailByCode(logModelType);
        switch (LogDetailEnums.getLogDetailEnum(logModelType)) {
   
            case CREATE_ACCOUNT:
                OperateTeacherReq req = JSONObject.parseObject(JSON.toJSONString(args[0]), OperateTeacherReq.class);
                System.out.println("获取请求参数：" + req);
                JSONObject jsonObject = JSONObject.parseObject(req.toString());
                logDetailInfo = MessageFormat.format(logDetailInfo, req.getId(), req.getName(), LogDetailEnums.getDetailByCode("pstnFlag_" + jsonObject.getString("pstnFlag")));
                break;
            default:
                System.out.println("无该类型！");
                break;
        }
        return Response.success(logDetailInfo);
    }
}

第五步：postman模拟调用接口，输出AOP中ProceedingJoinPoint获取目标方法，参数，注解

常量类详情日志占位符：
public static final String CREATE_ACCOUNT = "【Add Account】id:[{0}], User Name:[{1}],pstnFlag:[{2}]";

postman调用接口

image.png

postman结果打印

image.png

控制台打印：

image.png

获取目标方法上的注解指定的操作名称：public com.example.demo.response.Response com.example.demo.controller.Controller.operateLog(com.example.demo.bean.OperateTeacherReq)
获取自定义注解参数值logModelType：CREATE_ACCOUNT
获取目标方法名：com.example.demo.controller.Controller.operateLog
获取请求参数：{
   id:1, name:'教师1', pstnFlag:1}

项目代码路径图片

image.png

文章标签：
日志服务
Java
Spring
数据格式
数据库
JSON
相关实践学习
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
刘大猫.
目录
相关文章
泡沫o0
|
算法 Linux C++
【Linux系统编程】Linux目录操作：opendir、readdir与closedir详解
【Linux系统编程】Linux目录操作：opendir、readdir与closedir详解
泡沫o0
841 0
游客jfclsu2z7ufhs
|
测试技术
西门子S7-200 SMART自由口通信，如何编写发送程序，使用超级终端发送测试
今天我们学习编写西门子S7-200 SMART自由口通信的发送程序，并使用超级终端进行发送功能测试。首先设置参数，打开STEP7 Micro/WIN SMART编程软件，右键单击项目树中的CPU，选择打开，在打开的系统块中选择CPU类型和信号板类型。设置信号板，串口的类型为RS232，地址为2，波特率为9600。
游客jfclsu2z7ufhs
1053 0
西门子S7-200 SMART自由口通信，如何编写发送程序，使用超级终端发送测试
SoraLuna
|
缓存 搜索推荐 索引
「Mac畅玩鸿蒙与硬件12」鸿蒙UI组件篇2 - Image组件的使用
在鸿蒙应用开发中，Image 组件用于加载和显示图片资源，并提供多种属性来控制图片的显示效果和适配方式。本篇将带你学习如何在鸿蒙应用中加载本地和远程图片、设置图片样式以及实现简单的图片轮播功能。
SoraLuna
702 7
「Mac畅玩鸿蒙与硬件12」鸿蒙UI组件篇2 - Image组件的使用
SoraLuna
|
监控 Java Shell
「Mac畅玩鸿蒙与硬件7」鸿蒙开发环境配置篇7 - 使用命令行工具和本地模拟器管理项目
本篇将讲解在 macOS 上配置 HarmonyOS 开发环境的流程，聚焦 hvigorw 命令行工具的使用。我们将以创建 HelloWorld 项目为例，演示使用 hvigorw 进行项目构建、清理操作，并通过 DevEco Studio 的本地模拟器进行预览，帮助提升项目开发与调试效率。
SoraLuna
590 3
「Mac畅玩鸿蒙与硬件7」鸿蒙开发环境配置篇7 - 使用命令行工具和本地模拟器管理项目
刘大猫.
|
SQL 前端开发 关系型数据库
SpringBoot使用mysql查询昨天、今天、过去一周、过去半年、过去一年数据
SpringBoot使用mysql查询昨天、今天、过去一周、过去半年、过去一年数据
刘大猫.
394 9
智能计算老群群
|
传感器 网络协议
CCF推荐B类会议和期刊总结：（计算机网络领域）
中国计算机学会（CCF）推荐的B类会议和期刊在计算机网络领域具有较高水平。本文总结了所有B类会议和期刊的详细信息，包括全称、出版社、dblp文献网址及研究领域，涵盖传感器网络、移动网络、网络协议等多个方向，为学者提供重要学术交流平台。
智能计算老群群
4585 2
CCF推荐B类会议和期刊总结：（计算机网络领域）
c的前世今生
|
传感器 物联网 芯片
PWM 在智能照明系统中的应用优势有哪些
PWM（脉冲宽度调制）在智能照明系统中应用广泛，其优势包括：精准控制亮度、色温调节灵活、节能高效、延长灯具寿命、响应速度快及成本低廉。这些特点使其成为智能照明的理想选择。
c的前世今生
502 9
c的前世今生
|
传感器
水传感器的技术原理有哪些
水传感器通过多种技术原理检测水质，包括电导率测量、光学感应、化学反应和生物传感等方法，可监测pH值、溶解氧、浊度等参数。
c的前世今生
379 3
html的七十二变
|
缓存 算法 前端开发
如何降低 SPA 单页面应用的内存占用
单页面应用（SPA）由于其良好的用户体验而被广泛使用，但随着应用复杂度的增加，内存占用问题日益突出。本文将介绍几种有效降低SPA内存占用的方法，包括代码分割、懒加载、状态管理优化等技术，帮助开发者提升应用性能。
html的七十二变
354 6
Java开发者
|
Java 数据格式 索引
使用 Java 字节码工具检查类文件完整性的原理是什么
Java字节码工具通过解析和分析类文件的字节码，检查其结构和内容是否符合Java虚拟机规范，确保类文件的完整性和合法性，防止恶意代码或损坏的类文件影响程序运行。
Java开发者
219 5

物联网

热门文章

最新文章

  • 1
    使用MQTT客户端连接阿里云MQTT服务器
  • 2
    物联网+智慧城建，智慧城市建设的新动能
  • 3
    阿里云的物联网之路
  • 4
    PostgreSQL "物联网"应用 - 1 实时流式数据处理案例(万亿每天)
  • 5
    吃『派』那些事儿——阿里云物联网平台树莓派实战集锦
  • 6
    【直播回顾】小眯眼摄像头产品培训 - 物联网爆品推荐 - 88大促预告
  • 7
    阿里云物联网消息透传设备端payLoad设置问题
  • 8
    庆科：从安全设计上突破，云上物联网操作系统进化之路
  • 9
    LoRaWAN开放式实验平台
  • 10
    AliOS Things 3.0应用笔记：http client简单应用
  • 1
    稳压节能调控监控系统，电磁调压稳压，沃思智能
    23
  • 2
    路灯调压稳压节能装置系统，路灯节电器，沃思智能
    23
  • 3
    RFID助力路政资产高效管理
    28
  • 4
    实战丨如何用30天，将一款1688新品打造成类目爆款？
    40
  • 5
    RFID医院资产管理新模式
    33
  • 6
    国内人员定位系统厂家推荐：从公司背景、技术特点、定位方案和合作客户详解
    65
  • 7
    最新出炉！5家机加装备行业MES系统领军厂商大盘点
    34
  • 8
    1688运营自学全套流程，新店如何快速获得转化的指南！
    59
  • 9
    蓝牙信标、UWB等主流室内定位无线技术的参数对比、核心算法和选型指南详解（二）
    71
  • 10
    RFID助力钢材应用智能化管理
    43

    • 相关电子书

    更多
  • 低代码开发师（初级）实战教程
  • 冬季实战营第三期：MySQL数据库进阶实战
  • 阿里巴巴DevOps 最佳实践手册
    • 下一篇
    一文了解：阿里云对象存储OSS是什么？