您当前的位置:首页 > 电脑百科 > 程序开发 > 框架

SpringBoot中如何实现限流,这种方式才叫优雅!

时间:2023-03-24 11:25:26  来源:微信公众号  作者:JAVA日知录

很早以前,我曾写过两篇介绍如何在SpringBoot中使用Guava和redis实现接口限流的文章。具体包括:

  1. 使用Guava实现单机令牌桶限流
  2. 使用Redis实现分布式限流

现在,一个问题摆在我们面前:如何将这两种限流机制整合到同一个组件中,以便用户随时切换呢?

显然,我们需要定义一个通用的限流组件,将其引入到业务中,并支持通过配置文件自由切换不同的限流机制。举例而言,当使用limit.type=redis时,启用Redis分布式限流组件,当使用limit.type=local时,启用Guava限流组件。这种自由切换机制能够为用户提供更大的灵活性和可维护性。

接下来,让我们开始动手实现吧!

第一步,创建通用模块cloud-limiter-starter

首先在父项目下创建一个模块

图片

然后在pom文件中引入相关依赖

<dependencies>
  <dependency>
    <groupId>com.google.guava</groupId>
    <artifactId>guava</artifactId>
  </dependency>
  <!--SpringFramework-->
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <scope>provided</scope>
  </dependency>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
    <scope>provided</scope>
  </dependency>
  <dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <scope>provided</scope>
  </dependency>
  <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-aspects</artifactId>
    <scope>provided</scope>
  </dependency>

</dependencies>

小提示:通用模块命名最好遵照规则以starter命名结束,同时通用模块引入的依赖最好设置<scope>provided</scope>属性。

第二步,实现限流功能

  1. 创建限流接口

既然有两种限流机制,按照套路肯定得先创建一个限流接口,就叫LimiterManager吧。

public interface LimiterManager {
    boolean tryAccess(Limiter limiter);
}
  1. 分别实现Redis的限流功能和Guava的限流功能,这里只给出核心代码。

Guava限流的核心实现GuavaLimiter

@Slf4j
public class GuavaLimiter implements LimiterManager{
    private final Map<String, RateLimiter> limiterMap = Maps.newConcurrentMap();

    @Override
    public boolean tryAccess(Limiter limiter) {
        RateLimiter rateLimiter = getRateLimiter(limiter);
        if (rateLimiter == null) {
            return false;
        }

        boolean access = rateLimiter.tryAcquire(1,100, TimeUnit.MILLISECONDS);

        log.info("{} access :{}",limiter.getKey() , access);

        return access;
    }
}

Redis限流的核心实现RedisLimiter

@Slf4j
public class RedisLimiter implements LimiterManager{

    private final StringRedisTemplate stringRedisTemplate;

    public RedisLimiter(StringRedisTemplate stringRedisTemplate) {
        this.stringRedisTemplate = stringRedisTemplate;
    }

    @Override
    public boolean tryAccess(Limiter limiter) {

        String key = limiter.getKey();
        if (StringUtils.isEmpty(key)) {
            throw new LimiterException( "redis limiter key cannot be null" );
        }

        List<String> keys = new ArrayList<>();
        keys.add( key );

        int seconds = limiter.getSeconds();
        int limitCount = limiter.getLimitNum();

        String luaScript = buildLuaScript();

        RedisScript<Long> redisScript = new DefaultRedisScript<>(luaScript, Long.class);

        Long count = stringRedisTemplate.execute( redisScript, keys, "" + limitCount, "" + seconds );

        log.info( "Access try count is {} for key={}", count, key );

        return count != null && count != 0;
    }
}

第三步,创建配置类

编写配置类根据配置文件注入限流实现类,当配置文件中属性 limit.type=local 时启用Guava限流机制,当limit.type=redis 时启用Redis限流机制。

@Configuration
public class LimiterConfigure {

    @Bean
    @ConditionalOnProperty(name = "limit.type",havingValue = "local")
    public LimiterManager guavaLimiter(){
        return new GuavaLimiter();
    }


    @Bean
    @ConditionalOnProperty(name = "limit.type",havingValue = "redis")
    public LimiterManager redisLimiter(StringRedisTemplate stringRedisTemplate){
        return new RedisLimiter(stringRedisTemplate);
    }
}

第四步,创建AOP

根据前面的两篇文章可知,避免限流功能污染业务逻辑的最好方式是借助Spring AOP,所以很显然还得需要创建一个AOP。

@Aspect
@EnableAspectJAutoProxy(proxyTargetClass = true) //使用CGLIB代理
@Conditional(LimitAspectCondition.class)
public class LimitAspect {

