【Spring Boot 快速入门】二十、Spring Boot 基于AOP注解实现日志记录功能

先自我介绍一下，小编浙江大学毕业，去过华为、字节跳动等大厂，目前阿里P7

深知大多数程序员，想要提升技能，往往是自己摸索成长，但自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年最新Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

如果你需要这些资料，可以添加V获取：vip1024b （备注Java）

正文

• 0=其它,1=新增,2=修改,3=删除,4=授权,5=导出,6=导入,7=强退,8=登录,9=清空数据,10查询

• */

OTHER(0,“其它”),

ADD(1,“新增”),

UPDATE(2,“修改”),

DEL(3,“删除”),

AUTH(4,“授权”),

EXPORT(5,“导出”),

IMPORT(6,“导入”),

QUIT(7,“强退”),

GENERATE_CODE(8,“登录”),

CLEAR(9,“清空”),

QUERY(10,“查询”),

;

@EnumValue

private int value;

private String desc;

}

复制代码

Log注解

当数据初始化完成之后，就是编写一个自定义的Log注解。本次使用的注解主要是针对方法进行注解。具体如下：

• @Target：注解的目标位置，主要可以有接口、类、枚举、字段、方法、构造函数、包等位置。可以根据需要进行配置。日志使用的本次基于方法注解。

• @Retention：是指注解保留的位置，可以在源码中、类中、运行中。本次日志操作记录肯定是在运行中使用，所以选择RUNTIME。

• @Documented：字面意思文档，也就是说明该注解将被包含在javadoc中。

@Target(ElementType.METHOD)

@Retention(RetentionPolicy.RUNTIME)

@Documented

public @interface Log {

/**

• 模块

• */

String model() default “”;

/**

• 操作

• */

LogTypeEnum logType() default LogTypeEnum.OTHER;

}

复制代码

LogAspect

定义一个日志的LogAspect切面。在类中需要使用@Aspect和 @Component指明这是一个切面方法在运行中进行扫描包。需要注意的是这个方法中需要定义切面和通知类型。最后根据注解和请求参数中的信息，查询到操作日志需要的信息。由于本次无需登录直接接口请求，所以操作人和操作id在演示中使用了默认值。本次示例只提取了部分操作日志信息，在项目中需要加入的日志信息多，可以根据需求进行修改。

@Aspect

@Component

public class LogAspect {

@Resource

private LogInfoMapper logInfoMapper;

/**

• @ClassName logPointCut

• @Description:切点信息

• @Author JavaZhan @公众号:Java全栈架构师

• @Version V1.0

**/

@Pointcut(“@annotation(com.example.demo.log.Log)”)

public void logPointCut(){

}

/**

• @ClassName aroundForLog

• @Description:环绕通知

• @Author JavaZhan @公众号:Java全栈架构师

• @Version V1.0

**/

@Around(“logPointCut()”)

public Object aroundForLog(ProceedingJoinPoint point) throws Throwable {

long beginTime = System.currentTimeMillis();

Object result = point.proceed();

saveSmsLog(point);

return result;

}

/**

• @ClassName saveLogInfo

• @Description: 保存操作日志

• @Author JavaZhan @公众号:Java全栈架构师

• @Version V1.0

**/

private void saveLogInfo(ProceedingJoinPoint joinPoint) {

MethodSignature signature = (MethodSignature) joinPoint.getSignature();

Method method = signature.getMethod();

LogInfo logInfo = new LogInfo();

logInfo.setClassName(joinPoint.getTarget().getClass().getName());

logInfo.setMethodName(signature.getName());

Log log = method.getAnnotation(Log.class);

if(log != null){

logInfo.setModel(log.model());

logInfo.setLogType(log.logType().getValue());

}

Object[] args = joinPoint.getArgs();

try{

String params = JSONObject.toJSONString(args);

logInfo.setParams(params);

}catch (Exception e){

}

ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();

HttpServletRequest request = servletRequestAttributes.getRequest();

logInfo.setIp(IpUtils.getIpAddr(request));

logInfo.setUrl(request.getServletPath());

logInfo.setMethod(request.getMethod());

logInfo.setUserId(123);

logInfo.setUserName(“admin”);

logInfo.setCreateTime(new Date());

logInfo.setDataState(1);

//保存操作日志

logInfoMapper.insert(logInfo);

}

}

复制代码

测试日志

本示例将基于常用的接口进行测试。在Controller方法中，我们调用自定义注解，根据方法的实际使用含义指定方法的model信息和操作类型信息即可。

@RequestMapping(“user”)

@Controller

public class UserController {

@Resource

private UserService userService;

@RequestMapping(“getAllUser”)

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化的资料的朋友，可以添加V获取：vip1024b （备注Java）

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

userService;

@RequestMapping(“getAllUser”)

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化的资料的朋友，可以添加V获取：vip1024b （备注Java）
[外链图片转存中…(img-A7YpAwLr-1713665637026)]

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！