SpringBoot使用AOP实现统计全局接口访问次数详解


Posted in Java/Android onJune 16, 2022

AOP是什么

AOP(Aspect Oriented Programming),也就是面向切面编程,是通过预编译方式和运行期间动态代理实现程序功能的传统已维护的一种技术。

AOP的作用和优势

作用:在程序运行期间,在不修改源代码的情况下对某些方法进行功能增强

优势:减少重复代码,提高开发效率,并且便于维护

常见的动态代理技术

jdk代理:基于接口的动态代理技术

SpringBoot使用AOP实现统计全局接口访问次数详解

cglib代理:基于父类的动态代理技术

SpringBoot使用AOP实现统计全局接口访问次数详解

AOP相关概念

  • List item- Target(目标对象):代理的目标对象
  • Proxy(代理):一个类被AOP织入增强后,就产生一个结果代理类
  • Joinpoint(连接点):连接点是指那些被拦截到的点。在Spring中,这些点指的是方法,因为Spring只支持方法类型的连接点(可以被增强的方法叫连接点)
  • PointCut(切入点):切入点是指我们要对哪些Joinpoint进行拦截的定义
  • Advice(通知/增强):通知是指拦截到Joinpoint之后所要做的事情就是通知
  • Aspect(切面):是切入点和通知的结合
  • Weaving(织入):把增强应用到目标对象来创建新的代理对象的过程。Spring采用动态代理织入,而AspectJ采用编译器织入和类装载器织入

实现

我在这里采用基于注解形式的的AOP开发。

开发步骤

加入依赖

<!--引入AOP依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <!--AOP-->
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjrt</artifactId>
            <version>1.9.4</version>
        </dependency>
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.9.4</version>
        </dependency>
        <dependency>
            <groupId>cglib</groupId>
            <artifactId>cglib</artifactId>
            <version>3.2.12</version>
        </dependency>

创建目标接口和目标类(内部有切点)

创建切面类(内部有增强方法)

将目标类和切面类的对象创建权交给Spirng

在切面类中使用注解配置织入关系

在配置文件中开启组件扫描和AOP自动代理

SpringBoot使用AOP实现统计全局接口访问次数详解

因为我的项目是SpringBoot Web项目,在这里开启注解就好了。

下面的代码为使用到的原子计数类。

import java.util.concurrent.atomic.AtomicInteger;
public class AtomicCounter {
    private static final AtomicCounter atomicCounter = new AtomicCounter();
    /**
     * 单例,不允许外界主动实例化
     */
    private AtomicCounter() {
    }
    public static AtomicCounter getInstance() {
        return atomicCounter;
    }
    private static AtomicInteger counter = new AtomicInteger();
    public int getValue() {
        return counter.get();
    }
    public int increase() {
        return counter.incrementAndGet();
    }
    public int decrease() {
        return counter.decrementAndGet();
    }
    // 清零
    public void toZero(){
        counter.set(0);
    }
}

下面的代码为实现的全局接口监控。

我在项目中简单使用了Redis作缓存,所有你可以看到有Redis相关的操作。

使用 @Before 用于配置前置通知。指定增强的方法在切入点方法之前执行。

使用@ @AfterReturning 用于配置后置通知。指定增强的方法在切入点方法之后执行。

使用@ @AfterThrowing 用于配置异常抛出通知。指定增强的方法在出现异常时执行。

