## `Auth` 組件
?本組件用于 API 中的授權與會話,基于 JWT,使用 BearerToken 的方式傳遞,可獨立使用。
## 組件
使用 [composer]([https://www.phpcomposer.com/](https://www.phpcomposer.com/)) 安裝:
~~~
composer require mix/auth
~~~
## 依賴注入配置
- [beans/auth.php](https://github.com/mix-php/mix-skeleton/tree/v2.1/manifest/beans/auth.php)
JWT 支持的全部算法:
- Mix\Auth\JWT::ALGORITHM_HS256
- Mix\Auth\JWT::ALGORITHM_HS384
- Mix\Auth\JWT::ALGORITHM_HS512
- Mix\Auth\JWT::ALGORITHM_RS256
- Mix\Auth\JWT::ALGORITHM_RS384
- Mix\Auth\JWT::ALGORITHM_RS512
HS 算法配置:
```
// JWT
[
// 類路徑
'class' => \Mix\Auth\JWT::class,
// 屬性注入
'properties' => [
// 鑰匙
'key' => 'example_key',
// 簽名算法
'algorithm' => Mix\Auth\JWT::ALGORITHM_HS256,
],
],
```
RS 算法配置:
```
// JWT
[
// 類路徑
'class' => \Mix\Auth\JWT::class,
// 屬性注入
'properties' => [
// 私鑰
'privateKey' => '',
// 公鑰
'publicKey' => '',
// 簽名算法
'algorithm' => \Mix\Auth\JWT::ALGORITHM_RS256,
],
],
```
## 使用范例
- 獲取 access_token 的接口:
```
/**
* 授權方法
* @return Response
*/
public function auth(ServerRequest $request, Response $response)
{
/* 驗證賬號密碼成功后 */
// 創建Token
$time = time();
/** @var Authorization $auth */
$auth = context()->get('auth');
$payload = [
"iss" => "http://example.org", // 簽發人
'iat' => $time, // 簽發時間
'exp' => $time + 7200, // 過期時間
'uid' => 100008,
];
$accessToken = $auth->createToken($payload);
// 響應
$data = [
'status' => 0,
'data' => [
'access_token' => $accessToken,
'expire_in' => 7200,
],
];
return ResponseHelper::json($response, $data);
}
```
- 效驗Token (在中間件中校驗):
[>> AuthMiddleware::class 源碼 <<](https://github.com/mix-php/mix-skeleton/tree/v2.1/app/Api/Middleware/AuthMiddleware.php)
>[danger] 每調用一次 getPayload 就會解碼一次,所以解碼后的用戶信息需要保存起來,不要在獲取用戶信息時每次都去解碼, AuthMiddleware::class 把 JWT Payload 放入了 Request 中,其他位置調用時就不需要解碼了。
- BearerToken 傳值范例:

- 歡迎使用 MixPHP
- 安裝說明
- 全棧安裝
- Phar 開發安裝
- 新手教程
- 命令行常識
- 進程管理
- 熱更新
- 全局變量
- 入門須知
- 命名空間
- 自動加載
- 入口文件
- 增改應用
- 核心功能
- 配置 (manifest.php)
- 協程
- 什么是協程
- 開啟協程
- PHP Stream Hook
- xgo + Channel
- WaitGroup + xdefer
- 連接池
- 協程池
- 定時器
- 依賴注入
- 事件調度
- 命令行
- 簡介
- Application
- 創建命令
- 命令參數
- 打印與顏色
- 守護進程
- 后臺運行
- Web/API 應用
- 簡介
- 服務器
- 路由
- 中間件
- 請求
- 文件上傳
- 響應
- 控制器
- 視圖
- Auth
- Session
- 客戶端
- GuzzleHttp
- 調試與錯誤
- 安全建議
- WebSocket 應用
- 簡介
- 服務器
- 客戶端
- JavaScript
- Swoole
- nginx代理
- 60s無消息斷線
- TCP 應用
- 簡介
- 服務器
- 客戶端
- Telnet
- PHP
- Swoole
- UDP 應用
- 簡介
- 服務器
- 客戶端
- NC
- Swoole
- Sync Invoke 同步調用
- 簡介
- 服務器
- 客戶端
- 公共組件
- 驗證器
- 驗證器定義
- 驗證規則
- 靜態調用
- 日志
- 緩存
- 數據庫
- Database
- ConnectionPool
- Connection
- QueryBuilder
- ExecutedEvent
- Redis
- ConnectionPool
- Connection
- CalledEvent
- 常見問題
- 如何利用CPU多核
- 連接多個數據庫
- 使用主從數據庫
- 如何設置跨域
- form-data 上傳文件失敗
- 輸出大于2M的文件失敗 (xlsx)
- 如何接入EasyWeChat
- 升級指導
- 不兼容修改-001
- 不兼容修改-002
- 不兼容修改-003