SpringBoot通过注解形式实现系统操作日志

news2024/11/14 16:29:35

介绍

我们在日常开发工作中，肯定逃不开与日志接触，一些比较严谨的后台管理系统里面会涉及到一些比较重要的资料，有些公司为了知道有哪些人登录了系统，是谁在什么时候修改了用户信息或者资料，所以就有了操作日志这么个需求。

此文章介绍的是SpringBoot下如何通过注解的形式实现操作日志，仅供学习参考，不喜勿喷。

具体实现

pom依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        
        <!--aspectj依赖-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aspects</artifactId>
            <version>5.2.25.RELEASE</version>
        </dependency>

        <!--swagger依赖-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.8.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.8.0</version>
        </dependency>

        <!--工具依赖-->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.9</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>2.0.32</version>
        </dependency>

代码实现

  • 系统日志注解
/**
* 系统日志注解
*
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SysOperateLog {

   //用户操作
   String value();
   //保存入参
   boolean isSaveParams() default true;
   //保存返回结果
   boolean isSaveResult() default false;
   //异常信息
   boolean isRecordError() default false;
   //忽略属性
   String [] ignoreFields() default {};

}
  • 切面处理类
/**
* 系统日志，切面处理类
*/
@Component
@Aspect
public class SysLogAspect {
   private static final Logger logger = LoggerFactory.getLogger(SysLogAspect.class);

   @Resource
   private SysLogService sysLogService;

   // 定义切点,被@SysOperateLog注解标注的方法作为切点
   @Pointcut("@annotation(com.ou.common.annotation.SysOperateLog)")
   public void logPointCut() {

   }

   @Around("logPointCut()")
   public Object around(ProceedingJoinPoint point) throws Throwable {
       long beginTime = System.currentTimeMillis();
       //执行方法
       Object result = null;
       try {
           result = point.proceed();
       } catch (Throwable throwable) {
           //异常日志记录
           MethodSignature signature = (MethodSignature) point.getSignature();
           Method method = signature.getMethod();
           SysOperateLog syslog = method.getAnnotation(SysOperateLog.class);
           if(syslog != null && syslog.isRecordError()){
               //执行时长(毫秒)
               long time = System.currentTimeMillis() - beginTime;
               result = "异常返回，" + throwable.getMessage();

               sysLogService.aopTransactionalSysLog(point,"error!!", time);

           }

           throw  throwable;
       }
       //执行时长(毫秒)
       long time = System.currentTimeMillis() - beginTime;

       //保存日志
       sysLogService.aopSysLog(point,result, time);

       return result;
   }
   
}
  • 过滤器
public class FastJsonByteArrayValueFilter implements ValueFilter {
   public FastJsonByteArrayValueFilter() {
   }

   public Object process(Object object, String name, Object value) {
       try {
           if (value == null) {
               return value;
           }

           Field declaredField = object.getClass().getDeclaredField(name);
           Class<?> type = declaredField.getType();
           if (type.toString().equals("class [B")) {
               return null;
           }
       } catch (NoSuchFieldException var6) {
       }

       return value;
   }
}
  • 日志实体类
/**
 * 系统操作日志实体类
 */
@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@ApiModel(value = "SysLog对象", description = "系统操作日志")
public class SysLog implements Serializable {

    private static final long serialVersionUID = 1L;

    @ApiModelProperty(value = "日志主键ID")
    private String id;

    @ApiModelProperty(value = "用户ID")
    private String userId;

    private String userName;

    @ApiModelProperty(value = "用户操作")
    private String operation;

    @ApiModelProperty(value = "请求方法")
    private String method;

    private String params;

    private String result;

    @ApiModelProperty(value = "执行时长")
    private Long time;

    @ApiModelProperty(value = "IP地址")
    private String ip;

    @ApiModelProperty(value = "逻辑删除标志，0：正常，1：删除")
    private Integer delFlag;

    @ApiModelProperty(value = "创建人")
    private String createUser;

    @ApiModelProperty(value = "创建时间")
    private Date createTime;

    @ApiModelProperty(value = "更新人")
    private String updateUser;

    @ApiModelProperty(value = "更新时间")
    private Date updateTime;


}
  • 业务层接口
/**
* 系统操作日志
*/
public interface SysLogService{

   void aopTransactionalSysLog(ProceedingJoinPoint joinPoint, Object result, long time);

