## `Auth` 組件
?本組件用于 API 中的授權與會話,基于 JWT,使用 BearerToken 的方式傳遞。
| 類 | 調用 |
| --- | --- | ---
| Mix\Auth\Authorization | app()->auth |
## 依賴注入配置
[>> 到 GitHub 查看默認配置 <<](https://github.com/mix-php/mix/blob/v2/applications/http/config/main_coroutine.php#L233)
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 的接口:
```
// 授權方法
public function actionAuth()
{
/* 驗證賬號密碼成功后 */
// 創建Token
$payload = [
"iss" => "http://example.org", // 簽發人
'iat' => time(), // 簽發時間
'exp' => time() + 7200, // 過期時間
'uid' => 1088,
];
$accessToken = app()->auth->createToken($payload);
// 響應
$data = [
'status' => 0,
'data' => [
'access_token' => $accessToken,
'expire_in' => 7200,
],
];
return $data;
}
```
效驗Token:在前置中間件中校驗。
~~~
// 前置中間件的 handle 方法
public function handle($callable, \Closure $next)
{
// 添加中間件執行代碼
$payload = [];
try{
$payload = app()->auth->getPayload();
}catch (\Throwable $e){
// token解碼失敗
}
if (empty($payload)) {
// 返回錯誤碼
$data = [
'status' => 30001,
];
return $data;
}
// 執行下一個中間件
return $next();
}
~~~
>[danger] 每調用一次 getPayload 就會解碼一次,所以解碼后的用戶信息需要保存起來,不要在獲取用戶信息時每次都去解碼
BearerToken 傳值范例:

- 歡迎使用 MixPHP
- 安裝說明
- 全量安裝
- Phar 命令行
- 入門須知
- 增改應用
- 命名空間
- 自動加載
- 入口文件
- 配置文件
- 服務開發
- 核心基礎
- Bean
- Component
- Application
- 命令行
- 簡介
- 命令行開發常識
- 命令行開發
- 創建命令
- 命令參數
- 打印與顏色
- 控制臺程序
- 守護程序
- HTTP 服務
- 簡介
- 服務器
- 路由
- 請求
- 響應
- 控制器
- 視圖
- Auth
- Session
- 文件上傳
- 其他組件
- 分頁
- 驗證碼
- 圖片處理
- 客戶端
- GuzzleHttp
- 雜項
- Apache/PHP-FPM部署
- 調試與錯誤
- 安全建議
- WebSocket 服務
- 簡介
- 服務器
- 注冊器
- 連接
- 客戶端
- 測試
- 雜項
- nginx代理
- 60s無消息斷線
- TCP 服務
- 簡介
- 服務器
- 客戶端
- 測試
- UDP 服務
- 簡介
- 服務器
- 客戶端
- 測試
- 協程
- 簡介
- 開啟協程
- PHP Stream Hook
- xgo + Channel
- WaitGroup + xdefer
- 連接池
- 協程池
- 定時器
- 公共組件
- 中間件
- 驗證器
- 驗證器定義
- 驗證規則
- 靜態調用
- 模型
- 日志
- 緩存
- 數據庫
- Database
- QueryBuilder
- PDOConnection
- Persistent\PDOConnection
- Coroutine\PDOConnection
- MasterSlave\PDOConnection
- ExecuteListener
- Redis
- RedisConnection
- Persistent\RedisConnection
- Coroutine\RedisConnection
- ExecuteListener
- 常見問題
- 同一臺服務器部署多個服務
- 連接多個數據庫
- 如何設置跨域
- form-data 上傳文件失敗
- 開發工具
- 版本更新
- 不兼容改動
- 升級指南
- 文檔歷史