Spring如何基于aop实现操作日志功能
更新时间：2020年11月09日 15:33:40 作者：cqy19951026
这篇文章主要介绍了Spring如何基于aop实现操作日志功能,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
1. 在pom中添加所需依赖
创建一个springboot工程，添加所需要的依赖，持久化用的是mybatis
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--springboot aop依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<!--mybatis-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.3</version>
</dependency>
<!--mysql连接-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.19</version>
<scope>runtime</scope>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
2. 创建日志实体类
import lombok.Data;
import java.io.Serializable;
@Data
public class AdminLog implements Serializable {
private static final long serialVersionUID = -291495801959706565L;
private Integer id; //日志记录id
private Integer userId;//操作人id
private String userName;//操作人name
private String loginip;//登录ip
private int type;
private String url;
private String operation;
private String createtime;
private String remark;
}
3. 自定义log注解
import java.lang.annotation.*;
/**
* 自定义日志注解
*/
@Target(ElementType.METHOD) //注解防止位置
@Retention(RetentionPolicy.RUNTIME)//运行时可见
@Documented //生成文档
public @interface MyLog {
String operation() default "";
int type();
}
4. 创建aop切面处理类
import cn.***.springaopdemo.anno.MyLog;
import cn.***.springaopdemo.dao.MyLogMapper;
import cn.***.springaopdemo.pojo.Admin;
import cn.***.springaopdemo.pojo.AdminLog;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
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 org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;
/**
* 切面处理类
*/
@Aspect
@Component
public class SysLogAspect {
/**
* 使用log4j2把一些信息打印在控制台上面
*/
private static final Logger log = LogManager.getLogger(SysLogAspect.class);
@Autowired
private MyLogMapper myLogMapper;
//定义切点 @Pointcut
//在注解的位置切入代码
@Pointcut("@annotation(cn.***.springaopdemo.anno.MyLog)")
public void logPointCut() {
}
//切面 配置为前置通知
@Before("logPointCut()")
public void saveOperation(JoinPoint joinPoint) {
log.info("---------------接口日志记录---------------");
//创建一个日志对象
AdminLog adminLog = new AdminLog();
//获取切面织处入点的方法
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
//获取切入点所在的方法
Method method = signature.getMethod();
//获取操作日志的属性值
MyLog myLog = method.getAnnotation(MyLog.class);
if (myLog != null) {
//操作事件
String operation = myLog.operation();
adminLog.setOperation(operation);
//日志类型
int type = myLog.type();
adminLog.setType(type);
log.info("operation=" + operation + ",type=" + type);
}
//获取url
HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
String requestURL = request.getRequestURI().toString();
adminLog.setUrl(requestURL);
//获取客户端ip
String ip = request.getRemoteAddr();
adminLog.setLoginip(ip);
//获取操作人账号、姓名(需要提前将用户信息保存到Session)
Admin admin = (Admin) request.getSession().getAttribute("admin");
if (admin != null) {
Integer id = admin.getId();
String name = admin.getName();
adminLog.setUserId(id);
adminLog.setUserName(name);
}
log.info("url=" + requestURL + ",ip=" + ip);
//调用service保存Operation实体类到数据库
//可以在这设置id，因为是测试，这里就使用的是数据库的自增id
myLogMapper.insertLog(adminLog);
}
}
5. mapper层把日志数据存储到mysql数据库中
mapper接口
import cn.***.springaopdemo.pojo.AdminLog;
import java.util.List;
public interface MyLogMapper {
void insertLog(AdminLog adminLog);
}
mapper.xml文件
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="cn.***.springaopdemo.dao.MyLogMapper">
<insert id="insertLog" parameterType="cn.***.springaopdemo.pojo.AdminLog">
INSERT INTO admin_log (user_id,user_name,loginip,type,url,operation,createtime,remark)
VALUES (#{userId},#{userName},#{loginip},#{type},#{url},#{operation},now(),#{remark})
</insert>
</mapper>
6. 测试
先直接登录用户，因为是测试，直接从数据库中获取后登录，把admin存储到session中
import cn.***.springaopdemo.pojo.Admin;
import cn.***.springaopdemo.service.IAdminService;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletRequest;
import java.util.List;
@RestController
@RequestMapping("/admin")
public class AdminController {
private static final Logger log = LogManager.getLogger(AdminController.class);
//中间service层可以省略，直接通过mapper接口操作数据即可
@Autowired
private IAdminService adminService;
@RequestMapping("/login")
public Admin login(HttpServletRequest request) {
List<Admin> adminList = adminService.findAllAdmin();
Admin admin = adminList.get(0);
request.getSession().setAttribute("admin",admin );
return admin;
}
}
在浏览器中输入localhost:8080/admin/login，可以看到登录的admin
进行插入和查询操作,插入数据直接通过后台提供
import cn.***.springaopdemo.anno.MyLog;
import cn.***.springaopdemo.pojo.Type;
import cn.***.springaopdemo.service.ITypeService;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.ArrayList;
import java.util.List;
@RestController
@RequestMapping("/type")
public class TypeController {
private static final Logger log = LogManager.getLogger(TypeController.class);
@Autowired
private ITypeService typeService;
@MyLog(operation = "增加书籍类型", type = 2)
@RequestMapping("/add")
public void insertType() {
List<Type> typeList = new ArrayList<>();
Type type = new Type();
type.setName("自然科学");
typeList.add(type);
typeService.addTypeList(typeList);
log.info("添加书籍类型" + type.getName());
}
@MyLog(operation = "查询所有书籍类型", type = 1)
@RequestMapping("/findAll")
public List<Type> findAllType() {
List<Type> typeList = typeService.findAllType();
log.info("查询所有书籍类型");
return typeList;
}
}
在浏览器中输入localhost:8080/type/add，后台日志打印记录
再输入查询请求localhost:8080/type/findAll，获得查询出的分类
查看数据库是否添加成功
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。
相关文章
SpringBoot学习篇之@Valid与@Validated的区别
@Valid是使用Hibernate validation的时候使用,@Validated是只用Spring Validator校验机制使用,下面这篇文章主要给大家介绍了关于SpringBoot学习篇之@Valid与@Validated区别的相关资料,需要的朋友可以参考下2022-11-11
Java Stream中的Spliterator类概念及原理解析
Spliterator是Java 8引入的一个接口,位于java.util包中,它结合了迭代器（Iterator）的遍历能力和分割器（Splitter）的分割能力,本文将详细介绍Spliterator的概念、原理、作用、类中定义的关键方法,以及它在Stream API中的实际应用,感兴趣的朋友一起看看吧2024-08-08
这篇文章主要介绍了Java中@param注解与@see注解的作用,注解的功能类似于通常代码中的注释,需要的朋友可以参考下2015-12-12
本文给大家分享的是使用Java多线程来实现callable接口的方法，以及使用方法，另外还有一个网友的实例，希望能够对大家掌握Java多线程有所帮助。2016-06-06
这篇文章主要介绍了详解Http协议以及post与get区别,通过分别说明Http协议以及get与post各自的概念,再到两者作比较有着详细的说明,希望对你有所帮助2021-06-06
这篇文章主要介绍了Java Optional实践(小结)，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧2018-09-09
这篇文章主要介绍了Java中的泛型详细解析,泛型又称参数化类型,是JDK5.0出现的新特性,解决了数据类型的安全型问题,Java泛型可以保证如果程序在编译时没用发出警告,运行时就不会产生classCastException异常,需要的朋友可以参考下2024-01-01
基于Spring BeanUtils的copyProperties方法使用及注意事项
这篇文章主要介绍了基于Spring BeanUtils的copyProperties方法使用及注意事项，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2021-06-06
SpringBoot+SpringSecurity+JWT实现系统认证与授权示例
本文主要介绍了SpringBoot+SpringSecurity+JWT实现系统认证与授权示例，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2022-08-08
在面试的时候如果面试官问淘宝的七天自动确认收货让你设计，你会怎么具体实现呢？跟着小编看一下下边的实现过程，对大家的学习或工作具有一定的参考借鉴价值2021-09-09
最新评论