三种方式实现AOP

三种方式实现AOP

什么是AOP

AOP是（Aspect Oriented Programming的缩写），意为：面向切面编程，通过预编译方式和运行期间动态代理实现程序功能的统一维护的一种技术。AOP是OOP的延续，是软件开发中的一个热点，也是Spring框架中的一个重要内容，是函数式编程的一种衍生范型。利用AOP可以对业务逻辑的各个部分进行隔离，从而使得业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高了开发的效率。

AOP中的概念很多
先记住两个，一个是切点(pointcut)切点就是比如日志功能添加的函数
另一个是通知，即实现的日志功能的具体方法

SpringAOP中支持的5中类型的Advice:

通知类型	连接点	实现接口
前置通知	方法方法前	org.springframwork.aop.MethodBeforeAdvice
后置通知	方法后	org.springframwork.aop.AfterReturningAdvice
环绕通知	方法前后	org.aopalliance.intercept.MethodInterceptor
异常抛出通知	方法抛出异常	org.springframwork.aop.ThrowsAdvice
引介通知	类中增加新的方法属性	org.springframwork.aop.IntroductionInterceptor

实践

方式一 实现spring接口

背景：给Service中每个方法添加日志功能
service接口

package com.kuang.service;

/**
 * 功能描述
 *
 * @since 2022-07-05
 */
public interface IUserService {
    void add();

    void delete();

    void update();

    void query();
}

service实现类

package com.kuang.service;

/**
 * 功能描述
 *
 * @since 2022-07-05
 */
public class UserServiceImpl implements IUserService {
    @Override
    public void add() {
        System.out.println("add");
    }

    @Override
    public void delete() {
        System.out.println("delete");
    }

    @Override
    public void update() {
        System.out.println("update");
    }

    @Override
    public void query() {
        System.out.println("query");
    }
}

后置日志

package com.kuang.log;

import java.lang.reflect.Method;

import org.springframework.aop.AfterReturningAdvice;

/**
 * 功能描述
 *
 * @since 2022-07-05
 */
public class LogAfter implements AfterReturningAdvice {
    @Override
    public void afterReturning(Object returnValue, Method method, Object[] args, Object target) throws Throwable {
        System.out.println(target.getClass().getName() + "的" + method.getName() + "方法后执行并返回" + returnValue);
    }
}

前置日志

package com.kuang.log;

import java.lang.reflect.Method;

import org.springframework.aop.AfterReturningAdvice;

/**
 * 功能描述
 *
 * @since 2022-07-05
 */
public class LogAfter implements AfterReturningAdvice {
    @Override
    public void afterReturning(Object returnValue, Method method, Object[] args, Object target) throws Throwable {
        System.out.println(target.getClass().getName() + "的" + method.getName() + "方法后执行并返回" + returnValue);
    }
}

测试类

package com.kuang;

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

import com.kuang.service.IUserService;

/**
 * 功能描述
 *
 * @since 2022-07-05
 */
public class Test1 {
    public static void main(String[] args) {
        ApplicationContext context = new ClassPathXmlApplicationContext("ApplicationContext.xml");
        IUserService userService = context.getBean("userService", IUserService.class);
        userService.add();
        userService.delete();
    }
}

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
  https://www.springframework.org/schema/beans/spring-beans.xsd
  http://www.springframework.org/schema/aop
  https://www.springframework.org/schema/aop/spring-aop.xsd">

    <bean id="userService" class="com.kuang.service.UserServiceImpl"></bean>
    <bean id="logafter" class="com.kuang.log.LogAfter"></bean>
    <bean id="logbefore" class="com.kuang.log.LogBefore"></bean>

    <aop:config>
        <!--切入点：UserServiceImpl的所有方法-->
        <aop:pointcut id="pointcut" expression="execution(* com.kuang.service.UserServiceImpl.*(..))" />
        <!--执行环绕增加-->
        <aop:advisor advice-ref="logbefore" pointcut-ref="pointcut" />
        <aop:advisor advice-ref="logafter" pointcut-ref="pointcut" />
    </aop:config>