@Component
@Aspect
public class GlobalActuator {
    private static final Logger log = LoggerFactory.getLogger(GlobalActuator.class);
    @Resource
    private StringRedisTemplate stringRedisTemplate;
    ThreadLocal<Long> startTime = new ThreadLocal<>();
    ConcurrentHashMap<Object, Object> countMap = new ConcurrentHashMap<Object, Object>();
    /**
     * 匹配控制层层通知 这里监控controller下的所有接口
     */
    @Pointcut("execution(* com.sf.controller.*Controller.*(..))")
    private void controllerPt() {
    }
    /**
     * 在接口原有的方法执行前,将会首先执行此处的代码
     */
    @Before("com.sf.actuator.GlobalActuator.controllerPt()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        startTime.set(System.currentTimeMillis());
        //获取传入目标方法的参数
        Object[] args = joinPoint.getArgs();
    }
    /**
     * 只有正常返回才会执行此方法
     * 如果程序执行失败,则不执行此方法
     */
    @AfterReturning(returning = "returnVal", pointcut = "com.sf.actuator.GlobalActuator.controllerPt()")
    public void doAfterReturning(JoinPoint joinPoint, Object returnVal) throws Throwable {
        Signature signature = joinPoint.getSignature();
        String declaringName = signature.getDeclaringTypeName();
        String methodName = signature.getName();
        String mapKey = declaringName + methodName;
        // 执行成功则计数加一
        int increase = AtomicCounter.getInstance().increase();
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        synchronized (this) {
        //在项目启动时,需要在Redis中读取原有的接口请求次数
            if (countMap.size() == 0) {
                JSONObject jsonObject = RedisUtils.objFromRedis(StringConst.INTERFACE_ACTUATOR);
                if (jsonObject != null) {
                    Set<String> strings = jsonObject.keySet();
                    for (String string : strings) {
                        Object o = jsonObject.get(string);
                        countMap.putIfAbsent(string, o);
                    }
                }
            }
        }
        // 如果此次访问的接口不在countMap,放入countMap
        countMap.putIfAbsent(mapKey, 0);
        countMap.compute(mapKey, (key, value) -> (Integer) value + 1);
        synchronized (this) {
            // 内存计数达到30 更新redis
            if (increase == 30) {
                RedisUtils.objToRedis(StringConst.INTERFACE_ACTUATOR, countMap, Constants.AVA_REDIS_TIMEOUT);
                //删除过期时间
                stringRedisTemplate.persist(StringConst.INTERFACE_ACTUATOR);
                //计数器置为0
                AtomicCounter.getInstance().toZero();
            }
        }
        //log.info("方法执行次数:" + mapKey + "------>" + countMap.get(mapKey));
        //log.info("URI:[{}], 耗费时间:[{}] ms", request.getRequestURI(), System.currentTimeMillis() - startTime.get());
    }
    /**
     * 当接口报错时执行此方法
     */
    @AfterThrowing(pointcut = "com.sf.actuator.GlobalActuator.controllerPt()")
    public void doAfterThrowing(JoinPoint joinPoint) {
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        log.info("接口访问失败,URI:[{}], 耗费时间:[{}] ms", request.getRequestURI(), System.currentTimeMillis() - startTime.get());
    }
}

这里再给出Controller层代码。

@GetMapping("/interface/{intCount}")
    @ApiOperation(value = "查找接口成功访问次数(默认倒序)")
    public Result<List<InterfaceDto>> findInterfaceCount(
            @ApiParam(name = "intCount", value = "需要的接口数") @PathVariable Integer intCount
    ) {
        HashMap<String, Integer> hashMap = new HashMap<>();
        JSONObject jsonObject = RedisUtils.objFromRedis(StringConst.INTERFACE_ACTUATOR);
        if (jsonObject != null) {
            Set<String> strings = jsonObject.keySet();
            for (String string : strings) {
                Integer o = (Integer) jsonObject.get(string);
                hashMap.putIfAbsent(string, o);
            }
        }
        //根据value倒序
        Map<String, Integer> sortedMap = hashMap.entrySet().stream().sorted(Collections.reverseOrder(Map.Entry.comparingByValue()))
                .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (e1, e2) -> e1, LinkedHashMap::new));
        //返回列表
        List<InterfaceDto> resultList = new ArrayList<>();
        //排序后中的map中所有的key
        Object[] objects = sortedMap.keySet().toArray();
        for (int i = 0; i < intCount; i++) {
            InterfaceDto interfaceDto = new InterfaceDto();
            interfaceDto.setName((String) objects[i]);
            interfaceDto.setCount(sortedMap.get((String) objects[i]));
            resultList.add(interfaceDto);
        }
        return Result.success(resultList);
    }

项目运行一段时间后,在Redis中可以看到接口的请求次数。

SpringBoot使用AOP实现统计全局接口访问次数详解

Web最终效果图如下:

SpringBoot使用AOP实现统计全局接口访问次数详解

