【Aop+自定义注解实现日志插入】

原创 已于 2025-03-12 09:29:50 修改 · 488 阅读 · 10 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java

于 2024-01-12 14:09:15 首次发布
文章介绍了如何在Java中使用AOP技术，结合自定义注解AutoApiLog，实现在业务方法执行前后自动插入日志。同时展示了如何在切面中获取参数、执行结果和用户信息，用于生成详细的接口调用日志。

Aop+自定义注解实现日志插入


1.自定义注解AutoApiLog

package org.jeecg.modules.dataark.aspect.annotation;

import java.lang.annotation.*;

/**
 * 系统日志注解
 * 
 * @Author scott
 * @email jeecgos@163.com
 * @Date 2019年1月14日
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface AutoApiLog {

	/**
	 * 调用接口编码
	 * 
	 * @return
	 */
	String apiCode() default "";
	/**
	 * 业务类型编码
	 *
	 * @return
	 */
	String businessCode() default "";
	/**
	 * 业务类型名称
	 *
	 * @return
	 */
	String businessName() default "";

2.自定义Aop切面

```java
package org.jeecg.modules.dataark.aspect;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.ObjectUtils;
import org.apache.shiro.SecurityUtils;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.jeecg.common.system.vo.LoginUser;
import org.jeecg.modules.constart.OperateConstant;
import org.jeecg.modules.dataark.aspect.annotation.AutoApiLog;
import org.jeecg.common.operate.entity.YwDataarkApiLog;
import org.jeecg.modules.dataark.service.IYwDataarkApiLogService;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.util.Date;


/**
 * DataArk接口调用日志，切面处理类
 *
 * @Author scott
 * @email jeecgos@163.com
 * @Date 2018年1月14日
 */
@Slf4j
@Aspect
@Component
public class AutoApiLogAspect {

    @Resource
    private IYwDataarkApiLogService apiLogService;

    @Pointcut("@annotation(org.jeecg.modules.dataark.aspect.annotation.AutoApiLog)")
    public void logPointCut() {

    }

    @Around("logPointCut()")
    public Object around(ProceedingJoinPoint point) throws Throwable {
        //long beginTime = System.currentTimeMillis();
        // 接口开始执行时间
        Date startTime=new Date();
        //执行方法
        Object result = point.proceed();
        // 接口执行完成时间
        Date endTime=new Date();
        //执行时长(毫秒)
        //long time = System.currentTimeMillis() - beginTime;

        //保存日志
        saveSysLog(point,result,startTime,endTime);

        return result;
    }

    private void saveSysLog(ProceedingJoinPoint joinPoint, Object result,Date startTime,Date endTime) throws NoSuchMethodException {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();

        YwDataarkApiLog dto = new YwDataarkApiLog();
        AutoApiLog syslog = method.getAnnotation(AutoApiLog.class);
        if(syslog != null){
            //update-begin-author:taoyan date:
            // 调用接口编码
            String apiCode=syslog.apiCode();
            // 业务类型编码
            String businessCode=syslog.businessCode();
            // 业务类型名称
            String businessName=syslog.businessName();
            //注解上的描述,操作日志内容
            dto.setApiCode(apiCode);
            dto.setBusinessCode(businessCode);
            dto.setBusinessName(businessName);
        }
        // 获取请求参数
        JSONObject params=myAdvice(joinPoint);
        String paramsString=JSONObject.toJSONString(params);
        dto.setApiParam(paramsString);
        // 获取业务id
        String businessId=params.getString("businessId");
        dto.setBusinessId(businessId);
        try {
            //Object object=joinPoint.proceed();
            //获取方法返回值处理
            String objectString=JSONObject.toJSONString(result);
            dto.setApiReturn(objectString);
            log.info("返回值="+result);
            dto.setApiStatus(OperateConstant.FAIL);
            if(ObjectUtils.isNotEmpty(result) ){
                JSONObject res= JSON.parseObject(objectString);
                if("success".equals(res.getString("result"))){
                    dto.setApiStatus(OperateConstant.SUCCESS);
                }
            }
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
        //获取登录用户信息
        LoginUser sysUser = (LoginUser) SecurityUtils.getSubject().getPrincipal();
        if(sysUser!=null){
            dto.setSysOrgCode(sysUser.getOrgCode());
            dto.setCreateBy(sysUser.getUsername());
            dto.setUpdateBy(sysUser.getUsername());
        }
        dto.setStartTime(startTime);
        dto.setEndTime(endTime);
        //保存日志
        apiLogService.saveData(dto);
    }
    public JSONObject myAdvice(JoinPoint joinPoint)  {
        JSONObject json=new JSONObject();
        Object[] args = joinPoint.getArgs(); // 获取参数列表
        Method method = ((MethodSignature)joinPoint.getSignature()).getMethod(); // 获取目标方法
        Parameter[] parameters = method.getParameters(); // 获取方法的参数信息
        for (int i=0; i<args.length; i++) {
            String paramName = parameters[i].getName(); // 获取参数名
            log.info("参数名：" + paramName);
            log.info("参数值：" + args[i]);
            json.put(paramName,args[i]);
        }
        return json;
    }

}

}

3.业务方法调用

```java
package org.jeecg.modules.common.component;

