快捷導(dǎo)航

SpringBoot自定義注解及AOP的開發(fā)和使用詳解

更新時間：2023年08月15日 08:58:12 作者：JK凱

在公司項目中,如果需要做一些公共的功能,如日志等,最好的方式是使用自定義注解,自定義注解可以實現(xiàn)我們對想要添加日志的方法上添加,這篇文章基于日志功能來講講自定義注解應(yīng)該如何開發(fā)和使用,需要的朋友可以參考下

一、引入 AOP 依賴

自定義注解一般會和 AOP(切面) 結(jié)合使用，所以我們首先需要在項目中引入相應(yīng)的依賴。

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

二、創(chuàng)建自定義注解 Log

annotation.Log:

import java.lang.annotation.*;  
@Target(ElementType.METHOD)  
@Retention(RetentionPolicy.RUNTIME)  
@Documented  
public @interface Log {  
    String value() default "";  
}

@Target: 表明該注解可以作用的目標(biāo)是誰，也就是你的注解是用來修飾方法？類？還是屬性？這里是表明作用在方法上。
@Retention: 表明該注解作用的生命周期，這里表明在運行時有效。
@Documented: 表明被它修飾的注解將被 javadoc 提取成文檔。

三、創(chuàng)建 AOP切面類

aspect.LogAspect:

import org.aspectj.lang.ProceedingJoinPoint;  
import org.aspectj.lang.annotation.*;  
import org.springframework.stereotype.Component;  
@Aspect  
@Component  
public class LogAspect {  
    @Pointcut("@annotation(com.jk.annotation.Log)")  
    public void pointCut(){}  
    @Before("pointCut()")  
    public void before() {  
        System.out.println("前置通知...");  
    }  
    @After("pointCut()")  
    public void after() {  
        System.out.println("后置通知...");  
    }  
    @Around("pointCut()")  
    public void around(ProceedingJoinPoint point) throws Throwable {  
        System.out.println("環(huán)繞通知前...");  
        point.proceed();  
        System.out.println("環(huán)繞通知后...");  
    }  
}

@Aspect: 表明該類為切面類，定義切面類時必須加這個注解。
@Component: 表明把該類交給 IOC 容器控制。
@Pointcut: 定義切入點，結(jié)合 @annotation(@interface) 使用，表明該方法為切入點。 @interface 必須寫自定義注解的全路徑名。
@Before: 表明被自定義注解代理的方法執(zhí)行前，先調(diào)用的方法。
@After: 表明被自定義注解代理的方法執(zhí)行后， return 前調(diào)用的方法。
@Around: 將被自定義注解代理的方法封裝起來，環(huán)繞通知(即在他之前之后通知)， point.proceed() 表明執(zhí)行的目標(biāo)方法。

四、自定義注解測試

controller.TestController:

import com.jk.annotation.Log;  
import org.springframework.web.bind.annotation.GetMapping;  
import org.springframework.web.bind.annotation.RequestMapping;  
import org.springframework.web.bind.annotation.RestController;  
@RestController  
@RequestMapping("/test")  
public class TestController {  
    @GetMapping  
    @Log  
    public void test() {  
        System.out.println("執(zhí)行test方法");
    }  
}

在 test() 方法上添加了一個 @Log 注解，他會在執(zhí)行這個方法時，執(zhí)行我們之前定義切面時創(chuàng)建的前置方法、后置方法、環(huán)繞方法。