Spring Aop:三、使用 AspectJ 框架实现 Spring AOP

本文参考实验楼教程:https://www.shiyanlou.com/courses/578/learning/?id=1940

AspectJ是基于注解(Annotation)的,所以需要JDK5.0版本以上。本文实验环境延用之Spring Aop:一、四种advice 的实验环境。

AspectJ支持的注解类型如下:

  • @Before
  • @After
  • @AfterReturning
  • @AfterThrowing
  • @Around
1、准备工作

首先定义一个简单的bean,CustomerBo实现了ICustomerBo接口。ICustomerBo接口代码如下:

package com.shiyanlou.spring.aop.aspectj;

/**
 * Created by Administrator on 2019/11/2.
 */
public interface ICustomerBo {

    void addCustomer();
    void deleteCustomer();
    String addCustomerReturnValue();
    void addCustomerThrowException() throws Exception;
    void addCustomerAround(String name);

}

CustomerBo.java代码如下:

package com.shiyanlou.spring.aop.aspectj;

/**
 * Created by Administrator on 2019/11/2.
 */
public class CustomerBo implements ICustomerBo {
    @Override
    public void addCustomer() {
        System.out.println("addCustomer() is running...");
    }

    @Override
    public void deleteCustomer() {
        System.out.println("deleteCustomer() is running...");
    }

    @Override
    public String addCustomerReturnValue() {
        System.out.println("addCustomerReturnValue() is running...");
        return "abc";
    }

    @Override
    public void addCustomerThrowException() throws Exception {
        System.out.println("addCustomerThrowException() is running...");
        throw new Exception("Generic Error!");
    }

    @Override
    public void addCustomerAround(String name) {
        System.out.println("addCustomerAround() is running, args: " + name);
    }
}


2、简单的AspectJ,Advice和Pointcut结合在一块的

首先在没有引入AspectJ之前,Advice和Pointcut是混在一块的,步骤如下:

  1. 创建一个Aspect类
  2. 配置Spring配置文件

由于接下来要使用aspectj的jar包,首先要添加maven依赖,需要在pom.xml中添加:

    <dependency>
      <groupId>org.aspectj</groupId>
      <artifactId>aspectjweaver</artifactId>
      <version>1.9.2</version>
    </dependency>
    <dependency>
      <groupId>org.aspectj</groupId>
      <artifactId>aspectjtools</artifactId>
      <version>1.9.2</version>
    </dependency>
    <dependency>
      <groupId>org.aspectj</groupId>
      <artifactId>aspectjrt</artifactId>
      <version>1.9.2</version>
    </dependency>

注:这在之前已经添加过了,这里这是说明他们的用途。



创建AspectJ类,LoggingAspect.java如下:

package com.shiyanlou.spring.aop.aspectj;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;

/**
 * Created by Administrator on 2019/11/2.
 */

@Aspect
public class LoggingAspect {

    @Before("execution(public * com.shiyanlou.spring.aop.aspectj.CustomerBo.addCustomer(..))")
    public void logBefore(JoinPoint joinPoint){
        System.out.println("logBefore() is running...");
        System.out.println("wei:" + joinPoint.getSignature().getName());
        System.out.println("***********");
    }

    @After("execution(public * com.shiyanlou.spring.aop.aspectj.CustomerBo.deleteCustomer(..))")
    public void logAfter(JoinPoint joinPoint){
        System.out.println("logAfter() is running...");
        System.out.println("wei:" + joinPoint.getSignature().getName());
        System.out.println("***********");
    }
}

解释:

  1. 必须使用@AspectLoggingAspect之前声明,以便被框架扫描到;
  2. 此例中Advice和Poincut结合在一起,LoggingAspect类中的logBeforelogAfter即为Advice,要注入的代码,即它们上方的代码为Pointcut表达式,即定义了切入点。上例中@Before中代码表示在执行com.shiyanlou.spring.aop.aspectj.CustomerBoaddCustomer方法前注入logBefore代码;
  3. 需要在LoggingAspect类的方法前加上@Before@After等注释;
  4. execution(public * com.shiyanlou.spring.aop.aspectj.CustomerBo.addCustomer(..))是Aspect的Pointcut表达式:
  • *代表任意返回类型
  • 后面定义要拦截的方法名(全路径:包名.类名.方法名)
  • (..)代表匹配参数:任意多个任意类型的参数,若确认没有参数可以写();还可以用(*)代表任意一个类型的参数,(*,String)表示匹配两个参数,第一个任意类型,第二个必须是String类型。
  1. AspectJ表达式可以对整个包定义,例如:execution(public * com.shiyanlou.spring.aop.aspectj.*.*(..))表示切入点是com.shiyanlou.spring.aop.aspectj整个包的所有类的所有方法。



