SpringBoot之@Aspect注解解讀

更新時(shí)間：2024年01月18日 09:25:21 作者：小白不很白

這篇文章主要介紹了SpringBoot之@Aspect注解解讀,AOP是面向切面編程,通過(guò)預(yù)編譯方式和運(yùn)行期動(dòng)態(tài)代理實(shí)現(xiàn)程序功能的統(tǒng)一維護(hù)的一種技術(shù),而@Aspect 就是把一個(gè)類(lèi)定義為切面供容器讀取,需要的朋友可以參考下

@Aspect注解

AOP：面向切面編程，通過(guò)預(yù)編譯方式和運(yùn)行期動(dòng)態(tài)代理實(shí)現(xiàn)程序功能的統(tǒng)一維護(hù)的一種技術(shù)。而@Aspect 就是把一個(gè)類(lèi)定義為切面供容器讀取。

@before: 前置通知，在方法執(zhí)行之前執(zhí)行。
@After：后置通知，在方法執(zhí)行后執(zhí)行。
@AfterReturning: 返回通知，在方法返回結(jié)果之后執(zhí)行。
@AfterThrowing：異常通知，在方法拋出異常之后執(zhí)行。
@Around：環(huán)繞通知，圍繞著方法執(zhí)行。

1. 實(shí)現(xiàn)步驟

1.1 導(dǎo)入jar包

這兩個(gè)選一個(gè)就可以了，推薦使用第一個(gè)，因?yàn)榈谝粋€(gè)項(xiàng)目中肯定會(huì)用到的。

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <version>2.5.4</version>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

1.2 創(chuàng)建一個(gè)實(shí)體類(lèi)

@Component
@Aspect
public class TestAspect {
    @Pointcut("execution( * com.atguigu.gulimall.product.controller.CouponController.*(..))")
    private void log(){
    }
    @Before("log()")
    public void TestBefore(){
        System.out.println("在調(diào)用方法的時(shí)候都會(huì)調(diào)用這個(gè)切面");
    }

把這個(gè)類(lèi)加入到容器中，然后再添加上注解就可以就可以看成是一個(gè)切面容器。 ?

2. 語(yǔ)法

execution( * com.atguigu.gulimall.product.controller.CouponController.*(..));
// 第一個(gè)* 代表任意修飾符及任意返回值下的CouponController類(lèi)下的所有方法。
// 第二個(gè)* 代表CouponController類(lèi)下的所有方法。
// (..) 代表任意參數(shù)

// 匹配CouponController類(lèi)下面的所有共有方法。
@Pointcut("execution( public * com.atguigu.gulimall.product.controller.CouponController.*(..))")
// 第一個(gè)* 代表任意返回值
// 第二個(gè)* 當(dāng)表任意方法
//(..) 代表任意參數(shù)

// 返回double 類(lèi)型數(shù)值的方法
@Pointcut("execution(  public Double com.atguigu.gulimall.product.controller.CouponController.*(..))")

// 匹配第一個(gè)參數(shù)為Double的方法。
@Pointcut("execution(  public Double com.atguigu.gulimall.product.controller.CouponController.*(Double,..))")

// 匹配兩個(gè)參數(shù)都為double 的方法。
@Pointcut("execution(  public Double com.atguigu.gulimall.product.controller.CouponController.*(Double,Double))")

3. 簡(jiǎn)單實(shí)現(xiàn)

3.1 @Before

在方法執(zhí)行前執(zhí)行該方法，并且可以通過(guò)（JoinPoint類(lèi)）獲取請(qǐng)求參數(shù)和方法。

@Component
@Aspect
public class TestAspect {
    @Pointcut("execution(  * com.atguigu.gulimall.product.controller.CouponController.*(..))")
    private void log(){
    }
    @Before("log()")
    public void TestBefore(JoinPoint joinPoint){
        Object[] args = joinPoint.getArgs();
        String name = joinPoint.getSignature().getName();
        System.out.println(Arrays.asList(args).toString() +"  "+ name);
    }
}

@RestController
@RequestMapping("product/coupon")
public class CouponController {
	  /**
     * 列表
     */
    @RequestMapping("/list")
    public R list(@RequestBody Map<String, Object> params){
        return R.ok().put("page", "測(cè)試專(zhuān)用");
    }
}

3.2 @After

后置通知，在方法執(zhí)行后執(zhí)行?？梢酝ㄟ^(guò)（JoinPoint類(lèi)）獲取請(qǐng)求參數(shù)和方法。

當(dāng)方法拋出異常的時(shí)候也不會(huì)影響執(zhí)行切點(diǎn)方法，也就是說(shuō)不管如何都是會(huì)執(zhí)行切面方法的。

@Component
@Aspect
public class TestAspect {
    @Pointcut("execution(  * com.atguigu.gulimall.product.controller.CouponController.*(..))")
    private void log(){
    }
    @After("log()")
    public void TestBefore(JoinPoint joinPoint){
        Object[] args = joinPoint.getArgs();
        String name = joinPoint.getSignature().getName();
        System.out.println(Arrays.asList(args).toString() +"  "+ name);
    }
}

3.3 @AfterReturning

當(dāng)方法正常執(zhí)行返回后才執(zhí)行次方法，如果拋出異常就不會(huì)執(zhí)行此方法。

/**
     * 列表
     */
    @RequestMapping("/list")
    public R list(@RequestBody Map<String, Object> params){
        PageUtils<CouponEntity> page = couponService.queryPage(params);
        List<CouponEntity> list = page.getList();
        String s = JSONObject.toJSONString(list);
        // 當(dāng)這行拋出異常的時(shí)候就不會(huì)再執(zhí)行切點(diǎn)方法了。
        int i = 1/0;
        return R.ok().put("page", s);
    }

@Component
@Aspect
public class TestAspect {
    @Pointcut("execution(  * com.atguigu.gulimall.product.controller.CouponController.*(..))")
    private void log(){
    }
    @AfterReturning("log()")
    public void TestBefore(JoinPoint joinPoint){
        Object[] args = joinPoint.getArgs();
        String name = joinPoint.getSignature().getName();
        System.out.println(Arrays.asList(args).toString() +"  "+ name);
    }
}

3.4 @AfterThrowing(“log()”)

只有在拋出異常的時(shí)候才會(huì)調(diào)用切點(diǎn)方法。如果不拋出異常就不會(huì)調(diào)用切點(diǎn)方法。

