code-generation 2.x (代碼生成組件)
EasySwoole
代碼生成組件,使用命令行就可以一鍵生成業(yè)務(wù)通用代碼,支持生成的代碼如下:
- 一鍵生成
項(xiàng)目初始化 baseController、baseModel、baseUnitTest
; - 一鍵生成
表 Model,自帶屬性注釋
; - 一鍵生成
表 curd 控制器,自帶 5 個(gè) curd 方法
; - 一鍵生成
控制器單元測(cè)試用例,測(cè)試 5 個(gè) curd 方法
。
組件版本說(shuō)明
code-generation
組件當(dāng)前最新穩(wěn)定版本為 2.x
,code-generation 2.x
相對(duì)于 1.x
版本,兼容了 EasySwoole
的最新注解組件,支持了新的 EasySwoole
文檔自動(dòng)生成,以及最新的 phpunit
版本,同時(shí)完善了 Model->getList
返回參數(shù),以及控制器 getOne、getList
的 response
參數(shù)注解。
注:
code-generation 1.x
版本組件文檔詳見(jiàn) code-generation 1.x
組件要求
- easyswoole/trigger: ^1.0
- easyswoole/socket: ^1.0
- easyswoole/orm: ^1.4
- nette/php-generator: ^3.2
- easyswoole/http-annotation: ^1.4
- php-curl-class/php-curl-class: ^8.5
- easyswoole/command: ^1.1
安裝方法
composer require easyswoole/code-generation=2.x
倉(cāng)庫(kù)地址
easyswoole/code-generation 2.x
基本使用
配置文件 dev.php
配置如下:
<?php
return [
'SERVER_NAME' => "EasySwoole",
'MAIN_SERVER' => [
'LISTEN_ADDRESS' => '0.0.0.0',
'PORT' => 9501,
'SERVER_TYPE' => EASYSWOOLE_WEB_SERVER, //可選為 EASYSWOOLE_SERVER EASYSWOOLE_WEB_SERVER EASYSWOOLE_WEB_SOCKET_SERVER
'SOCK_TYPE' => SWOOLE_TCP,
'RUN_MODEL' => SWOOLE_PROCESS,
'SETTING' => [
'worker_num' => 8,
'reload_async' => true,
'max_wait_time' => 3
],
'TASK' => [
'workerNum' => 4,
'maxRunningNum' => 128,
'timeout' => 15
]
],
'TEMP_DIR' => null,
'LOG_DIR' => null,
'MYSQL' => [
'host' => '127.0.0.1',
'port' => 3306,
'user' => 'easyswoole',
'timeout' => 5,
'charset' => 'utf8mb4',
'password' => 'easyswoole100%',
'database' => 'easyswoole',
'maxObjectNum' => 20,
'minObjectNum' => 5,
'getObjectTimeout' => 3.0,
]
];
在項(xiàng)目根目錄新建一個(gè) TestCodeGeneration.php
,代碼內(nèi)容如下:
<?php
include __DIR__ . "/vendor/autoload.php";
\EasySwoole\EasySwoole\Core::getInstance()->initialize();
go(function () {
// 生成基礎(chǔ)類
$generation = new \EasySwoole\CodeGeneration\InitBaseClass\Controller\ControllerGeneration();
$generation->generate();
$generation = new \EasySwoole\CodeGeneration\InitBaseClass\UnitTest\UnitTestGeneration();
$generation->generate();
$generation = new \EasySwoole\CodeGeneration\InitBaseClass\Model\ModelGeneration();
$generation->generate();
// 獲取 dev.php 中的 MYSQL 配置文件,配置文件具體說(shuō)明請(qǐng)看:http://www.b3f21.cn/QuickStart/config.html
$mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
// 獲取數(shù)據(jù)庫(kù)連接
$connection = new \EasySwoole\ORM\Db\Connection($mysqlConfig);
// 指定表名(這里以 user_list 表作為示例表,表結(jié)構(gòu)請(qǐng)看下文)
$tableName = 'user_list';
$codeGeneration = new EasySwoole\CodeGeneration\CodeGeneration($tableName, $connection);
// 生成 model (默認(rèn)生成模型的路徑前綴為 App\Model 目錄,例如:如下生成的模型文件為 User模型【\App\Model\User\UserModel.php】 和 基礎(chǔ)模型【\App\Model\User\BaseModel.php】)
$codeGeneration->generationModel("\\User");
// 生成 controller (默認(rèn)生成控制器的路徑前綴為 App\HttpController 目錄,例如:如下生成的控制器文件為 User控制器【\App\Model\Api\User\User.php】 和 基礎(chǔ)控制器【\App\HttpController\Api\Base.php】)
$codeGeneration->generationController("\\Api\\User", null);
// 生成 unitTest (默認(rèn)生成 unitTest 的路徑前綴為項(xiàng)目根目錄的 UnitTest 目錄,例如:如下生成的單元測(cè)試用例為 UserTest【UnitTest\Api\User\UserTest.php】 和 基礎(chǔ)單元測(cè)試用例【UnitTest\BaseTest.php】)
$codeGeneration->generationUnitTest("\\Api\\User", null);
});
\Swoole\Timer::clearAll();
在配置好數(shù)據(jù)庫(kù)和數(shù)據(jù)庫(kù)配置文件之后,然后在項(xiàng)目根目錄運(yùn)行 TestCodeGeneration.php
(php TestCodeGeneration.php
),即可看到自動(dòng)生成的模型、控制器和單元測(cè)試用例。
EasySwoole\CodeGeneration\CodeGeneration
方法可自行查看,代碼很簡(jiǎn)單。
示例表結(jié)構(gòu)(user_list
)
CREATE TABLE `user_list` (
`id` int(11) NOT NULL,
`name` varchar(50) DEFAULT NULL,
`age` int(11) DEFAULT NULL,
`email` varchar(100) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
命令行使用
由于命令行特殊的特性,命令行功能支持并不完善,如果想要體驗(yàn)全部功能,請(qǐng)使用 \EasySwoole\CodeGeneration\CodeGeneration
生成,或參考 \EasySwoole\CodeGeneration\CodeGeneration
代碼生成。
注冊(cè)命令
配置數(shù)據(jù)庫(kù)配置文件 dev.php
,配置文件內(nèi)容詳見(jiàn)上文。
在 EasySwoole
項(xiàng)目根目錄中的 bootstrap.php
(即 bootstrap事件
) 中使用 Di
注入配置項(xiàng):
<?php
// 全局bootstrap事件
date_default_timezone_set('Asia/Shanghai');
\EasySwoole\EasySwoole\Core::getInstance()->initialize();
## 1 直接注入 mysql 連接
// 獲取 dev.php 中的 MYSQL 配置文件,配置文件具體說(shuō)明請(qǐng)看:http://www.b3f21.cn/QuickStart/config.html
$mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
// 獲取連接
$connection = new \EasySwoole\ORM\Db\Connection($mysqlConfig);
\EasySwoole\Component\Di::getInstance()->set('CodeGeneration.connection', $connection);
## 2 直接注入 mysql 配置對(duì)象
// $mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
// \EasySwoole\Component\Di::getInstance()->set('CodeGeneration.connection', $mysqlConfig);
## 3 直接注入 mysql 配置項(xiàng)
// \EasySwoole\Component\Di::getInstance()->set('CodeGeneration.connection',\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
// 以上 3 種注入 mysql 連接的方式均可,用戶可以任選 1 種進(jìn)行注入 mysql
// 注入執(zhí)行目錄項(xiàng),后面的為默認(rèn)值,initClass 不能通過(guò)注入改變目錄
\EasySwoole\Component\Di::getInstance()->set('CodeGeneration.modelBaseNameSpace', "App\\Model");
\EasySwoole\Component\Di::getInstance()->set('CodeGeneration.controllerBaseNameSpace', "App\\HttpController");
\EasySwoole\Component\Di::getInstance()->set('CodeGeneration.unitTestBaseNameSpace', "UnitTest");
\EasySwoole\Component\Di::getInstance()->set('CodeGeneration.rootPath', getcwd());
然后即可使用命令實(shí)現(xiàn)自動(dòng)生成代碼,具體使用命令如下(使用如下命令前提:必須先在 bootstrap事件
中使用 Di
注冊(cè)上述說(shuō)明的配置項(xiàng)):
php ./vendor/bin/code-generator
______ _____ _
| ____| / ____| | |
| |__ __ _ ___ _ _ | (___ __ __ ___ ___ | | ___
| __| / _` | / __| | | | | \___ \ \ \ /\ / / / _ \ / _ \ | | / _ \
| |____ | (_| | \__ \ | |_| | ____) | \ V V / | (_) | | (_) | | | | __/
|______| \__,_| |___/ \__, | |_____/ \_/\_/ \___/ \___/ |_| \___|
__/ |
|___/
Code auto generation tool
Usage:
./vendor/bin/code-generator ACTION [--opts ...]
Actions:
init initialization
all specify build
Options:
--tableName specify table name
--modelPath specify model path
--controllerPath specify controller path
--unitTestPath specify unit-test path
php ./vendor/bin/code-generator all --tableName="tableName" --modelPath="生成的模型所在目錄" [--controllerPath="生成的控制器所在目錄"] [--unitTestPath="生成的單元測(cè)試用例所在目錄"]
// 生成基礎(chǔ)模型(BaseModel)、基礎(chǔ)控制器(BaseController)、基礎(chǔ)單元測(cè)試用例(BaseUnitTest)
php ./vendor/bin/code-generator init
// 自動(dòng)生成指定的模型、控制器、單元測(cè)試用例和 基礎(chǔ)模型、基礎(chǔ)控制器、基礎(chǔ)單元測(cè)試用例
php vendor/bin/code-generator all --tableName="user_list" --modelPath="\\User" --controllerPath="\\Api\\User" --unitTestPath="\\User"
執(zhí)行結(jié)果示例如下:
[root@localhost es-code-generation]# php ./vendor/bin/code-generator init
┌────────────┬─────────────────────────────────────────────────────────────────────┐
│ className │ filePath │
├────────────┼─────────────────────────────────────────────────────────────────────┤
│ Model │ /www/wwwroot/easyswoole-code-generation/App/Model/BaseModel.php │
├────────────┼─────────────────────────────────────────────────────────────────────┤
│ Controller │ /www/wwwroot/easyswoole-code-generation/App/HttpController/Base.php │
├────────────┼─────────────────────────────────────────────────────────────────────┤
│ UnitTest │ /www/wwwroot/easyswoole-code-generation/UnitTest/BaseTest.php │
└────────────┴─────────────────────────────────────────────────────────────────────┘
[root@localhost es-code-generation]# php ./vendor/bin/code-generator all --tableName="user_list" --modelPath="\\User" --controllerPath="\\Api\\User" --unitTestPath="\\User"
┌────────────┬──────────────────────────────────────────────────────────────────────────────┐
│ className │ filePath │
├────────────┼──────────────────────────────────────────────────────────────────────────────┤
│ Model │ /www/wwwroot/easyswoole-code-generation/App/Model/User/UserModel.php │
├────────────┼──────────────────────────────────────────────────────────────────────────────┤
│ Controller │ /www/wwwroot/easyswoole-code-generation/App/HttpController/Api/User/User.php │
├────────────┼──────────────────────────────────────────────────────────────────────────────┤
│ UnitTest │ /www/wwwroot/easyswoole-code-generation/UnitTest/User/UserTest.php │
└────────────┴──────────────────────────────────────────────────────────────────────────────┘
獨(dú)立使用
生成器流程說(shuō)明
- 通過(guò)
\EasySwoole\ORM\Utility\TableObjectGeneration
,傳入\EasySwoole\ORM\Db\Connection
連接對(duì)象,通過(guò)generationTable
方法獲取表結(jié)構(gòu)對(duì)象; - 實(shí)例化類生成器配置,配置命名空間、生成文件路徑、類名等(詳情看下面);
- 實(shí)例化生成器對(duì)象,調(diào)用
generate
方法生成。
生成器基礎(chǔ)配置項(xiàng)
-
extendClass
繼承類,默認(rèn)為\EasySwoole\ORM\AbstractModel::class
- directory 生成路徑,生成路徑默認(rèn)為
rootPath+namespace
對(duì)應(yīng)路徑,namespace路徑將自動(dòng)通過(guò)composer.json->(autoload/autoload-dev)['psr-4']
配置目錄生成,如果沒(méi)有則默認(rèn)為根目錄 - namespace 命名空間配置.
- className 類名
- rootPath 項(xiàng)目根目錄,默認(rèn)為執(zhí)行目錄.
獲取數(shù)據(jù)表結(jié)構(gòu)
所有生成器都依賴于數(shù)據(jù)表結(jié)構(gòu)對(duì)象EasySwoole\ORM\Utility\Schema\Table
<?php
$mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
//獲取連接
$connection = new \EasySwoole\ORM\Db\Connection($mysqlConfig);
$tableName = 'user_list';
//獲取數(shù)據(jù)表結(jié)構(gòu)對(duì)象
$tableObjectGeneration = new \EasySwoole\ORM\Utility\TableObjectGeneration($connection, $tableName);
$schemaInfo = $tableObjectGeneration->generationTable();
Model生成
Model配置項(xiàng)說(shuō)明
- extendClass 繼承類,默認(rèn)為
\EasySwoole\ORM\AbstractModel::class
- directory 生成路徑,生成路徑默認(rèn)為
rootPath+namespace
對(duì)應(yīng)路徑,namespace路徑將自動(dòng)通過(guò)composer.json->(autoload/autoload-dev)['psr-4']
配置目錄生成,如果沒(méi)有則默認(rèn)為根目錄 - namespace 命名空間配置.默認(rèn)為
App\Model
- className 類名,Model配置無(wú)效,強(qiáng)制為
realTableName+fileSuffix
- rootPath 項(xiàng)目根目錄,默認(rèn)為執(zhí)行目錄.
- tablePre 表前綴,如果有配置,es_user 表=> UserModel
- table 表結(jié)構(gòu)對(duì)象
- realTableName 真實(shí)表名,通過(guò)下劃線形式轉(zhuǎn)為大駝峰,自動(dòng)轉(zhuǎn)化.用于生成最后的類名和文件名.
- fileSuffix 文件后綴,默認(rèn)為
Model
,用于生成最后的類名和文件名. - ignoreString 默認(rèn)為['list', 'log'], //生成時(shí)忽略表名存在的字符,例如user_list將生成=>UserModel
Model生成示例:
<?php
/**
* Created by PhpStorm.
* User: tioncico
* Date: 2020-05-20
* Time: 10:26
*/
include "./vendor/autoload.php";
\EasySwoole\EasySwoole\Core::getInstance()->initialize();
go(function () {
$mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
//獲取連接
$connection = new \EasySwoole\ORM\Db\Connection($mysqlConfig);
$tableName = 'user_list';
//獲取數(shù)據(jù)表結(jié)構(gòu)對(duì)象
$tableObjectGeneration = new \EasySwoole\ORM\Utility\TableObjectGeneration($connection, $tableName);
$schemaInfo = $tableObjectGeneration->generationTable();
$tablePre = '';//表前綴
$path = "App\\Model";
$extendClass = \EasySwoole\ORM\AbstractModel::class;
$modelConfig = new \EasySwoole\CodeGeneration\ModelGeneration\ModelConfig($schemaInfo, $tablePre, "{$path}", $extendClass);
$modelConfig->setRootPath(EASYSWOOLE_ROOT);//設(shè)置項(xiàng)目運(yùn)行目錄,默認(rèn)為當(dāng)前執(zhí)行腳本目錄.
$modelConfig->setIgnoreString(['list', 'log']);//生成時(shí)忽略表名存在的字符,例如user_list將生成=>UserModel
$modelGeneration = new \EasySwoole\CodeGeneration\ModelGeneration\ModelGeneration($modelConfig);
$result = $modelGeneration->generate();
var_dump($result);//生成成功返回生成文件路徑,否則返回false
});
\Swoole\Timer::clearAll();
Model方法
Model方法默認(rèn)生成一個(gè)GetList
方法,用于獲取列表.
<?php
public function getList(int $page = 1, int $pageSize = 10, string $field = '*'): array
{
$list = $this
->withTotalCount()
->order($this->schemaInfo()->getPkFiledName(), 'DESC')
->field($field)
->page($page, $pageSize)
->all();
$total = $this->lastQueryResult()->getTotalCount();;
return ['total' => $total, 'list' => $list];
}
可參考EasySwoole\CodeGeneration\ModelGeneration\Method\GetList
自定義其他方法.再進(jìn)行注入即可.
addGenerationMethod(new \EasySwoole\CodeGeneration\ModelGeneration\Method\GetList($modelGeneration));
Controller生成
Controller 配置項(xiàng)說(shuō)明
Controller配置項(xiàng)繼承與Model配置項(xiàng)
- modelClass Model類類名(包含命名空間),Controller生成依賴于Model,所以需要傳入Model類類名
- authSessionName 權(quán)限驗(yàn)證session參數(shù)名,比如在需要用戶登錄的控制器方法中,都需要傳入session字段名用于驗(yàn)權(quán),controller將在生成方法時(shí)自動(dòng)生成驗(yàn)證這個(gè)session參數(shù)的注解,默認(rèn)為空
- extendClass 繼承類,默認(rèn)為
\EasySwoole\HttpAnnotation\AnnotationController
- directory 生成路徑,生成路徑默認(rèn)為
rootPath+namespace
對(duì)應(yīng)路徑,namespace路徑將自動(dòng)通過(guò)composer.json->(autoload/autoload-dev)['psr-4']
配置目錄生成,如果沒(méi)有則默認(rèn)為根目錄 - namespace 命名空間配置.默認(rèn)為
App\\HttpController
- className 類名,Model配置無(wú)效,強(qiáng)制為
realTableName+fileSuffix
- fileSuffix 文件后綴,默認(rèn)為空,用于生成最后的類名和文件名.
- ignoreString 默認(rèn)為['list', 'log'], //生成時(shí)忽略表名存在的字符,例如user_list將生成=>User
controller生成示例
<?php
/**
* Created by PhpStorm.
* User: tioncico
* Date: 2020-05-20
* Time: 10:26
*/
include "./vendor/autoload.php";
\EasySwoole\EasySwoole\Core::getInstance()->initialize();
go(function () {
$mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
//獲取連接
$connection = new \EasySwoole\ORM\Db\Connection($mysqlConfig);
$tableName = 'user_list';
//獲取數(shù)據(jù)表結(jié)構(gòu)對(duì)象
$tableObjectGeneration = new \EasySwoole\ORM\Utility\TableObjectGeneration($connection, $tableName);
$schemaInfo = $tableObjectGeneration->generationTable();
$tablePre = '';//表前綴
$path = "App\\HttpController";
$extendClass = \EasySwoole\HttpAnnotation\AnnotationController::class;
$modelClass = \App\Model\UserModel::class;//$modelGeneration->getConfig()->getNamespace() . '\\' . $modelGeneration->getClassName();
$controllerConfig = new \EasySwoole\CodeGeneration\ControllerGeneration\ControllerConfig($modelClass, $schemaInfo, $tablePre, "{$path}", $extendClass);
$controllerConfig->setRootPath(EASYSWOOLE_ROOT);
$controllerGeneration = new \EasySwoole\CodeGeneration\ControllerGeneration\ControllerGeneration($controllerConfig);
$result = $controllerGeneration->generate();
var_dump($result);
});
\Swoole\Timer::clearAll();
Controller方法.
Controller支持了5個(gè)方法,Add
,Delete
,GetList
,GetOne
,Update
.
自定義其他方法可參考Model方法自定義.
unitTest
單元測(cè)試生成器生成.生成后的文件為作者本人自定義風(fēng)格代碼,需要依賴于BaseUnitTest
<?php
namespace UnitTest;
use Curl\Curl;
use EasySwoole\EasySwoole\Core;
use PHPUnit\Framework\TestCase;
/**
* BaseTest
* Class BaseTest
* Create With ClassGeneration
*/
class BaseTest extends TestCase
{
public static $isInit = 0;
/** @var Curl */
public $curl;
public $apiBase = 'http://127.0.0.1:9501';
public $modelName;
public function request($action, $data = [], $modelName = null)
{
$modelName = $modelName ?? $this->modelName;
$url = $this->apiBase . '/' . $modelName . '/' . $action;
$curl = $this->curl;
$curl->post($url, $data);
if ($curl->response) {
// var_dump($curl->response);
} else {
echo 'Error: ' . $curl->errorCode . ': ' . $curl->errorMessage . "
";
}
$this->assertTrue(!!$curl->response);
$this->assertEquals(200, $curl->response->code, $curl->response->msg);
return $curl->response;
}
public function setUp()
{
if (self::$isInit == 1) {
return true;
}
require_once dirname(__FILE__, 2) . '/vendor/autoload.php';
defined('EASYSWOOLE_ROOT') or define('EASYSWOOLE_ROOT', dirname(__FILE__, 2));
require_once dirname(__FILE__, 2) . '/EasySwooleEvent.php';
Core::getInstance()->initialize()->globalInitialize();
self::$isInit = 1;
$this->curl = new Curl();
}
}
unitTest配置項(xiàng)說(shuō)明
unitTest配置項(xiàng)繼承于Model配置項(xiàng)
- modelClass Model類類名(包含命名空間),UnitTest生成依賴于Model,所以需要傳入Model類類名
- ControllerClass ControllerClass類類名(包含命名空間),UnitTest生成依賴于ControllerClass,所以需要傳入ControllerClass類類名
- extendClass 繼承類,默認(rèn)為
\PHPUnit\Framework\TestCase
- directory 生成路徑,生成路徑默認(rèn)為
rootPath+namespace
對(duì)應(yīng)路徑,namespace路徑將自動(dòng)通過(guò)composer.json->(autoload/autoload-dev)['psr-4']
配置目錄生成,如果沒(méi)有則默認(rèn)為根目錄 - namespace 命名空間配置.默認(rèn)為
UnitTest
- className 類名,Model配置無(wú)效,強(qiáng)制為
realTableName+fileSuffix
- fileSuffix 文件后綴,默認(rèn)為
Test
,用于生成最后的類名和文件名. - ignoreString 默認(rèn)為['list', 'log'], //生成時(shí)忽略表名存在的字符,例如user_list將生成=>UserTest
unitTest生成示例
<?php
/**
* Created by PhpStorm.
* User: tioncico
* Date: 2020-05-20
* Time: 10:26
*/
include "./vendor/autoload.php";
\EasySwoole\EasySwoole\Core::getInstance()->initialize();
go(function () {
$mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
//獲取連接
$connection = new \EasySwoole\ORM\Db\Connection($mysqlConfig);
$tableName = 'user_list';
//獲取數(shù)據(jù)表結(jié)構(gòu)對(duì)象
$tableObjectGeneration = new \EasySwoole\ORM\Utility\TableObjectGeneration($connection, $tableName);
$schemaInfo = $tableObjectGeneration->generationTable();
$path = "UnitTest";
$modelClass = \App\Model\UserModel::class;
$controllerClass= \App\HttpController\User::class;
$extendClass = \PHPUnit\Framework\TestCase::class;
$tablePre = '';//表前綴
$controllerConfig = new \EasySwoole\CodeGeneration\UnitTest\UnitTestConfig($modelClass, $controllerClass, $schemaInfo, $tablePre, "{$path}", $extendClass);
$controllerConfig->setRootPath(EASYSWOOLE_ROOT);
$unitTestGeneration = new \EasySwoole\CodeGeneration\UnitTest\UnitTestGeneration($controllerConfig);
$result = $unitTestGeneration->generate();
var_dump($result);
});
\Swoole\Timer::clearAll();
UnitTest方法.
UnitTest支持了5個(gè)方法,Add
,Delete
,GetList
,GetOne
,Update
.
自定義其他方法可參考Model方法自定義.
初始化類
為了方便開(kāi)發(fā),提供了Controller,Model,UnitTest的初始化類.
Controller
生成方法:
<?php
$generation = new \EasySwoole\CodeGeneration\InitBaseClass\Controller\ControllerGeneration();
$generation->generate();
類內(nèi)容:
<?php
namespace App\HttpController;
use EasySwoole\EasySwoole\ServerManager;
use EasySwoole\EasySwoole\Trigger;
use EasySwoole\HttpAnnotation\AnnotationController;
use EasySwoole\HttpAnnotation\Exception\Annotation\ParamValidateError;
use EasySwoole\Http\Message\Status;
/**
* Base
* Class Base
* Create With ClassGeneration
*/
class Base extends AnnotationController
{
public function index()
{
$this->actionNotFound('index');
}
public function clientRealIP($headerName = 'x-real-ip')
{
$server = ServerManager::getInstance()->getSwooleServer();
$client = $server->getClientInfo($this->request()->getSwooleRequest()->fd);
$clientAddress = $client['remote_ip'];
$xri = $this->request()->getHeader($headerName);
$xff = $this->request()->getHeader('x-forwarded-for');
if ($clientAddress === '127.0.0.1') {
if (!empty($xri)) { // 如果有xri 則判定為前端有NGINX等代理
$clientAddress = $xri[0];
} elseif (!empty($xff)) { // 如果不存在xri 則繼續(xù)判斷xff
$list = explode(',', $xff[0]);
if (isset($list[0])) $clientAddress = $list[0];
}
}
return $clientAddress;
}
public function onException(\Throwable $throwable): void
{
if ($throwable instanceof ParamValidateError) {
$this->writeJson(Status::CODE_BAD_REQUEST,[], $throwable->getValidate()->getError()->__toString());
} else {
Trigger::getInstance()->throwable($throwable);
$this->writeJson(Status::CODE_INTERNAL_SERVER_ERROR, null, $throwable->getMessage());
}
}
}
Model
生成方法:
<?php
$generation = new \EasySwoole\CodeGeneration\InitBaseClass\Model\ModelGeneration();
$generation->generate();
類內(nèi)容:
<?php
namespace App\Model;
use EasySwoole\ORM\AbstractModel;
use EasySwoole\ORM\DbManager;
/**
* BaseModel
* Class BaseModel
* Create With ClassGeneration
*/
class BaseModel extends AbstractModel
{
public static function transaction(callable $callable)
{
try {
DbManager::getInstance()->startTransaction();
$result = $callable();
DbManager::getInstance()->commit();
return $result;
} catch (\Throwable $throwable) {
DbManager::getInstance()->rollback();
throw $throwable;;
}
}
}
UnitTest
生成方法:
<?php
$generation = new \EasySwoole\CodeGeneration\InitBaseClass\UnitTest\UnitTestGeneration();
$generation->generate();
類內(nèi)容:
<?php
namespace UnitTest;
use Curl\Curl;
use EasySwoole\EasySwoole\Core;
use PHPUnit\Framework\TestCase;
/**
* BaseTest
* Class BaseTest
* Create With ClassGeneration
*/
class BaseTest extends TestCase
{
public static $isInit = 0;
/** @var Curl */
public $curl;
public $apiBase = 'http://127.0.0.1:9501';
public $modelName;
public function request($action, $data = [], $modelName = null)
{
$modelName = $modelName ?? $this->modelName;
$url = $this->apiBase . '/' . $modelName . '/' . $action;
$curl = $this->curl;
$curl->post($url, $data);
if ($curl->response) {
// var_dump($curl->response);
} else {
echo 'Error: ' . $curl->errorCode . ': ' . $curl->errorMessage . "
";
}
$this->assertTrue(!!$curl->response);
$this->assertEquals(200, $curl->response->code, $curl->response->msg);
return $curl->response;
}
public function setUp()
{
if (self::$isInit == 1) {
return true;
}
require_once dirname(__FILE__, 2) . '/vendor/autoload.php';
defined('EASYSWOOLE_ROOT') or define('EASYSWOOLE_ROOT', dirname(__FILE__, 2));
require_once dirname(__FILE__, 2) . '/EasySwooleEvent.php';
Core::getInstance()->initialize()->globalInitialize();
self::$isInit = 1;
$this->curl = new Curl();
}
}