詳解基于SpringBoot使用AOP技術(shù)實(shí)現(xiàn)操作日志管理
操作日志對(duì)于程序員或管理員而言,可以快速定位到系統(tǒng)中相關(guān)的操作,而對(duì)于操作日志的管理的實(shí)現(xiàn)不能對(duì)正常業(yè)務(wù)實(shí)現(xiàn)進(jìn)行影響,否則即不滿足單一原則,也會(huì)導(dǎo)致后續(xù)代碼維護(hù)困難,因此我們考慮使用AOP切面技術(shù)來實(shí)現(xiàn)對(duì)日志管理的實(shí)現(xiàn)。
文章大致內(nèi)容:
1、基本概念
2、基本應(yīng)用
3、日志管理實(shí)戰(zhàn)
對(duì)這幾部分理解了,會(huì)對(duì)AOP的應(yīng)用應(yīng)該很輕松。
一、基本概念
項(xiàng)目 | 描述 |
---|---|
Aspect(切面) | 跨越多個(gè)類的關(guān)注點(diǎn)的模塊化,切面是通知和切點(diǎn)的結(jié)合。通知和切點(diǎn)共同定義了切面的全部?jī)?nèi)容——它是什么,在何時(shí)和何處完成其功能。事務(wù)處理和日志處理可以理解為切面 |
Join point(連接點(diǎn)) | 程序執(zhí)行過程中的一個(gè)點(diǎn),如方法的執(zhí)行或異常的處理 |
Advice(通知) | 切面在特定連接點(diǎn)上采取的動(dòng)作 |
Pointcut(切點(diǎn)) | 匹配連接點(diǎn)的斷言。通知與切入點(diǎn)表達(dá)式相關(guān)聯(lián),并在切入點(diǎn)匹配的任何連接點(diǎn)上運(yùn)行(例如,具有特定名稱的方法的執(zhí)行)。切入點(diǎn)表達(dá)式匹配的連接點(diǎn)概念是AOP的核心,Spring默認(rèn)使用AspectJ切入點(diǎn)表達(dá)式語言 |
Introduction(引用) | 為類型聲明其他方法或字段。Spring AOP允許您向任何建議的對(duì)象引入新的接口(和相應(yīng)的實(shí)現(xiàn))。例如,您可以使用介紹使bean實(shí)現(xiàn)IsModified接口,以簡(jiǎn)化緩存 |
Target object(目標(biāo)) | 由一個(gè)或多個(gè)切面通知的對(duì)象。也稱為“通知對(duì)象”。由于Spring AOP是通過使用運(yùn)行時(shí)代理實(shí)現(xiàn)的,所以這個(gè)對(duì)象始終是代理對(duì)象 |
AOP proxy(代理) | AOP框架為實(shí)現(xiàn)切面契約(通知方法執(zhí)行等)而創(chuàng)建的對(duì)象。在Spring框架中,AOP代理是JDK動(dòng)態(tài)代理或CGLIB代理 |
Weaving(織入) | 織入是將通知添加對(duì)目標(biāo)類具體連接點(diǎn)上的過程,可以在編譯時(shí)(例如使用AspectJ編譯器)、加載時(shí)或運(yùn)行時(shí)完成 |
Spring切面可以應(yīng)用5種類型的通知:
- 前置通知(Before):在目標(biāo)方法被調(diào)用之前調(diào)用通知
- 后置通知(After):在目標(biāo)方法完成之后調(diào)用通知(無論是正常還是異常退出)
- 返回通知(After-returning):在目標(biāo)方法成功執(zhí)行之后調(diào)用通知
- 異常通知(After-throwing):在目標(biāo)方法拋出異常后調(diào)用通知
- 環(huán)繞通知(Around):通知包裹了被通知的方法,在被通知的方法調(diào)用之前和調(diào)用之后執(zhí)行自定義的行為
其執(zhí)行的順序?yàn)椋?br />
后續(xù)的基本應(yīng)用,會(huì)將 環(huán)繞通知、前置通知、后置通知、返回通知、異常通知進(jìn)行實(shí)現(xiàn),并演示其執(zhí)行順序。
二、基本應(yīng)用
聲明通知
大家可以將下面的代碼復(fù)制出來,驗(yàn)證上面的執(zhí)行順序。
@Aspect public class Test { private static int step = 0; @Pointcut("@annotation(com.chenyanwu.erp.erpframework.annotation.Log)") // the pointcut expression private void operation() {} @Before("operation()") public void doBeforeTask() { System.out.println(++step + " 前置通知"); } @After("operation()") public void doAfterTask() { System.out.println(++step + " 后置通知"); } @AfterReturning(pointcut = "operation()", returning = "retVal") public void doAfterReturnningTask(Object retVal) { System.out.println(++step + " 返回通知,返回值為:" + retVal.toString()); } @AfterThrowing(pointcut = "operation()", throwing = "ex") public void doAfterThrowingTask(Exception ex) { System.out.println(++step + " 異常通知,異常信息為:" + ex.getMessage()); } /** * 環(huán)繞通知需要攜帶ProceedingJoinPoint類型的參數(shù) * 環(huán)繞通知類似于動(dòng)態(tài)代理的全過程ProceedingJoinPoint類型的參數(shù)可以決定是否執(zhí)行目標(biāo)方法 * 且環(huán)繞通知必須有返回值,返回值即目標(biāo)方法的返回值 */ //@Around("operation()") public Object doAroundTask(ProceedingJoinPoint pjp) { String methodname = pjp.getSignature().getName(); Object result = null; try { // 前置通知 System.out.println("目標(biāo)方法" + methodname + "開始,參數(shù)為" + Arrays.asList(pjp.getArgs())); // 執(zhí)行目標(biāo)方法 result = pjp.proceed(); // 返回通知 System.out.println("目標(biāo)方法" + methodname + "執(zhí)行成功,返回" + result); } catch (Throwable e) { // 異常通知 System.out.println("目標(biāo)方法" + methodname + "拋出異常: " + e.getMessage()); } // 后置通知 System.out.println("目標(biāo)方法" + methodname + "結(jié)束"); return result; } }
其中需要注意的是切入點(diǎn):@Pointcut的表達(dá)式
格式:
execution(modifiers-pattern? ret-type-pattern declaring-type-pattern? name-pattern(param-pattern)throws-pattern?)
括號(hào)中各個(gè)pattern分別表示:
- 修飾符匹配(modifier-pattern?)
- 返回值匹配(ret-type-pattern)可以為*表示任何返回值,全路徑的類名等
- 類路徑匹配(declaring-type-pattern?)
- 方法名匹配(name-pattern)可以指定方法名 或者 代表所有, set 代表以set開頭的所有方法
- 參數(shù)匹配((param-pattern))可以指定具體的參數(shù)類型,多個(gè)參數(shù)間用“,”隔開,各個(gè)參數(shù)也可以用“”來表示- 匹配任意類型的參數(shù),如(String)表示匹配一個(gè)String參數(shù)的方法;(,String) 表示匹配有兩個(gè)參數(shù)的方法,第一個(gè)參數(shù)可以是任意類型,而第二個(gè)參數(shù)是String類型;可以用(…)表示零個(gè)或多個(gè)任意參數(shù)
- 異常類型匹配(throws-pattern?)
- 其中后面跟著“?”的是可選項(xiàng)
示例:
1)execution(* (…))
//表示匹配所有方法
2)execution(public * com. savage.service.UserService.(…))
//表示匹配com.savage.server.UserService中所有的公有方法
3)execution(* com.savage.server….(…))
//表示匹配com.savage.server包及其子包下的所有方法
三、日志管理實(shí)戰(zhàn)
有了上面基本應(yīng)用的理解,現(xiàn)在我們直接就貼代碼:
1、依賴的jar包
<!-- aop依賴 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency>
2、自定義注解
@Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface Log { String value() default ""; }
3、實(shí)現(xiàn)切面
@Aspect @Order(5) @Component public class LogAspect { private Logger logger = LoggerFactory.getLogger(LogAspect.class); @Autowired private ErpLogService logService; @Autowired ObjectMapper objectMapper; private ThreadLocal<Date> startTime = new ThreadLocal<Date>(); @Pointcut("@annotation(com.chenyanwu.erp.erpframework.annotation.Log)") public void pointcut() { } /** * 前置通知,在Controller層操作前攔截 * * @param joinPoint 切入點(diǎn) */ @Before("pointcut()") public void doBefore(JoinPoint joinPoint) { // 獲取當(dāng)前調(diào)用時(shí)間 startTime.set(new Date()); } /** * 正常情況返回 * * @param joinPoint 切入點(diǎn) * @param rvt 正常結(jié)果 */ @AfterReturning(pointcut = "pointcut()", returning = "rvt") public void doAfter(JoinPoint joinPoint, Object rvt) throws Exception { handleLog(joinPoint, null, rvt); } /** * 異常信息攔截 * * @param joinPoint * @param e */ @AfterThrowing(pointcut = "pointcut()", throwing = "e") public void doAfter(JoinPoint joinPoint, Exception e) throws Exception { handleLog(joinPoint, e, null); } @Async private void handleLog(final JoinPoint joinPoint, final Exception e, Object rvt) throws Exception{ // 獲得注解 Method method = getMethod(joinPoint); Log log = getAnnotationLog(method); if (log == null) { return; } Date now = new Date(); // 操作數(shù)據(jù)庫日志表 ErpLog erpLog = new ErpLog(); erpLog.setErrorCode(0); erpLog.setIsDeleted(0); // 請(qǐng)求信息 HttpServletRequest request = ToolUtil.getRequest(); erpLog.setType(ToolUtil.isAjaxRequest(request) ? "Ajax請(qǐng)求" : "普通請(qǐng)求"); erpLog.setTitle(log.value()); erpLog.setHost(request.getRemoteHost()); erpLog.setUri(request.getRequestURI().toString()); // erpLog.setHeader(request.getHeader(HttpHeaders.USER_AGENT)); erpLog.setHttpMethod(request.getMethod()); erpLog.setClassMethod(joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName()); // 請(qǐng)求的方法參數(shù)值 Object[] args = joinPoint.getArgs(); // 請(qǐng)求的方法參數(shù)名稱 LocalVariableTableParameterNameDiscoverer u = new LocalVariableTableParameterNameDiscoverer(); String[] paramNames = u.getParameterNames(method); if (args != null && paramNames != null) { StringBuilder params = new StringBuilder(); params = handleParams(params, args, Arrays.asList(paramNames)); erpLog.setParams(params.toString()); } String retString = JsonUtil.bean2Json(rvt); erpLog.setResponseValue(retString.length() > 5000 ? JsonUtil.bean2Json("請(qǐng)求參數(shù)數(shù)據(jù)過長(zhǎng)不與顯示") : retString); if (e != null) { erpLog.setErrorCode(1); erpLog.setErrorMessage(e.getMessage()); } Date stime = startTime.get(); erpLog.setStartTime(stime); erpLog.setEndTime(now); erpLog.setExecuteTime(now.getTime() - stime.getTime()); erpLog.setUsername(MySysUser.loginName()); HashMap<String, String> browserMap = ToolUtil.getOsAndBrowserInfo(request); erpLog.setOperatingSystem(browserMap.get("os")); erpLog.setBrower(browserMap.get("browser")); erpLog.setId(IdUtil.simpleUUID()); logService.insertSelective(erpLog); } /** * 是否存在注解,如果存在就獲取 */ private Log getAnnotationLog(Method method) { if (method != null) { return method.getAnnotation(Log.class); } return null; } private Method getMethod(JoinPoint joinPoint) { Signature signature = joinPoint.getSignature(); MethodSignature methodSignature = (MethodSignature) signature; Method method = methodSignature.getMethod(); if (method != null) { return method; } return null; } private StringBuilder handleParams(StringBuilder params, Object[] args, List paramNames) throws JsonProcessingException { for (int i = 0; i < args.length; i++) { if (args[i] instanceof Map) { Set set = ((Map) args[i]).keySet(); List list = new ArrayList(); List paramList = new ArrayList<>(); for (Object key : set) { list.add(((Map) args[i]).get(key)); paramList.add(key); } return handleParams(params, list.toArray(), paramList); } else { if (args[i] instanceof Serializable) { Class<?> aClass = args[i].getClass(); try { aClass.getDeclaredMethod("toString", new Class[]{null}); // 如果不拋出NoSuchMethodException 異常則存在 toString 方法 ,安全的writeValueAsString ,否則 走 Object的 toString方法 params.append(" ").append(paramNames.get(i)).append(": ").append(objectMapper.writeValueAsString(args[i])); } catch (NoSuchMethodException e) { params.append(" ").append(paramNames.get(i)).append(": ").append(objectMapper.writeValueAsString(args[i].toString())); } } else if (args[i] instanceof MultipartFile) { MultipartFile file = (MultipartFile) args[i]; params.append(" ").append(paramNames.get(i)).append(": ").append(file.getName()); } else { params.append(" ").append(paramNames.get(i)).append(": ").append(args[i]); } } } return params; } }
4、對(duì)應(yīng)代碼添加注解
@Log("新增學(xué)生") @RequestMapping(value = "/create", method = RequestMethod.POST) @ResponseBody public ResultBean<String> create(@RequestBody @Validated ErpStudent item) { if(service.insertSelective(item) == 1) { // 插入 insertErpSFamilyMember(item); return new ResultBean<String>(""); } return new ResultBean<String>(ExceptionEnum.BUSINESS_ERROR, "新增學(xué)生異常!", "新增失敗!", ""); }
通過對(duì)業(yè)務(wù)進(jìn)行操作后,會(huì)寫入數(shù)據(jù)庫,界面查詢:
日志管理的完整的代碼可以從git上獲取:
https://github.com/chyanwu/erp-framework
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
- springboot使用自定義注解實(shí)現(xiàn)aop切面日志
- SpringBoot使用AOP記錄接口操作日志詳解
- SpringBoot使用AOP實(shí)現(xiàn)統(tǒng)計(jì)全局接口訪問次數(shù)詳解
- 在springboot中使用AOP進(jìn)行全局日志記錄
- SpringBoot使用AOP,內(nèi)部方法失效的解決方案
- Springboot使用@Valid 和AOP做參數(shù)校驗(yàn)及日志輸出問題
- SpringBoot使用AOP+注解實(shí)現(xiàn)簡(jiǎn)單的權(quán)限驗(yàn)證的方法
- SpringBoot中使用AOP打印接口日志的方法
- SpringBoot項(xiàng)目中使用AOP的方法
- Springboot 中使用 Aop代碼實(shí)戰(zhàn)教程
相關(guān)文章
Spring基于Aop實(shí)現(xiàn)事務(wù)管理流程詳細(xì)講解
這篇文章主要介紹了Spring基于Aop實(shí)現(xiàn)事務(wù)管理流程,事務(wù)管理對(duì)于企業(yè)應(yīng)用來說是至關(guān)重要的,即使出現(xiàn)異常情況,它也可以保證數(shù)據(jù)的一致性,感興趣想要詳細(xì)了解可以參考下文2023-05-05springBoot前后端分離項(xiàng)目中shiro的302跳轉(zhuǎn)問題
這篇文章主要介紹了springBoot前后端分離項(xiàng)目中shiro的302跳轉(zhuǎn)問題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-12-12SpringBoot分布式文件存儲(chǔ)數(shù)據(jù)庫mongod
MongoDB是一個(gè)基于分布式文件存儲(chǔ)的NoSQL數(shù)據(jù)庫,由C++語言編寫,旨在為Web應(yīng)用提供可擴(kuò)展的高性能數(shù)據(jù)存儲(chǔ)解決方案。MongoDB是一個(gè)介于關(guān)系數(shù)據(jù)庫和非關(guān)系數(shù)據(jù)庫之間的產(chǎn)品,是非關(guān)系數(shù)據(jù)庫中功能最豐富最像關(guān)系數(shù)據(jù)庫的2023-02-02Java實(shí)現(xiàn)的計(jì)算稀疏矩陣余弦相似度示例
這篇文章主要介紹了Java實(shí)現(xiàn)的計(jì)算稀疏矩陣余弦相似度功能,涉及java基于HashMap的數(shù)值計(jì)算相關(guān)操作技巧,需要的朋友可以參考下2018-07-07java實(shí)現(xiàn)簡(jiǎn)易撲克牌游戲
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)簡(jiǎn)易撲克牌游戲,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2020-04-04Intellij IDEA 旗艦版創(chuàng)建 Spring MVC 項(xiàng)目踩過的坑
IDEA旗艦版可以直接創(chuàng)建Spring MVC項(xiàng)目,但創(chuàng)建后的項(xiàng)目并不是直接就可以運(yùn)行,還需要進(jìn)行一些配置。這篇文章主要介紹了Intellij IDEA 旗艦版創(chuàng)建 Spring MVC 項(xiàng)目踩坑記 ,需要的朋友可以參考下2020-03-03DoytoQuery中關(guān)于N+1查詢問題解決方案詳解
這篇文章主要為大家介紹了DoytoQuery中關(guān)于N+1查詢問題解決方案詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-12-12Java設(shè)計(jì)模式中單一職責(zé)原則詳解
這篇文章主要介紹了Java設(shè)計(jì)模式中單一職責(zé)原則詳解,單一職責(zé)原則 (SRP) 是軟件設(shè)計(jì)中的一個(gè)重要原則,它要求每個(gè)類只負(fù)責(zé)一個(gè)職責(zé),需要的朋友可以參考下2023-05-05