springboot利用切面保存操作日志（支持Spring表达式语言（简称SpEL））

2024-05-09 11:12
文章标签 java 语言 日志 springboot 保存 操作 spring 支持 表达式 切面 简称 spel

本文主要是介绍springboot利用切面保存操作日志（支持Spring表达式语言（简称SpEL）），希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

springboot利用切面保存操作日志（支持Spring表达式语言（简称SpEL））

文章目录

  • springboot利用切面保存操作日志（支持Spring表达式语言（简称SpEL））
  • 前言
  • 一、Spring EL是什么？
  • 二、使用步骤
    • 1.定义日志实体类LogRecord
    • 2.定义日志记录注解LogSnipper
    • 3.定义上下文容器SnipperContext
    • 4.实现切面
    • 5.定义日志模板解析器LogTplParser
    • 6.定义业务代码

前言

在注解中使用Spring EL表达式，切面解析实现自定义操作日志。
在这里插入图片描述

一、Spring EL是什么？

Spring表达式语言（简称SpEL）是一个支持查询并在运行时操纵一个对象图的功能强大的表达式语言。SpEL语言的语法类似于统一EL，但提供了更多的功能，最主要的是显式方法调用和基本字符串模板函数。参考：SpringEL 表达式语言（Spring Expression Language）

二、使用步骤

1.定义日志实体类LogRecord

/*** 日志实体类，属性对应{@link LogSnipper}注解中的属性*/
@Data
@Builder
public class LogRecord {private String code;/*** 客户端ip*/private String ipAddr;/*** 业务编号（可以是任何标识）*/private String bizNo;/*** 对应{@link LogSnipper}注解中的success或者fail，当方法成功调用时，获取success中的值，反之则获取fail中的值*/private String content;/*** 日志类型*/private String category;/*** 操作者*/private String operator;/*** 备用字段，当其他字段不够用时可以使用该字段*/private String addition;/*** 操作时间*/private Date createTime;}

2.定义日志记录注解LogSnipper

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface LogSnipper {/*** 操作人* @return*/String operator() default "";/*** 操作成功时定义的模板* @return*/String success();/*** 操作失败时定义的模板* @return*/String fail() default "";/*** 业务主键* @return*/String bizNo() default "";/*** 日志类型* @return*/String category();/*** 其他信息，用于保存其他额外信息** @return*/String addition() default "";}

3.定义上下文容器SnipperContext

/*** 上下文容器，用来存放线程处理过程中的信息* <p>*/
public class SnipperContext {private static ThreadLocal<Map<String, Object>> context = new ThreadLocal<>();static {context.set(new HashMap<>());}public static Map<String, Object> getContext() {return context.get();}public static void set(String key, Object val) {Map<String, Object> map = new HashMap<>();map.put(key, val);context.set(map);}public static Object get(String key) {return context.get().get(key);}public static void clear() {context.remove();}}

4.实现切面

