您的位置: 首页  >  文章  >  【Spring】14 AOP 基础

【Spring】14 AOP 基础

分类: 文章 • 2024-08-18 08:03:04

AOP 基础

AOP 基础

  • AOP(Aspect-Oriented Programming, 面向切面编程): 是一种新的方法论, 是对传统 OOP(Object-Oriented Programming, 面向对象编程) 的补充.
  • AOP 的主要编程对象是切面(aspect), 而切面模块化横切关注点.
  • 在应用 AOP 编程时, 仍然需要定义公共功能, 但可以明确的定义这个功能在哪里, 以什么方式应用, 并且不必修改受影响的类. 这样一来横切关注点就被模块化到特殊的对象(切面)里.
  • AOP 的好处:
    • 每个事物逻辑位于一个位置, 代码不分散, 便于维护和升级
    • 业务模块更简洁, 只包含核心业务代码.
      【Spring】14 AOP 基础

AOP 术语

  • 切面(Aspect): 横切关注点(跨越应用程序多个模块的功能)被模块化的特殊对象
  • 通知(Advice): 切面必须要完成的工作
  • 目标(Target): 被通知的对象
  • 代理(Proxy): 向目标对象应用通知之后创建的对象
  • 连接点（Joinpoint）：程序执行的某个特定位置：如类某个方法调用前、调用后、方法抛出异常后等。连接点由两个信息确定：方法表示的程序执行点；相对点表示的方位。例如 ArithmethicCalculator#add() 方法执行前的连接点，执行点为 ArithmethicCalculator#add()； 方位为该方法执行前的位置
  • 切点（pointcut）：每个类都拥有多个连接点：例如 ArithmethicCalculator 的所有方法实际上都是连接点，即连接点是程序类中客观存在的事务。AOP 通过切点定位到特定的连接点。类比：连接点相当于数据库中的记录，切点相当于查询条件。切点和连接点不是一对一的关系，一个切点匹配多个连接点，切点通过 org.springframework.aop.Pointcut 接口进行描述，它使用类和方法作为连接点的查询条件。

示例

ArithmeticCalculator.java(com.test.spring.aop.helloworld.ArithmeticCalculator)

package com.test.spring.aop.helloworld;

public interface ArithmeticCalculator {

    int add(int i, int j);
    int sub(int i, int j);

    int mul(int i, int j);
    int div(int i, int j);
}

ArithmeticCalculatorImpl.java(com.test.spring.aop.helloworld.ArithmeticCalculatorImpl)

package com.test.spring.aop.helloworld;

public class ArithmeticCalculatorImpl implements ArithmeticCalculator {

    @Override
    public int add(int i, int j) {
        System.out.println("The method add begins with[" + i + "," + j + "]");
        int result = i + j;
        System.out.println("The method add ends with " + result);
        return result;
    }

    @Override
    public int sub(int i, int j) {
        System.out.println("The method sub begins with[" + i + "," + j + "]");
        int result = i - j;
        System.out.println("The method sub ends with " + result);
        return result;
    }

    @Override
    public int mul(int i, int j) {
        System.out.println("The method mul begins with[" + i + "," + j + "]");
        int result = i * j;
        System.out.println("The method mul ends with " + result);
        return result;
    }

    @Override
    public int div(int i, int j) {
        System.out.println("The method div begins with[" + i + "," + j + "]");
        int result = i / j;
        System.out.println("The method div ends with " + result);
        return result;
    }
}

Main.java(com.test.spring.aop.helloworld.Main)

package com.test.spring.aop.helloworld;

public class Main {

    public static void main(String[] args) {
        ArithmeticCalculator arithmeticCalculator = null;
        arithmeticCalculator = new ArithmeticCalculatorImpl();

        int result = arithmeticCalculator.add(1,2);
        System.out.println("--> " + result);

        result = arithmeticCalculator.div(4,2);
        System.out.println("--> " + result);
    }
}

使用动态代理方式改进

简化文件ArithmeticCalculatorImpl.java(com.test.spring.aop.helloworld.ArithmeticCalculatorImpl)

package com.test.spring.aop.helloworld;

public class ArithmeticCalculatorImpl implements ArithmeticCalculator {

