first commit

Author: chenpkg

.editorconfig

@@ -0,0 +1,20 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = false
+
+[*.{vue,js,scss}]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitattributes

@@ -0,0 +1,11 @@
+* text=auto
+
+/tests export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+.scrutinizer.yml export-ignore
+.travis.yml export-ignore
+phpunit.php export-ignore
+phpunit.xml.dist export-ignore
+phpunit.xml export-ignore
+.php_cs export-ignore

.gitignore

@@ -0,0 +1,8 @@
+.idea
+*.DS_Store
+/vendor
+/coverage
+sftp-config.json
+composer.lock
+.subsplit
+.php_cs.cache

README.md

@@ -0,0 +1,76 @@
+<h1 align="left"> Idempotent </h1>
+
+<p align="left"> laravel 幂等中间件，防止同一时间多次请求。</p>
+
+## Requirement
+
+1. PHP >= 7.0 | PHP >= 8.0
+2. laravel >= 6
+
+## Installation
+
+```shell
+$ composer require chenpkg/idempotent
+```
+
+## Usage
+
+发布配置文件
+
+```
+$ php artisan vendor:publish --tag="laravel-idempotent"
+```
+
+中间件为 `Chenpkg\Idempotent\IdempotentMiddleware`，别名 `idempotent`
+
+```php
+Route::group(['middleware' => 'idempotent'], function () {
+    //...
+});
+```
+
+或者你可以将它加入到指定路由中间件组中
+
+```php
+protected $middlewareGroups = [
+    // ...
+    'api' => [
+        'idempotent',
+        'throttle:api',
+        \Illuminate\Routing\Middleware\SubstituteBindings::class,
+    ],
+];
+```
+
+重复的请求将会抛出 `Chenpkg\Idempotent\Exceptions\RepeatRequestException` `Http` 异常
+
+## Configure
+
+
+```php
+// config/idempotent.php
+
+return [
+    // true 自动获取唯一key, false 前端提供
+    'forcible' => true,
+
+    // 需要过滤重复请求的请求类型
+    'methods' => ['POST', 'PUT', 'PATCH'],
+
+    // 缓存有效时间/秒，防止死锁
+    'seconds' => 10,
+
+    // 获取当前用户
+    'resolve_user' => function (\Illuminate\Http\Request $request) {
+        return auth()->user();
+    },
+
+    // 前端提供 key 请求头名称.
+    'header_name' => 'Idempotent-Key',
+];
+```
+
+
+## License
+
+MIT

composer.json

@@ -0,0 +1,27 @@
+{
+    "name": "chenpkg\/idempotent",
+    "description": "laravel idempotent middleware",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "cestbon",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "php": "^7.0|^8.0",
+        "laravel/framework": "^6.0|^7.0|^8.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Chenpkg\\Idempotent\\": "src"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Chenpkg\\Idempotent\\IdempotentServiceProvider"
+            ]
+        }
+    }
+}

config/idempotent.php

@@ -0,0 +1,20 @@
+<?php
+
+return [
+    // true 自动获取唯一key, false 前端提供
+    'forcible' => true,
+
+    // 需要过滤重复请求的请求类型
+    'methods' => ['POST', 'PUT', 'PATCH'],
+
+    // 缓存有效时间/秒，防止死锁
+    'seconds' => 10,
+
+    // 获取当前用户
+    'resolve_user' => function (\Illuminate\Http\Request $request) {
+        return auth()->user();
+    },
+
+    // 前端提供 key 请求头名称.
+    'header_name' => 'Idempotent-Key',
+];

src/Exceptions/RepeatRequestException.php

@@ -0,0 +1,18 @@
+<?php
+/**
+ * Created by Cestbon.
+ * Author Cestbon <[email protected]>
+ * Date 2021-08-23 11:43
+ */
+
+namespace Chenpkg\Idempotent\Exceptions;
+
+use Symfony\Component\HttpKernel\Exception\HttpException;
+
+class RepeatRequestException extends HttpException
+{
+    public function __construct($message = null)
+    {
+        parent::__construct(423, $message);
+    }
+}

