chore(release): 0.1.7

只有已登录的 Session 才保存

Signed-off-by: 李东云 <dongyu.li@luxcreo.ai>

CHANGELOG.md

@@ -1,4 +1,16 @@
 # 版本更新日志
+### [0.1.7](http://124.126.16.154:8888/singularity/HyperfDevelopmentKitCore/compare/v0.1.6...v0.1.7) (2023-07-05)
+
+
+### 📦‍ Build System | 打包构建
+
+* **composer:** 更新依赖 ([a570e19](http://124.126.16.154:8888/singularity/HyperfDevelopmentKitCore/commit/a570e1964e01b9e29de05f4a7607a4ed567beffa))
+
+
+### ✨ Features | 新功能
+
+* **session:** 增加了定制的 session 中间件 ([b51699b](http://124.126.16.154:8888/singularity/HyperfDevelopmentKitCore/commit/b51699b0d98322df33fb3a0bccebe5f4034e2a71))
+
 ### [0.1.6](http://124.126.16.154:8888/singularity/HyperfDevelopmentKitCore/compare/v0.1.5...v0.1.6) (2023-03-21)
 
 

composer.json

@@ -42,6 +42,7 @@
     "firebase/php-jwt": "^6.3",
     "friendsofphp/php-cs-fixer": "^3.13",
     "guzzlehttp/guzzle": "^7.5",
+    "hyperf/crontab": "<=3.0.9 || >3.0.13 <3.1",
     "hyperf/session": "^2.2",
     "hyperf/validation": "^2.2",
     "pestphp/pest": "^1.22",
@@ -113,5 +114,5 @@
       "url": "https://repo.huaweicloud.com/repository/php/"
     }
   },
-  "version": "0.1.6"
+  "version": "0.1.7"
 }

src/Middleware/SessionMiddleware.php

@@ -0,0 +1,165 @@
+<?php
+/**
+ * SessionMiddleware.php@HDK-Core
+ *
+ * @author 李东云 <Dongyun.Li@LuxCreo.Ai>
+ * Powered by PhpStorm
+ * Created on 2023/3/8
+ */
+
+namespace Singularity\HDK\Core\Middleware;
+
+use Carbon\Carbon;
+use Hyperf\Contract\ConfigInterface;
+use Hyperf\Contract\SessionInterface;
+use Hyperf\HttpMessage\Cookie\Cookie;
+use Hyperf\HttpMessage\Server\Response;
+use Hyperf\Session\SessionManager;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\MiddlewareInterface;
+use Psr\Http\Server\RequestHandlerInterface;
+
+/**
+ * Singularity\HDK\Auth\Middleware\SessionMiddleware@HDK-Core
+ *
+ * @author 李东云 <Dongyun.Li@LuxCreo.Ai>
+ * Powered by PhpStorm
+ * Created on 2023/3/8
+ */
+class SessionMiddleware implements MiddlewareInterface
+{
+    private SessionManager $sessionManager;
+    private ConfigInterface $config;
+
+    public function __construct(SessionManager $sessionManager, ConfigInterface $config)
+    {
+        $this->config = $config;
+        $this->sessionManager = $sessionManager;
+    }
+
+    /**
+     * Process an incoming server request.
+     * Processes an incoming server request in order to produce a response.
+     * If unable to produce the response itself, it may delegate to the provided
+     * request handler to do so.
+     */
+    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
+    {
+        if (!$this->isSessionAvailable()) {
+            return $handler->handle($request);
+        }
+
+        $session = $this->sessionManager->start($request);
+
+        try {
+            $response = $handler->handle($request);
+        } finally {
+            $this->storeCurrentUrl($request, $session);
+            $session = $this->sessionManager->getSession();
+
+            /*
+             * 现在的机制，但凡写入 Redis 的数据，
+             * 过期时间就是固定的 gc_maxlifetime
+             *
+             * 而 RedisHandler 只会被依赖注入时加载一次，
+             * 后续无法临时修改 gc_maxlifetime
+             *
+             * 又因为现在没有其他情况用到 session
+             * 只有登录之后才会记下用户信息
+             *
+             * 所以一个妥协的方案，就是只有登录了再写入 Redis
+             *
+             * （除非重写整套 RedisHandler/RedisHandlerFactory/...）
+             */
+            if (!$this->auth($session)) {
+                $this->sessionManager->end($session);
+            }
+        }
+
+        return $this->addCookieToResponse($request, $response, $session);
+    }
+
+    private function isSessionAvailable(): bool
+    {
+        return $this->config->has('session.handler');
+    }
+
+    /**
+     * Store the current URL for the request if necessary.
+     */
+    private function storeCurrentUrl(RequestInterface $request, SessionInterface $session)
+    {
+        if ($request->getMethod() === 'GET') {
+            $session->setPreviousUrl($this->fullUrl($request));
+        }
+    }
+
+    private function auth(SessionInterface $session): bool
+    {
+        return $session->has('userInfo');
+    }
+
+    /**
+     * Add the session cookie to the response·.
+     */
+    private function addCookieToResponse(
+        ServerRequestInterface $request,
+        ResponseInterface $response,
+        SessionInterface $session
+    ): ResponseInterface {
+        $cookie = new Cookie(
+             $session->getName(),
+             $session->getId(),
+             $this->getCookieExpirationDate($session),
+             $this->config->get('session.options.path', '/'),
+             $this->config->get('session.options.domain', $request->getUri()->getHost()),
+             $this->config->get(
+                'session.options.secure',
+                strtolower($request->getUri()->getScheme()) === 'https'
+            ),
+             true,
+             $this->config->get('session.options.samesite', Cookie::SAMESITE_LAX)
+        );
+        if (!method_exists($response, 'withCookie')) {
+            return $response->withHeader('Set-Cookie', (string)$cookie);
+        }
+        /* @var Response $response */
+        return $response->withCookie($cookie);
+    }
+
+    /**
+     * Get the full URL for the request.
+     */
+    private function fullUrl(RequestInterface $request): string
+    {
+        $uri = $request->getUri();
+        $query = $uri->getQuery();
+        $question = $uri->getHost() . $uri->getPath() == '/' ? '/?' : '?';
+        return $query ? $this->url($request) . $question . $query : $this->url($request);
+    }
+
+    /**
+     * Get the session lifetime in seconds.
+     */
+    private function getCookieExpirationDate(SessionInterface $session): int
+    {
+        // if ($this->config->get('session.options.expire_on_close')) {
+        if (!$this->auth($session)) {
+            $expirationDate = 0;
+        } else {
+            $expireSeconds = $this->config->get('session.options.cookie_lifetime', 5 * 60 * 60);
+            $expirationDate = Carbon::now()->addSeconds($expireSeconds)->getTimestamp();
+        }
+        return $expirationDate;
+    }
+
+    /**
+     * Get the URL (no query string) for the request.
+     */
+    private function url(RequestInterface $request): string
+    {
+        return rtrim(preg_replace('/\?.*/', '', (string)$request->getUri()));
+    }
+}