   void aopSysLog(ProceedingJoinPoint joinPoint, Object result, long time);
}
  • 业务层实现类
/**
* 系统操作日志 服务实现类
*/
@Service
public class SysLogServiceImpl implements SysLogService {

   private static final Logger logger = LoggerFactory.getLogger(SysLogServiceImpl.class);
   //MediumText
   private static final int MAX_BTYE_LENGTH = 16777215;



   //@Transactional(propagation = Propagation.REQUIRES_NEW,rollbackFor = Exception.class)
   @Override
   public void aopTransactionalSysLog(ProceedingJoinPoint joinPoint, Object result, long time){
   	aopSysLog(joinPoint,result,time);
   }

   /**
    * ProceedingJoinPoint继承了JoinPoint
    * JoinPoint.getSignature() = 获取到了方法的【修饰符 + 包名 + 组件名(类名) +方法】
    */
   @Override
   public void aopSysLog(ProceedingJoinPoint joinPoint, Object result, long time) {
   	MethodSignature signature = (MethodSignature) joinPoint.getSignature();
   	Method method = signature.getMethod();
   	SysLog sysLog = new SysLog();
   	//这里我是用UUID来模仿ID，可自行设置
   	//sysLog.setId(UUIDCreater.create());
   	SysOperateLog sysOperateLog = method.getAnnotation(SysOperateLog.class);
   	boolean isSaveResult = false;
   	boolean isSaveParams = false;
   	if(sysOperateLog != null){
   		//注解上的描述
   		sysLog.setOperation(sysOperateLog.value());
   		isSaveResult = sysOperateLog.isSaveResult();
   		isSaveParams = sysOperateLog.isSaveParams();
   	}

   	//请求的方法名
   	String className = joinPoint.getTarget().getClass().getName();
   	String methodName = signature.getName();
   	String[] parameterNames = signature.getParameterNames();
   	// 设置 com.ou.controller.SysLogController.testParam(map)
   	sysLog.setMethod(className + "." + methodName + "("+ StringUtils.join(parameterNames,",")+")");


   	try{
   		//保存参数信息
   		if(isSaveParams){
   			Object[] args = joinPoint.getArgs();
   			StringBuffer params = new StringBuffer();
   			for(int i = 0 ; i < args.length; i++){
   				if(args[i] instanceof ServletResponse){
   					continue;
   				}else if(args[i] instanceof Class){
   					continue;
   				}else  if(args[i] instanceof byte[]){
   					continue;
   				} else  if(args[i] instanceof ServletRequest){
   					ServletRequest request = (ServletRequest)args[i];
   					params.append(JSON.toJSONString(request.getParameterMap()));
   				}
   				else {
   					Object json = JSON.toJSON(args[i]);
   					String jsonString = JSON.toJSONString(json, new ValueFilter[]{new FastJsonByteArrayValueFilter()});
   					params.append(jsonString);
   				}


   				if(i < args.length - 1){
   					params.append("; ");
   				}
   			}
   			byte[] paramsBytes = params.toString().getBytes();
   			if(paramsBytes.length > MAX_BTYE_LENGTH){
   				byte[] subBytes = new byte[MAX_BTYE_LENGTH];
   				System.arraycopy(paramsBytes, 0, subBytes, 0, MAX_BTYE_LENGTH);
   				sysLog.setParams(new String(subBytes));
   			}else{
   				sysLog.setParams(params.toString());
   			}

   		}


   		//保存返回结果
   		if(isSaveResult && result != null){
   			Object json = JSON.toJSON(result);

   			String[] ignoreFields = sysOperateLog.ignoreFields();
   			if(ignoreFields.length > 0){
   				if(json instanceof JSONObject){
   					JSONObject jsonObject = (JSONObject) json;
   					for(String field : ignoreFields){
   						jsonObject.remove(field);
   					}
   				}else if(json instanceof JSONArray){
   					JSONArray jsonArray = (JSONArray) json;
   					for(Object obj : jsonArray){
   						if(obj instanceof JSONObject){
   							JSONObject jsonObject = (JSONObject) obj;
   							for(String field : ignoreFields){
   								jsonObject.remove(field);
   							}
   						}
   					}
   				}

   			}

   			String transferResult = JSON.toJSONString(json, new ValueFilter[]{new FastJsonByteArrayValueFilter()});
   			byte[] transferResultBytes = transferResult.toString().getBytes();
   			if(transferResultBytes.length > MAX_BTYE_LENGTH){
   				byte[] subBytes = new byte[MAX_BTYE_LENGTH];
   				System.arraycopy(transferResultBytes, 0, subBytes, 0, MAX_BTYE_LENGTH);
   				sysLog.setResult(new String(subBytes));
   			}else{
   				sysLog.setResult(transferResult);
   			}
   		}

   		try {
   			//获取request
   			HttpServletRequest request = HttpContextUtils.getHttpServletRequest();
   			//设置IP地址
   			sysLog.setIp(IPUtils.getIpAddr(request));
   		} catch (Exception e) {
   		}

   		sysLog.setTime(time);
   		//保存系统日志--这里是打印
   		logger.info("系统日志:{}",JSONObject.toJSONString(sysLog));
   	}catch (Exception e){
   		logger.error("系统日志记录失败：",e);
   	}

   }
}
  • 工具类
