Spring4 之 AOP

叁歲伎倆 2022-06-05 01:42 212阅读 0赞

## **Spring4 之 AOP** ##

本节我们学习一下Spring AOP 并通过示例来详细了解 SpringAOP 机制。

--------------------

## **概念** ##

*  AOP(Aspect-Oriented Programming, 面向切面编程): 是一种新的方法论, 是对传统 OOP(Object-Oriented Programming, 面向对象编程) 的补充。
 *  AOP 的主要编程对象是切面(aspect), 而切面模块化横切关注点。
 *  在应用 AOP 编程时, 仍然需要定义公共功能, 但可以明确的定义这个功能在哪里, 以什么方式应用, 并且不必修改受影响的类. 这样一来横切关注点就被模块化到特殊的对象(切面)里。
 *  AOP 的好处:
    
     *  每个事物逻辑位于一个位置, 代码不分散, 便于维护和升级
     *  业务模块更简洁, 只包含核心业务代码
 *  一个案例
    
    ![这里写图片描述][SouthEast]
    
    现在我们需要执行4个方法 分别为 add(),sub(),mul() 和 div()，但在执行之前我们需要：
    
     *  验证参数，在 div() 方法中有一个除法运算，其中 分母不能为0！
     *  方法调用前做前置日志输出
     *  方法调用之后做后置日志输出  
        因而用AOP的思想去处理这些需求是可以简化为一下：
        
        ![这里写图片描述][SouthEast 1]
 *  AOP 中的一些专业术语
    
     *  切面(Aspect): 横切关注点(跨越应用程序多个模块的功能)被模块化的特殊对象
     *  通知(Advice): 切面必须要完成的工作
     *  目标(Target): 被通知的对象
     *  代理(Proxy): 向目标对象应用通知之后创建的对象
     *  连接点（Joinpoint）：程序执行的某个特定位置：如类某个方法调用前、调用后、方法抛出异常后等。连接点由两个信息确定：方法表示的程序执行点；相对点表示的方位。例如 ArithmethicCalculator\#add() 方法执行前的连接点，执行点为 ArithmethicCalculator\#add()； 方位为该方法执行前的位置
     *  切点（pointcut）：每个类都拥有多个连接点：例如 ArithmethicCalculator 的所有方法实际上都是连接点，即连接点是程序类中客观存在的事务。AOP 通过切点定位到特定的连接点。类比：连接点相当于数据库中的记录，切点相当于查询条件。切点和连接点不是一对一的关系，一个切点匹配多个连接点，切点通过 org.springframework.aop.Pointcut 接口进行描述，它使用类和方法作为连接点的查询条件。

--------------------

## **实例** ##

下面我将通过实例来实现Spring AOP。

