Wie SpringBoot AOP zum Aufzeichnen von Schnittstellenbetriebsprotokollen verwendet

1. Einführung in AOP

AOP: Aspektorientierte Programmierung

AOP konzentriert sich nicht auf eine bestimmte Klasse oder bestimmte Methoden; Klassen und Methoden.

2. AOP-Anwendungsszenarien und allgemeine Begriffe

Berechtigungskontrolle, Cache-Steuerung, Transaktionskontrolle, verteilte Ablaufverfolgung, Ausnahmebehandlung usw.

• Ziel: Zielklasse, also die Klasse, die benötigt wird vertreten werden. Zum Beispiel: UserService

• Joinpoint (Verbindungspunkt): Der sogenannte Verbindungspunkt bezieht sich auf die Methoden, die abgefangen werden können. Zum Beispiel: Alle Methoden

• PointCut Pointcut: Ein Verbindungspunkt, der erweitert wurde. Zum Beispiel: addUser()

• Beratungsbenachrichtigung/-verbesserung, erweiterter Code. Zum Beispiel: nachher, vorher

• Weben (Weben): Bezieht sich auf den Prozess der Anwendung erweiterter Ratschläge auf das Zielobjektziel, um einen neuen Proxy-Objekt-Proxy zu erstellen.

• Aspekt (Aspekt): Es ist der Einstiegspunkt Pointcut und Benachrichtigung Kombination von Ratschlägen

• 3. Merkmale von AOP

1) Reduzieren Sie die Kopplung zwischen Modulen und verbessern Sie die Aggregation von Geschäftscode. (Hohe Kohäsion und geringe Kopplung) 2) Verbesserte Wiederverwendbarkeit des Codes

3) Verbesserte Systemskalierbarkeit. (Höhere Versionen sind mit niedrigeren Versionen kompatibel)

4) Neue Funktionen können hinzugefügt werden, ohne die ursprünglichen Funktionen zu beeinträchtigen

2. SpringBoot verwendet AOP, um den Prozess zu implementieren

<!-- Spring AOP -->
  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

2 Protokoll-Entitätsklasse

@Getter
@Setter
@ApiModel(value = "Systemlog对象", description = "")
public class Systemlog implements Serializable {

    private static final long serialVersionUID = 1L;

      @ApiModelProperty("ID")
      @TableId(value = "id", type = IdType.AUTO)
      private Integer id;

      @ApiModelProperty("用户名")
      private String userName;

      @ApiModelProperty("用户ID")
      private Integer userId;

      @ApiModelProperty("操作描述")
      private String operate;

      @ApiModelProperty("模块")
      private String module;

      @ApiModelProperty("创建日志时间")
      @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
      private Date createTime;

      @ApiModelProperty("操作结果")
      private String result;

}

3. Schreiben Sie eine Anmerkungsklasse

/**
 * controller层切面日志注解
 * @author hsq
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SystemControllerLog {
    // 操作描述
    String operate();
    // 模块
    String module();
}

4. Schreiben Sie eine Aspektklasse des Betriebsprotokolls

**
 * @author hsq
 */
@Aspect
@Component
public class SystemLogAspect {

    private static final Logger logger = LoggerFactory.getLogger(SystemLogAspect.class);

    @Autowired
    private ISystemlogService iSystemlogService;

    @Autowired
    private UserService userService;

    /**
     * Controller层切点
     */
    @Pointcut("@annotation(com.hsq.demo.config.SystemControllerLog)")
    public void SystemControllerLog(){

    }
    
   
    /**
     * 前置通知 用于拦截Controller层记录用户的操作的开始时间
     * @param joinPoint 切点
     * @throws InterruptedException
     */
    @Before("SystemControllerLog()")
    public void doBefore(JoinPoint joinPoint) throws InterruptedException{
        logger.info("进入日志切面前置通知!");

    }

    @After("SystemControllerLog()")
    public void doAfter(JoinPoint joinPoint) {
        logger.info("进入日志切面后置通知!");

    }

    /**value切入点位置
     * returning 自定义的变量，标识目标方法的返回值,自定义变量名必须和通知方法的形参一样
     * 特点：在目标方法之后执行的,能够获取到目标方法的返回值，可以根据这个返回值做不同的处理
     */
    @AfterReturning(value = "SystemControllerLog()", returning = "ret")
    public void doAfterReturning(Object ret) throws Throwable {
    }

    /***
     * 异常通知 记录操作报错日志
     * * @param joinPoint
     * * @param e
     * */
    @AfterThrowing(pointcut = "SystemControllerLog()", throwing = "e")
    public void doAfterThrowing(JoinPoint joinPoint, Throwable e) {
        logger.info("进入日志切面异常通知!!");
        logger.info("异常信息:" + e.getMessage());
    }
        
        
    //使用这个方法先注释前面三个方法，留before方法就行
    /**
     * 通知包裹了目标方法，在目标方法调用之前和之后执行自定义的行为
     * ProceedingJoinPoint切入点可以获取切入点方法上的名字、参数、注解和对象
     * @param joinPoint
     */
    @Around("SystemControllerLog() && @annotation(systemControllerLog)")
  public Result doAfterReturning(ProceedingJoinPoint joinPoint, SystemControllerLog systemControllerLog) throws Throwable {
        logger.info("设置日志信息存储到表中!");
        //joinPoint.proceed() 结果集
        //参数数组
        Object[] args = joinPoint.getArgs();
        //请求参数数据
        String requestJson = JSONUtil.toJsonStr(args);
        //方法名
        String methodName = joinPoint.getSignature().getName();
        //得到request
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        //得到token
        String token = request.getHeader("token");
        String userId = JWT.decode(token).getAudience().get(0);
        User user = userService.getById(userId);
        logger.info("得到用户信息："+user.toString());
        //写入数据库操作日志
        Systemlog systemlog = new Systemlog();
        systemlog.setUserId(user.getUid());
        systemlog.setUserName(user.getUname());
        systemlog.setOperate(systemControllerLog.operate());
        systemlog.setModule(systemControllerLog.module());
        systemlog.setCreateTime(new Date());
        //存入返回的结果集 joinPoint.proceed()
        Result proceed = (Result) joinPoint.proceed();
        systemlog.setResult(JSONUtil.toJsonStr(joinPoint.proceed()));
        //保存
       saveSystemLog(systemlog);

       return proceed;

    }

}

6

Das obige ist der detaillierte Inhalt vonWie SpringBoot AOP zum Aufzeichnen von Schnittstellenbetriebsprotokollen verwendet. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!