Download the PHP package pudongping/hyperf-throttle-requests without Composer

On this page you can find all versions of the php package pudongping/hyperf-throttle-requests. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of pudongping/hyperf-throttle-requests

Informations about the package hyperf-throttle-requests

hyperf-throttle-requests

适配 hyperf 框架的请求频率限流器。功能类似于 laravel 框架的 throttle 中间件。

运行环境

分支或者标签

分支

标签

安装

配置

发布配置

在你自己的项目根目录下，执行以下命令

配置说明

配置 默认值 说明
storage Pudongping\HyperfThrottleRequests\Storage\RedisStorage::class 数据存储驱动
maxAttempts 60 在指定时间内允许的最大请求次数
decaySeconds 60 单位时间（单位：s）
prefix '' 计数器 key 前缀，不填时，默认为：throttle:
key '' 具体的计数器的 key （一般只有在某些特定场景下才会使用，比如假设访问多个不同的路由时，均累加一个计数器）
generateKeyCallable [] 生成计数器 key 的方法（默认以当前请求路径加当前客户端 IP 地址作为 key）
tooManyAttemptsCallback [] 当触发到最大请求次数时的回调方法（默认会抛出 Pudongping\HyperfThrottleRequests\Exception\ThrottleRequestsException 异常）

使用

该组件提供了以下 3 种调用方式：

第一种：使用注解 Pudongping\HyperfThrottleRequests\Annotation\ThrottleRequests

该组件提供 Pudongping\HyperfThrottleRequests\Annotation\ThrottleRequests 注解，作用于类、类方法。
配置作用优先级为：类方法上的注解配置 > 类上的注解配置 > config/autoload/hyperf-throttle-requests.php > 注解默认配置

注意：只有使用注解调用时，才会使用 config/autoload/hyperf-throttle-requests.php 配置文件中的配置项。

使用注解 Pudongping\HyperfThrottleRequests\Annotation\ThrottleRequests 作用于类上，示例：

当提供 key 参数，且 key 参数的值为一个标量（不会变化的值）时，则该限流器同时作用于含有等值 key 上。举个例子来说：在以下代码中 Pudongping\HyperfThrottleRequests\Annotation\ThrottleRequests 注解作用于类上，也就意味着当访问 /throttle-requests/t1 路由 和 /throttle-requests/t2 路由时，共享相同的配置信息，由于此时的 key 参数的值为一个标量，也就意味着此时的现象是：在 15 秒内，当访问 /throttle-requests/t1 路由和 /throttle-requests/t2 路由时，总共只允许访问 5 次。

使用注解 Pudongping\HyperfThrottleRequests\Annotation\ThrottleRequests 作用于类方法上，示例：

以下示例代码和以上示例代码，均为同样的效果。

第二种：使用 throttle_requests(string $rateLimits = '30,60', string $prefix = '', string $key = '', mixed $generateKeyCallable = [], mixed $tooManyAttemptsCallback = []) 助手函数

第三种：直接调用 Pudongping\HyperfThrottleRequests\Handler\ThrottleRequestsHandler@handle() 方法

关于计数器的 key

本质上，当传入的 key 参数不为空字符串时，则以传入的 key 为主。当 key 为空字符串，但是 generateKeyCallable 为一个可调用的回调函数时， 则以回调函数的返回值作为计数器的 key。否则默认为 sha1(当前路由地址路径 . '|' . 当前客户端 IP 地址) 作为 key。

其实质来说，generateKeyCallable 回调函数就是去生成 key 参数的值，这是为了方便使用者根据自己的需求动态的去生成计数器的键名。比如说：可能 当用户登录之后，会加上 user_id 作为计数器的 key。

使用自定义 key 示例：

App\Controller\ThrottleRequestsController.php 文件中

触发访问频率限制

当限流被触发时，默认会抛出 Pudongping\HyperfThrottleRequests\Exception\ThrottleRequestsException 异常，可以通过捕获异常 或者配置 tooManyAttemptsCallback 限流回调处理。例如：

App\Controller\ThrottleRequestsController.php 文件中

App\Helper\ThrottleRequestsHelper.php 文件中

All versions of hyperf-throttle-requests with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
psr/container Version ^1.0|^2.0
hyperf/redis Version ~3.1.0
nesbot/carbon Version ^2.0
psr/http-message Version ^1.0|^2.0
hyperf/http-server Version ~3.1.0
hyperf/di Version ~3.1.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package pudongping/hyperf-throttle-requests contains the following files

Loading the files please wait ....