标签：Spring joinPoint Boot 切面 org 注解 import 方法

文章目录

• 1.什么是切面编程AOP
• 2.Spring Boot 集成AOP
• 2.1添加maven依赖
• 2.2 切面编程 (实现日志打印实例)
• 2.2.1 创建切面类LogAspectHandler.java
• 2.2.2 @Pointcut：切点
• 2.2.3 @Before：前置建言
• 2.2.4 @After：后置建言
• 2.2.5 @AfterReturning
• 2.2.6 @AfterThrowing
• 2.2.7 @Around：环绕
• 3.有什么应用场景
• 4.总结

1.什么是切面编程AOP

官方解释：

AOP通过预编译方式和运行期动态代理实现在不修改源代码的情况下给程序动态统一添加功能的一种技术。可以在代码阶段实现分离关注，实现松耦合，然后在运行时将相关动作特征植入运行，从而改变程序的运行顺序，达到拦截或者增加功能的目的。

好吧，我承认，读起来很拗口，而且估计你读完一遍再读一遍，也不能理解是什么意思。

下面我提出一种场景，看看你会怎么实现，用此例子来理解切面编程。

有A，B, C三个方法，但是在调用每一个方法之前，要求打印一个日志：某一个方法被开始调用了！在调用每个方法之后，也要求打印日志：某个方法被调用完了！统计一下每个方法执行的耗时。

一般人会在每一个方法的开始和结尾部分都会添加一句日志打印吧，这样做如果方法多了，就会有很多重复的代码，显得很麻烦，这时候有人会想到，为什么不把打印日志这个功能封装一下，然后让它能在指定的地方（比如执行方法前，或者执行方法后）自动的去调用呢？这样做也是比较啰嗦，不能让开发者专业的去做业务开发。

如果可以的话，业务功能代码中就不会掺杂这一下其他的代码，所以AOP就是做了这一类的工作，比如，日志输出，事务控制，异常的处理等。

下面介绍一下Springboot怎么集成AOP

2.Spring Boot 集成AOP

2.1添加maven依赖

使用AOP，首先要引入对AOP的依赖，如下：

<!--Aop的依赖-->
 <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-aop</artifactId>
 </dependency>

2.2 切面编程 (实现日志打印实例)

这是几个重要的注解：

1.@Pointcut：定义一个切面，即上面所描述的关注的某件事入口。
2.@Before：在做某件事之前做的事。
3.@After：在做某件事之后做的事。
4.@AfterReturning：在做某件事之后，对其返回值做增强处理。
5.@AfterThrowing：在做某件事抛出异常时，处理。
6.@Around：环绕建言（advice），在原方法执行前执行，在原方法执行后再执行（@Around可以实现其他两种advice）

2.2.1 创建切面类LogAspectHandler.java

Spring Boot 中集成 AOP 非常简单，假如我们要在项目中打印一些日志，我们新建一个类 LogAspectHandler，用来定义切面和处理方法。只要在类上加个@Aspect注解即可。@Aspect 注解用来描述一个切面类，定义切面类的时候需要打上这个注解。@Component 注解是把此类交给 Spring 来管理。

@Aspect
@Component
public class LogAspectHandler {

}

2.2.2 @Pointcut：切点

@Pointcut 注解：用来定义一个切面（切入点），即定义拦截规则，确定有哪些方法会被切入。切入点决定了连接点关注的内容，使得我们可以控制通知什么时候执行。

@Aspect
@Component
public class LogAspectHandler {
    /**
     * 定义一个切面，拦截com.ieslab.powergrid.demosvr.controller包和子包下的所有方法
     */
    @Pointcut("execution(* com.ieslab.powergrid.demosvr.controller..*.*(..))")
    public void pointCut() {}
}

@Pointcut 注解指定一个切面，定义需要拦截的东西，这里重点介绍两个常用的表达式：一个是使用 execution()，另一个是使用 annotation()。