/*** 日志记录切面**/
@Aspect
public class LogAspect {@Autowiredprivate LogTplParser logTplParser;@Autowired(required = false)private LogPersistent logPersistent;@Pointcut("@annotation(com.sztech.logsnipper.LogSnipper)")public void snip(){}/*** 正常执行方法，执行success模板*/@AfterReturning(pointcut = "snip()", returning = "returnValue")public void doAfter(JoinPoint joinPoint, Object returnValue) {//获取注解的实例LogSnipper logSnipper = getLogSnipper(joinPoint);String success = logSnipper.success();//表达式上下文，将方法中的参数设置到spel容器中EvaluationContext evaluationContext = generateEvaluationContext(joinPoint);/*** 将方法的返回结果设置进内置变量中* 其中_rs_对应为返回值* _ex_对应异常原因* _context_对应上下文内容，为map类型**/evaluationContext.setVariable(LogTplParser._RS_, returnValue);evaluationContext.setVariable(LogTplParser._CONTEXT, SnipperContext.getContext());saveLog(logSnipper, success, evaluationContext);}/*** 非正常执行，执行fail模板*/@AfterThrowing(pointcut = "snip()", throwing = "exception")public void doFail(JoinPoint joinPoint, Exception exception) {LogSnipper logSnipper = getLogSnipper(joinPoint);String fail = logSnipper.fail();/*** 将方法的返回结果设置进内置变量中* 其中_rs_对应为返回值* _ex_对应异常原因* _context_对应上下文内容，为map类型**/EvaluationContext evaluationContext = generateEvaluationContext(joinPoint);evaluationContext.setVariable(LogTplParser._EX_, exception);evaluationContext.setVariable(LogTplParser._CONTEXT, SnipperContext.getContext());saveLog(logSnipper, fail, evaluationContext);}/*** 保存日志* @param logSnipper* @param tpl* @param evaluationContext*/private void saveLog(LogSnipper logSnipper, String tpl, EvaluationContext evaluationContext) {String content = logTplParser.parseTpl(tpl, evaluationContext);String operator = logTplParser.parseTpl(logSnipper.operator(), evaluationContext);String bizNo = logTplParser.parseTpl(logSnipper.bizNo(), evaluationContext);String category = logTplParser.parseTpl(logSnipper.category(), evaluationContext);String addition = logTplParser.parseTpl(logSnipper.addition(), evaluationContext);LogRecord logRecord =LogRecord.builder().content(content).code(IdUtil.simpleUUID()).operator(operator).bizNo(bizNo).category(category).addition(addition).createTime(new Date()).build();if(null != logPersistent) {//实现日志存储logPersistent.save(logRecord);}}/*** 将方法中的参数设置到spel容器中** @param joinPoint* @return*/private EvaluationContext generateEvaluationContext(JoinPoint joinPoint) {EvaluationContext evaluationContext = new StandardEvaluationContext();//获取方法参数值Object[] args = joinPoint.getArgs();//获取方法参数名String[] parameterNames = ((MethodSignature) joinPoint.getSignature()).getParameterNames();int i = 0;for(Object arg : args) {evaluationContext.setVariable(parameterNames[i++], arg);}return evaluationContext;}/*** 获取方法{@link LogSnipper}的注解实例* @param joinPoint* @return*/private LogSnipper getLogSnipper(JoinPoint joinPoint) {MethodSignature signature = (MethodSignature) joinPoint.getSignature();LogSnipper logSnipper = signature.getMethod().getAnnotation(LogSnipper.class);return logSnipper;}/*** 最后执行，用于释放资源*/@After("snip()")public void finish() {//释放上下文SnipperContext.clear();}
}

5.定义日志模板解析器LogTplParser

/*** 日志模板解析器**/
@Component
public class LogTplParser {private ExpressionParser expressionParser = new SpelExpressionParser();/*** 通配符正则表达式：{#user.name}，user为实例对象，name为对象属性，也可以使用getName()方法*/private static final String expressionRegex = "\\{#.*?}";public static final String _CONTEXT = "_context_";public static final String _EX_ = "_ex_";public static final String _RS_ = "_rs_";private static final Pattern pattern = Pattern.compile(expressionRegex);/*** 解析Spel模板字符串** @param tpl 模板字符串，例如："操作人:{#username}, 操作模块：{#module.name}"等，使用了spring的spel表达式* @param context 对象容器，将spel表达式对应的值或者对象呢set进容器中* @return*/public String parseTpl(String tpl, EvaluationContext context) {Matcher matcher = pattern.matcher(tpl);List<String> sPelList = new ArrayList<>();//匹配正则表达式，可能会出现匹配到多个while (matcher.find()) {sPelList.add(matcher.group());}//如果没有匹配到通配符，直接返回原字符串if(sPelList.size() == 0) {return tpl;}String[] datas = new String[sPelList.size()];int i = 0;//从context中取出通配符对应的值for(String sp : sPelList) {Expression expression = expressionParser.parseExpression(sp);datas[i++] = expression.getValue(context, String.class);}//格式化字符串，并将通配符的值填充到字符串中String formatStr = tpl.replaceAll(expressionRegex, "%s");return String.format(formatStr, datas);}}

6.定义业务代码

@RestController
public class AController {@Autowiredprivate AService aService;@GetMapping("/sayBye")public String sayBye(String msg) {User user = new User();user.setName("李白");user.setAge(12);user.setDepartment("001");SnipperContext.set("currentUser", user);SnipperContext.set("nickName", "汪沦");return aService.sayBye(msg, user);}}@Component
public class aService {@LogSnipper(category = "打招呼行为",success = "{#_context_.get(\"nickName\")}向{#user.name}说：{#msg}",fail = "{#user.name}有事，请下次再来",bizNo = "{#user.department}",operator = "{#_context_.get(\"nickName\")}")public String sayBye(String msg, User user) {return "sayBye";}
}

这篇关于springboot利用切面保存操作日志（支持Spring表达式语言（简称SpEL））的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/973255。

相关文章

JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
Java进阶13讲__第12讲_1/2

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory
阅读更多...
C++11第三弹：lambda表达式 | 新的类功能 | 模板的可变参数

C++11第三弹：lambda表达式 | 新的类功能 | 模板的可变参数

🌈个人主页： 南桥几晴秋 🌈C++专栏： 南桥谈C++ 🌈C语言专栏： C语言学习系列 🌈Linux学习专栏： 南桥谈Linux 🌈数据结构学习专栏： 数据结构杂谈 🌈数据库学习专栏： 南桥谈MySQL 🌈Qt学习专栏： 南桥谈Qt 🌈菜鸡代码练习： 练习随想记录 🌈git学习： 南桥谈Git 🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈🌈�
阅读更多...
JAVA智听未来一站式有声阅读平台听书系统小程序源码

JAVA智听未来一站式有声阅读平台听书系统小程序源码

智听未来，一站式有声阅读平台听书系统 🌟&nbsp;开篇：遇见未来，从“智听”开始 在这个快节奏的时代，你是否渴望在忙碌的间隙，找到一片属于自己的宁静角落？是否梦想着能随时随地，沉浸在知识的海洋，或是故事的奇幻世界里？今天，就让我带你一起探索“智听未来”——这一站式有声阅读平台听书系统，它正悄悄改变着我们的阅读方式，让未来触手可及！ 📚&nbsp;第一站：海量资源，应有尽有 走进“智听
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2