SpringBoot Aop实现接口请求次数统计

一、前言

我们通过Spring AOP在每次执行方法前或执行方法后进行切面的处理，进而统计方法访问的次数等功能，可以持久化到数据库或者后面进行接口并发的处理。

二、添加依赖

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.31</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>

三、项目配置

我们主要添加数据库相关的配置。

spring.datasource.url=jdbc:mysql://127.0.0.1:3306/aop_db?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf-8&useSSL=false&allowPublicKeyRetrieval=true
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true

四、创建自定义计数注解

package com.example.aopdemo.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 访问次数注解
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface VisitCount {

}

五、创建实体类和持久层

package com.example.aopdemo.entity;

import javax.persistence.*;

/**
 * @author qx
 * @date 2024/2/4
 * @des 访问情况实体
 */
@Entity
@Table(name = "t_visit")
public class Visit {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    /**
     * 方法名称
     */
    private String methodName;

    /**
     * 请求路径
     */
    private String url;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getMethodName() {
        return methodName;
    }

    public void setMethodName(String methodName) {
        this.methodName = methodName;
    }

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }
}

package com.example.aopdemo.repository;

import com.example.aopdemo.entity.Visit;
import org.springframework.data.jpa.repository.JpaRepository;

/**
 * @author qx
 * @date 2024/2/4
 * @des 访问请求持久层
 */
public interface VisitRepository extends JpaRepository<Visit, Long> {
}

六、创建切面

package com.example.aopdemo.aspect;

import com.example.aopdemo.entity.Visit;
import com.example.aopdemo.repository.VisitRepository;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
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;

/**
 * @author qx
 * @date 2024/2/4
 * @des 方法访问切面
 */
@Aspect
@Component
public class VisitCountAspect {

    @Autowired
    private VisitRepository visitRepository;

    @Around("@annotation(com.example.aopdemo.annotation.VisitCount)")
    public Object VisitCountAround(ProceedingJoinPoint joinPoint) throws Throwable {
        // 获取当前请求的URL
        String url = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest().getRequestURL().toString();
        // 方法名
        String methodName = joinPoint.getSignature().getName();

        // 保存访问数据
        Visit visit = new Visit();
        visit.setUrl(url);
        visit.setMethodName(methodName);
        visitRepository.save(visit);
        return joinPoint.proceed();
    }

}

七、创建控制层并添加注解

package com.example.aopdemo.controller;

import com.example.aopdemo.annotation.VisitCount;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author qx
 * @date 2024/2/4
 * @des
 */
@RestController
@RequestMapping("/index")
public class IndexController {

    @GetMapping("/one")
    @VisitCount
    public String showOne() {
        return "one";
    }

    @GetMapping("/two")
    @VisitCount
    public String showTwo() {
        return "two";
    }
}

八、测试

启动程序，在浏览器上访问请求地址。

我们刷新数据库，发现新增了数据。这样我们就可以根据自己的需求获取请求次数。