springboot的AOP整理总结

标签：总结 springboot joke second AOP execution 方法 public String

aop是spring的两大功能模块之一，功能非常强大，为解耦提供了非常优秀的解决方案。

现在就以springboot中aop的使用来了解一下aop。

一：使用aop来完成全局请求日志处理

pom文件如下：

<?xml version="1.0" encoding="UTF-8"?>  
<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.example</groupId>  
    <artifactId>testaop</artifactId>  
    <version>0.0.1-SNAPSHOT</version>  
    <packaging>jar</packaging>  
  
    <name>testaop</name>  
    <description>Demo project for Spring Boot</description>  
  
    <parent>  
        <groupId>org.springframework.boot</groupId>  
        <artifactId>spring-boot-starter-parent</artifactId>  
        <version>1.5.9.RELEASE</version>  
        <relativePath/> <!-- lookup parent from repository -->  
    </parent>  
  
    <properties>  
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>  
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>  
        <java.version>1.8</java.version>  
    </properties>  
  
    <dependencies>  
        <dependency>  
            <groupId>org.springframework.boot</groupId>  
            <artifactId>spring-boot-starter-aop</artifactId>  
        </dependency>  
        <dependency>  
            <groupId>org.springframework.boot</groupId>  
            <artifactId>spring-boot-starter-web</artifactId>  
        </dependency>  
  
        <dependency>  
            <groupId>org.springframework.boot</groupId>  
            <artifactId>spring-boot-starter-test</artifactId>  
            <scope>test</scope>  
        </dependency>  
    </dependencies>  
  
    <build>  
        <plugins>  
            <plugin>  
                <groupId>org.springframework.boot</groupId>  
                <artifactId>spring-boot-maven-plugin</artifactId>  
            </plugin>  
        </plugins>  
    </build>  
  
</project>

controller

@RestController  
public class FirstController {  
  
    @RequestMapping("/first")  
    public Object first() {  
        return "first controller";  
    }  
  
    @RequestMapping("/doError")  
    public Object error() {  
        return 1 / 0;  
    }  
}

aspect切面类

package com.example.aop;  
  
import org.aspectj.lang.JoinPoint;  
import org.aspectj.lang.ProceedingJoinPoint;  
import org.aspectj.lang.annotation.*;  
import org.springframework.stereotype.Component;  
import org.springframework.web.context.request.RequestContextHolder;  
import org.springframework.web.context.request.ServletRequestAttributes;  
  
import javax.servlet.http.HttpServletRequest;  
import java.util.Arrays;  
  
/** 
 * Created by wuwf on 17/4/27. 
 * 日志切面 
 */  
@Aspect  
@Component  
public class LogAspect {  
    @Pointcut("execution(public * com.example.controller.*.*(..))")  
    public void webLog(){}  
  
