文章目录
原文链接:https://blog.csdn.net/likun557/article/details/107853045
Spel概述
Spring表达式语言全称为“Spring Expression Language”,缩写为“SPEL”,类似于Struts2x中使用的OGNL表达式语言,能在
运行时
构建复杂表达式
、存取对象图属性、对象方法调用等等
,并且能与Spring功能完美整合
,如能用来配置Bean定义。
表达式语言给静态Java语言增加了动态功能。
SpEL是单独模块,只依赖于core模块,不依赖于其他模块,可以单独使用。
SPEL表达式形式汇总
SPEL支持如下表达式:
一、基本表达式
: 字面量表达式、关系,逻辑与算数运算表达式、字符串连接及截取表达式、三目运算及Elivis表达式、正则表达式、括号优先级表达式
;
二、类相关表达式
: 类类型表达式、类实例化、instanceof表达式、变量定义及引用、赋值表达式、自定义函数、对象属性存取及安全导航表达式、对象方法调用、Bean引用
;
三、集合相关表达式
: 内联List、内联数组、集合,字典访问、列表,字典,数组修改、集合投影、集合选择;不支持多维内联数组初始化;不支持内联字典定义
;
四、其他表达式
:模板表达式:模板必须以“#{”开头,以“}”结尾,如"#{'Hello '}#{‘World!’}"。
注:SpEL表达式中的关键字
是不区分大小
写的。
支持SpEL的Jar包:“org.springframework.expression-3.0.5.RELEASE.jar”
SpEL求表达式值步骤:
步骤
一般分为四步,其中第三步可选:
1、
创建解析器
:SpEL使用ExpressionParser接口表示解析器,提供SpelExpressionParser
默认实现;
2、解析表达式
:使用ExpressionParser的parseExpression来解析相应的表达式为Expression对象
。
3、构造上下文
:准备比如变量定义等等表达式需要的上下文数据
。
4、求值
:通过Expression接口的getValue方法根据上下文获得表达式值
。
示例
package com.javacode2018.spel;
import org.junit.Test;
import org.springframework.expression.EvaluationContext;
import org.springframework.expression.Expression;
import org.springframework.expression.ExpressionParser;
import org.springframework.expression.spel.standard.SpelExpressionParser;
import org.springframework.expression.spel.support.StandardEvaluationContext;
public class SpelTest {
@Test
public void test1() {
ExpressionParser parser = new SpelExpressionParser();
Expression expression = parser.parseExpression("('Hello' + ' World').concat(#end)");
EvaluationContext context = new StandardEvaluationContext();
context.setVariable("end", "!");
System.out.println(expression.getValue(context));
}
}
输出
Hello World!
SpEL原理及接口
工作原理
1.首先定义表达式:“1+2”;
2.定义解析器ExpressionParser实现,SpEL提供默认实现SpelExpressionParser;
2.1.SpelExpressionParser解析器内部使用Tokenizer类进行词法分析,即把字符串流分析为记号流,记号在SpEL使用Token类来表示;
2.2.有了记号流后,解析器便可根据记号流生成内部抽象语法树;在SpEL中语法树节点由SpelNode接口实现代表:如OpPlus表示加操作节点、IntLiteral表示int型字面量节点;使用SpelNodel实现组成了抽象语法树;
2.3.对外提供Expression接口来简化表示抽象语法树,从而隐藏内部实现细节,并提供getValue简单方法用于获取表达式值;SpEL提供默认实现为SpelExpression;
3.定义表达式上下文对象(可选),SpEL使用EvaluationContext接口表示上下文对象,用于设置根对象、自定义变量、自定义函数、类型转换器等,SpEL提供默认实现StandardEvaluationContext;
4.使用表达式对象根据上下文对象(可选)求值(调用表达式对象的getValue方法)获得结果。
SpEL的主要接口
ExpressionParser接口
表示解析器,默认实现是org.springframework.expression.spel.standard包中的SpelExpressionParser类,使用parseExpression方法将字符串表达式转换为Expression对象,对于ParserContext接口用于定义字符串表达式是不是模板,及模板开始与结束字符:
public interface ExpressionParser {
Expression parseExpression(String expressionString) throws ParseException;
Expression parseExpression(String expressionString, ParserContext context) throws ParseException;
}
示例:
@Test
public void testParserContext() {
ExpressionParser parser = new SpelExpressionParser();
ParserContext parserContext = new ParserContext() {
@Override
public boolean isTemplate() {
return true;
}
@Override
public String getExpressionPrefix() {
return "#{";
}
@Override
public String getExpressionSuffix() {
return "}";
}
};
String template = "#{'Hello '}#{'World!'}";
Expression expression = parser.parseExpression(template, parserContext);
System.out.println(expression.getValue());
}
在此我们演示的是使用ParserContext的情况,此处定义了ParserContext实现:定义表达式是模板形式,表达式前缀为“#{”,后缀为“}”;使用parseExpression解析时传入的模板必须以“#{”开头,以“}”结尾,如"#{'Hello '}#{‘World!’}"。
默认传入的字符串表达式不是模板形式,如之前演示的Hello World。
EvaluationContext接口
表示上下文环境,默认实现是org.springframework.expression.spel.support包中的StandardEvaluationContext
类,使用setRootObject方法来设置根对象
,使用setVariable方法来注册自定义变量
,使用registerFunction来注册自定义函数
等等。
Expression接口
表示表达式对象,默认实现是org.springframework.expression.spel.standard包中的SpelExpression,提供getValue方法用于获取表达式值,提供setValue方法用于设置对象值
。
SpEL语法
基本表达式
字面量表达式
SpEL支持的字面量包括:字符串、数字类型(int、long、float、double)、布尔类型、null类型。
示例:
@Test
public void test2() {
ExpressionParser parser = new SpelExpressionParser();
String str1 = parser.parseExpression("'Hello World!'").getValue(String.class);
int int1 = parser.parseExpression("1").getValue(Integer.class);
long long1 = parser.parseExpression("-1L").getValue(long.class);
float float1 = parser.parseExpression("1.1").getValue(Float.class);
double double1 = parser.parseExpression("1.1E+2").getValue(double.class);
int hex1 = parser.parseExpression("0xa").getValue(Integer.class);
long hex2 = parser.parseExpression("0xaL").getValue(long.class);
boolean true1 = parser.parseExpression("true").getValue(boolean.class);
boolean false1 = parser.parseExpression("false").getValue(boolean.class);
Object null1 = parser.parseExpression("null").getValue(Object.class);
System.out.println("str1=" + str1);
System.out.println("int1=" + int1);
System.out.println("long1=" + long1);
System.out.println("float1=" + float1);
System.out.println("double1=" + double1);
System.out.println("hex1=" + hex1);
System.out.println("hex2=" + hex2);
System.out.println("true1=" + true1);
System.out.println("false1=" + false1);
System.out.println("null1=" + null1);
}
输出
str1=Hello World!
int1=1
long1=-1
float1=1.1
double1=110.0
hex1=10
hex2=10
true1=true
false1=false
null1=null
算数运算表达式
SpEL支持加(+)、减(-)、乘(*)、除(/)、求余(%)、幂(^)运算。
SpEL还提供求余(MOD)和除(DIV)而外两个运算符,与“%”和“/”等价,不区分大小写。
关系表达式
等于(==)、不等于(!=)、大于(>)、大于等于(>=)、小于(<)、小于等于(<=),区间(between)运算。
如parser.parseExpression(“1>2”).getValue(boolean.class);将返回false;
而parser.parseExpression(“1 between {1, 2}”).getValue(boolean.class);将返回true。
between运算符右边操作数必须是列表类型,且只能包含2个元素。第一个元素为开始,第二个元素为结束,区间运算是包含边界值的,即 xxx>=list.get(0) && xxx<=list.get(1)。
SpEL同样提供了等价的“EQ” 、“NE”、 “GT”、“GE”、 “LT” 、“LE”来表示等于、不等于、大于、大于等于、小于、小于等于,不区分大小写。
@Test
public void test3() {
ExpressionParser parser = new SpelExpressionParser();
boolean v1 = parser.parseExpression("1>2").getValue(boolean.class);
boolean between1 = parser.parseExpression("1 between {1,2}").getValue(boolean.class);
System.out.println("v1=" + v1);
System.out.println("between1=" + between1);
}
输出
v1=false
between1=true
逻辑表达式
且(and或者&&)、或(or或者||)、非(!或NOT)。
@Test
public void test4() {
ExpressionParser parser = new SpelExpressionParser();
boolean result1 = parser.parseExpression("2>1 and (!true or !false)").getValue(boolean.class);
boolean result2 = parser.parseExpression("2>1 && (!true || !false)").getValue(boolean.class);
boolean result3 = parser.parseExpression("2>1 and (NOT true or NOT false)").getValue(boolean.class);
boolean result4 = parser.parseExpression("2>1 && (NOT true || NOT false)").getValue(boolean.class);
System.out.println("result1=" + result1);
System.out.println("result2=" + result2);
System.out.println("result3=" + result3);
System.out.println("result4=" + result4);
}
输出
result1=true
result2=true
result3=true
result4=false
字符串连接及截取表达式
使用“+”进行字符串连接,使用“‘String’[0] [index]”来截取一个字符,目前只支持截取一个,如“'Hello ’ + ‘World!’”得到“Hello World!”;而“‘Hello World!’[0]”将返回“H”。
三目运算
三目运算符 **“表达式1?表达式2:表达式3”**用于构造三目运算表达式,如“2>1?true:false”将返回true;
Elivis运算符
Elivis运算符**“表达式1?:表达式2”**从Groovy语言引入用于简化三目运算符的,当表达式1为非null时则返回表达式1,当表达式1为null时则返回表达式2,简化了三目运算符方式“表达式1? 表达式1:表达式2”,如“null?:false”将返回false,而“true?:false”将返回true;
正则表达式
使用“str matches regex,如“‘123’ matches ‘\d{3}’”将返回true;
括号优先级表达式
使用“(表达式)”构造,括号里的具有高优先级。
类相关表达式
类类型表达式
使用“T(Type)”来表示java.lang.Class实例,“Type”必须是
类全限定名
,“java.lang”包除外
,即该包下的类可以不指定包名;
使用类类型表达式还可以进行访问类静态方法及类静态字段
。
具体使用方法如下:
@Test
public void testClassTypeExpression() {
ExpressionParser parser = new SpelExpressionParser();
//java.lang包类访问
Class<String> result1 = parser.parseExpression("T(String)").getValue(Class.class);
System.out.println(result1);
//其他包类访问
String expression2 = "T(com.javacode2018.spel.SpelTest)";
Class<SpelTest> value = parser.parseExpression(expression2).getValue(Class.class);
System.out.println(value == SpelTest.class);
//类静态字段访问
int result3 = parser.parseExpression("T(Integer).MAX_VALUE").getValue(int.class);
System.out.println(result3 == Integer.MAX_VALUE);
//类静态方法调用
int result4 = parser.parseExpression("T(Integer).parseInt('1')").getValue(int.class);
System.out.println(result4);
}
输出
class java.lang.String
true
true
1
对于java.lang包里的可以直接使用“T(String)”访问;其他包必须是类全限定名;可以进行静态字段访问如“T(Integer).MAX_VALUE”;也可以进行静态方法访问如“T(Integer).parseInt(‘1’)”。
类实例化
类实例化同样使用java关键字“new”,类名必须是全限定名,但java.lang包内的类型除外,如String、Integer。
@Test
public void testConstructorExpression() {
ExpressionParser parser = new SpelExpressionParser();
String result1 = parser.parseExpression("new String('路人甲java')").getValue(String.class);
System.out.println(result1);
Date result2 = parser.parseExpression("new java.util.Date()").getValue(Date.class);
System.out.println(result2);
}
实例化完全跟Java内方式一样,运行输出
路人甲java
Tue Aug 03 20:22:43 CST 2020
instanceof表达式
SpEL支持instanceof运算符,跟Java内使用同义;如“‘haha’ instanceof T(String)”将返回true。
@Test
public void testInstanceOfExpression() {
ExpressionParser parser = new SpelExpressionParser();
Boolean value = parser.parseExpression("'路人甲' instanceof T(String)").getValue(Boolean.class);
System.out.println(value);
}
输出
true
变量定义及引用
变量定义
通过EvaluationContext接口的setVariable(variableName, value)方法定义
;
在表达式中使用"#variableName"引用
;
除了引用自定义变量,SpE还允许引用根对象及当前上下文对象,使用"#root"引用根对象,使用"#this"引用当前上下文对象;
@Test
public void testVariableExpression() {
ExpressionParser parser = new SpelExpressionParser();
EvaluationContext context = new StandardEvaluationContext();
context.setVariable("name", "路人甲java");
context.setVariable("lesson", "Spring系列");
//获取name变量,lesson变量
String name = parser.parseExpression("#name").getValue(context, String.class);
System.out.println(name);
String lesson = parser.parseExpression("#lesson").getValue(context, String.class);
System.out.println(lesson);
//StandardEvaluationContext构造器传入root对象,可以通过#root来访问root对象
context = new StandardEvaluationContext("我是root对象");
String rootObj = parser.parseExpression("#root").getValue(context, String.class);
System.out.println(rootObj);
//#this用来访问当前上线文中的对象
String thisObj = parser.parseExpression("#this").getValue(context, String.class);
System.out.println(thisObj);
}
输出
路人甲java
Spring系列
我是root对象
我是root对象
使用“#variable”来引用在EvaluationContext定义的变量;除了可以引用自定义变量,还可以使用“#root”引用根对象,“#this”引用当前上下文对象,此处“#this”即根对象。
自定义函数
目前只支持类静态方法注册为自定义函数;SpEL使用StandardEvaluationContext的registerFunction方法进行注册自定义函数,其实完全可以使用setVariable代替,两者其实本质是一样的;
@Test
public void testFunctionExpression() throws SecurityException, NoSuchMethodException {
//定义2个函数,registerFunction和setVariable都可以,不过从语义上面来看用registerFunction更恰当
StandardEvaluationContext context = new StandardEvaluationContext();
Method parseInt = Integer.class.getDeclaredMethod("parseInt", String.class);
context.registerFunction("parseInt1", parseInt);
context.setVariable("parseInt2", parseInt);
ExpressionParser parser = new SpelExpressionParser();
System.out.println(parser.parseExpression("#parseInt1('3')").getValue(context, int.class));
System.out.println(parser.parseExpression("#parseInt2('3')").getValue(context, int.class));
String expression1 = "#parseInt1('3') == #parseInt2('3')";
boolean result1 = parser.parseExpression(expression1).getValue(context, boolean.class);
System.out.println(result1);
}
此处可以看出“registerFunction”和“setVariable”都可以注册自定义函数,但是两个方法的含义不一样,推荐使用“registerFunction”方法注册自定义函数。
运行输出
3
3
true
表达式赋值
使用Expression#setValue方法可以给表达式赋值
@Test
public void testAssignExpression1() {
Object user = new Object() {
private String name;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
@Override
public String toString() {
return "$classname{" +
"name='" + name + '\'' +
'}';
}
};
{
//user为root对象
ExpressionParser parser = new SpelExpressionParser();
EvaluationContext context = new StandardEvaluationContext(user);
parser.parseExpression("#root.name").setValue(context, "路人甲java");
System.out.println(parser.parseExpression("#root").getValue(context, user.getClass()));
}
{
//user为变量
ExpressionParser parser = new SpelExpressionParser();
EvaluationContext context = new StandardEvaluationContext();
context.setVariable("user", user);
parser.parseExpression("#user.name").setValue(context, "路人甲java");
System.out.println(parser.parseExpression("#user").getValue(context, user.getClass()));
}
}
输出
$classname{name=‘路人甲java’}
$classname{name=‘路人甲java’}
对象属性存取及安全导航表达式
对象属性获取非常简单,即使用如“a.property.property”这种点缀式获取,SpEL对于属性名首字母是不区分大小写的;SpEL还引入了Groovy语言中的安全导航运算符“(对象|属性)?.属性”,用来避免“?.”前边的表达式为null时抛出空指针异常,而是返回null;修改对象属性值则可以通过赋值表达式或Expression接口的setValue方法修改。
public static class Car {
private String name;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
@Override
public String toString() {
return "Car{" +
"name='" + name + '\'' +
'}';
}
}
public static class User {
private Car car;
public Car getCar() {
return car;
}
public void setCar(Car car) {
this.car = car;
}
@Override
public String toString() {
return "User{" +
"car=" + car +
'}';
}
}
@Test
public void test5() {
User user = new User();
EvaluationContext context = new StandardEvaluationContext();
context.setVariable("user", user);
ExpressionParser parser = new SpelExpressionParser();
//使用.符号,访问user.car.name会报错,原因:user.car为空
try {
System.out.println(parser.parseExpression("#user.car.name").getValue(context, String.class));
} catch (EvaluationException | ParseException e) {
System.out.println("出错了:" + e.getMessage());
}
//使用安全访问符号?.,可以规避null错误
System.out.println(parser.parseExpression("#user?.car?.name").getValue(context, String.class));
Car car = new Car();
car.setName("保时捷");
user.setCar(car);
System.out.println(parser.parseExpression("#user?.car?.toString()").getValue(context, String.class));
}
运行输出
出错了:EL1007E: Property or field ‘name’ cannot be found on null
null
Car{name=‘保时捷’}
对象方法调用
对象方法调用更简单,跟Java语法一样;如“‘haha’.substring(2,4)”将返回“ha”;而对于根对象可以直接调用方法;
Bean引用
SpEL支持使用“@”符号来引用Bean,在引用Bean时需要使用BeanResolver接口实现来查找Bean,Spring提供BeanFactoryResolver实现。
@Test
public void test6() {
DefaultListableBeanFactory factory = new DefaultListableBeanFactory();
User user = new User();
Car car = new Car();
car.setName("保时捷");
user.setCar(car);
factory.registerSingleton("user", user);
StandardEvaluationContext context = new StandardEvaluationContext();
context.setBeanResolver(new BeanFactoryResolver(factory));
ExpressionParser parser = new SpelExpressionParser();
User userBean = parser.parseExpression("@user").getValue(context, User.class);
System.out.println(userBean);
System.out.println(userBean == factory.getBean("user"));
}
运行输出
User{car=Car{name=‘保时捷’}}
true
集合相关表达式
内联List
从Spring3.0.4开始支持内联List,使用{表达式,……}定义内联List,如“{1,2,3}”将返回一个整型的ArrayList,而“{}”将返回空的List,对于字面量表达式列表,SpEL会使用java.util.Collections.unmodifiableList方法将列表设置为不可修改。
@Test
public void test7() {
ExpressionParser parser = new SpelExpressionParser();
//将返回不可修改的空List
List<Integer> result2 = parser.parseExpression("{}").getValue(List.class);
//对于字面量列表也将返回不可修改的List
List<Integer> result1 = parser.parseExpression("{1,2,3}").getValue(List.class);
Assert.assertEquals(new Integer(1), result1.get(0));
try {
result1.set(0, 2);
} catch (Exception e) {
e.printStackTrace();
}
//对于列表中只要有一个不是字面量表达式,将只返回原始List,
//不会进行不可修改处理
String expression3 = "{{1+2,2+4},{3,4+4}}";
List<List<Integer>> result3 = parser.parseExpression(expression3).getValue(List.class);
result3.get(0).set(0, 1);
System.out.println(result3);
//声明二维数组并初始化
int[] result4 = parser.parseExpression("new int[2]{1,2}").getValue(int[].class);
System.out.println(result4[1]);
//定义一维数组并初始化
int[] result5 = parser.parseExpression("new int[1]").getValue(int[].class);
System.out.println(result5[0]);
}
在Bean定义中使用spel表达式
xml风格的配置
SpEL支持在Bean定义时注入,默认使用“#{SpEL表达式}”表示,其中“#root”根对象默认可以认为是ApplicationContext,只有ApplicationContext实现默认支持SpEL,获取根对象属性其实是获取容器中的Bean。
如:
<bean id="world" class="java.lang.String">
<constructor-arg value="#{' World!'}"/>
</bean>
<bean id="hello1" class="java.lang.String">
<constructor-arg value="#{'Hello'}#{world}"/>
</bean>
<bean id="hello2" class="java.lang.String">
<constructor-arg value="#{'Hello' + world}"/>
</bean>
<bean id="hello3" class="java.lang.String">
<constructor-arg value="#{'Hello' + @world}"/>
</bean>
模板默认以前缀“#{”开头,以后缀“}”结尾,且不允许嵌套,如“#{‘Hello’#{world}}”错误,如“#{‘Hello’ + world}”中“world”默认解析为Bean。当然可以使用“@bean”引用了。
是不是很简单,除了XML配置方式,Spring还提供一种注解方式@Value,接着往下看吧。
注解风格的配置
基于注解风格的SpEL配置也非常简单,使用
@Value注解来指定SpEL表达式
,该注解可以放到字段、方法及方法参数上
。
测试Bean类如下,使用@Value来指定SpEL表达式:
public class SpELBean {
@Value("#{'Hello' + world}")
private String value;
}
在Bean定义中SpEL的问题?
如果有同学问“#{我不是SpEL表达式}”不是SpEL表达式,而是公司内部的模板,想换个前缀和后缀该如何实现呢?
我们使用BeanFactoryPostProcessor接口提供postProcessBeanFactory回调方法,它是在IoC容器创建好但还未进行任何Bean初始化时被ApplicationContext实现调用,因此在这个阶段把SpEL前缀及后缀修改掉是安全的,具体代码如下:
package com.javacode2018.spel.test1;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanExpressionResolver;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.context.expression.StandardBeanExpressionResolver;
import org.springframework.stereotype.Component;
@Component
public class SpelBeanFactoryPostProcessor implements BeanFactoryPostProcessor {
@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
BeanExpressionResolver beanExpressionResolver = beanFactory.getBeanExpressionResolver();
if (beanExpressionResolver instanceof StandardBeanExpressionResolver) {
StandardBeanExpressionResolver resolver = (StandardBeanExpressionResolver) beanExpressionResolver;
resolver.setExpressionPrefix("%{");
resolver.setExpressionSuffix("}");
}
}
}
上测试代码
package com.javacode2018.spel.test1;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
@Component
public class LessonModel {
@Value("你好,%{@name},%{@msg}")
private String desc;
@Override
public String toString() {
return "LessonModel{" +
"desc='" + desc + '\'' +
'}';
}
}
@name:容器中name的bean
@msg:容器中msg的bean
下面我们来个配置类,顺便定义name和msg这2个bean,顺便扫描上面2个配置类
package com.javacode2018.spel.test1;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
@ComponentScan
@Configuration
public class MainConfig {
@Bean
public String name() {
return "路粉";
}
@Bean
public String msg() {
return "欢迎和我一起学习java各种技术!";
}
}
测试用例
@Test
public void test12() {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
context.register(MainConfig.class);
context.refresh();
LessonModel lessonModel = context.getBean(LessonModel.class);
System.out.println(lessonModel);
}
运行输出
LessonModel{desc=‘你好,路粉,欢迎和我一起学习java各种技术!’}
总结
Spel功能还是比较强大的,可以脱离spring环境独立运行
spel可以用在一些动态规则的匹配方面
,比如监控系统中监控规则的动态匹配
;其他的一些条件动态判断等等
案例源码
https://gitee.com/javacode2018/spring-series
实例
通过aop方式实现日志记录、权限校验、数据统计等功能
日志记录
import com.google.common.collect.Lists;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.collections4.CollectionUtils;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.LocalVariableTableParameterNameDiscoverer;
import org.springframework.expression.EvaluationContext;
import org.springframework.expression.Expression;
import org.springframework.expression.spel.standard.SpelExpressionParser;
import org.springframework.expression.spel.support.StandardEvaluationContext;
import java.lang.reflect.Method;
import java.util.*;
@Slf4j
@Configuration
@Aspect
public class LogAspect {
@Autowired
ILogService logService;
private final LocalVariableTableParameterNameDiscoverer discoverer = new LocalVariableTableParameterNameDiscoverer();
//1.定义切点 切注解
@Pointcut("@annotation(com.xxx.aop.LogAnnotation)")
public void logPoint() {
// 应该是空的。其实该方法本身只是一个标识,供@Pointcut注解依附。
}
//2.定义增强 后置返回增强 在目标方法正常结束后被注入 如果,目标方法发生异常 不会被织入
@AfterReturning("logPoint()")
public void logAfter(JoinPoint joinPoint) {
// joinPoint 连接点对象 得到切点相关的信息
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
Method method = signature.getMethod();
LogAnnotation annotation = method.getAnnotation(LogAnnotation.class);
// 获取ids和权限点
List<String> ids = extractIdList(joinPoint, annotation);
if (CollectionUtils.isNotEmpty(ids)) {
// 动作 (需要识别的操作动作)
String action = annotation.action().getAction();
ids.forEach(id -> {
if (Objects.isNull(id)) {
return;
}
logService.insertLog(Collections.singletonList(Long.parseLong(id)), action);
});
}
}
private List<String> extractIdList(JoinPoint pjp, LogAnnotation annotation) {
String spelExpression = annotation.spelExpression();
if (StringUtils.isBlank(spelExpression)) {
return null;
}
Object[] args = pjp.getArgs();
// 从切面织入点处通过反射机制获取织入点处的方法
MethodSignature signature = (MethodSignature) pjp.getSignature();
// 获取切入点所在的方法
Method method = signature.getMethod();
// 实例化spel表达式解析器
SpelExpressionParser spelExpressionParser = new SpelExpressionParser();
// 绑定参数到上下文
EvaluationContext context = this.bindParam(method, args);
// 解析表达式内容
Expression expression = spelExpressionParser.parseExpression(spelExpression);
// 声明StandardEvaluationContext对象,用于设置上下文对象。
Object result = expression.getValue(context);
return parseIds(result);
}
/**
* 将方法的参数名和参数值绑定
*
* @param method 方法,根据方法获取参数名
* @param args 方法的参数值
* @return context
*/
private EvaluationContext bindParam(Method method, Object[] args) {
//获取方法的参数名
String[] params = discoverer.getParameterNames(method);
//将参数名与参数值对应起来
EvaluationContext context = new StandardEvaluationContext();
for (int len = 0; len < params.length; len++) {
context.setVariable(params[len], args[len]);
}
return context;
}
private List<String> parseIds(Object object) {
if (object == null) {
return null;
}
if (object instanceof String) {
String[] arr = object.toString().split(",");
return Arrays.asList(arr);
}
if (object instanceof List) {
List<String> stringList = new ArrayList<>();
for (Object o : (List) object) {
stringList.addAll(parseIds(o));
}
return stringList;
}
return Lists.newArrayList(object.toString());
}
}