5.6 KiB
視圖
視圖組件由 hyperf/view 實現並提供使用，滿足您對視圖渲染的需求，組件默認支持 Blade 、 Smarty 、 Twig 、 Plates 和 ThinkTemplate 五種模板引擎。
安裝
composer require hyperf/view
配置
View 組件的配置文件位於 config/autoload/view.php，若配置文件不存在可執行如下命令生成配置文件
php bin/hyperf.php vendor:publish hyperf/view
以下為相關配置的説明：
| 配置 | 類型 | 默認值 | 備註 |
|---|---|---|---|
| engine | string | Hyperf\View\Engine\BladeEngine::class | 視圖渲染引擎 |
| mode | string | Mode::TASK | 視圖渲染模式 |
| config.view_path | string | 無 | 視圖文件默認地址 |
| config.cache_path | string | 無 | 視圖文件緩存地址 |
配置文件格式示例：
<?php
declare(strict_types=1);
use Hyperf\View\Mode;
use Hyperf\View\Engine\BladeEngine;
return [
// 使用的渲染引擎
'engine' => BladeEngine::class,
// 不填寫則默認為 Task 模式，推薦使用 Task 模式
'mode' => Mode::TASK,
'config' => [
// 若下列文件夾不存在請自行創建
'view_path' => BASE_PATH . '/storage/view/',
'cache_path' => BASE_PATH . '/runtime/view/',
],
];
Task 模式
使用 Task 模式時，需引入 hyperf/task 組件且必須配置 task_enable_coroutine 為 false，否則會出現協程數據混淆的問題，更多請查閲 Task 組件文檔。
另外，在 Task 模式下，視圖渲染工作是在 Task Worker 進程中完成的，而請求處理即 Controller 是在 Worker 進程完成的，兩部分的工作由不同的進程完成，所以像 Request，Session 等在 Worker 進程通過上下文管理的對象或數據在視圖頁面上是無法直接使用的，這時候就需要您在 Controller 先處理好數據或判斷結果，然後再調用 render 時傳遞數據到視圖進行數據的渲染。
Sync 模式
若使用 Sync 模式渲染視圖時，請確保相關引擎是協程安全的，否則會出現數據混淆的問題，建議使用更加數據安全的 Task 模式。
配置靜態資源
如果您希望 Swoole 來管理靜態資源，請在 config/autoload/server.php 配置中增加以下配置。
return [
'settings' => [
...
// 靜態資源
'document_root' => BASE_PATH . '/public',
'enable_static_handler' => true,
],
];
視圖渲染引擎
官方目前支持 Blade 、 Smarty 、 Twig 、 Plates 和 ThinkTemplate 五種模板，默認安裝 hyperf/view 時不會自動安裝任何模板引擎，需要您根據自身需求，自行安裝對應的模板引擎，使用前必須安裝任一模板引擎。
安裝 Blade 引擎
composer require hyperf/view-engine
詳細方式見文檔 視圖引擎
或者使用
duncan3dc/blade 因為使用了 Laravel 的 Support 庫，所以會導致某些函數不兼容，暫時不推薦使用
composer require duncan3dc/blade
安裝 Smarty 引擎
composer require smarty/smarty
安裝 Twig 引擎
composer require twig/twig
安裝 Plates 引擎
composer require league/plates
安裝 ThinkTemplate 引擎
composer require sy-records/think-template
接入其他模板
假設我們想要接入一個虛擬的模板引擎名為 TemplateEngine，那麼我們需要在任意地方創建對應的 TemplateEngine 類，並實現 Hyperf\View\Engine\EngineInterface 接口。
<?php
declare(strict_types=1);
namespace App\Engine;
use Hyperf\View\Engine\EngineInterface;
class TemplateEngine implements EngineInterface
{
public function render($template, $data, $config): string
{
// 實例化對應的模板引擎的實例
$engine = new TemplateInstance();
// 並調用對應的渲染方法
return $engine->render($template, $data);
}
}
然後修改視圖組件的配置：
<?php
use App\Engine\TemplateEngine;
return [
// 將 engine 參數改為您的自定義模板引擎類
'engine' => TemplateEngine::class,
'mode' => Mode::TASK,
'config' => [
'view_path' => BASE_PATH . '/storage/view/',
'cache_path' => BASE_PATH . '/runtime/view/',
],
];
使用
以下以 BladeEngine 為例，首先在對應的目錄裏創建視圖文件 index.blade.php。
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Hyperf</title>
</head>
<body>
Hello, {{ $name }}. You are using blade template now.
</body>
</html>
控制器中獲取 Hyperf\View\Render 實例，然後調用 render 方法並傳遞視圖文件地址 index 和 渲染數據 即可，文件地址忽略視圖文件的後綴名。
<?php
declare(strict_types=1);
namespace App\Controller;
use Hyperf\HttpServer\Annotation\AutoController;
use Hyperf\View\RenderInterface;
#[AutoController]
class ViewController
{
public function index(RenderInterface $render)
{
return $render->render('index', ['name' => 'Hyperf']);
}
}
訪問對應的 URL，即可獲得如下所示的視圖頁面：
Hello, Hyperf. You are using blade template now.