springboot aop 自定义注解方式实现完善日志记录（完整源码）
- 2019 年 11 月 29 日
- 筆記
版权声明：本文为博主原创文章，欢迎转载，转载请注明作者、原文超链接
一：功能简介
本文主要记录如何使用aop切面的方式来实现日志记录功能。
主要记录的信息有: 操作人，方法名，参数，运行时间，操作类型(增删改查)，详细描述，返回值。
二：项目结构图
三：代码实现
1.配置文件
这里只有两个配置： 1)server.port=11000，设置项目启动的端口号,防止被其他服务占用; 2)spring.aop.auto=true，开启spring的aop配置,简单明了，不需要多配置其他的配置或注解。 application.yml文件
server: port: 11000 spring: aop: auto: true #启动aop配置
2.AOP切点类
这个是最主要的类,可以使用自定义注解或针对包名实现AOP增强。
1)这里实现了对自定义注解的环绕增强切点，对使用了自定义注解的方法进行AOP切面处理；
2)对方法运行时间进行监控；
3)对方法名，参数名，参数值，对日志描述的优化处理；
在方法上增加@Aspect 注解声明切面,使用@Pointcut 注解定义切点，标记方法。
使用切点增强的时机注解:@Before,@Around,@AfterReturning,@AfterThrowing,@After
package com.wwj.springboot.aop; import com.alibaba.fastjson.JSON; import com.wwj.springboot.annotation.OperationLogDetail; import com.wwj.springboot.model.OperationLog; import org.aspectj.lang.JoinPoint; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.*; import org.aspectj.lang.reflect.MethodSignature; import org.springframework.stereotype.Component; import java.util.Date; import java.util.HashMap; import java.util.Map; import java.util.UUID; /** * Created by IntelliJ IDEA * * @author weiwenjun * @date 2018/9/12 */ @Aspect @Component public class LogAspect { /** * 此处的切点是注解的方式，也可以用包名的方式达到相同的效果 * '@Pointcut("execution(* com.wwj.springboot.service.impl.*.*(..))")' */ @Pointcut("@annotation(com.wwj.springboot.annotation.OperationLogDetail)") public void operationLog(){} /** * 环绕增强，相当于MethodInterceptor */ @Around("operationLog()") public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable { Object res = null; long time = System.currentTimeMillis(); try { res = joinPoint.proceed(); time = System.currentTimeMillis() - time; return res; } finally { try { //方法执行完成后增加日志 addOperationLog(joinPoint,res,time); }catch (Exception e){ System.out.println("LogAspect 操作失败：" + e.getMessage()); e.printStackTrace(); } } } private void addOperationLog(JoinPoint joinPoint, Object res, long time){ MethodSignature signature = (MethodSignature)joinPoint.getSignature(); OperationLog operationLog = new OperationLog(); operationLog.setRunTime(time); operationLog.setReturnValue(JSON.toJSONString(res)); operationLog.setId(UUID.randomUUID().toString()); operationLog.setArgs(JSON.toJSONString(joinPoint.getArgs())); operationLog.setCreateTime(new Date()); 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 返回处理后的描述 */ private String getDetail(String[] argNames, Object[] args, OperationLogDetail annotation){ Map<Object, Object> map = new HashMap<>(4); for(int i = 0;i < argNames.length;i++){ map.put(argNames[i],args[i]); } String detail = annotation.detail(); try { detail = "'" + "#{currentUserName}" + "'=》" + annotation.detail(); for (Map.Entry<Object, Object> entry : map.entrySet()) { Object k = entry.getKey(); Object v = entry.getValue(); detail = detail.replace("{{" + k + "}}", JSON.toJSONString(v)); } }catch (Exception e){ e.printStackTrace(); } return detail; } @Before("operationLog()") public void doBeforeAdvice(JoinPoint joinPoint){ System.out.println("进入方法前执行....."); } /** * 处理完请求，返回内容 * @param ret */ @AfterReturning(returning = "ret", pointcut = "operationLog()") public void doAfterReturning(Object ret) { System.out.println("方法的返回值 : " + ret); } /** * 后置异常通知 */ @AfterThrowing("operationLog()") public void throwss(JoinPoint jp){ System.out.println("方法异常时执行....."); } /** * 后置最终通知,final增强，不管是抛出异常或者正常退出都会执行 */ @After("operationLog()") public void after(JoinPoint jp){ System.out.println("方法最后执行....."); } }
3.自定义注解
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; }
4.注解用到的枚举类型
package com.wwj.springboot.enums; /** * Created by IntelliJ IDEA * * @author weiwenjun * @date 2018/9/12 */ public enum OperationType { /** * 操作类型 */ UNKNOWN("unknown"), DELETE("delete"), SELECT("select"), UPDATE("update"), INSERT("insert"); private String value; public String getValue() { return value; } public void setValue(String value) { this.value = value; } OperationType(String s) { this.value = s; } }
package com.wwj.springboot.enums; /** * Created by IntelliJ IDEA * 被操作的单元 * @author weiwenjun * @date 2018/9/12 */ public enum OperationUnit { /** * 被操作的单元 */ UNKNOWN("unknown"), USER("user"), EMPLOYEE("employee"), Redis("redis"); private String value; OperationUnit(String value) { this.value = value; } public String getValue() { return value; } public void setValue(String value) { this.value = value; } }
5.日志记录对象
package com.wwj.springboot.model; import java.util.Date; /** * Created by IntelliJ IDEA * * @author weiwenjun * @date 2018/9/12 */ public class OperationLog { private String id; private Date createTime; /** * 日志等级 */ private Integer level; /** * 被操作的对象 */ private String operationUnit; /** * 方法名 */ private String method; /** * 参数 */ private String args; /** * 操作人id */ private String userId; /** * 操作人 */ private String userName; /** * 日志描述 */ private String describe; /** * 操作类型 */ private String operationType; /** * 方法运行时间 */ private Long runTime; /** * 方法返回值 */ private String returnValue; @Override public String toString() { 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 + ''' + '}'; } public Long getRunTime() { return runTime; } public void setRunTime(Long runTime) { this.runTime = runTime; } public String getReturnValue() { return returnValue; } public void setReturnValue(String returnValue) { this.returnValue = returnValue; } public String getId() { return id; } public void setId(String id) { this.id = id; } public Date getCreateTime() { return createTime; } public void setCreateTime(Date createTime) { this.createTime = createTime; } public Integer getLevel() { return level; } public void setLevel(Integer level) { this.level = level; } public String getOperationUnit() { return operationUnit; } public void setOperationUnit(String operationUnit) { this.operationUnit = operationUnit; } public String getMethod() { return method; } public void setMethod(String method) { this.method = method; } public String getArgs() { return args; } public void setArgs(String args) { this.args = args; } public String getUserId() { return userId; } public void setUserId(String userId) { this.userId = userId; } public String getUserName() { return userName; } public void setUserName(String userName) { this.userName = userName; } public String getDescribe() { return describe; } public void setDescribe(String describe) { this.describe = describe; } public String getOperationType() { return operationType; } public void setOperationType(String operationType) { this.operationType = operationType; } }
6.springboot启动类
package com.wwj.springboot; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; /** * Created by IntelliJ IDEA * * @author weiwenjun * @date 2018/9/12 */ @SpringBootApplication public class AopApplication { public static void main(String[] args) { SpringApplication.run(AopApplication.class); } }
7.controller类
package com.wwj.springboot.controller; import com.wwj.springboot.service.UserService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.ResponseBody; /** * Created by IntelliJ IDEA * * @author weiwenjun * @date 2018/9/12 */ @Controller @RequestMapping("user") public class UserController { @Autowired private UserService userService; /** * 访问路径 http://localhost:11000/user/findUserNameByTel?tel=1234567 * @param tel 手机号 * @return userName */ @ResponseBody @RequestMapping("/findUserNameByTel") public String findUserNameByTel(@RequestParam("tel") String tel){ return userService.findUserName(tel); } }
8.Service类
package com.wwj.springboot.service; /** * Created by IntelliJ IDEA * * @author weiwenjun * @date 2018/9/13 */ public interface UserService { /** * 获取用户信息 * @return * @param tel */ String findUserName(String tel); }
9.ServiceImpl类
package com.wwj.springboot.service.impl; import com.wwj.springboot.annotation.OperationLogDetail; import com.wwj.springboot.enums.OperationType; import com.wwj.springboot.enums.OperationUnit; import com.wwj.springboot.service.UserService; import org.springframework.stereotype.Service; /** * Created by IntelliJ IDEA * * @author weiwenjun * @date 2018/9/13 */ @Service public 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"; } }
四：MAVEM依赖
本项目有两个pom文件,父类的pom文件主要作用是对子类pom文件依赖的版本号进行统一管理。
1.最外层的pom文件配置如下
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.wwj.springboot</groupId> <artifactId>springboot</artifactId> <packaging>pom</packaging> <version>1.0-SNAPSHOT</version> <modules> <module>springboot-aop</module> </modules> <!-- Inherit defaults from Spring Boot --> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.0.4.RELEASE</version> </parent> <properties> <fastjson.version>1.2.49</fastjson.version> </properties> <dependencyManagement> <dependencies> <dependency> <!-- Import dependency management from Spring Boot --> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-dependencies</artifactId> <version>2.0.4.RELEASE</version> <type>pom</type> <scope>import</scope> </dependency> <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>${fastjson.version}</version> </dependency> </dependencies> </dependencyManagement> </project>
2.子pom文件配置如下
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <parent> <artifactId>springboot</artifactId> <groupId>com.wwj.springboot</groupId> <version>1.0-SNAPSHOT</version> </parent> <modelVersion>4.0.0</modelVersion> <artifactId>springboot-aop</artifactId> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!-- spring-boot aop依赖配置引入 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency> <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> </dependency> </dependencies> </project>
五:运行结果
进入方法前执行..... tel:1234567 记录日志:OperationLog{id='cd4b5ba7-7580-4989-a75e-51703f0dfbfc', createTime=Fri Sep 14 08:54:55 CST 2018, 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
感谢您的阅读，如果您觉得阅读本文对您有帮助，请点一下“推荐”按钮。本文欢迎各位转载，但是转载文章之后必须在文章页面中给出作者和原文连接。
