Spring Boot系列——AOP配自定义注解的最佳实践

AOP(Aspect Oriented Programming),即面向切面编程,是Spring框架的大杀器之一。

首先,我声明下,我不是来系统介绍什么是AOP,更不是照本宣科讲解什么是连接点、切面、通知和切入点这些让人头皮发麻的概念。

今天就来说说AOP的一些应用场景以及如何通过和其他特性的结合提升自己的灵活性。

AOP应用举例

AOP的一大好处就是解耦。通过切面,我们可以将那些反复出现的代码抽取出来,放在一个地方统一处理。

同时,抽出来的代码很多是与业务无关的,这样可以方便开发者更加专注自己的业务逻辑的开发。

一个AOP的典型应用场景就是日志打印。

下面是一个极端情况的Controller


@RestController
@RequestMapping("/")
public class HelloController {
    private static final Logger LOG = LoggerFactory.getLogger(HelloController.class);

    @GetMapping(value = "/index")
    public String index(HttpServletRequest request) {
        LOG.info("============打印日志开始============");
        LOG.info("URL: " + request.getRequestURL().toString());
        LOG.info("============打印日志结束============");
        return "hello jackie";
    }

    @GetMapping(value = "/test1")
    public String test1(HttpServletRequest request, String var1) {
        LOG.info("============打印日志开始============");
        LOG.info("URL: " + request.getRequestURL().toString());
        LOG.info("============打印日志结束============");
        return "test1";
    }

    @DemoAnnotation
    @GetMapping(value = "/test2")
    public String test2(HttpServletRequest request, String var1, String var2) {
        LOG.info("============打印日志开始============");
        LOG.info("URL: " + request.getRequestURL().toString());
        LOG.info("============打印日志结束============");
//        int i = 1/0;
        if (1<2)
            throw new IllegalArgumentException("exception");
        return "test2";
    }
}

HelloController中提供了三个Http接口,由于业务需要,所以每次进入某个方法的时候都需要打印请求的相关信息。

当然,如果只是上面的例子,我们完全可以通过其他手段让代码看着并不这么糟糕。我们可以抽象一个打印方法,将相同的代码封装在这个方法中,之后在各个方法中每次调用即可。

但是,这种处理方法似乎抽象的还不够,因为我们在每个Http接口中还是要调用这个抽象的函数。而且,比较要命的是,这打印日志的代码与其他业务代码显得有些格格不入。

所以,这时候,我们想到了AOP。

如何使用AOP

在Spring Boot项目中,只需要如下几步,就可以轻松上手AOP。

添加maven依赖


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

编写切面类


@Aspect
@Component
public class DemoAspect {
    private static final Logger LOG = LoggerFactory.getLogger(DemoAspect.class);

    @Pointcut("execution(public * com.jackie.springbootdemo.controller.HelloController.test*(..))")
    public void addAdvice(){}

    @Before("addAdvice()")
    public void before(JoinPoint joinPoint){
        Object[] args = joinPoint.getArgs();
        HttpServletRequest requests = (HttpServletRequest) args[0];
        LOG.info("============打印日志开始============");
        LOG.info("URL: " + requests.getRequestURL().toString());
        LOG.info("============打印日志结束============");
//        LOG.info("before....");
    }
}

结果验证对比

启动SpringBootDemoApplication,访问url:http://localhost:8080/test2?var1=1&var2=2

未使用切面功能打印日志

20181111-1-没有aop打印日志.gif

使用切面功能打印日志

image.png

从上面的结果展示发现,最终的效果是一样的,但是使用切面更加简洁,而且可复用。

如上访问的是test2接口,如果访问test1接口也可以走切面类实现打印日志的需求,但是如果走index请求就不会打印日志了。

这是为什么呢?

AOP的局限

在切面类DemoAspect中,我们看到了切入点的设置


@Pointcut("execution(public * com.jackie.springbootdemo.controller.HelloController.test*(..))")
public void addAdvice(){}

其中Pointcut后面的表达式是用于控制切面的有效影响范围。

表达式中,第一个表示返回任意类型,第二个表示任意方法名,后面的小括号表示任意参数值,这里是以test为前缀的,所以可以匹配上test1和test2方法。

注意,在第二个之前也可以再有个,即HelloController所在位置,表示任意类名,假如这里是有两个.则表示包括包里面的子包。*

好了,明白了表达式的含义,我们自然就看到了AOP的局限性。

当我们要使用切面前,就要写好表达式,但是项目一直在做,代码一直在加,那谁能保证后面接收代码的兄弟也正好知道这个test前缀的意义这么重大呢?

如果他非要用hello作为前缀,那么本应该匹配到的接口就匹配不上了,日志也就不能正常打印了。

这时候,自定义注解,就能够很好的解决这个问题。

自定义注解配合AOP

新建一个自定义注解


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

}

自定义注解的花样也很多,比如可以在注解中声明变量等,但这些不是我们这次讨论的重点。

将该注解添加到Http接口test2方法上


    @DemoAnnotation
    @GetMapping(value = "/test2")
    public String test2(HttpServletRequest request, String var1, String var2) {
//        LOG.info("============打印日志开始============");
//        LOG.info("URL: " + request.getRequestURL().toString());
//        LOG.info("============打印日志结束============");
//        int i = 1/0;
        if (1<2)
            throw new IllegalArgumentException("exception");
        return "test2";
    }

在切面类中将切入点的表达式改为


@Pointcut("execution(public * com.jackie.springbootdemo.controller.*.*(..)) && @annotation(com.jackie.springbootdemo.annotation.DemoAnnotation)")
public void addAdvice(){}

这样,我们不需要限制在controller类中是以test作为前缀了,只要是在上面定义的类路径下,并且扫描到注解DemoAnnotation就可以让切面生效。

image.png

从结果可以看出,访问http://localhost:8080/test1?var1=1并没有经过切面处理,因为不满足切入点中的表达式要求。

这样做的好处在于,控制的粒度更细,也更加灵活,方便切面功能的实现和细分。

代码已提交至rome

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,736评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,167评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,442评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,902评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,302评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,573评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,847评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,562评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,260评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,531评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,021评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,367评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,016评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,068评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,827评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,610评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,514评论 2 269

推荐阅读更多精彩内容

  • AOP实现可分为两类(按AOP框架修改源代码的时机): 静态AOP实现:AOP框架在编译阶段对程序进行修改,即实现...
    数独题阅读 2,253评论 0 22
  • 天空是灰暗的,我们的心情是愉悦的,厦门的老街显得格外的亲切感,列车缓缓行驶,路上行人三两,零零落落,但有条不紊,显...
    wild_uncle阅读 162评论 0 0
  • 遇见简书是一件让我值得骄傲并且神奇的事情。 我喜欢看有趣的文字,喜欢没事写写画画,总以为写作都是真正的作家能做到的...
    点点柠檬酸阅读 228评论 1 1
  • 新年后第一次离家。来到离家400多公里外的地方,忙了一天后很早就睡了的却在早晨4点就醒来。然后开始迷茫,开始感觉到...
    DAcrystal阅读 433评论 0 1
  • 最近这部电影在朋友圈和各个公众号里传播的很火,在豆瓣上的评分居然高达9.0,好奇的我果断买了电影票去电影院...
    越山的学习笔记阅读 219评论 0 1