gdshenrun/caiss-auth

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

hyperf 的 auth 组件

1.0.1 2021-01-18 09:58 UTC

This package is auto-updated.

Last update: 2021-11-18 11:48:25 UTC


README

hyperf 的 auth 组件,目前支持 jwt、session 驱动。用户可以自行扩展。
本组件参考了 laravel 的 auth 组件设计,使用体验大体和 laravel 的 auth 差不多, 参考了 gdshenrun/hyperf-auth

安装 - install

$ composer require gdshenrun/caiss-auth

hyperf 2 +

配置 - configuration

使用 Gdshenrun\CaissAuth\AuthExceptionHandler ,此步骤可选,开发者可以自行捕捉 AuthExceptionJWTException 进行处理

<?php
// config/autoload/exceptions.php
return [
    'handler' => [
        'http' => [
            \Gdshenrun\CaissAuth\AuthExceptionHandler::class,
        ],    
    ],
];

发布配置 vendor:publish

$ php bin/hyperf.php vendor:publish gdshenrun/hyperf-auth

修改 config/autoload/auth.php

如不需要自定义 guard、model 和 user provider,则可以不修改

<?php

use Doctrine\Common\Cache\FilesystemCache;
use Gdshenrun\SimpleJwt\Encoders\Base64UrlSafeEncoder;
use Gdshenrun\SimpleJwt\EncryptAdapters\PasswordHashEncrypter;

return [
    'default' => [
        'guard'=> 'jwt',
        'provider'=> 'users',
    ] ,
    'guards' => [ // 开发者可以在这里添加自己的 guard ,guard Gdshenrun\CaissAuth\AuthGuard 接口
        'jwt' => [
            'driver' => Gdshenrun\CaissAuth\Guard\JwtGuard::class,
            'provider' => 'users',

            // 以下是 simple-jwt 所需的参数,具体配置文档可以看 config/autoload/auth.php
            'secret' =>env('JWT_SECRET', 'gdshenrun/hyperf-auth'),
            'ttl' => 60 * 60, // 单位秒
            'default' => PasswordHashEncrypter::class,
            'encoder' => new Base64UrlSafeEncoder(),
//            'cache' => new FilesystemCache(sys_get_temp_dir()), // 如果需要分布式部署,请选择 redis 或者其他支持分布式的缓存驱动
            'cache' => function() {
                return make(Gdshenrun\CaissAuth\HyperfRedisCache::class);
            }, 
        ],
        'session' => [
            'driver' => Gdshenrun\CaissAuth\Guard\SessionGuard::class,
            'provider' => 'users',
        ],
    ],
    'providers' => [
        'users' => [
            'driver' => \Gdshenrun\CaissAuth\Provider\EloquentProvider::class, // user provider 需要实现 Gdshenrun\CaissAuth\UserProvider 接口
            'model' => App\Model\User::class, //  需要实现 Gdshenrun\CaissAuth\Authenticatable 接口
        ],
    ],
];

使用 - usage

以下是伪代码,仅供参考。Auth 注解可以用于类或者方法。

<?php
declare(strict_types=1);

namespace App\Controller;

use Hyperf\Di\Annotation\Inject;
use Hyperf\HttpServer\Annotation\Controller;
use Hyperf\HttpServer\Annotation\GetMapping;
use Gdshenrun\CaissAuth\Annotation\Auth;
use Gdshenrun\CaissAuth\AuthManager;

/**
* @Controller
* Class IndexController
*/
class IndexController extends AbstractController
{
  /**
   * @Inject
   * @var AuthManager
   */
  protected $auth;

  /**
   * @GetMapping(path="/login")
   * @return array
   */
  public function login()
  {
      /** @var User $user */
      $user = User::query()->firstOrCreate(['name' => 'test', 'avatar' => 'avatar']);
      return [
          'status' => $this->auth->guard('session')->login($user),
      ];
  }

  /**
   * @Auth("session")
   * @GetMapping(path="/logout")
   */
  public function logout()
  {
      $this->auth->guard('session')->logout();
      return 'logout ok';
  }

  /**
   * 使用 Auth 注解可以保证该方法必须通过某个 guard 的授权,支持同时传多个 guard,不传参数使用默认 guard
   * @Auth("session")
   * @GetMapping(path="/user")
   * @return string
   */
  public function user()
  {
      $user = $this->auth->guard('session')->user();
      return 'hello '.$user->name;
  }
}

除了上面的 Auth 注解用法,还支持中间件用法

<?php

declare(strict_types=1);

namespace App\Controller;

use Hyperf\HttpServer\Annotation\Middleware;
use Gdshenrun\CaissAuth\AuthMiddleware; 
use Hyperf\Di\Annotation\Inject;
use Hyperf\HttpServer\Annotation\GetMapping;
use Gdshenrun\CaissAuth\AuthManager;

/**
* @Middleware(AuthMiddleware::class)
* Class IndexController
*/
class IndexController extends AbstractController
{
  /**
   * @Inject
   * @var AuthManager
   */
  protected $auth;
  
  /**
   * @GetMapping(path="/user")
   * @return string
   */
  public function user()
  {
      $user = $this->auth->guard()->user();
      return 'hello '.$user->name;
  }
}

由于 hyperf 还不支持中间件传参,所以 Gdshenrun\CaissAuth\AuthMiddleware 中间件只支持默认guard校验
但是开发者可以继承该中间自行扩展。或者直接使用 Auth 注解进行自定义 guard 校验,与中间件的效果是一致的。

<?php

declare(strict_types=1);

use Gdshenrun\CaissAuth\AuthMiddleware; 

class SessionAuthMiddleware extends AuthMiddleware { 
    protected $guards = ['session']; // 支持多个 guard

 }

更多用法 - API

<?php

$auth = auth(); // 控制器内也可以通过 @Inject 注入

$user = new \HyperfTest\DemoUser(1);

// 直接调用 AuthGuard 方法,这种情况下会获取 默认 guard 然后调用 guard 的对应方法
$auth->login($user); // 默认使用 jwt 驱动,该方法将返回 token 字符串
$auth->logout(); // 退出登录
$auth->check(); // 检查是否登录
$auth->guest(); // 是否游客/是否未登录
$auth->user(); // 若登录返回当前登录用户,否则返回null

/** @var \Gdshenrun\CaissAuth\Guard\JwtGuard $jwtGuard */
$jwtGuard = $auth->guard('jwt');
$jwtGuard->user('your token or null'); // jwt 驱动支持手动传入 token,如不传或者传null则从 request 中解析
$jwtGuard->check('your token or null');
$jwtGuard->guest('your token or null');
$jwtGuard->refresh('your token or null'); // 该方法返回新的 token 或者 null

$auth->guard()->login($user); // guard 方法不传参数或者传null都将使用默认值

// 使用 session 驱动需要安装 hyperf/session 并启用 session
$auth->guard('session')->login($user); // guard 方法不传参数或者传null都会获取默认值

注意事项:使用 jwt 驱动且令牌异常的情况下调用 user 方法,会抛出相应的异常,需要自行捕捉处理,不想抛异常,可以调用 check 进行判断。

扩展 - extension

由于本组件参考了 laravel auth 的设计,所以 guard 和 user provider 的扩展也和 laravel 类似。只需要实现对应接口即可。

  • guard ===> Gdshenrun\CaissAuth\AuthGuard
  • user provider ===> Gdshenrun\CaissAuth\UserProvider

扩展教程请移步 hyperf教程之hyperf-auth高级用法

https://github.com/gdshenrun/hyperf-auth
appledady@foxmail.com