Spel 结合自定义注解简单使用

Spel 结合自定义注解简单使用

本文使用场景

结合自定义注解记录操作日志

快速使用

定义注解

@Documented
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface OperateLog {

    String content() default "";
}

​ 使用

@PostMapping("login")
@ApiOperation("登录")
@OperateLog(content = "用户：${#loginParam.username} 登录")
public ResultData<String> login(@RequestBody LoginParamDTO loginParam){
    return ResultUtil.ok(userService.login(loginParam));
}

@Getter
@Setter
public class LoginParamDTO {

    private String username;

    private String password;
}

定义切面

@Aspect
@Slf4j
@Component
public class OperateLogAspect {

    private final static String RESPONSE = "resp";

    @Autowired
    private OperateLogMapper operateLogMapper;


    @Pointcut("@annotation(zh.cn.annotation.OperateLog)")
    private void pt1(){}

    @AfterReturning(value = "pt1() && @annotation(operateLog)", returning = "tClass")
    public void after(JoinPoint joinPoint, OperateLog operateLog, Object tClass){
        log.info("记录操作日志...");
        TOperateLog tOperateLog = new TOperateLog();

        //1. 向spel表达式上下文加入数据
        StandardEvaluationContext context = contextSetVariable(joinPoint, tClass);

        //2. 创建解析器
        SpelExpressionParser parser = new SpelExpressionParser();
        //3. 解析内容
        // content数据为：用户：xxx 登录
        String content = parseContent(operateLog.content(), parser, context,true);
        tOperateLog.setContent(content);
        operateLogMapper.insert(tOperateLog);
    }

    /**
     * 向 Spel 上下文中加入数据
     * @param joinPoint 切入点
     * @param tClass 方法返回值
     * @return
     */
    private StandardEvaluationContext contextSetVariable(JoinPoint joinPoint,Object tClass){
        Method method = ((MethodSignature) joinPoint.getSignature()).getMethod();
        //SPEL上下文
        StandardEvaluationContext context = new StandardEvaluationContext();
        //向上下文中添加响应的对应数据
        if (tClass instanceof ResultData){
            ResultData data = (ResultData) tClass;
            context.setVariable(RESPONSE,data.getData());
        }
        //把请求的方法参数放入SPEL上下文中
        //获取方法的入参名
        Parameter[] parameters = method.getParameters();
        //获取传参值
        Object[] args = joinPoint.getArgs();
        //循环添加
        for(int i = 0 ; i < parameters.length ; i++){
            context.setVariable(parameters[i].getName(), args[i]);
        }
        return context;
    }

    /**
     * 字符内容解析
     * @param str 要解析的内容
     * @param context 解析上下文
     * @return spel解析后的内容
     */
    private String parseContent(String str,SpelExpressionParser parser, EvaluationContext context,Boolean isTemplate){

        if(StringUtils.isEmpty(str)) return null;

        if (isTemplate){
            //创建解析模板
            //spel 默认解析格式：#XXX，使用该模板可以指定外层格式；如下即：${#XXX} 可被解析，原 #XXX 不能再被解析
            TemplateParserContext template = new TemplateParserContext("${", "}");
            return parser.parseExpression(str,template).getValue(context,String.class);
        }else {
            return parser.parseExpression(str).getValue(context,String.class);
        }

    }

}

Spel 使用介绍

在使用Sepl时，首选存在一个Spel的上下文环境 StandardEvaluationContext，上下文存在一个 ConcurrentHashMap ，用来存储我们设置的变量数据。所以在使用spel的大致步骤：

1. 向其上下文中添加 key:value 数据
2. 解析我们写的表达式，自定义的需要创建表达式解析器 SpelExpressionParser

代码实现步骤

总览

@AfterReturning(value = "pt1() && @annotation(operateLog)", returning = "tClass")
public void after(JoinPoint joinPoint, OperateLog operateLog, Object tClass){
    log.info("记录操作日志...");
    TOperateLog tOperateLog = new TOperateLog();

    //1. 向spel表达式上下文加入数据
    StandardEvaluationContext context = contextSetVariable(joinPoint, tClass);

    //2. 创建解析器
    SpelExpressionParser parser = new SpelExpressionParser();
    //3. 解析内容
    // content数据为：用户：xxx 登录
    String content = parseContent(operateLog.content(), parser, context,true);
    tOperateLog.setContent(content);
    operateLogMapper.insert(tOperateLog);
}

第一步： 向 Spel 的上下文中加入数据（key:value）

/**
     * 向 Spel 上下文中加入数据
     * @param joinPoint 切入点
     * @param tClass 方法返回值
     * @return
     */
private StandardEvaluationContext contextSetVariable(JoinPoint joinPoint,Object tClass){
    Method method = ((MethodSignature) joinPoint.getSignature()).getMethod();
    // 1. 创建SPEL上下文
    StandardEvaluationContext context = new StandardEvaluationContext();
    // 2. 向上下文中添加数据
    
    // 2.1 添加接口响应结果中的数据
    if (tClass instanceof ResultData){
        ResultData data = (ResultData) tClass;
        context.setVariable(RESPONSE,data.getData());
    }
    // 2.2 添加接口参数数据
    // 2.2.1 获取方法的入参名
    Parameter[] parameters = method.getParameters();
    // 2.2.2 获取传参值
    Object[] args = joinPoint.getArgs();
    // 2.3 循环添加
    for(int i = 0 ; i < parameters.length ; i++){
        context.setVariable(parameters[i].getName(), args[i]);
    }
    return context;
}

第二步： 解析内容

/**
     * 字符内容解析
     * @param str 要解析的内容
     * @param context 解析上下文
     * @return spel解析后的内容
     */
private String parseContent(String str,SpelExpressionParser parser, EvaluationContext context,Boolean isTemplate){

    if(StringUtils.isEmpty(str)) return null;

    if (isTemplate){
        //创建解析模板
        //spel 默认解析格式：#XXX，使用该模板可以指定外层格式；如下即：${#XXX} 可被解析，原 #XXX 不能再被解析
        TemplateParserContext template = new TemplateParserContext("${", "}");
        return parser.parseExpression(str,template).getValue(context,String.class);
    }else {
        return parser.parseExpression(str).getValue(context,String.class);
    }

}