SpringBoot使用AOP完成对全局接口访问次数的统计

AOP是什么?

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

AOP的作用和优势?

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

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

常见的动态代理技术

jdk代理:基于接口的动态代理技术
在这里插入图片描述

cglib代理:基于父类的动态代理技术
在这里插入图片描述

AOP相关概念

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

实现:

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

  1. 加入依赖
		<!--引入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>
  1. 创建目标接口和目标类(内部有切点)

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

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

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

  5. 在配置文件中开启组件扫描和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中可以看到接口的请求次数。
在这里插入图片描述

Web最终效果图如下:效果图

@Component
public class RedisUtils {
    private static final Logger log = LoggerFactory.getLogger(RedisUtils.class);


    @Resource
    private StringRedisTemplate stringRedisTemplate;

    private static StringRedisTemplate staticStringRedisTemplate;

    @PostConstruct
    public void setStringRedisTemplate() {
        staticStringRedisTemplate = stringRedisTemplate;
    }


    /**
     * 设置缓存
     *
     * @param key
     * @param value
     */
    public static void setRedisCache(String key, String value) {
        staticStringRedisTemplate.opsForValue().set(key, value);
    }


    /**
     * 获得用户id
     *
     * @param token
     * @return
     */
    public static Integer getCurrentUserId(String token) {
        //从redis中取出当前用户对象id
        return Integer.valueOf(getCurrentUserAttr(token, "id"));
    }

    /**
     * 获得redis中用户的某个属性
     *
     * @param token
     * @param attr
     * @return
     */
    public static String getCurrentUserAttr(String token, String attr) {
        //从redis中取出当前用户对象的某个属性
        return getUserRedis(token).get(attr).toString();
    }

    /**
     * 获得redis中用户Map
     *
     * @param token
     * @return
     */
    public static JSONObject getUserRedis(String token) {
        //从redis中取出当前用户对象
        JSONObject user = objFromRedis(token);
        if (user == null) {
            throw new ServiceException(Constants.CODE_999, "token验证失败,请重新登录");
        }
        return user;
    }

    /**
     * 将redis中的单个对象(例如User)存入redis并设置时长(S)
     */
    public static void objToRedis(String key, Object obj, Integer TIMEOUT) {
        staticStringRedisTemplate.opsForValue().set(key, new JSONObject(obj).toString());
        staticStringRedisTemplate.expire(key, TIMEOUT, TimeUnit.SECONDS);
    }

    /**
     * 获得redis中的单个对象(例如User),将其还原为json对象格式返回
     */
    public static JSONObject objFromRedis(String key) {
        //从redis中取出单个对象的json字符串缓存,还原为json对象返回
        String obj = staticStringRedisTemplate.opsForValue().get(key);
        if (obj == null) {
            return null;
        }
        return new JSONObject(obj);
    }

    /**
     * 将List[jsonObjectString]存入redis并设置时长(S)
     */
    public static void listToRedis(String key, List<JSONObject> jsonList, Integer TIMEOUT) {
        if (Boolean.TRUE.equals(staticStringRedisTemplate.hasKey(key))) { // 如果有这个键存在
            staticStringRedisTemplate.opsForList().trim(key, 0, 0);// 进行裁剪清空
        }
        for (JSONObject obj : jsonList) {// 遍历列表将元素向右压入redis原List队列
            staticStringRedisTemplate.opsForList().rightPush(key, obj.toString());
        }
        staticStringRedisTemplate.expire(key, TIMEOUT, TimeUnit.SECONDS);
    }

    /**
     * 获得redis中的一组List缓存对象(取出的为List<String>)
     */
    public static List<String> listFromRedis(String key) {
        //从redis中取出对应Map缓存
        return staticStringRedisTemplate.opsForList().range(key, 0, -1);
    }

    /**
     * 将 List<jsonString> 列表 还原为 List<JSONObject>
     */
    public static List<JSONObject> jsonListFromList(List<String> strList) {
        //从redis中取出的List为 List<String>,将列表中的值还原为 json对象列表 返回
        List<JSONObject> resultList = new ArrayList<>();
        for (String obj : strList) {
            resultList.add(new JSONObject(obj));
        }
        return resultList;
    }

    /**
     * 将Map<唯一标识字符串, 对象转json对象再转字符串>存入redis并设置时长(S)
     */
    public static void mapToRedis(String key, Map<Object, Object> mapObject, Integer TIMEOUT) {
        staticStringRedisTemplate.opsForHash().putAll(key, mapObject);
        staticStringRedisTemplate.expire(key, TIMEOUT, TimeUnit.SECONDS);
    }

    /**
     * 获得redis中的一组Map缓存对象(例如Tags)
     */
    public static Map<Object, Object> mapFromRedis(String key) {
        //从redis中取出对应Map缓存
        return staticStringRedisTemplate.opsForHash().entries(key);
    }

    /**
     * 将从redis取出的Map<Object, Object>对象还原成 JSONObject
     */
    public static JSONObject jsonFromMap(Map<Object, Object> mapObject) {
        //从redis中取出的Map为 Map<Object, Object>,将其还原成  JSONObject 字符串返回
        JSONObject resultJson = new JSONObject();
        for (Object key : mapObject.keySet()) {
            resultJson.set((String) key, new JSONObject(mapObject.get(key)));
        }
        return resultJson;
    }

    /**
     * 将从redis取出的Map<Object, Object>对象转换成 json对象列表
     */
    public static List<JSONObject> jsonListFromMap(Map<Object, Object> mapObject) {
        //从redis中取出的Map为 Map<Object, Object>,将所有数据项的值放入 json列表 返回
        List<JSONObject> resultList = new ArrayList<>();
        for (Object key : mapObject.keySet()) {
            resultList.add(new JSONObject(mapObject.get(key)));
        }
        return resultList;
    }
}
  • 4
    点赞
  • 29
    收藏
    觉得还不错? 一键收藏
  • 6
    评论
评论 6
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值