Spring如何基于aop實現(xiàn)操作日志功能

更新時間：2020年11月09日 15:33:40 作者：cqy19951026

這篇文章主要介紹了Spring如何基于aop實現(xiàn)操作日志功能,文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下

1. 在pom中添加所需依賴

創(chuàng)建一個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. 創(chuàng)建日志實體類

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. 創(chuàng)建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("---------------接口日志記錄---------------");
    //創(chuàng)建一個日志對象
    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);

    //調(diào)用service保存Operation實體類到數(shù)據(jù)庫
    //可以在這設(shè)置id，因為是測試，這里就使用的是數(shù)據(jù)庫的自增id
    myLogMapper.insertLog(adminLog);

  }

}

5. mapper層把日志數(shù)據(jù)存儲到mysql數(shù)據(jù)庫中

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. 測試

先直接登錄用戶，因為是測試，直接從數(shù)據(jù)庫中獲取后登錄，把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接口操作數(shù)據(jù)即可
  @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

進行插入和查詢操作,插入數(shù)據(jù)直接通過后臺提供

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("自然科學(xué)");
    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，后臺日志打印記錄