import com.alibaba.fastjson.JSONObject;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.ObjectUtils;
import org.jeecg.common.tripartite.api.ITripartiteBaseAPI;
import org.jeecg.common.tripartite.vo.dataArk.MrsDatabaseSchemaVo;
import org.jeecg.common.tripartite.vo.dataArk.PrivilegesDwsGussdbParam;
import org.jeecg.common.tripartite.vo.dataArk.SyncLinkVo;
import org.jeecg.modules.common.config.DataArkConfig;
import org.jeecg.modules.dataark.aspect.annotation.AutoApiLog;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import java.util.ArrayList;
import java.util.List;

/**
 * 开发场景调用dataark接口日志记录
 */
@Component
@Slf4j
public class SceneApiComponent {

    @Resource
    public ITripartiteBaseAPI tripartiteBaseAPI;

    @AutoApiLog(apiCode="scene_empower_createWorkspaces",businessCode="scene_empower",businessName="场景授权")
    public JSONObject apiWorkspacesAdd(String businessId, String name, String desc) {
        // 具体实现逻辑
        return null;
    }
    



}
SpringMVC AOP和自定义注解实现日志管理
寻梦友的博客
08-08 1458
今天主要介绍“ AOP切面+自定义注解” 实现 日志管理功能。 很多应用场景中，对敏感、保密性高的表进行增删改查操作，或涉及金钱操作时，往往需要增加日志管理收集功能。在不修改原有功能方法基础上，可以使用“AOP切面+自定义注解”实现无感知的日志收集功能。【本人自己的见解，具体应用到什么场景，自己把控！！！】
SpringBoot+AOP+自定义注解，优雅实现日志记录
热门推荐
小学生波波
12-21 1万+
AOP切面编程+自定义注解，优雅记录系统日志
基于 Spring AOP + 自定义注解实现操作日志记录（附完整代码解析）
开往1982的博客
08-12 1068
Target(ElementType.METHOD) // 仅作用于方法@Retention(RetentionPolicy.RUNTIME) // 运行时保留，支持AOP反射解析// 用于描述操作（如"添加小区""删除用户"）作用：标记需要记录日志的方法，通过 value 配置操作描述。使用示例@LogAnnotation("添加小区信息")// ... 业务逻辑通过自定义注解 + Spring AOP，我们实现了低侵入、高复用无侵入。
Spring AOP + 自定义注解 实现公共字段的填充
人生如戏 全靠演技
04-02 802
Spring AOP + 自定义注解 实现公共字段的填充
利用【AOP+自定义注解】实现项目中【日志记录】
沐沐
12-07 549
项目中的操作日志记录,通过AOP技术配合自定义注解方式实现
Spring AOP + 自定义注解
qq_52066082的博客
03-19 1453
Spring AOP（面向切面编程）是Spring框架的一个重要模块，用于通过在运行时动态地织入到现有的类中，实现横切关注点的功能。横切关注点是那些会影响多个模块的功能，如日志、事务管理、安全性等。Spring AOP提供了一种方便的方式来实现横切关注点的功能，而无需修改目标对象的源代码。他通过代理机制，在目标对象的方法执行前、执行后或发生异常时插入额外的逻辑，从而实现注入性能监控、事务管理、日志记录等功能。这样可以避免在每个需要这些功能的方法中都编写重复的代码，提高了代码的重用性和可维护性。
若依框架使用springboot+AOP+自定义注解+反射实现操作日志记录修改前后数据，并保存至数据库日志表中
kay523393的博客
11-22 1952
若依框架使用springboot+AOP+自定义注解+反射实现操作日志记录修改前后数据，并保存至数据库日志表中
SpringBoot用AOP+自定义注解实现操作日志写入数据库
ww_run的博客
01-16 1845
SpringBoot用AOP+自定义注解实现日志写入数据库前言一、操作日志业务处理二、自定义注解1.了解自定义注解2.编写自定义注解二、AOP切面1.了解AOP切面1.编写日志切面类三、操作日志写入数据库(使用自定义注解) 前言 主要以将用户操作日志写入数据库的例子简单记录AOP结合自定义注解的运用 一、操作日志业务处理 根据数据库日志表和具体业务要求,写好操作日志实体类和操作日志业务层处理逻辑类OperationLogService 二、自定义注解 1.了解自定义注解 (1) 自定义注解使用@i
SpringBoot系列：通过AOP+注解优雅实现操作日志记录
weixin_73588491的博客
07-16 1万+
在企业应用开发中，操作日志记录是确保系统安全性、可追溯性以及调试分析的重要手段之一。通过记录用户的操作行为，不仅可以帮助开发者快速定位问题，还能满足审计和合规需求。本文旨在探讨如何在SpringBoot应用程序中通过AOP（面向切面编程）和自定义注解实现操作日志记录，并将日志存储到数据库中。我们将详细介绍实现这一功能的完整流程，包括项目环境搭建、数据库设计、代码实现及测试验证等步骤。操作日志在企业应用中扮演着至关重要的角色。
自定义注解+AOP实现日志记录
Demo的博客
04-21 582
记录日志：记录业务人员的操作日志【删除数据、修改数据、新增操作...】
Java ArrayList和线性表
最新发布
Harrybili的博客
12-22 627
在集合框架中，ArrayList是一个普通的类，实现了List接口，具体框架图如下说明是以泛型方式实现的，使用时必须要先实例化实现了接口，表明ArrayList支持随机访问实现了Cloneable接口，表明ArrayList是可以clone的实现了接口，表明ArrayList是支持序列化的5.和Vector不同，ArrayList不是线程安全的，在单线程下可以使用，在多线程中可以选择Vector或者CopyOnWriteArrayList。
MyBatis-Plus 单元测试中 Lambda Mock 的坑与解决
qq_43657722的博客
12-17 1256
本文总结了 MyBatis-Plus 在单元测试中使用 LambdaWrapper 时常见的 Lambda 缓存异常问题，分析其根源在于 Mock 环境缺失真实上下文。通过精简示例说明为何 any(LambdaWrapper.class) 易出错，并给出使用 any() 的稳定解决方案，强调单元测试应聚焦业务逻辑、避免过度关注 SQL 与 Lambda 细节。
Windows安装Maven
heqilai1的博客
12-17 252
Maven是一个基于POM模型的项目管理和构建自动化工具，其核心是通过一份配置文件，实现依赖管理和标准化的构建流程。对于Java开发者而言，Maven不是一个可选项，而是一个基础设施。它极大地降低了项目管理的复杂度，让开发者可以更专注于编写代码，而不是浪费时间在“搭建环境”和“寻找Jar包”上，Maven因其稳定、成熟和广泛的应用，至今仍是Java生态系统中最主流的构建工具。二、下载Maven https://maven.apache.org/download.cgi。至此Maven安装配置完成 😊😊。
JAVA设计模式之观察者模式
pingguocu3的博客
12-17 400
在我们开发的过程中，经常会遇到一些当什么什么事情发生的时候，然后做什么什么事。比如某种商品的物价上涨时会导致部分商家高兴，而消费者伤心。平台声明：文章内容（如有图片或视频亦包括在内）由作者上传并发布，文章内容仅代表作者本人观点，简书系信息发布平台，仅提供信息存储服务。著作权归作者所有,转载或内容合作请联系作者。
使用idea启动一个springboot项目
qq_51389137的博客
12-19 1615
5.装配置maven配置到idea下载项目依赖。4.装navicat。
【信创】中间件对比
zkw54334的博客
12-17 1815
中间件并非“是否替换”的问题，而是**“如何在稳定、成本、可控之间取得最优解”**。在信创背景下，国产中间件已从“可用”迈向“好用”，未来的关键在于规模化落地、生态成熟与工程经验积累。
计算一个字符串在另一个字符串中出现次数
沉下心,苦磨炼
12-21 139
【代码】计算一个字符串在另一个字符串中出现次数。
【FastAPI】FastAPI依赖注入完全指南
weixin_63434398的博客
12-18 3023
本文全面介绍FastAPI的依赖注入机制，主要包含两大注入方式：原生自动注入和Depends自定义注入。原生注入支持Request/Response等框架对象以及路径/查询参数等自动解析，而Depends则用于自定义依赖项注入。文章详细讲解依赖注入的核心思想、实现方式、生命周期管理、高级技巧，并通过完整认证系统案例展示实战应用。最后剖析Depends底层原理，并与Spring框架进行对比，帮助开发者彻底掌握FastAPI这一核心特性，实现代码解耦和高效开发。
基于Java TCP 聊天室
suny8的专栏
12-22 826
这是一个基于TCP协议的Java多人聊天室系统，支持多个客户端实时聊天、查看在线用户等功能。系统采用C/S架构，使用Java Socket编程实现。这个Java TCP聊天室项目是一个完整的网络应用程序，涵盖了从底层网络通信到上层用户界面的全栈开发。它不仅实现了基本的聊天功能，还扩展了用户服务管理，具有良好的可扩展性和实用性。通过这个项目，开发者可以：深入理解网络编程原理掌握Java并发编程技巧学习GUI设计和事件处理实践软件工程的设计思想培养解决实际问题的能力。
aop+自定义注解实现tcp传输
07-03
### 通过AOP结合自定义注解实现TCP数据传输功能 在Java中，AOP（面向切面编程）通常用于将横切关注点（如日志记录、事务管理、安全控制等）与业务逻辑分离。对于TCP数据传输这样的场景，可以利用Spring AOP和自定义注解来封装网络通信的细节，使得业务代码更加简洁，并提高可维护性。 #### 1. 自定义注解设计 首先，定义一个自定义注解，用于标记需要进行TCP传输的方法。该注解可以包含一些配置参数，例如目标主机、端口、超时时间等。 ```java @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface TcpTransmission { String host() default "localhost"; int port() default 8080; int timeout() default 5000; } ``` #### 2. 实现TCP客户端逻辑 接下来，编写一个基于`Socket`的TCP客户端类，用于处理实际的数据发送和接收。这个类可以通过依赖注入的方式被AOP切面所使用。 ```java @Component public class TcpClient { public String sendData(String host, int port, String message, int timeout) throws IOException { try (Socket socket = new Socket()) { socket.connect(new InetSocketAddress(host, port), timeout); socket.setSoTimeout(timeout); // 发送数据 OutputStream out = socket.getOutputStream(); out.write(message.getBytes(StandardCharsets.UTF_8)); out.flush(); // 接收响应 InputStream in = socket.getInputStream(); byte[] buffer = new byte[1024]; int bytesRead = in.read(buffer); return new String(buffer, 0, bytesRead, StandardCharsets.UTF_8); } } } ``` #### 3. 编写AOP切面 然后，创建一个切面类，用于拦截带有`@TcpTransmission`注解的方法，并在其执行前后插入TCP传输逻辑。可以通过获取注解中的参数来动态设置连接信息。 ```java @Aspect @Component public class TcpTransmissionAspect { @Autowired private TcpClient tcpClient; @Around("@annotation(tcpTransmission)") public Object handleTcpTransmission(ProceedingJoinPoint joinPoint, TcpTransmission tcpTransmission) throws Throwable { MethodSignature signature = (MethodSignature) joinPoint.getSignature(); Method method = signature.getMethod(); // 获取方法参数 Object[] args = joinPoint.getArgs(); // 构建请求内容（可以根据业务需求定制） String requestMessage = buildRequestMessage(method, args); // 执行TCP传输 String response = tcpClient.sendData(tcpTransmission.host(), tcpTransmission.port(), requestMessage, tcpTransmission.timeout()); // 解析响应并返回结果（根据实际情况处理） return parseResponse(response); } private String buildRequestMessage(Method method, Object[] args) { // 可以使用JSON序列化等方式构建请求体 StringBuilder sb = new StringBuilder(); sb.append("Method: ").append(method.getName()).append("\n"); for (int i = 0; i < args.length; i++) { sb.append("Arg[").append(i).append("]: ").append(args[i].toString()).append("\n"); } return sb.toString(); } private Object parseResponse(String response) { // 根据响应格式解析为特定对象或直接返回字符串 return response; } } ``` #### 4. 在业务方法上使用自定义注解 最后，在需要进行TCP传输的业务方法上添加`@TcpTransmission`注解，并指定相关参数。 ```java @Service public class BusinessService { @TcpTransmission(host = "192.168.1.100", port = 9090, timeout = 3000) public String performRemoteOperation(String param1, int param2) { // 这里可以不实际执行任何本地操作，而是通过AOP触发远程调用 return null; // 返回值由AOP切面处理 } } ``` #### 5. 配置Spring AOP支持 确保你的Spring Boot项目已经启用了AOP支持。通常情况下，只需引入以下依赖即可自动启用： ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency> ``` #### 6. 测试与验证 启动应用后，调用`BusinessService#performRemoteOperation`方法，观察是否能够正确地通过TCP协议向指定的目标发送请求并接收响应。 --- ###
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值