    @RequestMapping("/list")
    public R list(@RequestBody Map<String, Object> params){
        PageUtils<CouponEntity> page = couponService.queryPage(params);
        List<CouponEntity> list = page.getList();
        String s = JSONObject.toJSONString(list);
        int i = 1/0;
        return R.ok().put("page", s);
    }

@Component
@Aspect
public class TestAspect {
    @Pointcut("execution(  * com.atguigu.gulimall.product.controller.CouponController.*(..))")
    private void log(){
    }
    @AfterThrowing("log()")
    public void TestBefore(JoinPoint joinPoint){
        Object[] args = joinPoint.getArgs();
        String name = joinPoint.getSignature().getName();
        System.out.println(Arrays.asList(args).toString() +"  "+ name);
    }
}

3.5 @Around

使用 ProceedingJoinPoint 獲取參數(shù)信息
使用joinPoint.proceed()方法調(diào)用方法。
只有調(diào)用上面的方法才能夠執(zhí)行方法

@Component
@Aspect
public class TestAspect {
    @Pointcut("execution(  * com.atguigu.gulimall.product.controller.CouponController.*(..))")
    private void log(){
    }
    @Around("log()")
    public R TestBefore(ProceedingJoinPoint joinPoint) throws Throwable {
        Object[] args = joinPoint.getArgs();
        Object o = args[0];
        HashMap<String, String> stringStringHashMap = null;
        if (o instanceof Map){
            stringStringHashMap = (HashMap<String, String>) o;
        }
        if(stringStringHashMap.get("name").equals("xiaobai")){
            // 當(dāng)滿足參數(shù)中name值xiaobai的時(shí)候，才會(huì)調(diào)用下面的方法。
            R proceed = (R) joinPoint.proceed();
            return proceed;
        }else {
            return R.ok().put("name","小周");
        }
    }
}

    /**
     * 列表
     */
    @RequestMapping("/list")
    public R list(@RequestBody Map<String, Object> params){
        PageUtils<CouponEntity> page = couponService.queryPage(params);
        List<CouponEntity> list = page.getList();
        String s = JSONObject.toJSONString(list);
        return R.ok().put("page", s);
    }

4. 結(jié)合自定義注解實(shí)現(xiàn)

package com.atguigu.gulimall.product.annoation;
import java.lang.annotation.*;
/**
 * @author liruiqing
 * 注解和@Aspect注解之間的聯(lián)合使用
 */
@Documented
@Target({ElementType.METHOD}) // 在方法上加
@Retention(RetentionPolicy.RUNTIME) // 運(yùn)行時(shí)
public @interface AnnotationTest {
}

    @RequestMapping("/list")
    @AnnotationTest
    public R list(@RequestBody Map<String, Object> params){
        PageUtils<CouponEntity> page = couponService.queryPage(params);
        List<CouponEntity> list = page.getList();
        String s = JSONObject.toJSONString(list);
        return R.ok().put("page", s);
    }

    @Pointcut("@annotation(com.atguigu.gulimall.product.annoation.AnnotationTest)")
    private void annotation(){
    }
   @After("annotation()")
    public void testAnnotation(){
        System.out.println("執(zhí)行注解注釋的方法后執(zhí)行此方法");
    }

這樣就可以實(shí)現(xiàn)切面了。

到此這篇關(guān)于SpringBoot之@Aspect注解解讀的文章就介紹到這了,更多相關(guān)@Aspect注解內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: