前言

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

那么, 你有沒有碰到這樣一種場景: 需要?jiǎng)討B(tài)的傳參數(shù)進(jìn)注解, 注意是動(dòng)態(tài)的而不是寫死在代碼里的.

針對這種需求, 今天, 我們就來實(shí)現(xiàn)一個(gè)簡單的案例.

SpEl表達(dá)式簡介

正式擼代碼之前, 先了解下SpEl (Spring Expression Language) 表達(dá)式, 這是Spring框架中的一個(gè)利器.

Spring通過SpEl能在運(yùn)行時(shí)構(gòu)建復(fù)雜表達(dá)式、存取對象屬性、對象方法調(diào)用等等.

舉個(gè)簡單的例子方便理解, 如下

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

通過以上案例, 不難理解, 所謂的SpEl, 本質(zhì)上其實(shí)就是解析表達(dá)式,.

關(guān)于SpEl表達(dá)式感興趣的可以自行查閱資料, 本篇不做細(xì)致的討論.

實(shí)例: SpEl結(jié)合AOP動(dòng)態(tài)傳參

簡單了解了SpEl表達(dá)式, 那么接下來我們就直接開始擼代碼.

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

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

定義一個(gè)SpEl的工具類SpelUtil

public class SpelUtil {

    /**
     * 用于SpEL表達(dá)式解析.
     */
    private static final SpelExpressionParser parser = new SpelExpressionParser();

    /**
     * 用于獲取方法參數(shù)定義名字.
     */
    private static final DefaultParameterNameDiscoverer nameDiscoverer = new DefaultParameterNameDiscoverer();

    /**
     * 解析SpEL表達(dá)式
     *
     * @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獲取方法形參名數(shù)組
        String[] paramNames = nameDiscoverer.getParameterNames(method);
        // 解析過后的Spring表達(dá)式對象
        Expression expression = parser.parseExpression(spELStr);
        // Spring的表達(dá)式上下文對象
        EvaluationContext context = new StandardEvaluationContext();
        // 通過joinPoint獲取被注解方法的形參
        Object[] args = joinPoint.getArgs();
        // 給上下文賦值
        for (int i = 0; i < args.length; i++) {
            context.setVariable(paramNames[i], args[i]);
        }
        // 表達(dá)式從上下文中計(jì)算出實(shí)際參數(shù)值
        /*如:
            @annotation(key="#user.name")
            method(User user)
             那么就可以解析出方法形參的某屬性值，return “xiaoming”;
          */
        return expression.getValue(context).toString();
    }
}

定義一個(gè)帶參注解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();
        //獲取動(dòng)態(tài)參數(shù)
        String parm = SpelUtil.generateKeyBySpEL(spelGetParm.parm(), joinPoint);
        log.info("spel獲取動(dòng)態(tài)aop參數(shù): {}", parm);
        try {
            log.info("執(zhí)行目標(biāo)方法: {} ==>>開始......", methodName);
            result = joinPoint.proceed();
            log.info("執(zhí)行目標(biāo)方法: {} ==>>結(jié)束......", methodName);
            // 返回通知
            log.info("目標(biāo)方法 " + methodName + " 執(zhí)行結(jié)果 " + result);
        } finally {

        }
        // 后置通知
        log.info("目標(biāo)方法 " + methodName + " 結(jié)束");
        return result;
    }

以上已經(jīng)基本實(shí)現(xiàn)了案例的核心功能, 接下來我們使用該注解即可

定義一個(gè)實(shí)體User

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

    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);
    }
}

最后請求

image.png

image.png

可以看出, 切面成功獲取到了實(shí)體的name值“張三”.

小結(jié)

結(jié)合SpEl表達(dá)式可以實(shí)現(xiàn)各種“騷操作”, 各位大佬可自由發(fā)揮, 下面一章我們準(zhǔn)備結(jié)合SpEl來實(shí)現(xiàn)分布式鎖的功能.

項(xiàng)目地址

https://github.com/MrCoderStack/SpringBootDemo/tree/master/sb-spel-annotations

請關(guān)注我的訂閱號(hào)

訂閱號(hào).png