    @Setter(onMethod_ = @Autowired)
    private LimiterManager limiterManager;

    @Pointcut("@annotation(com.jianzh5.limit.aop.Limit)")
    private void check() {

    }

    @Before("check()")
    public void before(JoinPoint joinPoint){
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();

        Limit limit = method.getAnnotation(Limit.class);
        if(limit != null){

            Limiter limiter = Limiter.builder().limitNum(limit.limitNum())
                    .seconds(limit.seconds())
                    .key(limit.key()).build();

            if(!limiterManager.tryAccess(limiter)){
                throw new LimiterException( "There are currently many people , please try again later!" );
            }
        }
    }
}

注意到类上我加了一行@Conditional(LimitAspectCondition.class),使用了自定义条件选择器,意思是只有当配置类中出现了limit.type属性时才会加载这个AOP。

public class LimitAspectCondition implements Condition {
    @Override
    public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
        //检查配置文件是否包含limit.type属性
        return conditionContext.getEnvironment().containsProperty(ConfigConstant.LIMIT_TYPE);
    }
}

第四步,创建spring.factories文件,引导SpringBoot加载配置类

## AutoConfiguration
org.springframework.boot.autoconfigure.EnableAutoCnotallow=
  com.jianzh5.limit.config.LimiterConfigure,
  com.jianzh5.limit.aop.LimitAspect

完整目录结构如下:

图片

 

第五步,在项目中引用限流组件

  1. 引入依赖
<dependency>
    <groupId>com.jianzh5</groupId>
    <artifactId>cloud-limit-starter</artifactId>
</dependency>
  1. Application.properties中设置加载的限流组件
limit.type = redis

如果不配置此属性则不加载对应限流功能。

  1. 在需要限流的接口上加上注解
@Limit(key = "Limiter:test",limitNum = 3,seconds = 1)

小结

通过上述步骤,我们已经成功实现了一个通用限流组件。在实际应用中,只需要根据场景需求选择对应的限流机制,即可非常方便的进行限流操作。这种灵活性和便捷性,也是SpringBoot中定义Starter的一般套路。

如果你想详细了解这两种限流机制的原理,可以参考之前的文章中所介绍的内容。