    @Before("webLog()")  
    public void deBefore(JoinPoint joinPoint) throws Throwable {  
        // 接收到请求，记录请求内容  
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();  
        HttpServletRequest request = attributes.getRequest();  
        // 记录下请求内容  
        System.out.println("URL : " + request.getRequestURL().toString());  
        System.out.println("HTTP_METHOD : " + request.getMethod());  
        System.out.println("IP : " + request.getRemoteAddr());  
        System.out.println("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());  
        System.out.println("ARGS : " + Arrays.toString(joinPoint.getArgs()));  
  
    }  
  
    @AfterReturning(returning = "ret", pointcut = "webLog()")  
    public void doAfterReturning(Object ret) throws Throwable {  
        // 处理完请求，返回内容  
        System.out.println("方法的返回值 : " + ret);  
    }  
  
    //后置异常通知  
    @AfterThrowing("webLog()")  
    public void throwss(JoinPoint jp){  
        System.out.println("方法异常时执行.....");  
    }  
  
    //后置最终通知,final增强，不管是抛出异常或者正常退出都会执行  
    @After("webLog()")  
    public void after(JoinPoint jp){  
        System.out.println("方法最后执行.....");  
    }  
  
    //环绕通知,环绕增强，相当于MethodInterceptor  
    @Around("webLog()")  
    public Object arround(ProceedingJoinPoint pjp) {  
        System.out.println("方法环绕start.....");  
        try {  
            Object o =  pjp.proceed();  
            System.out.println("方法环绕proceed，结果是 :" + o);  
            return o;  
        } catch (Throwable e) {  
            e.printStackTrace();  
            return null;  
        }  
    }  
}

结果

启动项目

模拟正常执行的情况，访问http://localhost:8080/first，看控制台结果：

方法环绕start.....
URL : http://localhost:8080/first
HTTP_METHOD : GET
IP : 0:0:0:0:0:0:0:1
CLASS_METHOD : com.example.controller.FirstController.first
ARGS : []
方法环绕proceed，结果是 :first controller
方法最后执行.....
方法的返回值 : first controller

/****************************分割线****************************/

模拟出现异常时的情况，访问http://localhost:8080/doError，看控制台结果：
方法环绕start.....
URL : http://localhost:8080/doError
HTTP_METHOD : GET
IP : 0:0:0:0:0:0:0:1
CLASS_METHOD : com.example.controller.FirstController.error
ARGS : []
java.lang.ArithmeticException: / by zero

......

方法最后执行.....
方法的返回值 : null

/****************************分割线****************************/

通过上面的简单的例子，可以看到aop的执行顺序。知道了顺序后，就可以在相应的位置做切面处理了。

二：切面方法说明

@Aspect

作用是把当前类标识为一个切面供容器读取

@Before

标识一个前置增强方法，相当于BeforeAdvice的功能

@AfterReturning

后置增强，相当于AfterReturningAdvice，方法退出时执行

@AfterThrowing

异常抛出增强，相当于ThrowsAdvice

@After

final增强，不管是抛出异常或者正常退出都会执行

@Around

环绕增强，相当于MethodInterceptor

/分割线/

各方法参数说明：

除了@Around外，每个方法里都可以加或者不加参数JoinPoint，如果有用JoinPoint的地方就加，不加也可以，JoinPoint里包含了类名、被切面的方法名，参数等属性，可供读取使用。@Around参数必须为ProceedingJoinPoint，pjp.proceed相应于执行被切面的方法。@AfterReturning方法里，可以加returning = “XXX”，XXX即为在controller里方法的返回值，本例中的返回值是“first controller”。@AfterThrowing方法里，可以加throwing = "XXX"，供读取异常信息，如本例中可以改为：

//后置异常通知  
    @AfterThrowing(throwing = "ex", pointcut = "webLog()")  
    public void throwss(JoinPoint jp, Exception ex){  
        System.out.println("方法异常时执行.....");  
    }

一般常用的有before和afterReturn组合，或者单独使用Around，即可获取方法开始前和结束后的切面。

三：关于切面PointCut的切入点

1.execution表达式

<aop:config>
        <aop:pointcut id="pointcut" expression="execution(* com.loongshawn.method.ces..*.*    
                                                          (..))" />
        <aop:aspect ref="logAspect">
            <aop:before pointcut-ref="pointcut" method="beforeAdvice"/>
            <aop:after-returning pointcut-ref="pointcut" arg-names="joinPoint,retValue" 
                 returning="retValue" method="afterAdvice"/>
        </aop:aspect>
</aop:config>

上述配置为AOP配置代码片段，其中expression部分为定义切点的表达式部分，如下：

execution(* com.loongshawn.method.ces..*.*(..))

注意：markdown中符号“”是加粗，因此输出“”符号需要进行转义“*”。

表达式结构解释如下：

标识符	含义
execution()	表达式的主体
第一个“*”符号	表示返回值的类型任意
com.loongshawn.method.ces	AOP所切的服务的包名，即，需要进行横切的业务类
包名后面的“..”	表示当前包及子包
第二个“*”	表示类名，*即所有类
.*(..)	表示任何方法名，括号表示参数，两个点表示任何参数类型

2.官方文档介绍

execution(modifiers-pattern? ret-type-pattern declaring-type-pattern?name-pattern(param-pattern) 
throws-pattern?)

上述表达式结构是Spring官方文档说明，翻译为中文如下，其中除了返回类型模式、方法名模式和参数模式外，其它项都是可选的。

execution(<修饰符模式>?<返回类型模式><方法名模式>(<参数模式>)<异常模式>?)

接下来，结合官方文档中的例子从不同的维度来了解execution表达式。表达式上方的中文说明为对该表达式的解释，请注意阅读方式。

1.通过方法修饰符定义切点

匹配所有的public修饰符的方法:

execution(public * *(..))

2.通过方法名定义切点

匹配所有”set”开头的方法:

execution(* set*(..))

3.通过类定义切点

匹配AccountService 接口的所有方法:

execution(* com.xyz.service.AccountService.*(..))

4.通过包定义切点

匹配service包中的所有方法:

execution(* com.xyz.service..(..))

匹配service包及其子包中的所有方法:

execution(* com.xyz.service...(..))

5.通过方法入参定义切点
切点表达式中方法入参部分比较复杂，可以使用””和“..”通配符，其中“”表示任意类型的参数，而“..”表示任意类型参数且参数个数不限。

