springboot—spring aop 實現系統操作日誌記錄存儲到數據庫
阿新 • • 發佈:2018-08-31
work prop 請求 pack spa 成功 方法 代碼 shu
格式為 @+自定義註解的類名
作者:東方舵手
鏈接:https://www.jianshu.com/p/d0bbdf1974bd
來源:簡書
簡書著作權歸作者所有,任何形式的轉載都請聯系作者獲得授權並註明出處。
原文:https://www.jianshu.com/p/d0bbdf1974bd
采用方案: 使用spring 的 aop 技術切到自定義註解上,針對不同註解標誌進行參數解析,記錄日誌
缺點是要針對每個不同的註解標誌進行分別取註解標誌,獲取參數進行日誌記錄輸出
1. 需要引用的依賴
<!--spring切面aop依賴-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
在application.properties文件裏加這樣一條配置
spring.aop.auto=true //這個配置我的例子中沒有加 也正常運行
2. 創建實體類
public class SysLog implements Serializable {
private Long id;
private String username; //用戶名
private String operation; //操作
private String method; //方法名
private String params; //參數
private String ip; //ip地址
private Date createDate; //操作時間
//創建getter和setter方法
}
3. 使用spring 的 aop 技術切到自定義註解上,所以先創建一個自定義註解類
import java.lang.annotation.*;
/**
* 自定義註解類
*/
@Target(ElementType.METHOD) //註解放置的目標位置,METHOD是可註解在方法級別上
@Retention(RetentionPolicy.RUNTIME) //註解在哪個階段執行
@Documented //生成文檔
public @interface MyLog {
String value() default "";
}
4. 創建aop切面實現類
import com.alibaba.fastjson.JSON;
import com.qfedu.rongzaiboot.annotation.MyLog;
import com.qfedu.rongzaiboot.entity.SysLog;
import com.qfedu.rongzaiboot.service.SysLogService;
import com.qfedu.rongzaiboot.utils.HttpContextUtils;
import com.qfedu.rongzaiboot.utils.IPUtils;
import com.qfedu.rongzaiboot.utils.ShiroUtils;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
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;
/**
* 系統日誌:切面處理類
*/
@Aspect
@Component
public class SysLogAspect {
@Autowired
private SysLogService sysLogService;
//定義切點 @Pointcut
//在註解的位置切入代碼
@Pointcut("@annotation( com.qfedu.rongzaiboot.annotation.MyLog)")
public void logPoinCut() {
}
//切面 配置通知
@AfterReturning("logPoinCut()")
public void saveSysLog(JoinPoint joinPoint) {
System.out.println("切面。。。。。");
//保存日誌
SysLog sysLog = new SysLog();
//從切面織入點處通過反射機制獲取織入點處的方法
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
//獲取切入點所在的方法
Method method = signature.getMethod();
//獲取操作
MyLog myLog = method.getAnnotation(MyLog.class);
if (myLog != null) {
String value = myLog.value();
sysLog.setOperation(value);//保存獲取的操作
}
//獲取請求的類名
String className = joinPoint.getTarget().getClass().getName();
//獲取請求的方法名
String methodName = method.getName();
sysLog.setMethod(className + "." + methodName);
//請求的參數
Object[] args = joinPoint.getArgs();
//將參數所在的數組轉換成json
String params = JSON.toJSONString(args);
sysLog.setParams(params);
sysLog.setCreateDate(new Date());
//獲取用戶名
sysLog.setUsername(ShiroUtils.getUserEntity().getUsername());
//獲取用戶ip地址
HttpServletRequest request = HttpContextUtils.getHttpServletRequest();
sysLog.setIp(IPUtils.getIpAddr(request));
//調用service保存SysLog實體類到數據庫
sysLogService.save(sysLog);
}
}
5. 接下來就可以在需要監控的方法上添加 aop的自定義註解
格式為 @+自定義註解的類名 @MyLog
//例如在contoller類的方法上加註解
@RestController
@RequestMapping("/sys/menu")
public class SysMenuController extends AbstractController {
@Autowired
private SysMenuService sysMenuService;
@MyLog(value = "刪除菜單記錄") //這裏添加了AOP的自定義註解
@PostMapping("/del")
public R deleteBatch(@RequestBody Long[] menuIds) {
for (Long menuId : menuIds) {
if (menuId <= 31) {
return R.error("系統菜單,不能刪除");
}
}
sysMenuService.deleteBatch(menuIds);
return R.ok("刪除成功");
}
}
6. 執行上面的方法操作後,會將記錄保存到數據庫
作者:東方舵手
鏈接:https://www.jianshu.com/p/d0bbdf1974bd
來源:簡書
簡書著作權歸作者所有,任何形式的轉載都請聯系作者獲得授權並註明出處。
springboot—spring aop 實現系統操作日誌記錄存儲到數據庫