zyyzyykk/ip-restrictions-boot-starter

Ip-restrictions-boot-starter is a Maven dependency package based on SpringBoot, which can restrict and intercept requests for specific methods and IPs. ip-restrictions-boot-starter，一个基于SpringBoot框架的maven依赖包，能够对特定方法、特定IP的请求进行限制与拦截。

ip-restrictions-boot-starter

ip-restrictions-boot-starter，一个基于SpringBoot框架的maven依赖包，能够对特定方法、特定IP的请求进行限制与拦截。

Ip-restrictions-boot-starter is a Maven dependency package based on SpringBoot, which can restrict and intercept requests for specific methods and IPs.

作者：zyyzyykk

源代码：https://github.com/zyyzyykk/ip-restrictions-boot-starter

maven仓库地址：https://mvnrepository.com/artifact/com.kkbapps/ip-restrictions-boot-starter

更新时间：2024-02-27

简体中文 ｜ English

💪 使用

1.在Springboot项目中引入依赖：

<!-- https://mvnrepository.com/artifact/com.kkbapps/ip-restrictions-boot-starter -->
<dependency>
    <groupId>com.kkbapps</groupId>
    <artifactId>ip-restrictions-boot-starter</artifactId>
    <!-- 建议引入最新RELEASE版本 -->
    <version>1.1.4-RELEASE</version>
</dependency>

2.在需要请求限制的方法上添加 @EnableIPLimit 注解

@EnableIPLimit(count = 100, interval = 1000)
public String needIPLimit(String param) {

• 注解参数说明：
  • count：监控周期内同一IP最大访问次数
  • interval：监控周期内同一IP两次访问最小间隔时间（毫秒）
  • 若不添加注解参数，则配置取决于 application.properties 中的自定义配置以及默认值

3.在 application.properties 中可进行自定义配置属性：

# 相关配置以kkbapps.ip开头，其他配置见提示
kkbapps.ip.forbid-ip=true	# 是否封禁超出限制的ip，默认监控周期内有效

4.配置ip黑白名单：1.1.2及以上版本

• .properties 文件中配置：

  # 配置ip黑名单
  kkbapps.ip.ip-black-list[0]=192.168.42.1
  kkbapps.ip.ip-black-list[1]=192.168.42.2

• .yml 文件中配置：

  # 配置ip黑名单
  kkbapps:
    ip:
      ip-black-list:
        - 192.168.42.1
        - 192.168.42.2

5.获取ip请求信息：1.1.3及以上版本

@EnableIPLimit(count = 100, interval = 1000)
public String needIPLimit() {
    // 获取ip请求信息
    IpRequestInfo ipRequestInfo = IPContext.get();
    // 请求ip: 192.168.42.1
    System.out.println(ipRequestInfo.getIp());
    // ip周期内访问次数: 5
    System.out.println(ipRequestInfo.getCount());
    // ip最近访问时间: Mon Dec 11 19:27:39 CST 2023
    System.out.println(ipRequestInfo.getLastDate());
}

💡 说明

1.ip-restrictions-boot-starter 是一个基于SpringBoot框架的maven依赖包，能够对特定方法、特定IP的请求进行限制与拦截

2.拦截采用AOP实现，@EnableIPLimit 注解建议添加在 Controller 层的方法上

3.当请求超出设定的限制，会抛出 IpRequestErrorException 异常，可对此异常进行自定义捕获

👨‍💻 更新记录

1.1.4-RELEASE：latest

在AOP类中添加 @Order(1) 注解，确保拦截为最外层

1.1.3-RELEASE：

新增在添加有 @EnableIPLimit 注解的方法中获取本次ip请求信息

1.1.2-RELEASE：

新增ip黑白名单配置：黑名单ip直接拒绝请求，白名单ip直接放行

历史更新记录

🏘️ 关于此项目

作者：zyyzyykk

欢迎对此项目提出宝贵的意见或建议，也可以加入我们一起进行此项目的维护与开发