public class HttpContextUtils {

   public static HttpServletRequest getHttpServletRequest() {
   	return ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
   }
}

/**
* 获取IP地址的工具类
*/
public class IPUtils {
   private static Logger logger = LoggerFactory.getLogger(IPUtils.class);

   /**
    * 获取IP地址
    */
   public static String getIpAddr(HttpServletRequest request) {
   	String ip = null;
       try {
           ip = request.getHeader("x-forwarded-for");
           if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
               ip = request.getHeader("Proxy-Client-IP");
           }
           if (StringUtils.isEmpty(ip) || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
               ip = request.getHeader("WL-Proxy-Client-IP");
           }
           if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
               ip = request.getHeader("HTTP_CLIENT_IP");
           }
           if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
               ip = request.getHeader("HTTP_X_FORWARDED_FOR");
           }
           if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
               ip = request.getRemoteAddr();
           }
       } catch (Exception e) {
       	logger.error("IPUtils ERROR ", e);
       }
       return ip;
   }
   
}
  • Controller接口

@RestController
@RequestMapping("/sys/log")
public class SysLogController {
   /**
    * 触发操作日志
    */
   @SysOperateLog("触发-操作日志接口-不带参数")
   @RequestMapping("/test")
   public String test() {
       return "OK";
   }

   /**
    * 触发操作日志
    */
   @SysOperateLog("触发-操作日志接口-带参数")
   @RequestMapping("/testParam")
   public String testParam(@RequestBody Map map) {
      return "OK";
   }
}

测试

在这里插入图片描述
控制台输出：

 系统日志:{"id":"9e088286efe64183aa5992f30a8aa34b","ip":"127.0.0.1","method":"com.ou.controller.SysLogController.testParam(map)","operation":"触发-操作日志接口-带参数","params":"{\"sex\":\"男\",\"name\":\"张三\",\"age\":18,\"desc\":\"描述啊啊啊\"}","time":10}

我这里是直接输出日志，具体怎么存库还是由各自的业务来进行修改。

--------END

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1153167.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

MySQL 基础学习笔记（一）

MySQL 基础学习笔记（一）

目录 1 SQL简介2 MySQL基本语法2.1 语法规则2.2 数据类型 3 DDL3.1 操作数据库3.2 操作表 4 DML4.1 添加数据4.2 修改数据4.3 删除数据 5 DQL5.1 基础查询5.2 条件查询5.3 排序查询5.4 聚合查询5.5 分组查询5.6 分页查询 1 SQL简介 SQL &#xff1a;Structured Query Language&…
阅读更多...
基于 MySQL 多通道主主复制的机房容灾方案

基于 MySQL 多通道主主复制的机房容灾方案

文章中介绍了多种 MySQL 高可用技术&#xff0c;并介绍了根据自身需求选择多通道主主复制技术的过程和注意事项。 作者&#xff1a;徐良&#xff0c;现任中国移动智慧家庭运营中心数据库高级经理&#xff0c;多年数据库运维优化经验&#xff0c;历任华为、一线互联网公司高级 D…
阅读更多...
使用Nokogiri和OpenURI库进行HTTP爬虫

使用Nokogiri和OpenURI库进行HTTP爬虫

