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

介绍

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

此文章介绍的是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

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

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

灯串上亚马逊加拿大合规标准CSA认证如何办理？

灯串上亚马逊加拿大合规标准CSA认证如何办理？

灯串 灯串和配件都是插头连接的便携式、临时性商品&#xff0c;最大额定输入电压为 120 伏。 本政策适用于季节性照明、装饰性灯具以及灯串。 亚马逊灯串政策 根据亚马逊的要求&#xff0c;所有季节性和装饰性灯串均应经过检测&#xff0c;并且遵守下列法规、标准和要求&…
阅读更多...
LabVIEW应用开发——基本函数(一)

LabVIEW应用开发——基本函数(一)

前面我们介绍了一些控件的介绍和属性的配置&#xff0c;想要完成一个软件只会拖控件肯定是不行的&#xff0c;没办法实现既有的功能。比如我们要实现从串口中读到数据&#xff0c;根据一定的协议解析&#xff0c;然后转换成各个参数的值的显示&#xff0c;包括时间、电压、电流…
阅读更多...
VIVO应用商店评论数据抓取

VIVO应用商店评论数据抓取

VIVO应用商店的app评论数据抓取 每个应用的评论能获取到最新的 100页 数据 每页20条&#xff0c;也就是 2000条评论数据 接口&#xff1a; pl.appstore.vivo.com.cn/port/comments/ 爬取运行截图&#xff1a;
阅读更多...
Win10系统 如何使用cmd脚本命令，连接到指定WIFI并免手工输入WIFI密码连接？

Win10系统 如何使用cmd脚本命令，连接到指定WIFI并免手工输入WIFI密码连接？

环境&#xff1a; Win10 专业版 19041 WiFi 名称&#xff1a;LTG 问题描述&#xff1a; Win10系统 如何使用cmd脚本命令&#xff0c;连接到指定WIFI并免手工输入WIFI密码连接&#xff1f; 解决方案&#xff1a; 1.找一台已经连接过LTG这个wifi的电脑&#xff0c;导出.xlm配…
阅读更多...
Octave Convolution学习笔记 （附代码）

Octave Convolution学习笔记 （附代码）

论文地址&#xff1a;https://export.arxiv.org/pdf/1904.05049 代码地址&#xff1a;https://gitcode.com/mirrors/lxtgh/octaveconv_pytorch/overview?utm_sourcecsdn_github_accelerator 1.是什么&#xff1f; OctaveNet网络属于paper《Drop an Octave: Reducing Spatia…
阅读更多...
系列四、Springboot中使用DevTools

系列四、Springboot中使用DevTools

一、概述 日常开发中&#xff0c;修改了一个类的很小一部分&#xff0c;例如HelloService中有这样的一个方法listAllCity()&#xff0c;代码如下&#xff1a; Service public class HelloService {public List<String> listAllCity() {List<String> cities Arrays…
阅读更多...
第一次使用配音软件要怎么选择？

第一次使用配音软件要怎么选择？

现在的配音软件软件很多&#xff0c;各种类型的都比较多&#xff0c;对于新手小白来说不知该如何选择&#xff0c;今天就来给你分享几款好用的配音软件。不论是制作短视频还是制作平常音频都完全可以。第一款&#xff1a;悦音配音这是一款专业的视频配音软件&#xff0c;多端使…
阅读更多...
轻量级gif制作工具 GIFfun中文 for mac

轻量级gif制作工具 GIFfun中文 for mac

GIFfun是一款GIF制作工具&#xff0c;可以帮助用户从照片和视频中创建GIF动画。该软件具有多种功能&#xff0c;例如GIF转视频、视频转GIF、照片转GIF、照片转视频、GIF转JPG、调整GIF大小、PDF转GIF、PDF转JPG、裁剪视频、GIF编辑等。 GIFfun还提供了专业版功能&#xff0c;如…
阅读更多...
Unity 粒子特效-第三集-星星闪烁特效

Unity 粒子特效-第三集-星星闪烁特效

一、特效预览 二、制作原理 星星素材资源 链接&#xff1a;https://pan.baidu.com/s/17D-9sC-ErtqmUxl81Ln1Mw?pwdndm9 提取码&#xff1a;ndm9 1.素材介绍 仔细看&#xff0c;我们的粒子贴图是&#xff08;如下&#xff09;&#xff0c;一颗星星 2.步骤介绍 1.星星动画的…
阅读更多...
微信小程序 - 页面继承（非完美解决方案）

微信小程序 - 页面继承（非完美解决方案）

微信小程序 - 面页继承&#xff08;非完美解决方案&#xff09; 废话思路首页 indexindex.jsindex.jsonindex.wxml 父页面 page-basepage-base.jspage-base.wxml 子页面 page-apage-a.jspage-a.wxml 子页面 page-bpage-b.jspage-b.wxml 其它app.jsapp.jsonapp.wxss 参考资料 废…
阅读更多...
靶机DC系列 DC:1

