快捷導(dǎo)航

Springboot使用切面功能詳解

更新時間：2025年01月07日 08:36:23 作者：逐光猴

Spring?Boot?是一個基于Spring框架的項目,它簡化了基于Spring的應(yīng)用開發(fā),這篇文章主要介紹了?Spring?Boot?中的切面功能,需要的可以了解下

Spring切面功能介紹

Spring Boot 是一個基于Spring框架的項目，它簡化了基于Spring的應(yīng)用開發(fā)。在Spring框架中，切面（Aspect）是一種特殊的類，它定義了橫切關(guān)注點（cross-cutting concerns），比如日志記錄、事務(wù)管理、權(quán)限檢查等。這些關(guān)注點通常橫跨多個請求處理路徑，因此被稱為“橫切”關(guān)注點。

AOP在spring中又叫“面向切面編程”，它可以說是對傳統(tǒng)我們面向?qū)ο缶幊痰囊粋€補充，從字面上顧名思義就可以知道，它的主要操作對象就是“切面”，所以我們就可以簡單的理解它是貫穿于方法之中，在方法執(zhí)行前、執(zhí)行時、執(zhí)行后、返回值后、異常后要執(zhí)行的操作。相當于是將我們原本一條線執(zhí)行的程序在中間切開加入了一些其他操作一樣。

下面這個圖就展示了切面的樣子。我們定義了日志切面、安全切面等，可以實現(xiàn)統(tǒng)一的日志管理和安全管理。請求來了之后，先依次通過各個切面，然后調(diào)用業(yè)務(wù)邏輯。返回的時候再次通過各個切面。切面的好處我認為在兩個方面：1）不侵入現(xiàn)有的業(yè)務(wù)代碼 2）一個切面的代碼，可以實現(xiàn)對多個業(yè)務(wù)模塊進行處理，提升了代碼復(fù)用性。

切面定義和使用流程

在Spring框架中，切面是通過使用AOP（面向切面編程）來實現(xiàn)的。Spring AOP提供了一個強大而靈活的機制來實現(xiàn)切面。以下是在Spring Boot中使用切面的一些基本概念和步驟：

引入依賴 ：

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

定義切面（Aspect） ：

創(chuàng)建一個類，使用@Aspect注解來聲明它是一個切面。

切點（Pointcut） ：

使用@Pointcut注解來定義一個切點，它指定了哪些方法將被切面攔截。

通知（Advice） ：

定義通知，它指定了在切點處應(yīng)該執(zhí)行什么操作。有不同類型的通知，包括：

@Before：在目標方法執(zhí)行之前執(zhí)行。
@After：在目標方法執(zhí)行之后執(zhí)行。
@AfterReturning：在目標方法成功返回后執(zhí)行。
@AfterThrowing：在目標方法拋出異常后執(zhí)行。
@Around：在目標方法執(zhí)行前后都執(zhí)行。

織入（Weaving） ：

織入是將切面應(yīng)用到目標對象的過程。Spring AOP通過代理機制來實現(xiàn)織入。

啟用AOP：

在Spring Boot應(yīng)用中，你可以通過在啟動類上添加@EnableAspectJAutoProxy注解來啟用AOP。

下面是一個簡單的Spring Boot切面示例，實現(xiàn)了日志的切面功能：

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;

@Aspect     // 聲明這是一個切面類
@Component // 讓Spring容器接管
public class LoggingAspect {

    // 定義切點，攔截com.example包及其子包下的所有方法
    @Pointcut("within(com.example..*)")
    public void loggable() {}

    // 定義一個前置通知
    @Before("loggable()")
    public void beforeAdvice() {
        System.out.println("Before the method is called");
    }
    
