Spring AOP增强(Advice)

Sring AOP通过PointCut来指定在那些类的那些方法上织入横切逻辑,通过Advice来指定在切点上具体做什么事情。如方法前做什么,方法后做什么,抛出异常做什么。

再来看一下图


定义PointCut

Spring中有两种方式定义Pointcut:

  • XML文件
  • 注解

在xml文件中,入门中做了的演示:


<aop:config>
        <!-- 定义切点 -->
        <aop:pointcut id="hello" expression="execution(public * * (..))"></aop:pointcut>
       ...
</aop:config>

注解的方式:

@Component
@Aspect
public class HelloWorld {

    @Pointcut("execution(public * * (..))")
    public void sayHello(){
        System.out.println("hello");
    }
    
    ...
}

XML与注解方式类似,学会了一种,另外一种无难度上手,我们使用XML演示。

增强(Advice)

通过Idea,看一下Advice接口的接口继承类:
[图片上传失败...(image-d49d25-1530458748566)]

主要可分为5类增强:

  • MthodBeforeAdvice:目标方法实施前增强

  • AfterReturningAdvice:目标方法实施后增强

  • ThrowsAdvice 异常抛出增强

  • IntroductionAdvice 引介增强,为目标类添加新的属性和方法。可以构建组合对象来实现多继承

  • MethodInterceptor 方法拦截器,环绕增强,在方法的前后实施操作

AfterAdvice,BeforeAdvice当前是作为标记使用,内部无接口方法,为后来扩展使用。
Interceptor接口也不是直接使用,同样作为标记类,可使用其子接口。

前置增强

前置增强主要在匹配到的切点运行之前执行,在XML配置中使用<aop:before>,相应的接口为MethodBeforeAdvice,其方法为

    /**
     * @param method 要被激发的方法
     * @param args 方法的参数
     * @param target 目标对象,可能为null
     * @throws Throwable 如果这个对象想要终止调用,那么抛出异常,异常会返回给方法调用者,否则异常会被包装为运行时异常
     */
void before(Method method, Object[] args, Object target) throws Throwable;

当一个Bean对象实现了MethodBeforeAdvice,在XML配置文件中指定这个bean为advice,Spring会自动在切点方法执行前执行MethodBeforeAdvice的接口。

    <bean id="helloworld" class="me.aihe.exam.controller.HelloWorld" />
    
    <!-- timelog实现了MethodBeforeAdvice接口 -->
    <bean id="timeLog" class="me.aihe.exam.controller.TimeLoggingAop" />
    <aop:config>
        <aop:pointcut id="hello" expression="execution(public * * (..))"></aop:pointcut>
        
        <!-- advisor的作用为将Pointcut和Advice组装起来 -->
        <aop:advisor
                id="timelogAdvisor"
                advice-ref="timeLog"
                pointcut-ref="hello"
        />
    </aop:config>

在调用相应的切点方法之前,前置增强都会生效。

后置增强

弄明白了前置增强,后置增强也是同一个道理,不过后置增强是在切点运行后执行。接口为AfterReturningAdvice,方法为

/**
     * 当方法成功返回之后运行
     * @param returnValue 如果方法有返回值,那么returnValue就是返回值
     * @param method 激发的方法
     * @param args 方法的参数
     * @param target 目标对象
     * @throws Throwable 同上
     */
    void afterReturning(Object returnValue, Method method, Object[] args, Object target) throws Throwable;

在切点方法运行之后,后置增强会生效。

异常抛出增强

当切点方法抛出异常时,异常抛出增强才会被执行。其接口为ThrowsAdvice,接口没有指定方法,实现这个接口的对象是通过反射来调用其增强方法的。

// 异常增强方法格式如下
// 前面的三个参数是可选的,ThrowableSubclass为Throwable的子类
void afterThrowing([Method, args, target], ThrowableSubclass)

//案例如下
public void afterThrowing(Exception ex)
public void afterThrowing(RemoteException)
public void afterThrowing(Method method, Object[] args, Object target, Exception ex)
public void afterThrowing(Method method, Object[] args, Object target, ServletException ex)

增强案例

根据前面的前置,后置,异常抛出增强,看一个完整的案例:

// TimeLoggingAop实现了前置增强,后置增强,异常环绕增强
public class TimeLoggingAop implements MethodBeforeAdvice,AfterReturningAdvice,ThrowsAdvice {
    private long startTime = 0;

    @Override
    public void before(Method method, Object[] objects, Object o) throws Throwable {
        startTime = System.nanoTime();
    }


    @Override
    public void afterReturning(Object returnValue, Method method, Object[] objects, Object target) throws Throwable {
        long spentTime = System.nanoTime() - startTime;
        String clazzName = target.getClass().getCanonicalName();
        String methodName = method.getName();
        System.out.println("执行" + clazzName + "#" + methodName + "消耗" + new BigDecimal(spentTime).divide(new BigDecimal(1000000)) + "毫秒");
    }

    public void afterThrowing(Method method, Object[] args, Object target, Exception ex){
        System.out.println("执行" + method.getName() + "出现异常," + "异常消息为:" + ex.getMessage());
    }
}
// 普通的HelloWorld对象
public class HelloWorld {
    
    public void sayHello(){
        System.out.println("hello");
    }

    public void sayHelloWithException(){
        System.out.println("hello");
        throw new RuntimeException("Hello World运行时出了一点问题");
    }
}

  public static void main(String[] args) {
        //普通对象
        HelloWorld helloWorld = new HelloWorld();
        //增强对象
        BeforeAdvice beforeAdvice = new TimeLoggingAop();
        //组装普通对象和增强对象
        ProxyFactory proxyFactory = new ProxyFactory();
        proxyFactory.setTarget(helloWorld);
        proxyFactory.addAdvice(beforeAdvice);

        //获取组装后的代理对象
        HelloWorld proxyHelloWorld = (HelloWorld) proxyFactory.getProxy();
        //运行
        proxyHelloWorld.sayHello();
        proxyHelloWorld.sayHelloWithException();
    }

//运行结果
hello
执行me.aihe.exam.controller.HelloWorld#sayHello消耗29.392268毫秒

hello
执行sayHelloWithException出现异常,异常消息为:Hello World运行时出了一点问题

通过上面这个案例,我们大体知道什么是增强,字面意思:
在原本方法之上增加一些额外的东西,原本的功能增强了,所以叫增强,这是中文翻译过来的增强。
英文名为Advice,建议,在方法周围建议方法做什么事情,然后真的做了...

环绕增强

环绕增强可以理解为前置增强,后置增强,异常抛出增强的结合体,只有一个接口MethodInterceptor,其方法为:

// MethodInvocation封装了目标对象和参数数组,调用它的invocation.proceed()方法即激发目标对象的方法。
Object invoke(MethodInvocation invocation) throws Throwable;

一个用法案例:

    public Object invoke(MethodInvocation invocation) throws Throwable {
        System.out.println("前置增强执行");
        try {

            Object result = invocation.proceed();
            
            System.out.println("后置增强执行");
            
            return result;
        }catch (Exception e){
            System.out.println("异常抛出增强执行");
            //做其它的动作
        }
        
        return null;
    }

增强顺序

当多个增强作用与同一个切点的时候,具体哪一个增强会先执行呢?

Spring根据@Order注解或者实现了Ordered接口的增强类来进行判断。

public interface Ordered {
    int HIGHEST_PRECEDENCE = -2147483648;
    int LOWEST_PRECEDENCE = 2147483647;
    int getOrder();
}

注解相关增强

增强的概念一样,在使用方式上稍微有点区别,增强的相关注解有:
@Before
@AfterReturning
@AfterThrowing(
@After //相当于try-catch-finally中的final,一般用于释放资源
@Around

使用上与接口差不多

最后

增强是AOP中核心概念之一,本文在增强上稍作一些探索,深入还要靠大家,最后希望能帮到大家

参考

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,111评论 18 139
  • Spring Web MVC Spring Web MVC 是包含在 Spring 框架中的 Web 框架,建立于...
    Hsinwong阅读 21,815评论 1 92
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,430评论 6 342
  • 本章内容: 面向切面编程的基本原理 通过POJO创建切面 使用@AspectJ注解 为AspectJ切面注入依赖 ...
    谢随安阅读 3,061评论 0 9
  • 今天下午呼呼睡了一下午,所有的计划都没有做。 这样我意识到,我这段时间真的很累,我一直没感觉,其实身体是非常疲乏的...
    那条红鲤鱼阅读 291评论 0 0