Hyperf Auth 组件使用教程

Hyperf Auth 组件使用教程

1. 项目的目录结构及介绍

Hyperf Auth 组件的目录结构如下：

hyperf-auth/
├── src/
│   ├── AuthManager.php
│   ├── AuthMiddleware.php
│   ├── Contracts/
│   ├── Exception/
│   ├── Guards/
│   ├── Providers/
│   └── Auth.php
├── tests/
│   ├── AuthManagerTest.php
│   └── AuthTest.php
├── composer.json
├── LICENSE
├── README.md
└── phpunit.xml

目录结构介绍

• src/：包含组件的核心代码，如 AuthManager、AuthMiddleware 等。
• tests/：包含单元测试文件，确保组件的稳定性和可靠性。
• composer.json：项目的依赖管理文件。
• LICENSE：项目的开源许可证。
• README.md：项目的说明文档。
• phpunit.xml：PHPUnit 测试配置文件。

2. 项目的启动文件介绍

Hyperf Auth 组件的启动文件主要是 src/Auth.php，这个文件是组件的入口点，负责初始化和配置 Auth 组件。

// src/Auth.php
namespace Qbhy\HyperfAuth;

use Hyperf\Contract\ConfigInterface;
use Hyperf\Utils\ApplicationContext;

class Auth
{
    public static function getManager(): AuthManager
    {
        return ApplicationContext::getContainer()->get(AuthManager::class);
    }
}

启动文件介绍

• Auth.php：提供了一个静态方法 getManager，用于获取 AuthManager 实例，从而进行认证操作。

3. 项目的配置文件介绍

Hyperf Auth 组件的配置文件位于 config/autoload/auth.php，这个文件定义了认证相关的配置，如驱动、提供者等。

// config/autoload/auth.php
return [
    'default' => 'jwt',
    'guards' => [
        'jwt' => [
            'driver' => 'jwt',
            'provider' => 'users',
        ],
        'session' => [
            'driver' => 'session',
            'provider' => 'users',
        ],
    ],
    'providers' => [
        'users' => [
            'driver' => 'eloquent',
            'model' => App\Model\User::class,
        ],
    ],
];

配置文件介绍

• default：默认的认证驱动。
• guards：定义了不同的认证守卫，如 jwt 和 session。
• providers：定义了用户提供者，如 eloquent 驱动和用户模型。

通过以上配置，可以灵活地设置和切换不同的认证方式和用户提供者。