    ```
//	方法正常執(zhí)行完之后
    /**
     * 在程序正常執(zhí)行完之后如果有返回值，我們可以對這個返回值進行接收
     * returning用來接收方法的返回值
     * */
    @AfterReturning("loggable()",returning="result")
    public void LogReturn(JoinPoint joinPoint,Object result) {
		System.out.println("【" + joinPoint.getSignature().getName() + "】程序方法執(zhí)行完畢了...結(jié)果是：" + result);
	}
}

在這個例子中，LoggingAspect類定義了一個切點loggable，它攔截com.example包及其子包下的所有方法。beforeAdvice方法是一個前置通知，它會在匹配的每個方法執(zhí)行之前被調(diào)用。

JointPoint可以獲得方法的相關(guān)信息，如方法的返回值、方法名、參數(shù)類型等。

要使用這個切面，你需要在Spring Boot的主類上添加@EnableAspectJAutoProxy注解：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.EnableAspectJAutoProxy;

@SpringBootApplication
@EnableAspectJAutoProxy
public class MyApp {
    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }
}

這種方式下，除非你對項目代碼特別熟悉，才知道哪里定義了切面的功能，對哪些類起作用。

否則，如果你是接手一個新的項目，或者一個開源項目，梳理清楚這些關(guān)系還是比較麻煩的。我覺得切面結(jié)合注解來使用，可能更好一些。

切面結(jié)合注解使用

在Spring框架中，切面（Aspect）可以與注解（Annotation）結(jié)合使用，以提供更靈活的橫切關(guān)注點處理。通過注解，你可以在代碼中直接指定哪些方法需要被特定的切面處理，而不需要在切面中硬編碼方法名或類名。這種方式使得代碼更加清晰，并且易于維護。

以下是如何結(jié)合注解使用切面的步驟：

1. 定義注解

首先，你需要定義一個注解，這個注解將被用來標記需要被切面處理的方法。

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.METHOD}) // 這個注解只能應(yīng)用至方法上
@Retention(RetentionPolicy.RUNTIME) // 運行時還會保留這個注解
public @interface Loggable { 
}

2. 創(chuàng)建切面

然后，創(chuàng)建一個切面類，并在其中定義一個切點（Pointcut），這個切點將匹配所有標記了@Loggable注解的方法。

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class LoggingAspect {

    // 定義切點，匹配所有標記了@Loggable注解的方法
    @Pointcut("@annotation(com.example.Loggable)")
    public void loggable() {}

    // 定義一個前置通知
    @Before("loggable()")
    public void beforeAdvice(JoinPoint joinPoint) {
        // 這里利用了JAVA反射的特性
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Loggable loggable = signature.getMethod().getAnnotation(Loggable.class);
        if (loggable != null) {
            System.out.println("Before method: " + joinPoint.getSignature().getName() + " - " + loggable);
        }
    }
}

在這個例子中，loggable切點匹配所有標記了@Loggable注解的方法。beforeAdvice方法是一個前置通知，它會在每個標記了@Loggable注解的方法執(zhí)行之前被調(diào)用。

3. 使用注解

最后，在你的業(yè)務(wù)邏輯中，使用@Loggable注解來標記需要被切面處理的方法。

import com.example.Loggable;
import org.springframework.stereotype.Service;

@Service
public class MyService {

    @Loggable
    public void someMethod() {
        System.out.println("Executing someMethod");
    }
}

在這個例子中，someMethod方法被標記了@Loggable注解，因此它會被LoggingAspect中的beforeAdvice方法攔截。

4. 啟用AOP

確保你的Spring Boot應(yīng)用已經(jīng)啟用了AOP，如之前所述，可以在啟動類上添加@EnableAspectJAutoProxy注解。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.EnableAspectJAutoProxy;

@SpringBootApplication
@EnableAspectJAutoProxy
public class MyApp {
    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }
}

通過這種方式，你可以靈活地使用注解來控制哪些方法需要被切面處理，而不需要在切面中硬編碼方法名或類名，使得代碼更加模塊化和易于維護。

以上就是Springboot使用切面功能詳解的詳細內(nèi)容，更多關(guān)于Springboot切面的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: