SpringBoot基礎(chǔ)系列之AOP結(jié)合SpEL實(shí)現(xiàn)日志輸出中兩點(diǎn)注意事項(xiàng)

image

【SpringBoot 基礎(chǔ)系列】AOP結(jié)合SpEL實(shí)現(xiàn)日志輸出的注意事項(xiàng)一二

使用 AOP 來打印日志大家一把都很熟悉了捐顷，最近在使用的過程中衅金，發(fā)現(xiàn)了幾個(gè)有意思的問題，一個(gè)是 SpEL 的解析禁悠，一個(gè)是參數(shù)的 JSON 格式輸出

I. 項(xiàng)目環(huán)境

1. 項(xiàng)目依賴

本項(xiàng)目借助SpringBoot 2.2.1.RELEASE + maven 3.5.3 + IDEA進(jìn)行開發(fā)

開一個(gè) web 服務(wù)用于測試

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

II. AOP & SpEL

關(guān)于 AOP 與 SpEL 的知識(shí)點(diǎn)耘沼，之前都有過專門的介紹魁衙，這里做一個(gè)聚合羡忘，一個(gè)非常簡單的日志輸出切面，在需要打印日志的方法上诀浪，添加注解@Log，這個(gè)注解中定義一個(gè)key赋荆，作為日志輸出的標(biāo)記笋妥；key 支持 SpEL 表達(dá)式

1. AOP 切面

注解定義

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Log {
    String key();
}

切面邏輯

@Slf4j
@Aspect
@Component
public class AopAspect implements ApplicationContextAware {
    private ExpressionParser parser = new SpelExpressionParser();
    private ParameterNameDiscoverer parameterNameDiscoverer = new DefaultParameterNameDiscoverer();

    @Around("@annotation(logAno)")
    public Object around(ProceedingJoinPoint joinPoint, Log logAno) throws Throwable {
        long start = System.currentTimeMillis();
        String key = loadKey(logAno.key(), joinPoint);
        try {
            return joinPoint.proceed();
        } finally {
            log.info("key: {}, args: {}, cost: {}", key,
                    JSONObject.toJSONString(joinPoint.getArgs()),
                    System.currentTimeMillis() - start);
        }
    }

    private String loadKey(String key, ProceedingJoinPoint joinPoint) {
        if (key == null) {
            return key;
        }

        StandardEvaluationContext context = new StandardEvaluationContext();

        context.setBeanResolver(new BeanFactoryResolver(applicationContext));
        String[] params = parameterNameDiscoverer.getParameterNames(((MethodSignature) joinPoint.getSignature()).getMethod());
        Object[] args = joinPoint.getArgs();
        for (int i = 0; i < args.length; i++) {
            context.setVariable(params[i], args[i]);
        }

        return parser.parseExpression(key).getValue(context, String.class);
    }

    private ApplicationContext applicationContext;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }
}

上面這個(gè)邏輯比較簡單懊昨，和大家熟知的使用姿勢沒有太大的區(qū)別

2. StandardEvaluationContext 安全問題

關(guān)于StandardEvaluationContext的注入問題窄潭，有興趣的可以查詢一下相關(guān)文章；對于安全校驗(yàn)較高的酵颁，要求只能使用SimpleEvaluationContext嫉你，使用它的話，SpEL 的能力就被限制了

如加一個(gè)測試

@Data
@Accessors(chain = true)
public class DemoDo {

    private String name;

    private Integer age;
}

服務(wù)類

@Service
public class HelloService {

    @Log(key = "#demo.getName()")
    public String say(DemoDo demo, String prefix) {
        return prefix + ":" + demo;
    }
}

為了驗(yàn)證SimpleEvaluationContext躏惋，我們修改一下上面的loadKeys方法

private String loadKey(String key, ProceedingJoinPoint joinPoint) {
    if (key == null) {
        return key;
    }

    SimpleEvaluationContext context = new SimpleEvaluationContext.Builder().build();
    String[] params = parameterNameDiscoverer.getParameterNames(((MethodSignature) joinPoint.getSignature()).getMethod());
    Object[] args = joinPoint.getArgs();
    for (int i = 0; i < args.length; i++) {
        context.setVariable(params[i], args[i]);
    }

    return parser.parseExpression(key).getValue(context, String.class);
}