Tags:SpringBoot   点击:()  评论:()
声明:本站部分内容及图片来自互联网,转载是出于传递更多信息之目的,内容观点仅代表作者本人,如有任何标注错误或版权侵犯请与我们联系(Email:2595517585@qq.com),我们将及时更正、删除,谢谢。
▌相关推荐
很早以前,我曾写过两篇介绍如何在SpringBoot中使用Guava和Redis实现接口限流的文章。具体包括: 使用Guava实现单机令牌桶限流 使用Redis实现分布式限流现在,一个问题摆在我们面...【详细内容】
2023-03-24  Tags: SpringBoot  点击:(0)  评论:(0)  加入收藏
Spring MVC自动配置Spring Boot为Spring MVC提供了自动配置,可以在大多数应用程序中很好地工作。自动配置在Spring默认的基础上添加了以下特性: 包含ContentNegotiatingViewR...【详细内容】
2023-03-23  Tags: SpringBoot  点击:(3)  评论:(0)  加入收藏
今天了不起带大家研究了一个 SpringBoot​ 的外部化配置,并且通过实际的一个 case 跟踪代码的调用链来给大家测试了一下,虽然说这个知识点我们经常都在使用,但是没看到底层源码...【详细内容】
2023-03-20  Tags: SpringBoot  点击:(9)  评论:(0)  加入收藏
前言每次启动SpringBoot项目时,总是能看到控制台打印了一串字符,隐约能辨认出是“Spring”,不知大家是否也好奇过是怎么实现的,是直接打印固定的字符串,还是根据什么算法去生成...【详细内容】
2023-03-13  Tags: SpringBoot  点击:(12)  评论:(0)  加入收藏
Spring Boot 是一个基于 Spring 框架的快速开发框架,而 RabbitMQ 和 RocketMQ 则是常用的消息队列中间件。下面是它们常用的一些用法和场景。 订单处理在电商等系统中,下单后...【详细内容】
2023-03-09  Tags: SpringBoot  点击:(18)  评论:(0)  加入收藏
在分布式系统中,接口幂等性是一个非常重要的概念,它保证了在同样的条件下,同一请求的多次执行所产生的效果都是相同的。在实际开发中,为了防止重复提交或者重复操作带来的问题,我...【详细内容】
2023-03-07  Tags: SpringBoot  点击:(28)  评论:(0)  加入收藏
一、前言小编最近一直在研究关于分库分表的东西,前几天docker安装了mycat实现了分库分表,但是都在说mycat的bug很多。很多人还是倾向于shardingsphere,其实他是一个全家桶,有JDB...【详细内容】
2023-03-05  Tags: SpringBoot  点击:(24)  评论:(0)  加入收藏
在Spring Boot中实现接口数据的加密和解密,可以使用对称加密算法,例如AES算法,将请求参数和响应结果进行加密和解密。以下是一种示例实现方案: 添加依赖在pom.xml文件中添加以...【详细内容】
2023-03-03  Tags: SpringBoot  点击:(9)  评论:(0)  加入收藏
如果使用@ConditionalOnClass或@ConditionalOnMissingClass作为元注释的一部分来组合自己的组合注释,则必须使用name,因为在这种情况下引用类不会被处理。理解自动配置bean在...【详细内容】
2023-03-02  Tags: SpringBoot  点击:(16)  评论:(0)  加入收藏
一、前言Springboot的自动配置原理,面试中经常问到,一直看也记不住,不如手写一个starter,加深一下记忆。 看了之后发现大部分的starter都是这个原理,实践才会记忆深刻。核心思想:...【详细内容】
2023-02-27  Tags: SpringBoot  点击:(26)  评论:(0)  加入收藏
▌简易百科推荐
很早以前,我曾写过两篇介绍如何在SpringBoot中使用Guava和Redis实现接口限流的文章。具体包括: 使用Guava实现单机令牌桶限流 使用Redis实现分布式限流现在,一个问题摆在我们面...【详细内容】
2023-03-24  JAVA日知录  微信公众号  Tags:SpringBoot   点击:(0)  评论:(0)  加入收藏
Spring MVC自动配置Spring Boot为Spring MVC提供了自动配置,可以在大多数应用程序中很好地工作。自动配置在Spring默认的基础上添加了以下特性: 包含ContentNegotiatingViewR...【详细内容】
2023-03-23  Springboot实战案例锦集    Tags:SpringBoot   点击:(3)  评论:(0)  加入收藏
译者 | 李睿审校 | 孙淑娟 ​如果用户想在公共云基础设施上运行Java微服务,那么可以利用多个云区域。这是一个好主意,其中有几个原因。​首先,由于硬件问题、云服务升级后引入...【详细内容】
2023-03-21   李睿  51CTO  Tags:Spring Cloud   点击:(9)  评论:(0)  加入收藏
今天了不起带大家研究了一个 SpringBoot​ 的外部化配置,并且通过实际的一个 case 跟踪代码的调用链来给大家测试了一下,虽然说这个知识点我们经常都在使用,但是没看到底层源码...【详细内容】
2023-03-20  Java极客技术  微信公众号  Tags:SpringBoot   点击:(9)  评论:(0)  加入收藏
2023-03-20  YourBatman  微信公众号  Tags:Spring Boot   点击:(12)  评论:(0)  加入收藏
1.概览HummerRisk 是开源的云原生安全平台,以非侵入的方式解决云原生环境的安全和治理问题。核心能力包括混合云的安全治理和容器云安全检测。本文将介绍如何使用HummerRisk...【详细内容】
2023-03-20  HummerCloud  今日头条  Tags:HummerRisk   点击:(6)  评论:(0)  加入收藏
之前写过关于 Apache Pulsar 的简单示例,用来了解如何使用 Pulsar 这个新生代的消息队列中间件,但是如果想要在项目中使用,还会欠缺很多,最明显的就是 集成复杂,如果你用过其他消...【详细内容】
2023-03-17  java易  今日头条  Tags:spring boot   点击:(2)  评论:(0)  加入收藏
无人驾驶系统的核心可以概述为三个部分:感知(Perception),规划(Planning)和控制(Control),这些部分的交互以及其与车辆硬件、其他车辆的交互可以用下图表示: 感知是指无人驾驶系统从...【详细内容】
2023-03-15    智驾最前沿  Tags:   点击:(8)  评论:(0)  加入收藏
大家好,我是Echa。好消息,Astro 官网Blog 中 Fred Schott 大佬发文公布了 Web 框架性能报告清单,如何让前端开发者们更好的选择前端框架,以及相关性能和在Web 上整体运作流程...【详细内容】
2023-03-14  Echa  今日头条  Tags:框架   点击:(20)  评论:(0)  加入收藏
本报告的目的是通过真实的数据来更好地了解框架选择、性能和实际用户体验之间的关系。我们将试图回答以下几个关键问题: 现代Web框架在实际使用和性能方面如何比较? 框架选择...【详细内容】
2023-03-14  大迁世界  微信公众号  Tags:框架   点击:(8)  评论:(0)  加入收藏
站内最新
站内热门
站内头条