Springboot Aspect切面的實(shí)現(xiàn)

今天我們來說說spring中的切面Aspect，這是Spring的一大優(yōu)勢。面向切面編程往往讓我們的開發(fā)更加低耦合，也大大減少了代碼量，同時(shí)呢讓我們更專注于業(yè)務(wù)模塊的開發(fā)，把那些與業(yè)務(wù)無關(guān)的東西提取出去，便于后期的維護(hù)和迭代。

好了，廢話少說！我們直接步入正題

以系統(tǒng)日志為例

首先，我們先做一些準(zhǔn)備工作。

1、新建一個(gè)Springboot工程

2、添加必要的依賴

AOP 必須

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

gson主要是我用于數(shù)據(jù)的處理，不是必須的

<dependency> <groupId>com.google.code.gson</groupId> <artifactId>gson</artifactId> <version>2.8.1</version></dependency>

個(gè)人喜好

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <scope>runtime</scope></dependency><dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional></dependency>

3、日志實(shí)體類和service

package com.space.aspect.bo; import lombok.Data; /** * 系統(tǒng)日志bo * @author zhuzhe * @date 2018/6/4 9:36 * @email 1529949535@qq.com */@Datapublic class SysLogBO { private String className; private String methodName; private String params; private Long exeuTime; private String remark; private String createDate;}package com.space.aspect.service; import com.space.aspect.bo.SysLogBO;import lombok.extern.slf4j.Slf4j;import org.springframework.stereotype.Service; /** * @author zhuzhe * @date 2018/6/4 9:41 * @email 1529949535@qq.com */@Slf4j@Servicepublic class SysLogService { public boolean save(SysLogBO sysLogBO){// 這里就不做具體實(shí)現(xiàn)了log.info(sysLogBO.getParams());return true; }}

4、定義日志注解

這里呢，我們記錄日志使用注解的形式。所以，先定義一個(gè)注解

package com.space.aspect.anno;import java.lang.annotation.*; /** * 定義系統(tǒng)日志注解 * @author zhuzhe * @date 2018/6/4 9:24 * @email 1529949535@qq.com */@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface SysLog { String value() default '';}

5、聲明切面，完成日志記錄

以上4點(diǎn)我們的準(zhǔn)備工作已經(jīng)完成。接下來就是重點(diǎn)了

這里需要你對AOP有一定的了解。起碼知道切點(diǎn)表達(dá)式、環(huán)繞通知、前置通知、后置通知等。。。

package com.space.aspect.aspect;import com.google.gson.Gson;import com.space.aspect.anno.SysLog;import com.space.aspect.bo.SysLogBO;import com.space.aspect.service.SysLogService;import org.aspectj.lang.ProceedingJoinPoint;import org.aspectj.lang.annotation.Around;import org.aspectj.lang.annotation.Aspect;import org.aspectj.lang.annotation.Pointcut;import org.aspectj.lang.reflect.MethodSignature;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Component;import java.lang.reflect.Method;import java.text.SimpleDateFormat;import java.util.ArrayList;import java.util.Date;import java.util.List; /** * 系統(tǒng)日志切面 * @author zhuzhe * @date 2018/6/4 9:27 * @email 1529949535@qq.com */@Aspect // 使用@Aspect注解聲明一個(gè)切面@Componentpublic class SysLogAspect { @Autowired private SysLogService sysLogService; /** * 這里我們使用注解的形式 * 當(dāng)然，我們也可以通過切點(diǎn)表達(dá)式直接指定需要攔截的package,需要攔截的class 以及 method * 切點(diǎn)表達(dá)式: execution(...) */ @Pointcut('@annotation(com.space.aspect.anno.SysLog)') public void logPointCut() {} /** * 環(huán)繞通知 @Around ， 當(dāng)然也可以使用 @Before (前置通知) @After (后置通知) * @param point * @return * @throws Throwable */ @Around('logPointCut()') public Object around(ProceedingJoinPoint point) throws Throwable {long beginTime = System.currentTimeMillis();Object result = point.proceed();long time = System.currentTimeMillis() - beginTime;try { saveLog(point, time);} catch (Exception e) {}return result; } /** * 保存日志 * @param joinPoint * @param time */ private void saveLog(ProceedingJoinPoint joinPoint, long time) {MethodSignature signature = (MethodSignature) joinPoint.getSignature();Method method = signature.getMethod();SysLogBO sysLogBO = new SysLogBO();sysLogBO.setExeuTime(time);SimpleDateFormat dateFormat = new SimpleDateFormat('yyyy-MM-dd hh:mm:ss');sysLogBO.setCreateDate(dateFormat.format(new Date()));SysLog sysLog = method.getAnnotation(SysLog.class);if(sysLog != null){ //注解上的描述 sysLogBO.setRemark(sysLog.value());}//請求的 類名、方法名String className = joinPoint.getTarget().getClass().getName();String methodName = signature.getName();sysLogBO.setClassName(className);sysLogBO.setMethodName(methodName);//請求的參數(shù)Object[] args = joinPoint.getArgs();try{ List<String> list = new ArrayList<String>(); for (Object o : args) {list.add(new Gson().toJson(o)); } sysLogBO.setParams(list.toString());}catch (Exception e){ }sysLogService.save(sysLogBO); }}

6、測試

接下來，我們就來測試一下吧

package com.space.aspect.controller;import com.space.aspect.anno.SysLog;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RequestParam;import org.springframework.web.bind.annotation.RestController; /** * @author zhuzhe * @date 2018/6/4 9:47 * @email 1529949535@qq.com */@RestControllerpublic class TestController { @SysLog('測試') @GetMapping('/test') public String test(@RequestParam('name') String name){return name; }}

啟動項(xiàng)目，訪問我們的test方法。

我們在service里打一個(gè)斷點(diǎn)

可以看到，我們所需要的值都成功拿到了。

這樣，我們就成功實(shí)現(xiàn)了使用Aspect實(shí)現(xiàn)切面記錄日志。

源碼：https://github.com/zhuzhegithub/springboot-aop-aspect

Springboot Aspect切面實(shí)現(xiàn)方法日志打印

項(xiàng)目每次寫controller方法，都要在開始和結(jié)束打印一行日志表示方法開始和結(jié)束，每個(gè)方法都要寫，太過于麻煩和重復(fù)，想到了spring的aop切面，所以使用@Aspect切面和自定義log注解實(shí)現(xiàn)了下切面日志打印.

AOP

AOP（Aspect Orient Programming）,直譯過來就是 面向切面編程。AOP 是一種編程思想，是面向?qū)ο缶幊蹋∣OP）的一種補(bǔ)充,在程序開發(fā)中主要用來解決一些系統(tǒng)層面上的問題，比如日志，事務(wù)，權(quán)限等等，這里主要是做一下方法的日志打印。

aop相關(guān)注解：

@Aspect:作用是把當(dāng)前類標(biāo)識為一個(gè)切面供容器讀取

@Pointcut：Pointcut是植入Advice的觸發(fā)條件。每個(gè)Pointcut的定義包括2部分，一是表達(dá)式，二是方法簽名。方法簽名必須是 public及void型。可以將Pointcut中的方法看作是一個(gè)被Advice引用的助記符，因?yàn)楸磉_(dá)式不直觀，因此我們可以通過方法簽名的方式為 此表達(dá)式命名。因此Pointcut中的方法只需要方法簽名，而不需要在方法體內(nèi)編寫實(shí)際代碼。