到此这篇关于SpringBoot使用AOP实现统计全局接口访问次数详解的文章就介绍到这了,更多相关SpringBoot AOP内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!


Tags in this post...

Java/Android 相关文章推荐
解决ObjectMapper.convertValue() 遇到的一些问题
Jun 30 Java/Android
Java基础之this关键字的使用
Jun 30 Java/Android
SpringBoot工程下使用OpenFeign的坑及解决
Jul 02 Java/Android
解决Jenkins集成SonarQube遇到的报错问题
Jul 15 Java/Android
mybatis 获取无数据的字段不显示的问题
Jul 15 Java/Android
java泛型通配符详解
Jul 25 Java/Android
使用springMVC所需要的pom配置
Sep 15 Java/Android
springboot+zookeeper实现分布式锁
Mar 21 Java/Android
Java 数据结构七大排序使用分析
Apr 02 Java/Android
Spring Boot 实现 WebSocket
Apr 30 Java/Android
springboot+rabbitmq实现智能家居实例详解
Jul 23 Java/Android
Java使用HttpClient实现文件下载
Aug 14 Java/Android
Java中的Kotlin 内部类原理
Jun 16 #Java/Android
Spring Security动态权限的实现方法详解
Java实现注册登录跳转
Jun 16 #Java/Android
Java界面编程实现界面跳转
springboot实现string转json json里面带数组
Jun 16 #Java/Android
Android Gradle 插件自定义Plugin实现注意事项
Jun 16 #Java/Android
Java完整实现记事本代码
Jun 16 #Java/Android
You might like
php面向对象全攻略 (十五) 多态的应用
2009/09/30 PHP
zend framework文件上传功能实例代码
2013/12/25 PHP
微信公众平台接口开发入门示例
2014/12/24 PHP
基于PHP常用文件函数和目录函数整理
2017/08/17 PHP
php获取手机端的号码以及ip地址实例代码
2018/09/12 PHP
php 中的信号处理操作实例详解
2020/03/04 PHP
动态改变textbox的宽高的js
2006/10/26 Javascript
jQuery提交表单ajax查询实例代码
2012/10/07 Javascript
JavaScript中的style.display属性操作
2013/03/27 Javascript
jQuery中获取Radio元素值的方法
2013/07/02 Javascript
js confirm()方法的使用方法实例
2013/07/13 Javascript
Node.js 的异步 IO 性能探讨
2014/10/08 Javascript
javascript动态设置样式style实例分析
2015/05/13 Javascript
Javascript动画效果(1)
2016/10/11 Javascript
angular forEach方法遍历源码解读
2017/01/25 Javascript
Bootstrap栅格系统简单实现代码
2017/03/06 Javascript
JavaScript实现计数器基础方法
2017/10/10 Javascript
vue2.0 elementUI制作面包屑导航栏
2018/02/22 Javascript
JavaScript代码实现txt文件的上传预览功能
2018/03/27 Javascript
Vue 使用计时器实现跑马灯效果的实例代码
2019/07/11 Javascript
python实现的各种排序算法代码
2013/03/04 Python
Python删除空文件和空文件夹的方法
2015/07/14 Python
Python制作刷网页流量工具
2017/04/23 Python
详解Django 中是否使用时区的区别
2018/06/14 Python
python 3.7.0 下pillow安装方法
2018/08/27 Python
Python如何通过百度翻译API实现翻译功能
2020/04/02 Python
Python3如何判断三角形的类型
2020/04/12 Python
keras 解决加载lstm+crf模型出错的问题
2020/06/10 Python
基于Python实现简单学生管理系统
2020/07/24 Python
Numpy实现卷积神经网络(CNN)的示例
2020/10/09 Python
HTML5自定义元素播放焦点图动画的实现
2019/09/25 HTML / CSS
中学教师岗位职责
2013/11/26 职场文书
药店促销活动总结
2014/07/10 职场文书
装修施工安全责任书
2014/07/24 职场文书
村支部书记群众路线对照检查材料思想汇报
2014/10/08 职场文书
Win11局域网共享权限在哪里设置? Win11高级共享的设置技巧
2022/04/05 数码科技