靶机DC系列 DC:1

DC:1 文章目录 DC:1信息收集端口IP信息网页信息 漏洞利用shell提权 信息收集 端口IP信息 使用arp-scan获得靶机ip 使用nmap对端口进行详细扫描 可以看到该目标机开放了三个端口 有ssh、http、rpcbind服务 其中rpcbind是拥有该漏洞可使攻击者在远程rpcbind绑定主机上分配任意…
阅读更多...
信道数据传输速率、信号传播速度——参考《天勤计算机网络》

信道数据传输速率、信号传播速度——参考《天勤计算机网络》

一、缘起题目 二、解析 三、总结 信道数据传输速率和信号传播速度是两个不同的概念。 3.1 信道数据传输速率&#xff08;Channel Data Transfer Rate&#xff09; 指的是在通信系统中&#xff0c;通过信道传输的数据量&#xff0c;通常以 比特率&#xff08;bits per second…
阅读更多...
第19章_写在最后

第19章_写在最后

第19章_写在最后 分享1 分享2 如何看待生活上、工作上的冗余、反冗余&#xff1f; 又如何看待社会的脆弱性&#xff1f;反脆弱性&#xff1f; 个人如何应对&#xff1f;
阅读更多...
[Linux]线程池

[Linux]线程池

[Linux]线程池 文章目录 [Linux]线程池线程池的概念线程池的优点线程池的应用场景线程池的实现 线程池的概念 线程池是一种线程使用模式。线程池是一种特殊的生产消费模型&#xff0c;用户作为生产者&#xff0c;线程池作为消费者和缓冲区。 线程过多会带来调度开销&#xff0c…
阅读更多...
ElasticSearch深度解析入门篇：高效搜索解决方案的介绍与实战案例讲解，带你避坑

ElasticSearch深度解析入门篇：高效搜索解决方案的介绍与实战案例讲解，带你避坑

ElasticSearch深度解析入门篇&#xff1a;高效搜索解决方案的介绍与实战案例讲解&#xff0c;带你避坑 1.Elasticsearch 产生背景 大规模数据如何检索 如&#xff1a;当系统数据量上了 10 亿、100 亿条的时候&#xff0c;我们在做系统架构的时候通常会从以下角度去考虑问题&a…
阅读更多...
Android问题笔记四十三：JNI 开发如何快速定位崩溃问题

Android问题笔记四十三：JNI 开发如何快速定位崩溃问题

点击跳转>Unity3D特效百例点击跳转>案例项目实战源码点击跳转>游戏脚本-辅助自动化点击跳转>Android控件全解手册点击跳转>Scratch编程案例点击跳转>软考全系列 &#x1f449;关于作者 专注于Android/Unity和各种游戏开发技巧&#xff0c;以及各种资源分享&…
阅读更多...
【c++|opencv】二、灰度变换和空间滤波---2.直方图和均衡化

【c++|opencv】二、灰度变换和空间滤波---2.直方图和均衡化

every blog every motto: You can do more than you think. https://blog.csdn.net/weixin_39190382?typeblog 0. 前言 图像直方图、直方图均衡化 1. 图像直方图 #include <iostream> #include <opencv2/opencv.hpp>using namespace cv; using namespace std;…
阅读更多...
Django之登录注册

Django之登录注册

最近在准备上线一个网站&#xff08;基于django的编程技术学习与外包服务网站&#xff09;&#xff0c;所以会将自己的在做这个项目的过程中遇到的模块业务以及所涉及到的部分技术记录在CSDN平台里&#xff0c;一是希望可以帮到有需要的同学&#xff0c;二十以供自己后续回顾学…
阅读更多...
玩转ChatGPT：批量下载Alphafold的蛋白pdb文件

玩转ChatGPT：批量下载Alphafold的蛋白pdb文件

一、写在前面 突发奇想&#xff0c;想批量下载Alphafold网站的蛋白pdb文件&#xff0c;后续再做个分子对接用。又不想手动下载&#xff0c;来求助CSDN和GPT。 二、CSDN白嫖基础代码 CSDN大神多&#xff0c;这不&#xff0c;找到一个&#xff1a;Alphafold批量下载蛋白的pdb文…
阅读更多...
Flutter PopupMenuButton下拉菜单

Flutter PopupMenuButton下拉菜单

下拉菜单是移动应用交互中一种常见的交互方式，可以使用下拉列表来展示多个内容标签，实现页面引导的作用。在Flutter开发中，实现下拉弹框主要有两种方式，一种是继承Dialog组件使用自定义布局的方式实现，另一种则是使用官方的PopupMenuButton组件进行实现。 如果没有特殊的…
阅读更多...
最新文章

Copyright @ 2022~2023