springboot中的aop使用

基础

概念

AOP,一般称为面向切面,作为面向对象OOP的一种补充,用于将那些与业务无关,但却对多个对象产生影响的公共行为和逻辑,抽取并封装为一个可重用的模块,这个模块被命名为“切面”(Aspect),减少系统中的重复代码,降低了模块之间的耦合度,提高了系统的可维护性。可用于权限认证,日志和事务处理.

相关注解

@Component

将当前类注入到Spring容器内。

@Aspect

表明当前类是一个切面类。

@Pointcut

切入点,PointCut(切入点)表达式有很多种,其中execution用于使用切面的连接点。

@Before

前置通知,在被切入方法执行之前执行。

@After

后置通知,在被切入方法执行之后执行。

@AfterRuturning

返回通知,在被切入方法返回结果之后执行。使用此注解的方法,可以使用returning = "XXX"返回被切入方法的返回值,XXX即为被切入方法的返回值。

@Around

环绕通知,围绕着被切入方法执行。参数必须为ProceedingJoinPoint,pjp.proceed相应于执行被切面的方法。环绕通知一般单独使用,环绕通知可以替代上面的几种通知。

AOP demo使用

  1. 引入依赖
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-aop</artifactId>
   <version>2.7.1</version>
</dependency>

2.新建控制器及路由方法

package com.example.springbootTest.controller;

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

@RestController
public class TestController {

    @RequestMapping("/test1")
    public String test1() {
        System.out.println("test1");
        return "test1";
    }

    @RequestMapping("/test2")
    public Object test2(String name){
        System.out.println("test2");
        return "test2";
    }
}

3.新建切面类并根据业务配置切片类

package com.example.springbootTest.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;

@Aspect
@Component
public class TestAop {
    @Pointcut("execution(* *.*.*.*.TestController.test1(..))")
    public void log(){};

    @Before("log()")
    public void deBefore(JoinPoint jp) 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("CLASS_METHOD : " + jp);
        System.out.println("ARGS : " + Arrays.toString(jp.getArgs()));
        System.out.println("前置通知:方法执行前执行...");
    }
    @After("log()")
    public void deAfter(JoinPoint jp) throws Throwable {
        System.out.println("后置通知:方法执行后执行...");
    }
    @AfterReturning(returning = "ret", pointcut = "log()")
    public void  deAfterReturning(String ret) throws Throwable{
        System.out.println("返回通知:方法的返回值 : " + ret);
        System.out.println("AfterReturning");
    }

    @Around("log()")
    public Object deAround(ProceedingJoinPoint pjp) throws  Throwable{
        System.out.println("around");
        Object rtValue = null;
        try {
            Object[] args = pjp.getArgs();//得到方法执行所需的参数
            System.out.println("通知类中的aroundAdvice方法执行了。。前置");
            rtValue = pjp.proceed(args);//明确调用切入点方法(切入点方法)
            System.out.println("通知类中的aroundAdvice方法执行了。。返回");
            System.out.println("返回通知:"+rtValue);
        } catch (Throwable e) {
            System.out.println("通知类中的aroundAdvice方法执行了。。异常");
            throw new RuntimeException(e);
        } finally {
            System.out.println("通知类中的aroundAdvice方法执行了。。后置");
        }
    }
}

PointCut表达式

execution

execution(<修饰符模式>?<返回类型模式><方法名模式>(<参数模式>)),修饰符模式为非必填

execution(public * *(..))

匹配所有目标类的public方法,第一个“”代表方法返回值类型,第二个“”代表方法名,而".."代表任意入参的方法;

execution(* *st2(..))

匹配目标类所有以st2为后缀的方法。第一个“”代表任意方法返回类型,而“To”代表任意以To结尾的方法名。

execution(* ....TestController.*(..))

匹配TestController接口的所有方法,第一个“*”代表任意返回类型,“com.taotao.Waiter.”代表Waiter接口中的所有方法。

within

是用来指定类型的,指定类型中的所有方法将被拦截是用来指定类型的,指定类型中的所有方法将被拦截

within(com.example.springbootTest.service.impl.TestServiceImpl) 匹配TestServiceImpl类对应对象的所有方法调用,并且只能是TestServiceImpl对象,不能是它的子对象

within(com.demo…*)匹配com.demo包及其子包下面的所有类的所有方法的外部调用

this

SpringAOP是基于代理的,this就代表代理对象,语法是this(type),当生成的代理对象可以转化为type指定的类型时表示匹配。

this(com.demo.service.IUserService)匹配生成的代理对象是IUserService类型的所有方法的外部调用

target

SpringAOP是基于代理的,target表示被代理的目标对象,当被代理的目标对象可以转换为指定的类型时则表示匹配。

target(com.demo.service.IUserService) 匹配所有被代理的目标对象能够转化成IuserService类型的所有方法的外部调用。(暂时想不到应用场景)

@annotation

带有相应标注的任意方法

@Pointcut("@annotation(com.example.springbootTest.annotation.Test))")

annotation 自定义注解

@Retention(保留)
  1. RetentionPolicy.SOURCE:注解只保留在源文件,当Java文件编译成class文件的时候,注解被遗弃;

  2. RetentionPolicy.CLASS:注解被保留到class文件,但jvm加载class文件时候被遗弃,这是默认的生命周期;

  3. RetentionPolicy.RUNTIME:注解不仅被保存到class文件中,jvm加载class文件之后,仍然存在;

@Target

Annotation所修饰的对象范围,@Target(value = ElementType.METHOD)修饰范围为方法。

interface和@interface的区别

①、interface :声明了这是一个java 的接口

②、@interface : 是用来修饰 Annotation 的。这个关键字声明隐含了一个信息:它是继承了 java.lang.annotation.Annotation 接口。

切片获取annotation参数
MethodSignature methodSignature = (MethodSignature) jp.getSignature();
//获取方法注解的类型
Test annotation = methodSignature.getMethod().getAnnotation(Test.class);
System.out.println("annotation:"+annotation.userId());

参考资料:https://blog.csdn.net/XiongHuyi/article/details/118417301

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,463评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,868评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,213评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,666评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,759评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,725评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,716评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,484评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,928评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,233评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,393评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,073评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,718评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,308评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,538评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,338评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,260评论 2 352

推荐阅读更多精彩内容