springboot通過spel結合aop實現動態傳參的案例

2022-07-26 18:02:26

前言

基於SpingBoot框架中, 我們隨處可以見的便是各種各樣的功能註解, 註解的實現原理AOP之前有說過(翻看本系列的前面幾章即可), 這裡不過多贅述.

那麼, 你有沒有碰到這樣一種場景: 需要動態的傳引數進註解, 注意是動態的而不是寫死在程式碼裡的.

針對這種需求, 今天, 我們就來實現一個簡單的案例.

SpEl表示式簡介

正式擼程式碼之前, 先了解下SpEl (Spring Expression Language) 表示式, 這是Spring框架中的一個利器.

Spring通過SpEl能在執行時構建複雜表示式、存取物件屬性、物件方法呼叫等等.

舉個簡單的例子方便理解, 如下

//定義了一個表示式
String expressionStr = "1+1";
ExpressionParser parser = new SpelExpressionParser();
Expression expression = parser.parseExpression(expressionStr);
Integer val = expression.getValue(Integer.class);
System.out.println(expressionStr + "的結果是：" + val);

通過以上案例, 不難理解, 所謂的SpEl, 本質上其實就是解析表示式,.

關於SpEl表示式感興趣的可以自行查閱資料, 本篇不做細緻的討論.

範例: SpEl結合AOP動態傳參

簡單瞭解了SpEl表示式, 那麼接下來我們就直接開始擼程式碼.

先引入必要的pom依賴, 其實只有aop依賴, SpEl本身就被Spring支援, 所以無需額外引入.

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

定義一個SpEl的工具類SpelUtil

public class SpelUtil {
    /**
     * 用於SpEL表示式解析.
     */
    private static final SpelExpressionParser parser = new SpelExpressionParser();

    /**
     * 用於獲取方法引數定義名字.
     */
    private static final DefaultParameterNameDiscoverer nameDiscoverer = new DefaultParameterNameDiscoverer();

    /**
     * 解析SpEL表示式
     *
     * @param spELStr
     * @param joinPoint
     * @return
     */
    public static String generateKeyBySpEL(String spELStr, ProceedingJoinPoint joinPoint) {
        // 通過joinPoint獲取被註解方法
        MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
        Method method = methodSignature.getMethod();
        // 使用Spring的DefaultParameterNameDiscoverer獲取方法形參名陣列
        String[] paramNames = nameDiscoverer.getParameterNames(method);
        // 解析過後的Spring表示式物件
        Expression expression = parser.parseExpression(spELStr);
        // Spring的表示式上下文物件
        EvaluationContext context = new StandardEvaluationContext();
        // 通過joinPoint獲取被註解方法的形參
        Object[] args = joinPoint.getArgs();
        // 給上下文賦值
        for (int i = 0; i < args.length; i++) {
            context.setVariable(paramNames[i], args[i]);
        }
        // 表示式從上下文中計算出實際引數值
        /*如:
            @annotation(key="#user.name")
            method(User user)
             那麼就可以解析出方法形參的某屬性值，return 「xiaoming」;
          */
        return expression.getValue(context).toString();
    }
}

定義一個帶參註解SpelGetParm

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface SpelGetParm {

    String parm() default "";
    
}

定義帶參註解SpelGetParmAop

@Aspect
@Slf4j
@Component
public class SpelGetParmAop {

    @PostConstruct
    public void init() {
        log.info("SpelGetParm init ......");
    }
    /**
     * 攔截加了SpelGetParm註解的方法請求
     *
     * @param joinPoint
     * @param spelGetParm
     * @return
     * @throws Throwable
     */
    @Around("@annotation(spelGetParm)")
    public Object beforeInvoce(ProceedingJoinPoint joinPoint, SpelGetParm spelGetParm) throws Throwable {
        Object result = null;
        // 方法名
        String methodName = joinPoint.getSignature().getName();
        //獲取動態引數
        String parm = SpelUtil.generateKeyBySpEL(spelGetParm.parm(), joinPoint);
        log.info("spel獲取動態aop引數: {}", parm);
        try {
            log.info("執行目標方法: {} ==>>開始......", methodName);
            result = joinPoint.proceed();
            log.info("執行目標方法: {} ==>>結束......", methodName);
            // 返回通知
            log.info("目標方法 " + methodName + " 執行結果 " + result);
        } finally {

        }
        // 後置通知
        log.info("目標方法 " + methodName + " 結束");
        return result;
    }

以上已經基本實現了案例的核心功能, 接下來我們使用該註解即可

定義一個實體User

@Getter
@Setter
@NoArgsConstructor
@JsonSerialize
@JsonInclude(Include.NON_NULL)
public class User implements Serializable {
    private static final long serialVersionUID = -7229987827039544092L;

    private String name;
    private Long id;

}

我們在UserController直接使用該帶參註解即可

@CrossOrigin
@RestController
@RequestMapping("/user")
public class UserController {
    @PostMapping("/param")
    @SpelGetParm(parm = "#user.name")
    public R repeat(@RequestBody User user) {
        return R.success(user);
    }
}

最後請求