記錄系統(tǒng)用戶的操作日志
采用方案: 使用spring 的 aop 技術(shù)切到自定義注解上陡蝇,針對(duì)不同注解標(biāo)志進(jìn)行參數(shù)解析,記錄日志
缺點(diǎn)是要針對(duì)每個(gè)不同的注解標(biāo)志進(jìn)行分別取注解標(biāo)志,獲取參數(shù)進(jìn)行日志記錄輸出
1. 需要引用的依賴
<!--spring切面aop依賴-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
在application.properties文件里加這樣一條配置
spring.aop.auto=true //這個(gè)配置我的例子中沒有加 也正常運(yùn)行
2. 創(chuàng)建實(shí)體類
public class SysLog implements Serializable {
private Long id;
private String username; //用戶名
private String operation; //操作
private String method; //方法名
private String params; //參數(shù)
private String ip; //ip地址
private Date createDate; //操作時(shí)間
//創(chuàng)建getter和setter方法
}
3. 使用spring 的 aop 技術(shù)切到自定義注解上,所以先創(chuàng)建一個(gè)自定義注解類
import java.lang.annotation.*;
/**
* 自定義注解類
*/
@Target(ElementType.METHOD) //注解放置的目標(biāo)位置,METHOD是可注解在方法級(jí)別上
@Retention(RetentionPolicy.RUNTIME) //注解在哪個(gè)階段執(zhí)行
@Documented //生成文檔
public @interface MyLog {
String value() default "";
}
4. 創(chuàng)建aop切面實(shí)現(xiàn)類
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;
/**
* 系統(tǒng)日志:切面處理類
*/
@Aspect
@Component
public class SysLogAspect {
@Autowired
private SysLogService sysLogService;
//定義切點(diǎn) @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();
//從切面織入點(diǎn)處通過反射機(jī)制獲取織入點(diǎn)處的方法
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
//獲取切入點(diǎn)所在的方法
Method method = signature.getMethod();
//獲取操作
MyLog myLog = method.getAnnotation(MyLog.class);
if (myLog != null) {
String value = myLog.value();
sysLog.setOperation(value);//保存獲取的操作
}
//獲取請(qǐng)求的類名
String className = joinPoint.getTarget().getClass().getName();
//獲取請(qǐng)求的方法名
String methodName = method.getName();
sysLog.setMethod(className + "." + methodName);
//請(qǐng)求的參數(shù)
Object[] args = joinPoint.getArgs();
//將參數(shù)所在的數(shù)組轉(zhuǎn)換成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));
//調(diào)用service保存SysLog實(shí)體類到數(shù)據(jù)庫
sysLogService.save(sysLog);
}
}
5. 接下來就可以在需要監(jiān)控的方法上添加 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("系統(tǒng)菜單缚俏,不能刪除");
}
}
sysMenuService.deleteBatch(menuIds);
return R.ok("刪除成功");
}
}