啟動(dòng)測試

@SpringBootApplication
public class Application {

    public Application(HelloService helloService) {
        helloService.say(new DemoDo().setName("一灰灰blog").setAge(18), "welcome");
    }

    public static void main(String[] args) {
        SpringApplication.run(Application.class);
    }
}

image

直接提示方法找不到Ｓ奈邸！簿姨！

3. gson 序列化問題

上面的 case 中距误，使用的 FastJson 對傳參進(jìn)行序列化，接下來我們采用 Gson 來做序列化

<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
</dependency>

然后新增一個(gè)特殊的方法

@Service
public class HelloService {
    /**
     * 字面量扁位，注意用單引號包裹起來
     * @param key
     * @return
     */
    @Log(key = "'yihuihuiblog'")
    public String hello(String key, HelloService helloService) {
        return key + "_" + helloService.say(new DemoDo().setName(key).setAge(10), "prefix");
    }
}

注意上面方法的第二個(gè)參數(shù)准潭，非常有意思的是，傳參是自己的實(shí)例域仇；再次執(zhí)行

public Application(HelloService helloService) {
    helloService.say(new DemoDo().setName("一灰灰blog").setAge(18), "welcome");

    String ans = helloService.hello("一灰灰", helloService);
    System.out.println(ans);
}

直接拋了異常

image

這就很尷尬了刑然，一個(gè)輸出日志的輔助工具，因?yàn)樾蛄谢苯訉?dǎo)致接口不可用暇务，這就不優(yōu)雅了泼掠；而我們作為日志輸出的切面，又是沒有辦法控制這個(gè)傳參的垦细，沒辦法要求使用的參數(shù)择镇，一定能序列化，這里需要額外注意（比較好的方式就是簡單對象都實(shí)現(xiàn) toString,然后輸出 toString 的結(jié)果括改；而不是 json 串）

4. 小結(jié)

雖然上面一大串的內(nèi)容沐鼠，總結(jié)下來，也就兩點(diǎn)

SpEL 若采用的是SimpleEvaluationContext叹谁，那么注意 spel 的功能是減弱的饲梭，一些特性不支持
若將方法參數(shù) json 序列化輸出，那么需要注意某些類在序列化的過程中焰檩，可能會(huì)拋異常

（看到這里的小伙伴憔涉，不妨點(diǎn)個(gè)贊，順手關(guān)注下微信公眾號”一灰灰 blog“析苫，我的公眾號已經(jīng)寂寞的長草了 ??）

III. 不能錯(cuò)過的源碼和相關(guān)知識(shí)點(diǎn)

0. 項(xiàng)目

工程：https://github.com/liuyueyi/spring-boot-demo
源碼: https://github.com/liuyueyi/spring-boot-demo/tree/master/spring-boot/014-spel-aop

AOP 系列博文

SpringBoot 基礎(chǔ)系列 AOP 無法攔截接口上注解場景兼容
SpringBoot 基礎(chǔ)系列實(shí)現(xiàn)一個(gè)簡單的分布式定時(shí)任務(wù)(應(yīng)用篇)
SpringBoot 基礎(chǔ)篇 AOP 之?dāng)r截優(yōu)先級詳解
SpringBoot 應(yīng)用篇之 AOP 實(shí)現(xiàn)日志功能
SpringBoot 基礎(chǔ)篇 AOP 之高級使用技能
SpringBoot 基礎(chǔ)篇 AOP 之基本使用姿勢小結(jié)

1. 一灰灰 Blog

盡信書則不如兜叨，以上內(nèi)容穿扳，純屬一家之言，因個(gè)人能力有限国旷，難免有疏漏和錯(cuò)誤之處矛物，如發(fā)現(xiàn) bug 或者有更好的建議，歡迎批評指正跪但，不吝感激

下面一灰灰的個(gè)人博客履羞，記錄所有學(xué)習(xí)和工作中的博文，歡迎大家前去逛逛

一灰灰 Blog 個(gè)人博客 https://blog.hhui.top
一灰灰 Blog-Spring 專題博客 http://spring.hhui.top