目录 一、Nokogiri库 二、OpenURI库 三、结合Nokogiri和OpenURI进行爬虫编程 四、高级爬虫编程 1、并发爬取 2、错误处理和异常处理 3、深度爬取 总结 在当今的数字化时代&#xff0c;网络爬虫已经成为收集和处理大量信息的重要工具。其中&#xff0c;Nokogiri和OpenUR…
阅读更多...
softmax的高效CUDA编程和oneflow实现初步解析

softmax的高效CUDA编程和oneflow实现初步解析

本文参考了添加链接描述，其中oneflow实现softmax的CUDA编程源代码参考链接添加链接描述 关于softmax的解读以及CUDA代码实现可以参考本人之前编写的几篇文章添加链接描述，添加链接描述，添加链接描述 下面这个图片是之前本人实现的softmax.cu经过接入python接口，最终和pytor…
阅读更多...
Javascript基础-BOM

Javascript基础-BOM

文章目录 BOM——Browser Object Model定时器--延时函数 JS执行机制具体流程 三个常见对象location对象navigator对象history对象 本地存储介绍sessionStoragesessionStorage 存储复杂数据类型字符串拼接 正则表达式元字符 BOM——Browser Object Model 浏览器对象模型&#x…
阅读更多...
【LeetCode:26. 删除有序数组中的重复项 | 双指针】

【LeetCode:26. 删除有序数组中的重复项 | 双指针】

&#x1f680; 算法题 &#x1f680; &#x1f332; 算法刷题专栏 | 面试必备算法 | 面试高频算法 &#x1f340; &#x1f332; 越难的东西,越要努力坚持&#xff0c;因为它具有很高的价值&#xff0c;算法就是这样✨ &#x1f332; 作者简介&#xff1a;硕风和炜&#xff0c;…
阅读更多...
怎么从外面远程访问服务器设备？

怎么从外面远程访问服务器设备？

怎么从外面远程访问服务器设备&#xff1f; “我家里有一台服务器设备&#xff0c;当我在学校时需要远程访问家里的服务器。请问是否可以从外网远程访问家里的服务器设备&#xff0c;有什么方法可以实现吗&#xff1f;” 远程访问服务器设备&#xff0c;一种典型…
阅读更多...
20量子比特！芬兰成功研发第二台量子计算机

20量子比特！芬兰成功研发第二台量子计算机

&#xff08;图片来源&#xff1a;网络&#xff09; 近期&#xff0c;芬兰国家技术研究中心&#xff08;VTT&#xff09;宣布&#xff0c;已顺利研发芬兰第二台量子计算机&#xff0c;该计算机具有20个超导量子比特&#xff0c;由芬兰国家技术研究中心&#xff08;VTT&#xf…
阅读更多...
java如何获取调用接口的ip?

java如何获取调用接口的ip?

获取调用者的ip 场景&#xff1a;想知道哪个ip访问的某个接口时&#xff0c;就需要打印出来看看&#xff0c;这时就可以使用这个方法了。 案例&#xff1a; //HttpServletRequest 入参加上,请求对象public ForkResponse queryXXX(RequestBody XXXX xxxx, HttpServletRequest …
阅读更多...
Ps：快速选择工具​

Ps：快速选择工具​

对那些有清晰轮廓的对象进行抠图&#xff0c;在 Ps 中传统的方法是钢笔工具和快速选择工具 Quick Selection Tool。其中&#xff0c;快速选择工具以其使用简单快捷而受到众人喜爱。 快捷键&#xff1a;W ◆ ◆ ◆ 常用操作方法与技巧 1、将快速选择工具的笔刷从目标对象的内部…
阅读更多...
用前端框架Bootstrap和Django实现用户注册页面

用前端框架Bootstrap和Django实现用户注册页面

01-新建一个名为“mall_backend”的Project 命令如下&#xff1a; CD E:\Python_project\P_001\myshop-test E: django-admin startproject mall_backend02-新建应用并注册应用 执行下面条命令依次创建需要的应用&#xff1a; CD E:\Python_project\P_001\myshop-test\mall…
阅读更多...
Nacos常规问题汇总

Nacos常规问题汇总

一、Nacos常规问题 Nacos是什么 Nacos 致力于帮助您发现、配置和管理微服务。Nacos 提供了一组简单易用的特性集&#xff0c;帮助您快速实现动态服务发现、服务配置、服务元数据及流量管理。详情可以参考Nacos官网介绍。 Nacos如何支持多环境 在日常使用中常常需要不同的环…
阅读更多...
“破解我！“---160个CrackMe练习002-Afkayas.1.Exe

