如何使用Hyperf框架进行身份认证

如何使用Hyperf框架进行身份认证

在现代的Web应用程序中，用户身份认证是一个非常重要的功能。为了保护敏感信息和确保应用程序的安全性，身份认证可以确保只有经过验证的用户才能访问受限资源。

Hyperf是一个基于Swoole的高性能PHP框架，提供了很多现代化和高效的功能和工具。在Hyperf框架中，我们可以使用多种方法来实现身份认证，下面将介绍其中两种常用的方法。

1. 使用JWT（JSON Web Token）

JWT是一种开放标准（RFC 7519），它定义了一个简洁的、自包含的方法，用于在通信双方之间安全地传输信息。在Hyperf框架中，我们可以使用lcobucci/jwt扩展库来实现JWT的生成和验证。

首先，我们需要在composer.json文件中添加lcobucci/jwt库的依赖项：

"require": {
    "lcobucci/jwt": "^3.4"
}

然后执行composer update命令安装依赖项。

接下来，我们可以创建一个JwtAuthenticator类，用于生成和验证JWT：

<?php

declare(strict_types=1);

namespace AppAuth;

use HyperfExtAuthAuthenticatable;
use HyperfExtAuthContractsAuthenticatorInterface;
use LcobucciJWTConfiguration;
use LcobucciJWTToken;

class JwtAuthenticator implements AuthenticatorInterface
{
    private Configuration $configuration;

    public function __construct(Configuration $configuration)
    {
        $this->configuration = $configuration;
    }

    public function validateToken(string $token): bool
    {
        $parsedToken = $this->configuration->parser()->parse($token);
        $isVerified = $this->configuration->validator()->validate($parsedToken, ...$this->configuration->validationConstraints());
        
        return $isVerified;
    }

    public function generateToken(Authenticatable $user): string
    {
        $builder = $this->configuration->createBuilder();
        $builder->issuedBy('your_issuer')
            ->issuedAt(new DateTimeImmutable())
            ->expiresAt((new DateTimeImmutable())->modify('+1 hour'))
            ->withClaim('sub', (string) $user->getAuthIdentifier());
        
        $token = $builder->getToken($this->configuration->signer(), $this->configuration->signingKey());
        
        return $token->toString();
    }
}

然后，我们需要在Hyperf框架的容器中注册JwtAuthenticator类：

HyperfUtilsApplicationContext::getContainer()->define(AppAuthJwtAuthenticator::class, function (PsrContainerContainerInterface $container) {
    $configuration = LcobucciJWTConfiguration::forAsymmetricSigner(
        new LcobucciJWTSignerRsaSha256(),
        LcobucciJWTSignerKeyLocalFileReference::file('path/to/private/key.pem')
    );

    return new AppAuthJwtAuthenticator($configuration);
});

最后，在需要认证的路由或控制器方法中，我们可以使用JwtAuthenticator类来验证用户的JWT：

<?php

declare(strict_types=1);

namespace AppController;

use AppAuthJwtAuthenticator;
use HyperfHttpServerAnnotationController;
use HyperfHttpServerAnnotationRequestMapping;

/**
 * @Controller(prefix="/api")
 */
class ApiController
{
    private JwtAuthenticator $authenticator;

    public function __construct(JwtAuthenticator $authenticator)
    {
        $this->authenticator = $authenticator;
    }

    /**
     * @RequestMapping(path="profile", methods="GET")
     */
    public function profile()
    {
        $token = $this->request->getHeader('Authorization')[0] ?? '';
        $token = str_replace('Bearer ', '', $token);
        
        if (!$this->authenticator->validateToken($token)) {
            // Token验证失败，返回错误响应
            return 'Unauthorized';
        }

        // Token验证成功，返回用户信息
        return $this->authenticator->getUserByToken($token);
    }
}

2. 使用Session

除了JWT认证，Hyperf框架也支持使用Session进行身份认证。我们可以通过配置文件来启用Session认证功能。

首先，我们需要在配置文件config/autoload/session.php中进行相应的配置，例如：

return [
    'handler' => [
        'class' => HyperfRedisSessionHandler::class,
        'options' => [
            'pool' => 'default',
        ],
    ],
];

然后，在需要认证的路由或控制器方法中，我们可以使用Hyperf框架提供的AuthManager类来验证用户的Session：

<?php

declare(strict_types=1);

namespace AppController;

use HyperfHttpServerAnnotationController;
use HyperfHttpServerAnnotationRequestMapping;
use HyperfExtAuthContractsAuthManagerInterface;

/**
 * @Controller(prefix="/api")
 */
class ApiController
{
    private AuthManagerInterface $authManager;

    public function __construct(AuthManagerInterface $authManager)
    {
        $this->authManager = $authManager;
    }

    /**
     * @RequestMapping(path="profile", methods="GET")
     */
    public function profile()
    {
        if (!$this->authManager->check()) {
            // 用户未登录，返回错误响应
            return 'Unauthorized';
        }

        // 用户已登录，返回用户信息
        return $this->authManager->user();
    }
}

在上述代码中，AuthManagerInterface接口提供了许多用于认证和用户操作的方法，具体可根据实际需求进行调用。

以上是使用Hyperf框架进行身份认证的两种常用方法，通过JWT或者Session来实现用户身份验证。根据实际需求和项目特点，选择合适的方法以确保应用程序的安全性和用户体验。在实际开发中，可以根据框架提供的文档和示例代码深入了解更多高级用法和最佳实践。