在Spring 中使用@Aspect 控制自定義註解的操作
阿新 • • 發佈:2021-01-21
Spring 中使用@Aspect 控制自定義註解
看這篇介紹@Aspect
1.定義系統日誌註解類
@Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface SysLog { String value() default ""; }
2.定義切面處理類
package com.kxs.common.aspect; import com.google.gson.Gson; import com.kxs.common.annotation.SysLog; import com.kxs.common.utils.HttpContextUtils; import com.kxs.common.utils.IPUtils; import com.kxs.modules.sys.entity.SysLogEntity; import com.kxs.modules.sys.entity.SysUserEntity; import com.kxs.modules.sys.service.SysLogService; import org.apache.shiro.SecurityUtils; 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 javax.servlet.http.HttpServletRequest; import java.lang.reflect.Method; import java.util.Date; /** * 系統日誌,切面處理類 * * @author * @email * @date */ @Aspect @Component public class SysLogAspect { @Autowired private SysLogService sysLogService; @Pointcut("@annotation(com.kxs.common.annotation.SysLog)")//指向自定義註解路徑 public void logPointCut() { } /** * 切面記錄系統日誌 * @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; //儲存日誌 saveSysLog(point,time); return result; } //儲存日誌 private void saveSysLog(ProceedingJoinPoint joinPoint,long time) { MethodSignature signature = (MethodSignature) joinPoint.getSignature(); Method method = signature.getMethod(); SysLogEntity sysLog = new SysLogEntity(); SysLog syslog = method.getAnnotation(SysLog.class); if(syslog != null){ //註解上的描述 sysLog.setOperation(syslog.value()); } //請求的方法名 String className = joinPoint.getTarget().getClass().getName(); String methodName = signature.getName(); sysLog.setMethod(className + "." + methodName + "()"); //請求的引數 Object[] args = joinPoint.getArgs(); try{ String params = new Gson().toJson(args[0]); sysLog.setParams(params); }catch (Exception e){ } //獲取request HttpServletRequest request = HttpContextUtils.getHttpServletRequest(); //設定IP地址 sysLog.setIp(IPUtils.getIpAddr(request)); //使用者名稱 String username = ((SysUserEntity) SecurityUtils.getSubject().getPrincipal()).getUsername(); sysLog.setUsername(username); sysLog.setTime(time); sysLog.setCreateDate(new Date()); //儲存系統日誌 sysLogService.save(sysLog); } }
補充:為什麼添加了@Aspect 還要加@Component
官方文件中有寫:
You may register aspect classes as regular beans in your Spring XML configuration,or autodetect them through classpath scanning - just like any other Spring-managed bean. However,note that the @Aspect annotation is not sufficient for autodetection in the classpath: For that purpose,you need to add a separate @Component annotation (or alternatively a custom stereotype annotation that qualifies,as per the rules of Spring's component scanner).
翻譯:
您可以在Spring XML配置中註冊aspect類,或者通過類路徑掃描自動檢測它們,就像任何其他Spring管理bean一樣。但是,請注意,@aspect註釋對於在類路徑中自動檢測是不夠的:為了達到這個目的,您需要新增一個單獨的@component註解(或者根據Spring的元件掃描器的規則來定義一個定製的原型註解)。
以上為個人經驗,希望能給大家一個參考,也希望大家多多支援我們。如有錯誤或未考慮完全的地方,望不吝賜教。