*  新建一个Spring 项目可以是纯JAVA 项目也可以是WEB项目。
    
     *  项目结构  
        ![这里写图片描述][SouthEast 2]
     *  pom.xml
        
            <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
                <modelVersion>4.0.0</modelVersion>
                <groupId>com.apache.spring</groupId>
                <artifactId>SpringExample</artifactId>
                <version>0.0.1-SNAPSHOT</version>
                <packaging>war</packaging>
            
                
                <dependencies>
                    <dependency>
                        <groupId>org.springframework</groupId>
                        <artifactId>spring-core</artifactId>
                        <version>4.3.7.RELEASE</version>
                    </dependency>
            
                    
                    <dependency>
                        <groupId>org.springframework</groupId>
                        <artifactId>spring-webmvc</artifactId>
                        <version>4.3.7.RELEASE</version>
                    </dependency>
            
                    
                    <dependency>
                        <groupId>org.springframework</groupId>
                        <artifactId>spring-web</artifactId>
                        <version>4.3.7.RELEASE</version>
                    </dependency>
            
                    
                    
                    <dependency>
                        <groupId>cglib</groupId>
                        <artifactId>cglib</artifactId>
                        <version>2.2.2</version>
                    </dependency>
            
                    
                    <dependency>
                        <groupId>org.aopalliance</groupId>
                        <artifactId>com.springsource.org.aopalliance</artifactId>
                        <version>1.0.0</version>
                    </dependency>
            
                    
                    <dependency>
                        <groupId>org.aspectj</groupId>
                        <artifactId>aspectjweaver</artifactId>
                        <version>1.6.8</version>
                    </dependency>
            
                    
                    <dependency>
                        <groupId>org.springframework</groupId>
                        <artifactId>spring-aspects</artifactId>
                        <version>4.3.7.RELEASE</version>
                    </dependency>
            
            
                    
                </dependencies>
            </project>
 *  JAVA 部分代码
    
     *  ArithmeticCalculator.java
        
            package com.spring.example.dao;
            
            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
        
            package com.spring.example.dao.impl;
            
            import com.spring.example.dao.ArithmeticCalculator;
            
            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
        
            package com.spring.example.utils.aop;
            
            import java.util.Arrays;
            
            import org.aspectj.lang.JoinPoint;
            import org.aspectj.lang.ProceedingJoinPoint;
            import org.aspectj.lang.annotation.Around;
            
            public class LoggingAspect {
            
                public void beforeMethod(JoinPoint joinPoint){
                    String methodName = joinPoint.getSignature().getName();
                    Object [] args = joinPoint.getArgs();
            
                    System.out.println("LoggingValidation " + methodName + " begins with " + Arrays.asList(args));
                }
            
                public void afterMethod(JoinPoint joinPoint){
                    String methodName = joinPoint.getSignature().getName();
                    System.out.println("LoggingValidation " + methodName + " ends");
                }
            
                public void afterReturning(JoinPoint joinPoint, Object result){
                    String methodName = joinPoint.getSignature().getName();
                    System.out.println("LoggingValidation " + methodName + " ends with " + result);
                }
            
                public void afterThrowing(JoinPoint joinPoint, Exception e){
                    String methodName = joinPoint.getSignature().getName();
                    System.out.println("LoggingValidation " + methodName + " occurs excetion:" + e);
                }
            
                @Around("execution(public int com.spring.example.dao.impl.ArithmeticCalculatorImpl.*(..))")
                public Object aroundMethod(ProceedingJoinPoint pjd){
            
                    Object result = null;
                    String methodName = pjd.getSignature().getName();
            
                    try {
                        //前置通知
                        System.out.println(" Around Annotation The method " + methodName + " begins with " + Arrays.asList(pjd.getArgs()));
                        //执行目标方法
                        result = pjd.proceed();
                        //返回通知
                        System.out.println(" Around Annotation The method " + methodName + " ends with " + result);
                    } catch (Throwable e) {
                        //异常通知
                        System.out.println(" Around Annotation The method " + methodName + " occurs exception:" + e);
                        throw new RuntimeException(e);
                    }
                    //后置通知
                    System.out.println(" Around Annotation The method " + methodName + " ends");
                    return result;
                }
            }
     *  ValidationAspect.java
        
            package com.spring.example.utils.aop;
            
            import java.util.Arrays;
            
            import org.aspectj.lang.JoinPoint;
            
            public class ValidationAspect {
            
                public void validateArgs(JoinPoint joinPoint){
                    System.out.println("--> Args validate:" + Arrays.asList(joinPoint.getArgs()));
                }
            
            }
     *  TestAOP.java
        
            package com.spring.example.test;
            
            import org.springframework.context.ApplicationContext;
            import org.springframework.context.support.ClassPathXmlApplicationContext;
            
            import com.spring.example.dao.ArithmeticCalculator;
            
            public class TestAOP {
            
                public static void main(String[] args) {
            
                    ApplicationContext ctx = new ClassPathXmlApplicationContext("ApplicationContext.xml");
                    ArithmeticCalculator arithmeticCalculator = (ArithmeticCalculator) ctx.getBean("arithmeticCalculator");
            
                    System.out.println(arithmeticCalculator.getClass().getName());
            
                    int result = arithmeticCalculator.add(1, 2);
                    System.out.println("result:" + result);
            
                    result = arithmeticCalculator.sub(8, 5);
                    System.out.println("result:" + result);
            
                    result = arithmeticCalculator.div(1000, 10);
                    System.out.println("result:" + result);
            
                }
            
            }
 *  Bean 的 AOP 配置
    
        
            <bean id="arithmeticCalculator" class="com.spring.example.dao.impl.ArithmeticCalculatorImpl"></bean>
        
            
            <bean id="loggingAspect" class="com.spring.example.utils.aop.LoggingAspect"></bean>
        
            <bean id="validationAspect" class="com.spring.example.utils.aop.ValidationAspect"></bean>
        
            
            <aop:config>
                
                <aop:pointcut expression="execution(* com.spring.example.dao.impl.ArithmeticCalculatorImpl.*(..))" id="pointcut" />
        
                
                <aop:aspect ref="loggingAspect" order="2">
                    
                    <aop:before method="beforeMethod" pointcut-ref="pointcut" />
                    
                    <aop:after method="afterMethod" pointcut-ref="pointcut" />
                           
                    <aop:after-throwing method="afterThrowing" pointcut-ref="pointcut" throwing="e" />
        
                    <aop:after-returning method="afterReturning" pointcut-ref="pointcut" returning="result" />
                    
                    <aop:around method="aroundMethod" pointcut-ref="pointcut" />
                </aop:aspect>
        
                <aop:aspect ref="validationAspect" order="1">
                    <aop:before method="validateArgs" pointcut-ref="pointcut" />
                </aop:aspect>
            </aop:config>
 *  结果
    
        com.sun.proxy.$Proxy8
        --> Args validate:[1, 2]
        LoggingValidation add begins with [1, 2]
         Around Annotation The method add begins with [1, 2]
         Around Annotation The method add ends with 3
         Around Annotation The method add ends
        LoggingValidation add ends with 3
        LoggingValidation add ends
        result:3
        --> Args validate:[8, 5]
        LoggingValidation sub begins with [8, 5]
         Around Annotation The method sub begins with [8, 5]
         Around Annotation The method sub ends with 3
         Around Annotation The method sub ends
        LoggingValidation sub ends with 3
        LoggingValidation sub ends
        result:3
        --> Args validate:[1000, 10]
        LoggingValidation div begins with [1000, 10]
         Around Annotation The method div begins with [1000, 10]
         Around Annotation The method div ends with 100
         Around Annotation The method div ends
        LoggingValidation div ends with 100
        LoggingValidation div ends
        result:100

--------------------

## **小结** ##

*  Spring AOP 在 实际项目中的应用要复杂的多，但基本的配置与思路万变不离其宗。
 *  要实现Spring AOP 需要 AspectJ 的配合(需要添加而外的 jar包，参考pom.xml)

[SouthEast]: /images/20220605/8e653bf3461b414f8341803ca05d0957.png
[SouthEast 1]: /images/20220605/c5af5e2f50b648b280474df955e6a49f.png
[SouthEast 2]: /images/20220605/c131483ac94143018de1b7f6fdea54c8.png