code-generation 2.x (代码生成组件)

EasySwoole 代码生成组件，使用命令行就可以一键生成业务通用代码，支持生成的代码如下：

  • 一键生成 项目初始化 baseController、baseModel、baseUnitTest；
  • 一键生成 表 Model，自带属性注释；
  • 一键生成 表 curd 控制器，自带 5 个 curd 方法；
  • 一键生成 控制器单元测试用例，测试 5 个 curd 方法。

组件版本说明

code-generation 组件当前最新稳定版本为 2.x，code-generation 2.x 相对于 1.x 版本，兼容了 EasySwoole 的最新注解组件，支持了新的 EasySwoole 文档自动生成，以及最新的 phpunit 版本，同时完善了 Model->getList 返回参数，以及控制器 getOne、getList 的 response 参数注解。

注：code-generation 1.x 版本组件文档详见 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

仓库地址

easyswoole/code-generation 2.x

基本使用

配置文件 dev.php 配置如下：

  1. <?php
  2. return [
  3.     'SERVER_NAME' => "EasySwoole",
  4.     'MAIN_SERVER' => [
  5.         'LISTEN_ADDRESS' => '0.0.0.0',
  6.         'PORT' => 9501,
  7.         'SERVER_TYPE' => EASYSWOOLE_WEB_SERVER, //可选为 EASYSWOOLE_SERVER  EASYSWOOLE_WEB_SERVER EASYSWOOLE_WEB_SOCKET_SERVER
  8.         'SOCK_TYPE' => SWOOLE_TCP,
  9.         'RUN_MODEL' => SWOOLE_PROCESS,
  10.         'SETTING' => [
  11.             'worker_num' => 8,
  12.             'reload_async' => true,
  13.             'max_wait_time' => 3
  14.         ],
  15.         'TASK' => [
  16.             'workerNum' => 4,
  17.             'maxRunningNum' => 128,
  18.             'timeout' => 15
  19.         ]
  20.     ],
  21.     'TEMP_DIR' => null,
  22.     'LOG_DIR' => null,
  23.     'MYSQL' => [
  24.         'host'          => '127.0.0.1',
  25.         'port'          => 3306,
  26.         'user'          => 'easyswoole',
  27.         'timeout'       => 5,
  28.         'charset'       => 'utf8mb4',
  29.         'password'      => 'easyswoole100%',
  30.         'database'      => 'easyswoole',
  31.         'maxObjectNum'  => 20,
  32.         'minObjectNum'  => 5,
  33.         'getObjectTimeout'  => 3.0,
  34.     ]
  35. ];

在项目根目录新建一个 TestCodeGeneration.php，代码内容如下：

  1. <?php
  3. include __DIR__ . "/vendor/autoload.php";
  5. \EasySwoole\EasySwoole\Core::getInstance()->initialize();
  7. go(function () {
  8.     // 生成基础类
  9.     $generation = new \EasySwoole\CodeGeneration\InitBaseClass\Controller\ControllerGeneration();
  10.     $generation->generate();
  11.     $generation = new \EasySwoole\CodeGeneration\InitBaseClass\UnitTest\UnitTestGeneration();
  12.     $generation->generate();
  13.     $generation = new \EasySwoole\CodeGeneration\InitBaseClass\Model\ModelGeneration();
  14.     $generation->generate();
  16.     // 获取 dev.php 中的 MYSQL 配置文件，配置文件具体说明请看：https://www.easyswoole.com/QuickStart/config.html
  17.     $mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
  19.     // 获取数据库连接
  20.     $connection = new \EasySwoole\ORM\Db\Connection($mysqlConfig);
  22.     // 指定表名(这里以 user_list 表作为示例表，表结构请看下文)
  23.     $tableName = 'user_list';
  24.     $codeGeneration = new EasySwoole\CodeGeneration\CodeGeneration($tableName, $connection);
  26.     // 生成 model (默认生成模型的路径前缀为 App\Model 目录，例如：如下生成的模型文件为 User模型【\App\Model\User\UserModel.php】 和 基础模型【\App\Model\User\BaseModel.php】)
  27.     $codeGeneration->generationModel("\\User");
  29.     // 生成 controller (默认生成控制器的路径前缀为 App\HttpController 目录，例如：如下生成的控制器文件为 User控制器【\App\Model\Api\User\User.php】 和 基础控制器【\App\HttpController\Api\Base.php】)
  30.     $codeGeneration->generationController("\\Api\\User", null);
  32.     // 生成 unitTest (默认生成 unitTest 的路径前缀为项目根目录的 UnitTest 目录，例如：如下生成的单元测试用例为 UserTest【UnitTest\Api\User\UserTest.php】 和 基础单元测试用例【UnitTest\BaseTest.php】)
  33.     $codeGeneration->generationUnitTest("\\Api\\User", null);
  34. });
  35. \Swoole\Timer::clearAll();