配置SpringAopAspectJ.xml文件如下:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">

    <aop:aspectj-autoproxy/>

    <bean id="customerBo" class="com.shiyanlou.spring.aop.aspectj.CustomerBo"/>
    <bean id="loggingAspect" class="com.shiyanlou.spring.aop.aspectj.LoggingAspect"/>
</beans>

<aop:aspectj-autoproxy/>代表启动AspectJ支持,这样Spring会自动寻找@Aspect注释过的类,其他配置一致;

执行App.java,如下:

package com.shiyanlou.spring;

import com.shiyanlou.spring.aop.advice.CustomerService;
import com.shiyanlou.spring.aop.aspectj.CustomerBo;
import com.shiyanlou.spring.aop.aspectj.ICustomerBo;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

/**
 * Hello world!
 *
 */
public class App 
{
    private static ApplicationContext context;

    public static void main( String[] args ) {

        context = new ClassPathXmlApplicationContext("SpringAopAspectJ.xml");

        ICustomerBo cust = (ICustomerBo) context.getBean("customerBo");

        cust.addCustomer();
        System.out.println("-----------------------");
        cust.deleteCustomer();
    }
}

执行结果如下:

logBefore() is running...
wei:addCustomer
***********
addCustomer() is running...
-----------------------
deleteCustomer() is running...
logAfter() is running...
wei:deleteCustomer
***********


3、将Advice和Pointcut 分开

需要三步骤:

  1. 创建Pointcut
  2. 创建Advice
  3. 配置Spring的配置文件

1)、定义Pointcut
创建PointcutsDefinitions.java,如下:

package com.shiyanlou.spring.aop.aspectj;

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;

/**
 * Created by Administrator on 2019/11/2.
 */
@Aspect
public class PointcutsDefinitions {

    @Pointcut("execution(public * com.shiyanlou.spring.aop.aspectj.CustomerBo.*(..))")
    public void customreLog(){
    }
}

解释:

  1. 类声明之前加上@Aspect注释,一遍被框架扫描到;
  2. @Pointcut定义了切入点声明,指定需要注入代码的位置(即在哪个类的哪个方法中注入额外代码),上例中指定的切入点为CustomerBo.java类中的所有方法;但是往往实际应用中,我们需要切入的是一整个业务逻辑层(简单点说就是某个包),例如@Pointcut("execution(public * com.shiyanlou.spring.aop.aspectj.*.*(..))"),表示的是com.shiyanlou.spring.aop.aspectj 包中所有类的所有方法。
  3. 方法customreLog只是一个签名,在Advice中可以用此签名代替切入点表达式,多以不需要写方法体,只起到助记功能,例如此处代表操作CustomerBo类中的切入点。

2)、修改LoggingAspect.java

package com.shiyanlou.spring.aop.aspectj;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;

/**
 * Created by Administrator on 2019/11/2.
 */

@Aspect
public class LoggingAspect {

@Before("com.shiyanlou.spring.aop.aspectj.PointcutsDefinitions.customreLog()")
    public void logBefore(JoinPoint joinPoint){
        System.out.println("logBefore() is running...");
        System.out.println("wei:" + joinPoint.getSignature().getName());
        System.out.println("***********");
    }

    @After("com.shiyanlou.spring.aop.aspectj.PointcutsDefinitions.customreLog()")
    public void logAfter(JoinPoint joinPoint){
        System.out.println("logAfter() is running...");
        System.out.println("wei:" + joinPoint.getSignature().getName());
        System.out.println("***********");
    }
}

解释:

  1. @Before@After注释使用PointcutsDefinitions中的方法签名代替Pointcut表达式找到相应的切入点, 即通过签名找到PointcutsDefinitions方法customreLog前定义的Pointcut表达式;
  2. 对于PointcutsDefinitions来说,它的主要职责是定义Pointcut即切入点,可以在其中定义多个切入点,并且使用便于记忆的方法签名表示;
  3. 单独定义Pointcut表达式的好处有,一是使用了有意义的方法名,二是Pointcut表达式可以被多个Advice共享,修改一处其他所有使用的地方均被修改。

3)、配置Spring配置文件
配置的SpringAopAspectJ.xml如下:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">

    <aop:aspectj-autoproxy/>

    <bean id="customerBo" class="com.shiyanlou.spring.aop.aspectj.CustomerBo"/>
    <bean id="loggingAspect" class="com.shiyanlou.spring.aop.aspectj.LoggingAspect"/>
</beans>

App.java不变,运行如下:

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

推荐阅读更多精彩内容