@Around：環(huán)繞增強(qiáng)，相當(dāng)于MethodInterceptor

@AfterReturning：后置增強(qiáng)，相當(dāng)于AfterReturningAdvice，方法正常退出時(shí)執(zhí)行

@Before：標(biāo)識一個(gè)前置增強(qiáng)方法，相當(dāng)于BeforeAdvice的功能，相似功能的還有

@AfterThrowing：異常拋出增強(qiáng)，相當(dāng)于ThrowsAdvice

@After: final增強(qiáng)，不管是拋出異常或者正常退出都會執(zhí)行

自定義注解

聲明一個(gè)注解要用到的東西

修飾符：訪問修飾符必須為public,不寫默認(rèn)為pubic；

關(guān)鍵字：關(guān)鍵字為@interface；

注解名稱：注解名稱為自定義注解的名稱，使用時(shí)還會用到；

注解類型元素：注解類型元素是注解中內(nèi)容，可以理解成自定義接口的實(shí)現(xiàn)部分；

代碼：

自定義log注解代碼

/** * 日志注解 * * Target：用于明確注解用于目標(biāo)類的哪個(gè)位置 * Retention：用于標(biāo)識自定義注解的生命周期 * RUNTIME:生命周期持續(xù)到運(yùn)行時(shí)，能夠通過反射獲取到 * Documented：用于標(biāo)識自定義注解能夠使用javadoc命令生成關(guān)于注解的文檔 * * @author xxx * @date 2020/xx/xx */@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface LogMessage { /** * 使用value值，在使用注解的時(shí)候，不需要寫@LogMessage(value=xxx）,直接寫@LogMessage(xxx）即可 */ String value() default ''; /** * 別名使用value，所以在使用注解時(shí)，既可以寫@LogMessage(xxx），也可以寫@LogMessage(description=xxx） */ @AliasFor('value') String description() default ''; /** * 是否打印參數(shù) */ boolean parameterPrint() default true;}