首先以 execution(* com.ieslab.powergrid.demosvr.controller..*.*(..))) 表达式为例，语法如下：

1. execution() 为表达式主体
2. 第一个 * 号的位置：表示返回值类型，* 表示所有类型
3. 包名：表示需要拦截的包名，后面的两个句点表示当前包和当前包的所有子包，com.itcodai.course09.controller 包、子包下所有类的方法
4. 第二个 * 号的位置：表示类名，* 表示所有类
5. *(..) ：这个星号表示方法名，* 表示所有的方法，后面括弧里面表示方法的参数，两个句点表示任何参数

annotation() 方式是针对某个注解来定义切面，比如我们对具有@GetMapping注解的方法做切面，可以如下定义切面：

@Pointcut("@annotation(org.springframework.web.bind.annotation.GetMapping)")
public void annotationCut() {}

然后使用该切面的话，就会切入注解是 @GetMapping 的方法。因为在实际项目中，可能对于不同的注解有不同的逻辑处理，比如 @GetMapping、@PostMapping、@DeleteMapping 等。所以这种按照注解的切入方式在实际项目中也很常用。

在实际的应用中，我们有时也会自定义注解，并按照自定义注解进行定义切面，这样就可以针对添加自定义注解的方法进行拦截。

2.2.3 @Before：前置建言

@Before 注解：前置建言（advice），指定的方法在切面切入目标方法之前执行，可以做一些 log 处理，也可以做一些信息的统计，比如获取用户的请求 url 以及用户的 ip 地址等等，这个在做个人站点的时候都能用得到，都是常用的方法。例如：

package com.ieslab.powergrid.demosvr.utils;

import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;

/** <p>Title: LogAspectHandler </p>
 * <p>Description: 日志切面处理类 </p>
 *
 * @author bingge
 * @date 2020-2-20 下午7:15:30
 * @version V1.0
 */
@Aspect
@Component
@Slf4j
public class LogAspectHandler {
    /**
     * 定义一个切面，拦截com.ieslab.powergrid.demosvr.controller包和子包下的所有方法
     */
    @Pointcut("execution(* com.ieslab.powergrid.demosvr.controller..*.*(..))")
    public void pointCut() {}

    /**
     * 在上面定义的切面方法之前执行该方法
     * @param joinPoint jointPoint
     */
    @Before("pointCut()")
    public void doBefore(JoinPoint joinPoint) {
        log.info("====doBefore方法进入了====");

        // 获取签名
        Signature signature = joinPoint.getSignature();
        // 获取切入的包名
        String declaringTypeName = signature.getDeclaringTypeName();
        // 获取即将执行的方法名
        String funcName = signature.getName();
        log.info("即将执行方法为: {}，属于{}包", funcName, declaringTypeName);

        // 也可以用来记录一些信息，比如获取请求的url和ip
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        // 获取请求url
        String url = request.getRequestURL().toString();
        // 获取请求ip
        String ip = request.getRemoteAddr();
        log.info("用户请求的url为：{}，ip地址为：{}", url, ip);
    }
}

JointPoint 对象很有用，可以用它来获取一个签名，然后利用签名可以获取请求的包名、方法名，包括参数（通过 joinPoint.getArgs() 获取）等等。

2.2.4 @After：后置建言

后置建言（advice），@After 注解和 @Before 注解相对应，指定的方法在切面切入目标方法之后执行，也可以做一些完成某方法之后的 log 处理。

增加代码如下：

/**
     * 在上面定义的切面方法之后执行该方法
     * @param joinPoint jointPoint
     */
    @After("pointCut()")
    public void doAfter(JoinPoint joinPoint) {
        log.info("====doAfter方法进入了====");
        Signature signature = joinPoint.getSignature();
        String method = signature.getName();
        log.info("方法{}已经执行完", method);
    }

讲到到这里，我们先写一个 Controller 来测试一下执行结果，新建一个 AopController 如下：

package com.ieslab.powergrid.demosvr.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/aop")
public class AopController {