    @Override
    public int add(int i, int j) {
        int result = i + j;
        return result;
    }

    @Override
    public int sub(int i, int j) {
        int result = i - j;
        return result;
    }

    @Override
    public int mul(int i, int j) {
        int result = i * j;
        return result;
    }

    @Override
    public int div(int i, int j) {
        int result = i / j;
        return result;
    }
}

添加文件ArithmeticCalculatorLoggingProxy.java(com.test.spring.aop.helloworld.ArithmeticCalculatorLoggingProxy)

package com.test.spring.aop.helloworld;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.util.Arrays;

public class ArithmeticCalculatorLoggingProxy {

    // 要代理的对象
    private ArithmeticCalculator target;

    public ArithmeticCalculatorLoggingProxy(ArithmeticCalculator target){
        this.target = target;
    }

    public ArithmeticCalculator getLoggingProxy(){
        ArithmeticCalculator proxy = null;

        // 代理对象由哪一个类加载器负责加载
        ClassLoader loader = target.getClass().getClassLoader();
        // 代理对象的类型，即其中有哪些方法
        Class [] interfaces = new Class[]{ArithmeticCalculator.class};
        // 当调用代理对象其中的方式时，该执行的代码
        InvocationHandler h = new InvocationHandler() {
            /**
             *
             * proxy: 正在返回的那个代理对象，一般情况下，在 invoke 方法中都不使用该对象。
             * method: 正在调用的方法
             * args: 调用方法时，传入的参数
             */
            @Override
            public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                String methodName = method.getName();
                // 日志
                System.out.println("The method " + methodName + " begins with " + Arrays.asList(args));
                // 执行方法
                Object result = method.invoke(target, args);
                // 日志
                System.out.println("The method " + methodName + " ends with " + result);
                return result;
            }
        };

        proxy = (ArithmeticCalculator) Proxy.newProxyInstance(loader, interfaces, h);
        
        return proxy;
    }
}

使用AOP方式改进

导入aop包和Aspect包

aspectjweaver-1.9.3.RC1.jar
aspectj-1.9.3.RC1.jar
aspectj-1.9.3.RC1-src.jar
aopalliance-alpha1.jar
【Spring】14 AOP 基础

ArithmeticCalculator.java(com.test.spring.aop.impl.ArithmeticCalculator)

package com.test.spring.aop.impl;

public interface ArithmeticCalculator {

    int add(int i, int j);
    int sub(int i, int j);

    int mul(int i, int j);
    int div(int i, int j);
}

ArithmeticCalculatorImpl.java(com.test.spring.aop.impl.ArithmeticCalculatorImpl)

package com.test.spring.aop.impl;

import org.springframework.stereotype.Component;

@Component
public class ArithmeticCalculatorImpl implements ArithmeticCalculator {

    @Override
    public int add(int i, int j) {
        int result = i + j;
        return result;
    }

    @Override
    public int sub(int i, int j) {
        int result = i - j;
        return result;
    }

    @Override
    public int mul(int i, int j) {
        int result = i * j;
        return result;
    }

    @Override
    public int div(int i, int j) {
        int result = i / j;
        return result;
    }
}

LoggingAspect.java(com.test.spring.aop.impl.LoggingAspect)

package com.test.spring.aop.impl;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;

import java.util.Arrays;
import java.util.List;

// 把这个类声明为一个切面： 需要把该类放入 IOC 容器中、在声明为一个切面
@Aspect
@Component
public class LoggingAspect {

    // 声明该方法是一个前置通知：在目标方法开始之前执行
    @Before("execution(* com.test.spring.aop.impl.*.*(int, int))")
    public void beforeMothod(JoinPoint joinPoint){
        String methodName = joinPoint.getSignature().getName();
        List<Object> args = Arrays.asList(joinPoint.getArgs());

        System.out.println("The method " + methodName + " begins with " + args);
    }

