springboot aop 自定义注解方式实现一套完善的日志记录

packagecom.wwj.springboot.aop;importcom.alibaba.fastjson.JSON;importcom.wwj.springboot.annotation.OperationLogDetail;importcom.wwj.springboot.model.OperationLog;importorg.aspectj.lang.JoinPoint;importorg.aspectj.lang.ProceedingJoinPoint;importorg.aspectj.lang.annotation.*;importorg.aspectj.lang.reflect.MethodSignature;importorg.springframework.stereotype.Component;importjava.util.Date;importjava.util.HashMap;importjava.util.Map;importjava.util.UUID;/**
 * Created by IntelliJ IDEA
 *
 * @author weiwenjun
 * @date 2018/9/12
 */@Aspect@Componentpublicclass LogAspect {/**
 * 此处的切点是注解的方式，也可以用包名的方式达到相同的效果
 * '@Pointcut("execution(* com.wwj.springboot.service.impl.*.*(..))")'
 */@Pointcut("@annotation(com.wwj.springboot.annotation.OperationLogDetail)")publicvoidoperationLog(){}/**
 * 环绕增强，相当于MethodInterceptor
 */@Around("operationLog()")publicObjectdoAround(ProceedingJoinPoint joinPoint)throwsThrowable {Objectres =null;longtime = System.currentTimeMillis();try{ res = joinPoint.proceed(); time = System.currentTimeMillis() - time;returnres; }finally{try{//方法执行完成后增加日志addOperationLog(joinPoint,res,time); }catch(Exception e){ System.out.println("LogAspect 操作失败："+ e.getMessage()); e.printStackTrace(); } } }privatevoidaddOperationLog(JoinPoint joinPoint,Objectres,longtime){ MethodSignature signature = (MethodSignature)joinPoint.getSignature(); OperationLog operationLog =newOperationLog(); operationLog.setRunTime(time); operationLog.setReturnValue(JSON.toJSONString(res)); operationLog.setId(UUID.randomUUID().toString()); operationLog.setArgs(JSON.toJSONString(joinPoint.getArgs())); operationLog.setCreateTime(newDate()); operationLog.setMethod(signature.getDeclaringTypeName() +"."+ signature.getName()); operationLog.setUserId("#{currentUserId}"); operationLog.setUserName("#{currentUserName}"); OperationLogDetail annotation = signature.getMethod().getAnnotation(OperationLogDetail.class);if(annotation !=null){ operationLog.setLevel(annotation.level()); operationLog.setDescribe(getDetail(((MethodSignature)joinPoint.getSignature()).getParameterNames(),joinPoint.getArgs(),annotation)); operationLog.setOperationType(annotation.operationType().getValue()); operationLog.setOperationUnit(annotation.operationUnit().getValue()); }//TODO 这里保存日志System.out.println("记录日志:"+ operationLog.toString());// operationLogService.insert(operationLog);}/**
 * 对当前登录用户和占位符处理
 * @param argNames 方法参数名称数组
 * @param args 方法参数数组
 * @param annotation 注解信息
 * @return 返回处理后的描述
 */privateStringgetDetail(String[] argNames,Object[] args, OperationLogDetail annotation){ Mapmap=newHashMap<>(4);for(inti =0;i < argNames.length;i++){map.put(argNames[i],args[i]); }Stringdetail = annotation.detail();try{ detail ="'"+"#{currentUserName}"+"'=》"+ annotation.detail();for(Map.Entry entry :map.entrySet()) {Objectk = entry.getKey();Objectv = entry.getValue(); detail = detail.replace("{{"+ k +"}}", JSON.toJSONString(v)); } }catch(Exception e){ e.printStackTrace(); }returndetail; } @Before("operationLog()")publicvoiddoBeforeAdvice(JoinPoint joinPoint){ System.out.println("进入方法前执行....."); }/**
 * 处理完请求，返回内容
 * @param ret
 */@AfterReturning(returning ="ret", pointcut ="operationLog()")publicvoiddoAfterReturning(Objectret) { System.out.println("方法的返回值 : "+ ret); }/**
 * 后置异常通知
 */@AfterThrowing("operationLog()")publicvoidthrowss(JoinPoint jp){ System.out.println("方法异常时执行....."); }/**
 * 后置最终通知,final增强，不管是抛出异常或者正常退出都会执行
 */@After("operationLog()")publicvoidafter(JoinPoint jp){ System.out.println("方法最后执行....."); }}

package com.wwj.springboot.annotation;import com.wwj.springboot.enums.OperationType;import com.wwj.springboot.enums.OperationUnit;import java.lang.annotation.*;/**
 * Created by IntelliJ IDEA
 *
 * @author weiwenjun
 * @date 2018/9/12*/
//@OperationLogDetail(detail = "通过手机号[{{tel}}]获取用户名",level = 3,operationUnit = OperationUnit.USER,operationType = OperationType.SELECT)
@Documented
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface OperationLogDetail {
 /** * 方法描述,可使用占位符获取参数:{{tel}}*/
 String detail() default "";
 /** * 日志等级:自己定，此处分为1-9*/
 int level() default 0;
 /** * 操作类型(enum):主要是select,insert,update,delete*/
 OperationType operationType() default OperationType.UNKNOWN;
 /** * 被操作的对象(此处使用enum):可以是任何对象，如表名(user)，或者是工具(redis)*/
 OperationUnit operationUnit() default OperationUnit.UNKNOWN;
}

package com.wwj.springboot.enums;/**
 * Created by IntelliJ IDEA
 *
 * @author weiwenjun
 * @date 2018/9/12
 */publicenumOperationType {/**
 * 操作类型
 */UNKNOWN("unknown"), DELETE("delete"), SELECT("select"), UPDATE("update"), INSERT("insert");privateStringvalue;publicStringgetValue(){returnvalue; }publicvoidsetValue(Stringvalue){this.value=value; } OperationType(String s) {this.value= s; }}package com.wwj.springboot.enums;/**
 * Created by IntelliJ IDEA
 * 被操作的单元
 * @author weiwenjun
 * @date 2018/9/12
 */publicenumOperationUnit {/**
 * 被操作的单元
 */UNKNOWN("unknown"), USER("user"), EMPLOYEE("employee"), Redis("redis");privateStringvalue; OperationUnit(Stringvalue) {this.value=value; }publicStringgetValue(){returnvalue; }publicvoidsetValue(Stringvalue){this.value=value; }}

package com.wwj.springboot.model;importjava.util.Date;/**
 * Created by IntelliJ IDEA
 *
 * @author weiwenjun
 * @date 2018/9/12
 */publicclassOperationLog {privateStringid;privateDatecreateTime;/**
 * 日志等级
 */privateInteger level;/**
 * 被操作的对象
 */privateStringoperationUnit;/**
 * 方法名
 */privateStringmethod;/**
 * 参数
 */privateStringargs;/**
 * 操作人id
 */privateStringuserId;/**
 * 操作人
 */privateStringuserName;/**
 * 日志描述
 */privateStringdescribe;/**
 * 操作类型
 */privateStringoperationType;/**
 * 方法运行时间
 */privateLong runTime;/**
 * 方法返回值
 */privateStringreturnValue;@OverridepublicStringtoString() {return"OperationLog{"+"id='"+ id +'\''+", createTime="+ createTime +", level="+ level +", operationUnit='"+ operationUnit +'\''+", method='"+ method +'\''+", args='"+ args +'\''+", userId='"+ userId +'\''+", userName='"+ userName +'\''+", describe='"+ describe +'\''+", operationType='"+ operationType +'\''+", runTime="+ runTime +", returnValue='"+ returnValue +'\''+'}'; }publicLong getRunTime() {returnrunTime; }publicvoidsetRunTime(Long runTime) {this.runTime = runTime; }publicStringgetReturnValue() {returnreturnValue; }publicvoidsetReturnValue(StringreturnValue) {this.returnValue = returnValue; }publicStringgetId() {returnid; }publicvoidsetId(Stringid) {this.id = id; }publicDategetCreateTime() {returncreateTime; }publicvoidsetCreateTime(DatecreateTime) {this.createTime = createTime; }publicInteger getLevel() {returnlevel; }publicvoidsetLevel(Integer level) {this.level = level; }publicStringgetOperationUnit() {returnoperationUnit; }publicvoidsetOperationUnit(StringoperationUnit) {this.operationUnit = operationUnit; }publicStringgetMethod() {returnmethod; }publicvoidsetMethod(Stringmethod) {this.method = method; }publicStringgetArgs() {returnargs; }publicvoidsetArgs(Stringargs) {this.args = args; }publicStringgetUserId() {returnuserId; }publicvoidsetUserId(StringuserId) {this.userId = userId; }publicStringgetUserName() {returnuserName; }publicvoidsetUserName(StringuserName) {this.userName = userName; }publicStringgetDescribe() {returndescribe; }publicvoidsetDescribe(Stringdescribe) {this.describe = describe; }publicStringgetOperationType() {returnoperationType; }publicvoidsetOperationType(StringoperationType) {this.operationType = operationType; }}

packagecom.wwj.springboot;importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;/** * Created by IntelliJ IDEA * *@authorweiwenjun *@date2018/9/12 */@SpringBootApplicationpublicclassAopApplication{publicstaticvoidmain(String[] args) { SpringApplication.run(AopApplication.class); }}

packagecom.wwj.springboot.controller;importcom.wwj.springboot.service.UserService;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.stereotype.Controller;importorg.springframework.web.bind.annotation.RequestMapping;importorg.springframework.web.bind.annotation.RequestParam;importorg.springframework.web.bind.annotation.ResponseBody;/**
 * Created by IntelliJ IDEA
 *
 * @author weiwenjun
 * @date 2018/9/12
 */@Controller@RequestMapping("user")public class UserController { @Autowiredprivate UserService userService;/**
 * 访问路径 http://localhost:11000/user/findUserNameByTel?tel=1234567
 * @param tel 手机号
 * @return userName
 */@ResponseBody@RequestMapping("/findUserNameByTel") public String findUserNameByTel(@RequestParam("tel") String tel){returnuserService.findUserName(tel); }}

packagecom.wwj.springboot.service;/** * Created by IntelliJ IDEA * *@authorweiwenjun *@date2018/9/13 */publicinterfaceUserService{/** * 获取用户信息 *@return*@paramtel */StringfindUserName(String tel);}

packagecom.wwj.springboot.service.impl;importcom.wwj.springboot.annotation.OperationLogDetail;importcom.wwj.springboot.enums.OperationType;importcom.wwj.springboot.enums.OperationUnit;importcom.wwj.springboot.service.UserService;importorg.springframework.stereotype.Service;/**
 * Created by IntelliJ IDEA
 *
 * @author weiwenjun
 * @date 2018/9/13
 */@Servicepublic class UserServiceImpl implements UserService { @OperationLogDetail(detail="通过手机号[{{tel}}]获取用户名",level =3,operationUnit = OperationUnit.USER,operationType = OperationType.SELECT) @Override public String findUserName(String tel) {System.out.println("tel:"+tel);return"zhangsan"; }}

<?xml version="1.0"encoding="UTF-8"?>4.0.0com.wwj.springbootspringbootpom1.0-SNAPSHOTspringboot-aop<!-- Inherit defaults from Spring Boot -->org.springframework.bootspring-boot-starter-parent2.0.4.RELEASE1.2.49<!-- Import dependency management from Spring Boot -->org.springframework.bootspring-boot-dependencies2.0.4.RELEASEpomimportcom.alibabafastjson${fastjson.version}

<?xml version="1.0"encoding="UTF-8"?>springbootcom.wwj.springboot1.0-SNAPSHOT4.0.0springboot-aoporg.springframework.bootspring-boot-starter-web<!-- spring-boot aop依赖配置引入 -->org.springframework.bootspring-boot-starter-aopcom.alibabafastjson

进入方法前执行.....tel:1234567记录日志:OperationLog{id='cd4b5ba7-7580-4989-a75e-51703f0dfbfc', createTime=Fri Sep1408:54:55CST2018, level=3, operationUnit='user', method='com.wwj.springboot.service.impl.UserServiceImpl.findUserName', args='["1234567"]', userId='#{currentUserId}', userName='#{currentUserName}', describe=''#{currentUserName}'=》通过手机号["1234567"]获取用户名', operationType='select', runTime=4, returnValue='"zhangsan"'}方法最后执行.....方法的返回值 : zhangsan