    /**
     * 测试接口
     * @param name 名称
     * @return
     */
    @GetMapping("/test/{name}")
    public String testAop(@PathVariable String name) {
        return "Hello " + name;
    }

}

启动项目，在浏览器中输入 http://localhost:8080/aop/test/binge，看一下控制台的输出信息：

如果所示，前两步增加的日志都已经打印出来。

2.2.5 @AfterReturning

在做某件事之后，对其返回值做增强处理：@AfterReturning 注解和 @After 有些类似，区别在于 @AfterReturning 注解可以用来捕获切入方法执行完之后的返回值，对返回值进行业务逻辑上的增强处理。

例如：在LogAspectHandler.java类中继续增加如下代码：

    /**
     * 可以捕获返回对象或者对返回对象进行增强
     * @param joinPoint joinPoint
     * @param result result
     */
    @AfterReturning(pointcut = "pointCut()", returning = "result")
    public void doAfterReturning(JoinPoint joinPoint, Object result) {
        Signature signature = joinPoint.getSignature();
        String classMethod = signature.getName();
        log.info("方法{}执行完毕，返回参数为：{}", classMethod, result);
        // 实际项目中可以根据业务做具体的返回值增强
        log.info("对返回参数进行业务上的增强：{}", result + "增强版");
    }

运行程序，继续在浏览器中输入 http://localhost:8080/aop/test/binge，观察控制台日志：

注意：在 @AfterReturning注解 中，属性 returning 的值必须要和参数保持一致，否则会检测不到。该方法中的第二个入参就是被切方法的返回值，在 doAfterReturning 方法中可以对返回值进行增强，可以根据业务需要做相应的处理再封装。

2.2.6 @AfterThrowing

顾名思义，@AfterThrowing 注解是当被切方法执行时抛出异常时，会进入 @AfterThrowing 注解的方法中执行，在该方法中可以做一些异常的处理逻辑。要注意的是 throwing 属性的值必须要和参数一致，否则会报错。该方法中的第二个入参即为抛出的异常。

在LogAspectHandler.java类中继续增加如下代码：

/**
 * 在上面定义的切面方法执行抛异常时，执行该方法
 * @param joinPoint 切入点
 * @param ex 错误信息
 */
@AfterThrowing(pointcut = "pointCut()", throwing = "ex")
public void afterThrowing(JoinPoint joinPoint, Throwable ex) {
    Signature signature = joinPoint.getSignature();
    String method = signature.getName();
    // 处理异常的逻辑
    log.info("执行方法{}出错，异常为：{}", method, ex);
}

在TestController类中添加如下代码，故意制造异常：

@GetMapping("/testException")
public String testException() {
    int num = 1/0;
    return "Hello world";
}

重新启动程序，继续在浏览器中输入 http://localhost:8080/aop/test/binge，观察控制台日志：

2.2.7 @Around：环绕

环绕建言（advice），在原方法执行前执行，在原方法执行后再执行（@Around可以实现其他两种advice）。此处不再介绍，请自己试试。

3.有什么应用场景

权限控制、日志输出，事务控制，异常的处理。
日志场景已经介绍，后续会在其他文章介绍其他场景的使用。

4.总结

本节课针对Spring Boot中的切面 AOP 做了详细的讲解，主要介绍了 Spring Boot中 AOP的引入，常用注解的使用，参数的使用，以及常用api的介绍。

AOP在实际项目中很有用，对切面方法执行前后都可以根据具体的业务，做相应的预处理或者增强处理，同时也可以用作异常捕获处理，可以根据具体业务场景，合理去使用AOP。

• 点赞 1
• 收藏
• 分享
• • 文章举报

斌哥谈程序 发布了25 篇原创文章 · 获赞 5 · 访问量 617 私信 关注

标签：Spring,joinPoint,Boot,切面,org,注解,import,方法
来源： https://blog.csdn.net/houpeibin2012/article/details/104444756

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。