</beans>

pom.xml中添加aop的依赖

<!-- https://mvnrepository.com/artifact/org.aspectj/aspectjweaver -->
<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjweaver</artifactId>
    <version>1.9.9</version>
</dependency>

com.kuang.service.UserServiceImpl的add方法先执行
add
com.kuang.service.UserServiceImpl的add方法后执行并返回null
com.kuang.service.UserServiceImpl的delete方法先执行
delete
com.kuang.service.UserServiceImpl的delete方法后执行并返回null

实现二 自定义日志类
以实现一中的例子为基础继续

定义自己的日志实现类

package com.kuang.diy;

/**
 * 功能描述
 *
 * @since 2022-07-06
 */
public class DiyLog {
    public void before1() {
        System.out.println("--------------before func-----------------");
    }

    public void after1() {
        System.out.println("--------------after func-----------------");
    }
}

更改配置类

<?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
  https://www.springframework.org/schema/beans/spring-beans.xsd
  http://www.springframework.org/schema/aop
  https://www.springframework.org/schema/aop/spring-aop.xsd">

    <bean id="userService" class="com.kuang.service.UserServiceImpl"></bean>
    <bean id="logafter" class="com.kuang.log.LogAfter"></bean>
    <bean id="logbefore" class="com.kuang.log.LogBefore"></bean>

    <!--  第二种方法：自定义类实现日志功能  -->
    <bean id="diy" class="com.kuang.diy.DiyLog"></bean>
    <aop:config>
        <aop:aspect ref="diy">
            <aop:pointcut id="pointcut" expression="execution(* com.kuang.service.UserServiceImpl.*(..))" />
            <aop:before method="before1" pointcut-ref="pointcut"></aop:before>
            <aop:after method="after1" pointcut-ref="pointcut"></aop:after>
        </aop:aspect>
    </aop:config>

</beans>

执行测试类的结果

--------------before func-----------------
add
--------------after func-----------------
--------------before func-----------------
delete
--------------after func-----------------

分析：
DiyLog的实例就是一个切面（Aspect），这个切面中的方法就是通知（Advice）
被插入日志功能的地方就是切入点（PointCut）例子中就是UserServiceImpl中的所有方法

方式三 通过注解实现

在方法一的基础上新增注解方式的日志类

package com.kuang.diy;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;

/**
 * 功能描述
 *
 * @since 2022-07-06
 */
@Aspect
public class AnnotationLog {
    private static final String POINTCUT1 = "execution(* com.kuang.service.UserServiceImpl.*(..))";

    @Before(POINTCUT1)
    public void before() {
        System.out.println("-----------before------------");
    }

    @After(POINTCUT1)
    public void after() {
        System.out.println("-----------after------------");
    }

    @Around(POINTCUT1)
    public void around(ProceedingJoinPoint pj) throws Throwable {

        System.out.println("-----------before around------------");
        System.out.println(pj.getSignature());
        Object proceed = pj.proceed();
        System.out.println("-----------after arond------------");
    }
}

Spring配置文件中添加注解支持

<?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
  https://www.springframework.org/schema/beans/spring-beans.xsd
  http://www.springframework.org/schema/aop
  https://www.springframework.org/schema/aop/spring-aop.xsd">

    <bean id="userService" class="com.kuang.service.UserServiceImpl"></bean>
    <bean id="logafter" class="com.kuang.log.LogAfter"></bean>
    <bean id="logbefore" class="com.kuang.log.LogBefore"></bean>

    <!--方式三-->
    <bean id="annotationLog" class="com.kuang.diy.AnnotationLog"></bean>
    <!--开启注解支持-->
    <aop:aspectj-autoproxy></aop:aspectj-autoproxy>

</beans>

运行测试类输出结果

-----------before around------------
void com.kuang.service.IUserService.add()
-----------before------------
add
-----------after------------
-----------after arond------------
-----------before around------------
void com.kuang.service.IUserService.delete()
-----------before------------
delete
-----------after------------
-----------after arond------------