A
📖 Wiki
中

为了防止接口被恶意调用,设计API秘钥方式提升接口安全性,并通过滑动窗口粗实现接口调用限流。

🏅 项目难点&亮点 12 min read 84 views Updated 2026-09-30 Chinese only

导读

关于「为了防止接口被恶意调用,设计API秘钥方式提升接口安全性,并通过滑动窗口粗实现接口调用限流。」,这里按「结论 → 原理 → 追问」的顺序梳理,方便随时查阅。

背景

在一个典型的业务场景中,我们提供了一个API ,被用来允许外部或内部客户端调用。这些 API 可能会暴露敏感数据或业务逻辑,因此需要确保只有授权的用户才能访问。同时,为了防止系统过载,需要对 API 调用进行限制。

技术选型

  1. API 认证:使用 API 密钥或 OAuth 令牌。
  2. API 限流:使用滑动窗口算法实现限流。
  3. 限流存储:使用 Redis 作为存储和计算滑动窗口的工具。

具体实现

API 认证
  1. 生成 API 密钥:为每个用户生成唯一的 API 密钥。当用户创建账户时,后端生成密钥并提供给用户。
  2. 客户端请求:客户端在发起请求时需在 HTTP 头部附带 API 密钥。
  3. 服务器端验证:服务器接收到请求后,提取并验证 API 密钥。如果密钥无效或缺失,请求将被拒绝。
import org.springframework.stereotype.Component;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@Component
public class ApiKeyAuthenticationFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        HttpServletResponse httpResponse = (HttpServletResponse) response;

        String apiKey = httpRequest.getHeader("X-API-KEY");
        if (!isValidApiKey(apiKey)) {
            httpResponse.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
            httpResponse.getWriter().write("Unauthorized");
            return;
        }
        chain.doFilter(request, response);
    }

    private boolean isValidApiKey(String apiKey) {
        // 实现 API 密钥的验证逻辑
        return true;
    }
}

API 限流
  1. 滑动窗口算法:使用 Redis 来存储和计算每个用户的请求计数。
  2. 请求计数:每个请求到达时,使用 Redis 记录该请求的时间戳。
  3. 窗口计算:检查当前时间窗口内的请求数量,如果超过阈值,则拒绝请求。
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.time.Instant;
import java.util.List;
import java.util.concurrent.TimeUnit;

@Component
public class RateLimitingFilter implements Filter {

    @Autowired
    SlidingWindowRateLimiter limiter;

    private final RedisTemplate<String, String> redisTemplate;
    private static final int LIMIT = 100; // 设置每分钟的请求限制
    private static final int WINDOW_SIZE_IN_SECONDS = 60; // 时间窗口大小

    public RateLimitingFilter(RedisTemplate<String, String> redisTemplate) {
        this.redisTemplate = redisTemplate;
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        HttpServletResponse httpResponse = (HttpServletResponse) response;

        String apiKey = httpRequest.getHeader("X-API-KEY");
        String key = "rate_limit:" + apiKey;
        long currentTime = Instant.now().getEpochSecond();
        long windowStart = currentTime - WINDOW_SIZE_IN_SECONDS;

        boolean result = limiter.allowRequest(key);

        if (result) {
            httpResponse.setStatus(HttpServletResponse.SC_TOO_MANY_REQUESTS);
            httpResponse.getWriter().write("Too Many Requests");
            return;
        }

        chain.doFilter(request, response);
    }
}

这里面的SlidingWindowRateLimiter实现如下:

import redis.clients.jedis.Jedis;

public class SlidingWindowRateLimiter {
    private Jedis jedis;
    private String key;
    private int limit;

    public SlidingWindowRateLimiter(Jedis jedis, String key, int limit) {
        this.jedis = jedis;
        this.key = key;
        this.limit = limit;
    }

    public boolean allowRequest(String key) {
        // 当前时间戳
        long currentTime = System.currentTimeMillis();

        // 使用Lua脚本来确保原子性操作
        String luaScript = "local window_start = ARGV[1] - 60000\n" +
                           "redis.call('ZREMRANGEBYSCORE', KEYS[1], '-inf', window_start)\n" +
                           "local current_requests = redis.call('ZCARD', KEYS[1])\n" +
                           "if current_requests < tonumber(ARGV[2]) then\n" +
                           "    redis.call('ZADD', KEYS[1], ARGV[1], ARGV[1])\n" +
                           "    return 1\n" +
                           "else\n" +
                           "    return 0\n" +
                           "end";

        Object result = jedis.eval(luaScript, 1, key, String.valueOf(currentTime), String.valueOf(limit));

        return (Long) result == 1;
    }
}

其他安全和性能考虑

  • API 密钥安全性:确保 API 密钥通过安全的方式传输(例如 HTTPS)。
  • 密钥旋转和管理:提供机制允许用户定期更换 API 密钥。
  • 错误处理和日志:合理记录错误和请求日志,以便于问题追踪和分析。

通过这种结合了 API 密钥认证和滑动窗口限流的策略,可以有效提高 API 的安全性和稳定性,防止滥用和系统过载,同时保证合法用户的正常访问。

学习资料

由站内小编编辑整理

Related

基于TTL 解决线程池中 ThreadLocal 线程无法共享的问题
在基于Java的应用开发中,尤其是在使用Spring框架、异步处理和微服务架构的系统中,经常需要在不同线程或服务间传递用户会话、数据库事务或其他上下文信息
基于Redis的zset实现秒级排行榜
假设我们有一个在线游戏平台,需要为每个游戏的玩家实现排行榜功能,以显示每个游戏的最高得分排名
使用自定义注解+切面减少冗余代码,提升代码的鲁棒性
不知道大家有没有遇到过类似的诉求,就是希望在一个方法的入口处或者出口处做统一的日志处理,比如记录一下入参、出参、记录下方法执行的时间等
通过热点数据预热、多级缓存、异步化编程等方式解决热门数据接口耗时长问题
在很多大型网站中,某些数据(比如热门文章、热点商品详情等)可能会成为热点,经常被大量用户请求
基于Spring Event,实现同步转异步,解决定时任务扫表导致数据库连接池不够的问题
有这样一个业务场景,作为一个金融产品,很多用户会在借款后发生逾期,每一笔逾期都是一笔单独的借据,在贷后催收环节中,需要基于用户维度做聚合,把多笔借据合并成一个案件进行统一的催…
通过采用“一锁二判三更新”方式设计接口幂等,解决支付单重复支付的问题
负责了一个支付相关的功能,因为我们的支付渠道有很多,有的时候用户在选择某一个支付渠道支付(如微信)之后一直处理中,然后用户又换了一个其他的支付渠道(如支付宝)来支付。但是后面…