“破解我！“---160个CrackMe练习002-Afkayas.1.Exe

文章目录 前言题目分析程序分析Keygen 前言 系列之002&#xff0c;记录学习。 题目分析 一道一星的题目 惯例查壳。 32-bit的文件&#xff0c;用的是 VB 写的。 关于Visual Basic&#xff1a; Visual Basic&#xff08;VB&#xff09;是由微软公司开发的包含环境的事件驱动…
阅读更多...
酒店预订订房小程序源码系统 带完整搭建教程

酒店预订订房小程序源码系统 带完整搭建教程

酒店预订订房小程序源码系统是一种基于互联网技术的线上预订平台&#xff0c;旨在为用户提供方便快捷的酒店预订服务。该系统通常包括前端用户界面、后端服务器和数据库三个部分&#xff0c;其中前端界面主要展示酒店信息、订房需求信息、订单信息等&#xff0c;后端服务器负责…
阅读更多...
国风AI绘画平台Trik；「一个女孩的一生」走红；音视频转文字的精准处理指南；神经网络原理动画 | ShowMeAI日报

国风AI绘画平台Trik；「一个女孩的一生」走红；音视频转文字的精准处理指南；神经网络原理动画 | ShowMeAI日报

&#x1f440;日报&周刊合集 | &#x1f3a1;生产力工具与行业应用大全 | &#x1f9e1; 点赞关注评论拜托啦&#xff01; &#x1f251; 智谱AI推出第三代基座大模型ChatGLM3&#xff0c;瞄向了 GPT-4V https://github.com/THUDM/ChatGLM3 10月27日&#xff0c;智谱AI宣布…
阅读更多...
EVM6678L 开发教程: 烧写 IBL(Intermediate Bootloader)

EVM6678L 开发教程: 烧写 IBL(Intermediate Bootloader)

目录 EVM6678L 开发教程: 烧写 IBL烧写出厂IBL修改IBL引导格式 EVM6678L 开发教程: 烧写 IBL 参考: C:\ti\mcsdk_2_01_02_06\tools\boot_loader\ibl\doc\README.txtC:\ti\mcsdk_2_01_02_06\tools\boot_loader\ibl\doc\evmc6678-instructions.txtC:\ti\mcsdk_2_01_02_06\tools…
阅读更多...
js 异常数组 [空白，Array(10)，空白，Array(10)，空白]

js 异常数组 [空白，Array(10)，空白，Array(10)，空白]

异常数组 [空白&#xff0c;Array(10)&#xff0c;空白&#xff0c;Array(10)&#xff0c;空白] 的解决方案
阅读更多...
Elasticsearch（二）---搭建

Elasticsearch（二）---搭建

搭建es 不允许root用于运行 创建esuser用户&#xff1a; useradd esuser 设置密码 passwd esuser 让esuser拥有sudo的权限&#xff0c;需要修改/etc/sudoers文件 需要先给/etc/sudoers添加写的权限 [rootnode1 ~]# vim /etc/sudoers 改完之后将写权限删除 三台服务器上操…
阅读更多...
halcon canny 和opencv c++ canny 实现对比

halcon canny 和opencv c++ canny 实现对比

Opencv和C实现canny边缘检测_opencv边缘增强-CSDN博客 一、canny实现步骤 1、图像必须是单通道的&#xff0c;也就是说必须是灰度图像 2、图像进行高斯滤波&#xff0c;去掉噪点 3、sobel 算子过程的实现&#xff0c;计算x y方向 、梯度&#xff08;用不到&#xff0c;但是…
阅读更多...
如何选购适合自己的内衣洗衣机？性价比高内衣洗衣机推荐

如何选购适合自己的内衣洗衣机？性价比高内衣洗衣机推荐

内衣洗衣机&#xff0c;在几年前或许是个新事物&#xff0c;但近两年却是成为了很普遍的家电产品&#xff0c;由于近几年内衣洗衣机需求量的增加&#xff0c;我们在商场的电子产品区都能见到它&#xff0c;就像普通的家庭洗衣机那样&#xff0c;直接摆在展台上销售&#xff0c;…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023