    // 后置通知： 在目标执行后(无论是否发生异常)，执行得到通知。
    // 在后置通知中还不能访问目标发放执行的结果。
    @After("execution(* com.test.spring.aop.impl.*.*(int, int))")
    public void afterMehtod(JoinPoint joinPoint){
        String methodName = joinPoint.getSignature().getName();

        System.out.println("The method " + methodName + " ends");
    }
}
AspectJ 注解声明切面
  • 要在 Spring 中声明 AspectJ 切面, 只需要在 IOC 容器中将切面声明为 Bean 实例. 当在 Spring IOC 容器中初始化 AspectJ 切面之后, Spring IOC 容器就会为那些与 AspectJ 切面相匹配的 Bean 创建代理.
  • 在 AspectJ 注解中, 切面只是一个带有 @Aspect 注解的 Java 类.
  • 通知是标注有某种注解的简单的 Java 方法.
  • AspectJ 支持 5 种类型的通知注解:
    • @Before: 前置通知, 在方法执行之前执行
    • @After: 后置通知, 在方法执行之后执行
    • @AfterRunning: 返回通知, 在方法返回结果之后执行
    • @AfterThrowing: 异常通知, 在方法抛出异常之后
    • @Around: 环绕通知, 围绕着方法执行
利用方法签名编写 AspectJ 切入点表达式
  • execution * com.atguigu.spring.ArithmeticCalculator.*(…)：匹配 ArithmeticCalculator 中声明的所有方法,第一个 * 代表任意修饰符及任意返回值，第二个 * 代表任意方法. … 匹配任意数量的参数，若目标类与接口与该切面在同一个包中，可以省略包名。
  • execution public * ArithmeticCalculator.*(…)：匹配 ArithmeticCalculator 接口的所有公有方法。
  • execution public double ArithmeticCalculator.*(…)：匹配 ArithmeticCalculator 中返回 double 类型数值的方法。
  • execution public double ArithmeticCalculator.*(double, …)：匹配第一个参数为 double 类型的方法，… 匹配任意数量任意类型的参数。
  • execution public double ArithmeticCalculator.*(double, double)：匹配参数类型为 double, double 类型的方法。
  • 在 AspectJ 中, 切入点表达式可以通过操作符 &&, ||, ! 结合起来，如图
    【Spring】14 AOP 基础
后置通知
  • 后置通知是在连接点完成之后执行的，即连接点返回结果或者抛出异常的时候，下面的后置通知记录了方法的终止.。
  • 一个切面可以包括一个或者多个通知。
  • 无论连接点是正常返回还是抛出异常，后置通知都会执行. 如果只想在连接点返回的时候记录日志, 应使用返回通知代替后置通知。

启用 AspectJ 注解支持 applicationContext.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:context="http://www.springframework.org/schema/context"
       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/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">

    <!-- 配置自动扫描的包 -->
    <context:component-scan base-package="com.test.spring.aop.impl"></context:component-scan>

    <!-- 使 AspjectJ 注解起作用： 自动为匹配的类生成代理对象 -->
    <aop:aspectj-autoproxy></aop:aspectj-autoproxy>

</beans>

· 要在 Spring 应用中使用 AspectJ 注解, 必须在 classpath 下包含 AspectJ 类库: aopalliance.jar、aspectj.weaver.jar 和 spring-aspects.jar

  • 将 aop Schema 添加到 根元素中.
  • 要在 Spring IOC 容器中启用 AspectJ 注解支持, 只要在 Bean 配置文件中定义一个空的 XML 元素 aop:aspectj-autoproxy
  • 当 Spring IOC 容器侦测到 Bean 配置文件中的 aop:aspectj-autoproxy 元素时, 会自动为与 AspectJ 切面匹配的 Bean 创建代理.

Main.java(com.test.spring.aop.impl.Main)

package com.test.spring.aop.impl;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class Main {
    public static void main(String[] args) {

        // 1. 创建 Spring 的 IOC 容器
        ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext.xml");

        // 2. 从 IOC 容器中获取 bean 的实例
        ArithmeticCalculator arithmeticCalculator = ctx.getBean(ArithmeticCalculator.class);

        // 3. 使用 bean
        int result = arithmeticCalculator.add(3, 6);
        System.out.println("result：" + result);

        result = arithmeticCalculator.div(12, 6);
        System.out.println("result：" + result);
    }
}

【Spring】14 AOP 基础

相关推荐