匹配joke(String,int)方法，且joke()方法的第一个入参是String，第二个入参是int。如果方法中的入参类型是Java.lang包下的类，可以直接使用类名，否则必须使用全限定类名，如joke(java.util.List,int)；

execution(* joke(String,int))

匹配目标类中的joke()方法，该方法第一个入参为String，第二个入参可以是任意类型，如joke(Strings1,String s2)和joke(String s1,double d2)都匹配，但joke(String s1,doubled2,String s3)则不匹配；

execution(* joke(String,*))

匹配目标类中的joke()方法，该方法第一个入参为String，后面可以有任意个入参且入参类型不限，如joke(Strings1)、joke(String s1,String s2)和joke(String s1,double d2,Strings3)都匹配。

execution(* joke(String,..))

匹配目标类中的joke()方法，方法拥有一个入参，且入参是Object类型或该类的子类。它匹配joke(Strings1)和joke(Client c)。如果我们定义的切点是execution(*joke(Object))，则只匹配joke(Object object)而不匹配joke(Stringcc)或joke(Client c)。

execution(* joke(Object+))

3.官方文档

Aspect Oriented Programming with Spring–>11.2.3 Declaring a pointcut
https://docs.spring.io/spring/docs/current/spring-framework-reference/html/aop.html

仅对官方文档做了翻译及简要说明，需要在实际使用过程中加深印象及理解。

四：自定义注解

一般多用于某些特定的功能，比较零散的切面，譬如特定的某些方法需要处理，就可以单独在方法上加注解切面。

我们来自定义一个注解：

/** 
 * Created by wuwf on 17/4/27. 
 */  
@Target({ElementType.METHOD, ElementType.TYPE})  
@Retention(RetentionPolicy.RUNTIME)  
public @interface UserAccess {  
    String desc() default "无信息";  
}

注解里提供了一个desc的方法，供被切面的地方传参，如果不需要传参可以不写。

在Controller里加个方法

@RequestMapping("/second")  
    @UserAccess(desc = "second")  
    public Object second() {  
        return "second controller";  
    }

切面类：

/** 
 * Created by wuwf on 17/4/27. 
 */  
@Component  
@Aspect  
public class UserAccessAspect {  
  
    @Pointcut(value = "@annotation(com.example.aop.UserAccess)")  
    public void access() {  
  
    }  
  
    @Before("access()")  
    public void deBefore(JoinPoint joinPoint) throws Throwable {  
        System.out.println("second before");  
    }  
  
    @Around("@annotation(userAccess)")  
    public Object around(ProceedingJoinPoint pjp, UserAccess userAccess) {  
        //获取注解里的值  
        System.out.println("second around:" + userAccess.desc());  
        try {  
            return pjp.proceed();  
        } catch (Throwable throwable) {  
            throwable.printStackTrace();  
            return null;  
        }  
    }  
}

主要看一下@Around注解这里，如果需要获取在controller注解中赋给UserAccess的desc里的值，就需要这种写法，这样UserAccess参数就有值了。

结果

/****************************分割线****************************/

启动项目，访问http://localhost:8080/second，看控制台：

 

方法环绕start.....
URL : http://localhost:8080/second
HTTP_METHOD : GET
IP : 0:0:0:0:0:0:0:1
CLASS_METHOD : com.example.controller.FirstController.second
ARGS : []
second around:second
second before
方法环绕proceed，结果是 :second controller
方法最后执行.....
方法的返回值 : second controller

/****************************分割线****************************/

通知结果可以看到，两个aop切面类都工作了，顺序呢就是下面的：

aop1(最外层)---> aop2 ---> method（最里层）
所以大部分情况下，我们需要指定顺序，最简单的方式就是在Aspect切面类上加上@Order(1)注解即可，order越小最先执行，也就是位于最外层。像一些全局处理的就可以把order设小一点，具体到某个细节的就设大一点。

标签：总结,springboot,joke,second,AOP,execution,方法,public,String
From： https://www.cnblogs.com/ElloeStudy/p/17612420.html

一：使用aop来完成全局请求日志处理

二：切面方法说明

三：关于切面PointCut的切入点

1.execution表达式

2.官方文档介绍

1.通过方法修饰符定义切点

2.通过方法名定义切点

3.通过类定义切点

4.通过包定义切点

3.官方文档

四：自定义注解

相关文章

赞助商

阅读排行

springboot的AOP整理总结

一：使用aop来完成全局请求日志处理

二： 切面方法说明

三：关于切面PointCut的切入点

1.execution表达式

2.官方文档介绍

1.通过方法修饰符定义切点

2.通过方法名定义切点

3.通过类定义切点

4.通过包定义切点

3.官方文档

四：自定义注解

相关文章

赞助商

阅读排行

二：切面方法说明