配置AOP

1. AOP簡介

要介紹面向切面編程(Aspect-Oriented Programming，AOP) ，需要首先考慮這樣一個(gè)場景:公司有一個(gè)人力資源管理系統(tǒng)目前已經(jīng)上線，但是系統(tǒng)運(yùn)行不穩(wěn)定，有時(shí)運(yùn)行得很慢，為了檢測出到底是哪個(gè)環(huán)節(jié)出問題了，開發(fā)人員想要監(jiān)控每一個(gè)方法的執(zhí)行時(shí)間，再根據(jù)這些執(zhí)行時(shí)間判斷出問題所在。當(dāng)問題解決后，再把這些監(jiān)控移除掉。系統(tǒng)目前已經(jīng)運(yùn)行，如果手動(dòng)修改系統(tǒng)中成千上萬個(gè)方法，那么工作量未免太大，而且這些監(jiān)控方法以后還要移除掉;如果能夠在系統(tǒng)運(yùn)行過程中動(dòng)態(tài)添加代碼，就能很好地解決這個(gè)需求。這種在系統(tǒng)運(yùn)行時(shí)動(dòng)態(tài)添加代碼的方式稱為面向切面編程(AOP)。Spring框架對AOP提供了很好的支持。在AOP中，有一些常見的概念需要讀者了解。

• Joinpoint (連接點(diǎn)):類里面可以被增強(qiáng)的方法即為連接點(diǎn)。例如，想修改哪個(gè)方法的功能，那么該方法就是一個(gè)連接點(diǎn)。
• Pointcut(切入點(diǎn)):對Joinpoint進(jìn)行攔截的定義即為切入點(diǎn)。例如，攔截所有以insert 開始的方法，這個(gè)定義即為切入點(diǎn)。
• Advice (通知):攔截到Joinpoint 之后所要做的事情就是通知。例如，上文說到的打印日志監(jiān)控。通知分為前置通知、后置通知、異常通知、最終通知和環(huán)繞通知。
• Aspect ( 切面): Pointcut 和Advice的結(jié)合。
• Target (目標(biāo)對象):要增強(qiáng)的類稱為Target。

2. Spring Boot支持

Spring Boot 在Spring 的基礎(chǔ)上對AOP的配置提供了自動(dòng)化配置解決方案spring-boot-starter-aop,使開發(fā)者能夠更加便捷地在Spring Boot項(xiàng)目中使用AOP。配置步驟如下。

首先在Spring Boot Web項(xiàng)目中引入spring- boot-starter-aop依賴，代碼如下:

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

然后在org.sang.aop.service包下創(chuàng)建UserService類，代碼如下:

@Service
public class UserService {
    public String getUserById(Integer id){
        System.out.println("get...");
        return "user";
    }
    public void deleteUserById(Integer id){
        System.out.println("delete...");
    }
}

接下來創(chuàng)建切面，代碼如下:

@Component
@Aspect
public class LogAspect {
    @Pointcut("execution(* com.example.*.*(..))")
    public void pc1() {
    }
    @Before(value = "pc1()")
    public void before(JoinPoint jp) {
        String name = jp.getSignature().getName();
        System.out.println(name + "方法開始執(zhí)行...");
    }
    @After(value = "pc1()")
    public void after(JoinPoint jp) {
        String name = jp.getSignature().getName();
        System.out.println(name + "方法執(zhí)行結(jié)束...");
    }
    @AfterReturning(value = "pc1()", returning = "result")
    public void afterReturning(JoinPoint jp, Object result) {
        String name = jp.getSignature().getName();
        System.out.println(name + "方法返回值為: " + result);
    }
    @AfterThrowing(value = "pc1 ()", throwing = "e")
    public void afterThrowing(JoinPoint jp, Exception e) {
        String name = jp.getSignature().getName();
        System.out.println(name + "方法拋異常了，異常是: " + e.getMessage());
    }
    @Around("pc1()")
    public Object around(ProceedingJoinPoint pjp) throws Throwable {
        return pjp.proceed();
    }
}

代碼解釋:

• @Aspect注解表明這是一個(gè)切面類。
• 第4~6行定義的pcl方法使用了@Pointcut注解，這是一個(gè)切入點(diǎn)定義。execution 中的第一個(gè) * 表示方法返回任意值，第二個(gè) * 表示service 包下的任意類，第三個(gè) * 表示類中的任意方法，括號(hào)中的兩個(gè)點(diǎn)表示方法參數(shù)任意，即這里描述的切入點(diǎn)為service 包下所有類中的所有方法。
• 第 8~12行定義的方法使用了@Before注解，表示這是一個(gè)前置通知，該方法在目標(biāo)方法執(zhí)行之前執(zhí)行。通過JoinPoint參數(shù)可以獲取目標(biāo)方法的方法名、修飾符等信息。
• 第14~18行定義的方法使用了@After注解，表示這是一個(gè)后置通知，該方法在目標(biāo)方法執(zhí)行之后執(zhí)行。
• 第 20~24行定義的方法使用了@AfterReturning注解，表示這是一個(gè)返回通知，在該方法中可以獲取目標(biāo)方法的返回值。@AfterReturmning 注解的returning參數(shù)是指返回值的變量名，對應(yīng)方法的參數(shù)。注意，在方法參數(shù)中定義了result 的類型為Object，表示目標(biāo)方法的返回值可以是任意類型，若result 參數(shù)的類型為Long,則該方法只能處理目標(biāo)方法返回值為Long的情況。
• 第26~30行定義的方法使用了@AfterThrowing注解，表示這是一個(gè)異常通知，即當(dāng)目標(biāo)方法發(fā)生異常時(shí)，該方法會(huì)被調(diào)用，異常類型為Exception 表示所有的異常都會(huì)進(jìn)入該方法中執(zhí)行，若異常類型為ArithmeticException,則表示只有目標(biāo)方法拋出的ArithmeticException異常才會(huì)進(jìn)入該方法中處理。
• 第32~35行定義的方法使用了@Around注解，表示這是一一個(gè)環(huán)繞通知。環(huán)繞通知是所有通知里功能最為強(qiáng)大的通知，可以實(shí)現(xiàn)前置通知、后置通知、異常通知以及返回通知的功能。目標(biāo)方法進(jìn)入環(huán)繞通知后,通過調(diào)用ProceedingJoinPoint對象的proceed方法使目標(biāo)方法繼續(xù)執(zhí)行，開發(fā)者可以在此修改目標(biāo)方法的執(zhí)行參數(shù)、返回值等，并且可以在此處理目標(biāo)方法的異常。

配置完成后，接下來在Controller 中創(chuàng)建接口，分別調(diào)用UserService中的兩個(gè)方法，即可看到LogAspect中的代碼動(dòng)態(tài)地嵌入目標(biāo)方法中執(zhí)行了。UserController 類的定義如下:

@RestController
public class UserController {
    @Autowired
    UserService userService;

    @GetMapping("/getUserById")
    public String getUserById(Integer id) {
        return userService.getUserById(id);
    }

    @GetMapping("/deleteUserById")
    public void deleteUserById(Integer id) {
        userService.deleteUserById(id);
    }
}

當(dāng)訪問/getUserById 接口時(shí)，打印日志

getUserById方法開始執(zhí)行...
get...
getUserById方法返回值為: user
getUserById方法執(zhí)行結(jié)束...

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

最新評(píng)論