src/IdempotentMiddleware.php

@@ -0,0 +1,117 @@
+<?php
+/**
+ * Created by Cestbon.
+ * Author Cestbon <[email protected]>
+ * Date 2021-08-20 15:45
+ */
+
+namespace Chenpkg\Idempotent;
+
+use Chenpkg\Idempotent\Exceptions\RepeatRequestException;
+use Closure;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Cache;
+
+class IdempotentMiddleware
+{
+    protected $config;
+
+    const PLACE_HOLDER = 'idempotent_place_holder';
+
+    public function handle(Request $request, Closure $next)
+    {
+        $this->config = config('idempotent');
+
+        if (! in_array($request->method(), $this->config['methods'])) {
+            return $next($request);
+        }
+
+        $idempotentKey = $this->getIdempotentKey();
+
+        if (! $idempotentKey) {
+            return $next($request);
+        }
+
+        $this->repeated($idempotentKey);
+
+        return $next($request);
+    }
+
+    /**
+     * @param $request
+     * @param $response
+     */
+    public function terminate($request, $response)
+    {
+        Cache::forget($this->getCacheKey($request->header($this->config['header_name'])));
+    }
+
+    /**
+     * @param $key
+     * @return string
+     */
+    protected function getCacheKey($key)
+    {
+        return 'idempotent_key:'.$key;
+    }
+
+    /**
+     * @param $idempotentKey
+     * @return true
+     * @throws RepeatRequestException
+     */
+    protected function repeated($idempotentKey)
+    {
+        $value = Cache::get($this->getCacheKey($idempotentKey));
+
+        if ($value == static::PLACE_HOLDER) {
+            throw new RepeatRequestException('Your request is still being processed.');
+        }
+
+        $seconds = (int)$this->config['seconds'];
+        $seconds = $seconds > 0 ? $seconds : null;
+
+        Cache::put($this->getCacheKey($idempotentKey), static::PLACE_HOLDER, $seconds);
+
+        return true;
+    }
+
+    /**
+     * @return array|string|null
+     */
+    protected function getIdempotentKey()
+    {
+        return $this->config['forcible'] ? $this->generateIdempotentKey() : request()->header($this->config['header_name']);
+    }
+
+    /**
+     * @return string
+     */
+    protected function generateIdempotentKey()
+    {
+        $user = $this->resolveUser();
+
+        $idempotentKey = $user ? $user->getAuthIdentifier().request() : request()->ip().request();
+        $idempotentKey = sha1($idempotentKey);
+
+        request()->headers->set(config('idempotent.header_name'), $idempotentKey);
+
+        return $idempotentKey;
+    }
+
+    /**
+     * @return mixed|null
+     */
+    protected function resolveUser()
+    {
+        $user = null;
+
+        $resolveUser = $this->config['resolve_user'];
+
+        if ($resolveUser instanceof Closure && $result = app()->call($resolveUser)) {
+            $user = $result;
+        }
+
+        return $user;
+    }
+}

src/IdempotentServiceProvider.php

@@ -0,0 +1,30 @@
+<?php
+/**
+ * Created by Cestbon.
+ * Author Cestbon <[email protected]>
+ * Date 2021-08-20 15:14
+ */
+
+namespace Chenpkg\Idempotent;
+
+use Illuminate\Support\ServiceProvider;
+
+class IdempotentServiceProvider extends ServiceProvider
+{
+    public function register()
+    {
+        $this->mergeConfigFrom(__DIR__.'/../config/idempotent.php', 'idempotent');
+
+        $this->app->singleton(IdempotentMiddleware::class);
+        $this->app['router']->aliasMiddleware('idempotent', IdempotentMiddleware::class);
+    }
+
+    public function boot()
+    {
+        if ($this->app->runningInConsole()) {
+            $this->publishes([
+                __DIR__.'/../config/idempotent.php' => config_path('idempotent.php')
+            ], 'laravel-idempotent');
+        }
+    }
+}