在配置好数据库和数据库配置文件之后，然后在项目根目录运行 TestCodeGeneration.php(php TestCodeGeneration.php)，即可看到自动生成的模型、控制器和单元测试用例。

EasySwoole\CodeGeneration\CodeGeneration 方法可自行查看，代码很简单。

示例表结构(user_list)

  1. CREATE TABLE `user_list` (
  2.   `id` int(11) NOT NULL,
  3.   `name` varchar(50) DEFAULT NULL,
  4.   `age` int(11) DEFAULT NULL,
  5.   `email` varchar(100) DEFAULT NULL,
  6.   PRIMARY KEY (`id`)
  7. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

命令行使用

由于命令行特殊的特性，命令行功能支持并不完善，如果想要体验全部功能，请使用 \EasySwoole\CodeGeneration\CodeGeneration 生成，或参考 \EasySwoole\CodeGeneration\CodeGeneration 代码生成。

注册命令

配置数据库配置文件 dev.php，配置文件内容详见上文。

在 EasySwoole 项目根目录中的 bootstrap.php(即 bootstrap事件) 中使用 Di 注入配置项:

  1. <?php
  2. // 全局bootstrap事件
  3. date_default_timezone_set('Asia/Shanghai');
  5. \EasySwoole\EasySwoole\Core::getInstance()->initialize();
  7. ## 1 直接注入 mysql 连接
  8. // 获取 dev.php 中的 MYSQL 配置文件，配置文件具体说明请看：https://www.easyswoole.com/QuickStart/config.html
  9. $mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
  10. // 获取连接
  11. $connection = new \EasySwoole\ORM\Db\Connection($mysqlConfig);
  12. \EasySwoole\Component\Di::getInstance()->set('CodeGeneration.connection', $connection);
  14. ## 2 直接注入 mysql 配置对象
  15. //   $mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
  16. //   \EasySwoole\Component\Di::getInstance()->set('CodeGeneration.connection', $mysqlConfig);
  18. ## 3 直接注入 mysql 配置项
  19. //   \EasySwoole\Component\Di::getInstance()->set('CodeGeneration.connection',\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
  21. // 以上 3 种注入 mysql 连接的方式均可，用户可以任选 1 种进行注入 mysql
  23. // 注入执行目录项，后面的为默认值，initClass 不能通过注入改变目录
  24. \EasySwoole\Component\Di::getInstance()->set('CodeGeneration.modelBaseNameSpace', "App\\Model");
  25. \EasySwoole\Component\Di::getInstance()->set('CodeGeneration.controllerBaseNameSpace', "App\\HttpController");
  26. \EasySwoole\Component\Di::getInstance()->set('CodeGeneration.unitTestBaseNameSpace', "UnitTest");
  27. \EasySwoole\Component\Di::getInstance()->set('CodeGeneration.rootPath', getcwd());

然后即可使用命令实现自动生成代码，具体使用命令如下（使用如下命令前提：必须先在 bootstrap事件 中使用 Di 注册上述说明的配置项）：

  1. php ./vendor/bin/code-generator
  2.  ______                          _____                              _
  3. |  ____|                        / ____|                            | |
  4. | |__      __ _   ___   _   _  | (___   __      __   ___     ___   | |   ___
  5. |  __|    / _` | / __| | | | |  \___ \  \ \ /\ / /  / _ \   / _ \  | |  / _ \
  6. | |____  | (_| | \__ \ | |_| |  ____) |  \ V  V /  | (_) | | (_) | | | |  __/
  7. |______|  \__,_| |___/  \__, | |_____/    \_/\_/    \___/   \___/  |_|  \___|
  8.                          __/ |
  9.                         |___/
  11. Code auto generation tool
  12. Usage:
  13.   ./vendor/bin/code-generator ACTION [--opts ...]
  14. Actions:
  15.   init  initialization
  16.   all   specify build
  17. Options:
  18.   --tableName       specify table name
  19.   --modelPath       specify model path
  20.   --controllerPath  specify controller path
  21.   --unitTestPath    specify unit-test path
  23. php ./vendor/bin/code-generator all --tableName="tableName" --modelPath="生成的模型所在目录" [--controllerPath="生成的控制器所在目录"] [--unitTestPath="生成的单元测试用例所在目录"]
  25. // 生成基础模型(BaseModel)、基础控制器(BaseController)、基础单元测试用例(BaseUnitTest)
  26. php ./vendor/bin/code-generator init
  28. // 自动生成指定的模型、控制器、单元测试用例和 基础模型、基础控制器、基础单元测试用例
  29. php vendor/bin/code-generator all --tableName="user_list" --modelPath="\\User" --controllerPath="\\Api\\User" --unitTestPath="\\User"

执行结果示例如下：

  1. [root@localhost es-code-generation]# php ./vendor/bin/code-generator init
  2. ┌────────────┬─────────────────────────────────────────────────────────────────────┐
  3. │ className  │                              filePath                               │
  4. ├────────────┼─────────────────────────────────────────────────────────────────────┤
  5. │ Model      │ /www/wwwroot/easyswoole-code-generation/App/Model/BaseModel.php     │
  6. ├────────────┼─────────────────────────────────────────────────────────────────────┤
  7. │ Controller │ /www/wwwroot/easyswoole-code-generation/App/HttpController/Base.php │
  8. ├────────────┼─────────────────────────────────────────────────────────────────────┤
  9. │ UnitTest   │ /www/wwwroot/easyswoole-code-generation/UnitTest/BaseTest.php       │
  10. └────────────┴─────────────────────────────────────────────────────────────────────┘
  12. [root@localhost es-code-generation]# php ./vendor/bin/code-generator all --tableName="user_list" --modelPath="\\User" --controllerPath="\\Api\\User" --unitTestPath="\\User"
  13. ┌────────────┬──────────────────────────────────────────────────────────────────────────────┐
  14. │ className  │                                   filePath                                   │
  15. ├────────────┼──────────────────────────────────────────────────────────────────────────────┤
  16. │ Model      │ /www/wwwroot/easyswoole-code-generation/App/Model/User/UserModel.php         │
  17. ├────────────┼──────────────────────────────────────────────────────────────────────────────┤
  18. │ Controller │ /www/wwwroot/easyswoole-code-generation/App/HttpController/Api/User/User.php │
  19. ├────────────┼──────────────────────────────────────────────────────────────────────────────┤
  20. │ UnitTest   │ /www/wwwroot/easyswoole-code-generation/UnitTest/User/UserTest.php           │
  21. └────────────┴──────────────────────────────────────────────────────────────────────────────┘

独立使用

生成器流程说明

  • 通过 \EasySwoole\ORM\Utility\TableObjectGeneration，传入 \EasySwoole\ORM\Db\Connection 连接对象，通过 generationTable 方法获取表结构对象；
  • 实例化类生成器配置，配置命名空间、生成文件路径、类名等(详情看下面)；
  • 实例化生成器对象，调用 generate方法生成。

生成器基础配置项

  • extendClass 继承类，默认为\EasySwoole\ORM\AbstractModel::class
  • directory 生成路径,生成路径默认为 rootPath+namespace对应路径,namespace路径将自动通过composer.json->(autoload/autoload-dev)['psr-4'] 配置目录生成,如果没有则默认为根目录
  • namespace 命名空间配置.
  • className 类名
  • rootPath 项目根目录,默认为执行目录.

获取数据表结构

所有生成器都依赖于数据表结构对象EasySwoole\ORM\Utility\Schema\Table

  1. <?php
  2. $mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
  3. //获取连接
  4. $connection = new \EasySwoole\ORM\Db\Connection($mysqlConfig);
  5. $tableName = 'user_list';
  6. //获取数据表结构对象
  7. $tableObjectGeneration = new \EasySwoole\ORM\Utility\TableObjectGeneration($connection, $tableName);
  8. $schemaInfo = $tableObjectGeneration->generationTable();

Model生成

Model配置项说明

  • extendClass 继承类,默认为\EasySwoole\ORM\AbstractModel::class
  • directory 生成路径,生成路径默认为 rootPath+namespace对应路径,namespace路径将自动通过composer.json->(autoload/autoload-dev)['psr-4'] 配置目录生成,如果没有则默认为根目录
  • namespace 命名空间配置.默认为 App\Model
  • className 类名,Model配置无效,强制为realTableName+fileSuffix
  • rootPath 项目根目录,默认为执行目录.
  • tablePre 表前缀,如果有配置,es_user 表=> UserModel
  • table 表结构对象
  • realTableName 真实表名,通过下划线形式转为大驼峰,自动转化.用于生成最后的类名和文件名.
  • fileSuffix 文件后缀,默认为Model,用于生成最后的类名和文件名.
  • ignoreString 默认为[‘list’, ‘log’], //生成时忽略表名存在的字符,例如user_list将生成=>UserModel

Model生成示例:

  1. <?php
  2. /**
  3.  * Created by PhpStorm.
  4.  * User: tioncico
  5.  * Date: 2020-05-20
  6.  * Time: 10:26
  7.  */
  8. include "./vendor/autoload.php";
  10. \EasySwoole\EasySwoole\Core::getInstance()->initialize();
  12. go(function () {
  13.     $mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
  14.     //获取连接
  15.     $connection = new \EasySwoole\ORM\Db\Connection($mysqlConfig);
  16.     $tableName = 'user_list';
  17.     //获取数据表结构对象
  18.     $tableObjectGeneration = new \EasySwoole\ORM\Utility\TableObjectGeneration($connection, $tableName);
  19.     $schemaInfo = $tableObjectGeneration->generationTable();
  21.     $tablePre = '';//表前缀
  22.     $path = "App\\Model";
  23.     $extendClass = \EasySwoole\ORM\AbstractModel::class;
  24.     $modelConfig = new \EasySwoole\CodeGeneration\ModelGeneration\ModelConfig($schemaInfo, $tablePre, "{$path}", $extendClass);
  25.     $modelConfig->setRootPath(EASYSWOOLE_ROOT);//设置项目运行目录,默认为当前执行脚本目录.
  26.     $modelConfig->setIgnoreString(['list', 'log']);//生成时忽略表名存在的字符,例如user_list将生成=>UserModel
  28.     $modelGeneration = new \EasySwoole\CodeGeneration\ModelGeneration\ModelGeneration($modelConfig);
  29.     $result = $modelGeneration->generate();
  30.     var_dump($result);//生成成功返回生成文件路径,否则返回false
  31. });
  32. \Swoole\Timer::clearAll();

Model方法

Model方法默认生成一个GetList方法,用于获取列表.

  1. <?php
  2. public function getList(int $page = 1, int $pageSize = 10, string $field = '*'): array
  3. {
  4.     $list = $this
  5.         ->withTotalCount()
  6.         ->order($this->schemaInfo()->getPkFiledName(), 'DESC')
  7.         ->field($field)
  8.         ->page($page, $pageSize)
  9.         ->all();
  10.     $total = $this->lastQueryResult()->getTotalCount();;
  11.     return ['total' => $total, 'list' => $list];
  12. }

可参考EasySwoole\CodeGeneration\ModelGeneration\Method\GetList自定义其他方法.再进行注入即可.

  1. addGenerationMethod(new \EasySwoole\CodeGeneration\ModelGeneration\Method\GetList($modelGeneration));

Controller生成

Controller 配置项说明

Controller配置项继承与Model配置项

  • modelClass Model类类名(包含命名空间),Controller生成依赖于Model,所以需要传入Model类类名
  • authSessionName 权限验证session参数名,比如在需要用户登录的控制器方法中,都需要传入session字段名用于验权,controller将在生成方法时自动生成验证这个session参数的注解,默认为空
  • extendClass 继承类,默认为\EasySwoole\HttpAnnotation\AnnotationController
  • directory 生成路径,生成路径默认为 rootPath+namespace对应路径,namespace路径将自动通过composer.json->(autoload/autoload-dev)['psr-4'] 配置目录生成,如果没有则默认为根目录
  • namespace 命名空间配置.默认为 App\\HttpController
  • className 类名,Model配置无效,强制为realTableName+fileSuffix
  • fileSuffix 文件后缀,默认为空,用于生成最后的类名和文件名.
  • ignoreString 默认为[‘list’, ‘log’], //生成时忽略表名存在的字符,例如user_list将生成=>User

controller生成示例

  1. <?php
  2. /**
  3.  * Created by PhpStorm.
  4.  * User: tioncico
  5.  * Date: 2020-05-20
  6.  * Time: 10:26
  7.  */
  8. include "./vendor/autoload.php";
  9. \EasySwoole\EasySwoole\Core::getInstance()->initialize();
  11. go(function () {
  12.     $mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
  13.     //获取连接
  14.     $connection = new \EasySwoole\ORM\Db\Connection($mysqlConfig);
  15.     $tableName = 'user_list';
  16.     //获取数据表结构对象
  17.     $tableObjectGeneration = new \EasySwoole\ORM\Utility\TableObjectGeneration($connection, $tableName);
  18.     $schemaInfo = $tableObjectGeneration->generationTable();
  20.     $tablePre = '';//表前缀
  21.     $path = "App\\HttpController";
  22.     $extendClass = \EasySwoole\HttpAnnotation\AnnotationController::class;
  23.     $modelClass = \App\Model\UserModel::class;//$modelGeneration->getConfig()->getNamespace() . '\\' . $modelGeneration->getClassName();
  24.     $controllerConfig = new \EasySwoole\CodeGeneration\ControllerGeneration\ControllerConfig($modelClass, $schemaInfo, $tablePre, "{$path}", $extendClass);
  25.     $controllerConfig->setRootPath(EASYSWOOLE_ROOT);
  26.     $controllerGeneration = new \EasySwoole\CodeGeneration\ControllerGeneration\ControllerGeneration($controllerConfig);
  27.     $result = $controllerGeneration->generate();
  28.     var_dump($result);
  29. });
  30. \Swoole\Timer::clearAll();

Controller方法.

Controller支持了5个方法,Add,Delete,GetList,GetOne,Update. 自定义其他方法可参考Model方法自定义.

unitTest

单元测试生成器生成.生成后的文件为作者本人自定义风格代码,需要依赖于BaseUnitTest

  1. <?php
  3. namespace UnitTest;
  5. use Curl\Curl;
  6. use EasySwoole\EasySwoole\Core;
  7. use PHPUnit\Framework\TestCase;
  9. /**
  10.  * BaseTest
  11.  * Class BaseTest
  12.  * Create With ClassGeneration
  13.  */
  14. class BaseTest extends TestCase
  15. {
  16.     public static $isInit = 0;
  18.     /** @var Curl */
  19.     public $curl;
  20.     public $apiBase = 'http://127.0.0.1:9501';
  21.     public $modelName;
  23.     public function request($action, $data = [], $modelName = null)
  24.     {
  25.         $modelName = $modelName ?? $this->modelName;
  26.         $url = $this->apiBase . '/' . $modelName . '/' . $action;
  27.         $curl = $this->curl;
  28.         $curl->post($url, $data);
  29.         if ($curl->response) {
  30.         //            var_dump($curl->response);
  31.         } else {
  32.             echo 'Error: ' . $curl->errorCode . ': ' . $curl->errorMessage . "
  33. ";
  34.         }
  35.         $this->assertTrue(!!$curl->response);
  36.         $this->assertEquals(200, $curl->response->code, $curl->response->msg);
  37.         return $curl->response;
  38.     }
  40.     public function setUp()
  41.     {
  42.         if (self::$isInit == 1) {
  43.             return true;
  44.         }
  45.         require_once dirname(__FILE__, 2) . '/vendor/autoload.php';
  46.         defined('EASYSWOOLE_ROOT') or define('EASYSWOOLE_ROOT', dirname(__FILE__, 2));
  47.         require_once dirname(__FILE__, 2) . '/EasySwooleEvent.php';
  48.         Core::getInstance()->initialize()->globalInitialize();
  49.         self::$isInit = 1;
  50.         $this->curl = new Curl();
  51.     }
  52. }

unitTest配置项说明

unitTest配置项继承于Model配置项

  • modelClass Model类类名(包含命名空间),UnitTest生成依赖于Model,所以需要传入Model类类名
  • ControllerClass ControllerClass类类名(包含命名空间),UnitTest生成依赖于ControllerClass,所以需要传入ControllerClass类类名
  • extendClass 继承类,默认为\PHPUnit\Framework\TestCase
  • directory 生成路径,生成路径默认为 rootPath+namespace对应路径,namespace路径将自动通过composer.json->(autoload/autoload-dev)['psr-4'] 配置目录生成,如果没有则默认为根目录
  • namespace 命名空间配置.默认为 UnitTest
  • className 类名,Model配置无效,强制为realTableName+fileSuffix
  • fileSuffix 文件后缀,默认为Test,用于生成最后的类名和文件名.
  • ignoreString 默认为[‘list’, ‘log’], //生成时忽略表名存在的字符,例如user_list将生成=>UserTest

unitTest生成示例

  1. <?php
  2. /**
  3.  * Created by PhpStorm.
  4.  * User: tioncico
  5.  * Date: 2020-05-20
  6.  * Time: 10:26
  7.  */
  8. include "./vendor/autoload.php";
  9. \EasySwoole\EasySwoole\Core::getInstance()->initialize();
  11. go(function () {
  12.     $mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
  13.     //获取连接
  14.     $connection = new \EasySwoole\ORM\Db\Connection($mysqlConfig);
  15.     $tableName = 'user_list';
  16.     //获取数据表结构对象
  17.     $tableObjectGeneration = new \EasySwoole\ORM\Utility\TableObjectGeneration($connection, $tableName);
  18.     $schemaInfo = $tableObjectGeneration->generationTable();
  20.     $path = "UnitTest";
  21.     $modelClass = \App\Model\UserModel::class;
  22.     $controllerClass= \App\HttpController\User::class;
  23.     $extendClass = \PHPUnit\Framework\TestCase::class;
  24.     $tablePre = '';//表前缀
  25.     $controllerConfig = new \EasySwoole\CodeGeneration\UnitTest\UnitTestConfig($modelClass, $controllerClass, $schemaInfo, $tablePre, "{$path}", $extendClass);
  26.     $controllerConfig->setRootPath(EASYSWOOLE_ROOT);
  27.     $unitTestGeneration = new \EasySwoole\CodeGeneration\UnitTest\UnitTestGeneration($controllerConfig);
  28.     $result = $unitTestGeneration->generate();
  29.     var_dump($result);
  30. });
  31. \Swoole\Timer::clearAll();

UnitTest方法.

UnitTest支持了5个方法,Add,Delete,GetList,GetOne,Update. 自定义其他方法可参考Model方法自定义.

初始化类

为了方便开发,提供了Controller,Model,UnitTest的初始化类.

Controller

生成方法:

  1. <?php
  2. $generation = new \EasySwoole\CodeGeneration\InitBaseClass\Controller\ControllerGeneration();
  3.     $generation->generate();

类内容:

  1. <?php
  3. namespace App\HttpController;
  5. use EasySwoole\EasySwoole\ServerManager;
  6. use EasySwoole\EasySwoole\Trigger;
  7. use EasySwoole\HttpAnnotation\AnnotationController;
  8. use EasySwoole\HttpAnnotation\Exception\Annotation\ParamValidateError;
  9. use EasySwoole\Http\Message\Status;
  11. /**
  12.  * Base
  13.  * Class Base
  14.  * Create With ClassGeneration
  15.  */
  16. class Base extends AnnotationController
  17. {
  18.     public function index()
  19.     {
  20.         $this->actionNotFound('index');
  21.     }
  23.     public function clientRealIP($headerName = 'x-real-ip')
  24.     {
  25.         $server = ServerManager::getInstance()->getSwooleServer();
  26.         $client = $server->getClientInfo($this->request()->getSwooleRequest()->fd);
  27.         $clientAddress = $client['remote_ip'];
  28.         $xri = $this->request()->getHeader($headerName);
  29.         $xff = $this->request()->getHeader('x-forwarded-for');
  30.         if ($clientAddress === '127.0.0.1') {
  31.             if (!empty($xri)) {  // 如果有xri 则判定为前端有NGINX等代理
  32.                 $clientAddress = $xri[0];
  33.             } elseif (!empty($xff)) {  // 如果不存在xri 则继续判断xff
  34.                 $list = explode(',', $xff[0]);
  35.                 if (isset($list[0])) $clientAddress = $list[0];
  36.             }
  37.         }
  38.         return $clientAddress;
  39.     }
  41.     public function onException(\Throwable $throwable): void
  42.     {
  43.         if ($throwable instanceof ParamValidateError) {
  44.             $this->writeJson(Status::CODE_BAD_REQUEST,[], $throwable->getValidate()->getError()->__toString());
  45.         }  else {
  46.             Trigger::getInstance()->throwable($throwable);
  47.             $this->writeJson(Status::CODE_INTERNAL_SERVER_ERROR, null, $throwable->getMessage());
  48.         }
  49.     }
  50. }

Model

生成方法:

  1. <?php
  2. $generation = new \EasySwoole\CodeGeneration\InitBaseClass\Model\ModelGeneration();
  3. $generation->generate();

类内容:

  1. <?php
  3. namespace App\Model;
  5. use EasySwoole\ORM\AbstractModel;
  6. use EasySwoole\ORM\DbManager;
  8. /**
  9.  * BaseModel
  10.  * Class BaseModel
  11.  * Create With ClassGeneration
  12.  */
  13. class BaseModel extends AbstractModel
  14. {
  15.     public static function transaction(callable $callable)
  16.     {
  17.         try {
  18.             DbManager::getInstance()->startTransaction();
  19.             $result = $callable();
  20.             DbManager::getInstance()->commit();
  21.             return $result;
  22.         } catch (\Throwable $throwable) {
  23.             DbManager::getInstance()->rollback();
  24.             throw $throwable;;
  25.         }
  26.     }
  27. }

UnitTest

生成方法:

  1. <?php
  2. $generation = new \EasySwoole\CodeGeneration\InitBaseClass\UnitTest\UnitTestGeneration();
  3. $generation->generate();

类内容:

  1. <?php
  3. namespace UnitTest;
  5. use Curl\Curl;
  6. use EasySwoole\EasySwoole\Core;
  7. use PHPUnit\Framework\TestCase;
  9. /**
  10.  * BaseTest
  11.  * Class BaseTest
  12.  * Create With ClassGeneration
  13.  */
  14. class BaseTest extends TestCase
  15. {
  16.     public static $isInit = 0;
  18.     /** @var Curl */
  19.     public $curl;
  20.     public $apiBase = 'http://127.0.0.1:9501';
  21.     public $modelName;
  23.     public function request($action, $data = [], $modelName = null)
  24.     {
  25.         $modelName = $modelName ?? $this->modelName;
  26.         $url = $this->apiBase . '/' . $modelName . '/' . $action;
  27.         $curl = $this->curl;
  28.         $curl->post($url, $data);
  29.         if ($curl->response) {
  30.         //            var_dump($curl->response);
  31.         } else {
  32.             echo 'Error: ' . $curl->errorCode . ': ' . $curl->errorMessage . "
  33. ";
  34.         }
  35.         $this->assertTrue(!!$curl->response);
  36.         $this->assertEquals(200, $curl->response->code, $curl->response->msg);
  37.         return $curl->response;
  38.     }
  40.     public function setUp()
  41.     {
  42.         if (self::$isInit == 1) {
  43.             return true;
  44.         }
  45.         require_once dirname(__FILE__, 2) . '/vendor/autoload.php';
  46.         defined('EASYSWOOLE_ROOT') or define('EASYSWOOLE_ROOT', dirname(__FILE__, 2));
  47.         require_once dirname(__FILE__, 2) . '/EasySwooleEvent.php';
  48.         Core::getInstance()->initialize()->globalInitialize();
  49.         self::$isInit = 1;
  50.         $this->curl = new Curl();
  51.     }
  52. }