apsect切面類注解

/** * 日志切面類 * Aspect ：作用是把當(dāng)前類標(biāo)識為一個(gè)切面供容器讀取 * * @author xxx * @date 2020/xx/xx */@Slf4j@Aspect@Componentpublic class LogAspect { /** * 前置增強(qiáng)，目標(biāo)方法執(zhí)行之前執(zhí)行 * within:用于匹配所以持有指定注解類型內(nèi)的方法 * annotation:用于匹配當(dāng)前執(zhí)行方法持有指定注解的方法 * within(com.xxx.xxx..*) com.xxx.xxx包及子包下的任何方法執(zhí)行 * * @param joinPoint * @param logManage * @return void * @author xxx * @date 2020/xx/xx */ @Before('within(com.xxx.xxx..*) && @annotation(logManage)') public void addBeforeLogger(JoinPoint joinPoint, LogMessage logManage) {log.info('[{}] Start', logManage.value());// 處理參數(shù)try { if (logManage.parameterPrint()) {Object[] args = joinPoint.getArgs(); // 參數(shù)值String[] argNames = ((MethodSignature) joinPoint.getSignature()).getParameterNames();Map<String, Object> paramsMap = new HashMap<>();StringBuilder sb = new StringBuilder();if (args != null && args.length > 0) { for (int i = 0; i < args.length; i++) {paramsMap.put(argNames[i], args[i] != null ? args[i].toString() : ''); } for (Map.Entry<String, Object> entry : paramsMap.entrySet()) {sb.append(entry.getKey()).append(':').append(entry.getValue()).append(';'); }}log.info('[方法名稱：{}，方法參數(shù)：{}', ((MethodSignature) joinPoint.getSignature()).getMethod().getName(), sb.toString()); }} catch (Exception e) { log.info('切面日志打印異常！');} } /** * 返回增強(qiáng)，目標(biāo)方法正常執(zhí)行完畢時(shí)執(zhí)行 * * within:用于匹配所以持有指定注解類型內(nèi)的方法 * annotation:于匹配當(dāng)前執(zhí)行方法持有指定注解的方法 * within(com.xxx.xxx..*) com.xxx.xxx 包及子包下的任何方法執(zhí)行 * * @param joinPoint * @param logManage * @return void * @author xxx * @date 2020/xx/xx */ @AfterReturning('within(com.xxx.xxx..*) && @annotation(logManage)') public void addAfterReturningLogger(JoinPoint joinPoint, LogMessage logManage) {log.info('[{}] End', logManage.value()); }}

controller中使用

@LogMessage('測試日志打印')@GetMapping(value = '/test', produces = MediaType.APPLICATION_JSON_UTF8_VALUE)public void xxx() { log.info('test');}

這樣在方法執(zhí)行前和返回后都會打印日志，只需要在想要打印日志的方法上添加@LogMessage('')注解就可以了。

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持好吧啦網(wǎng)。