easyswoole/code-generation

Maintainers

Details

github.com/easy-swoole/code-generation

Source

Issues

Installs: 6 489

Dependents: 2

Suggesters: 0

Security: 0

Stars: 13

Watchers: 2

Forks: 7

Open Issues: 1

2.1.3 2021-09-16 08:54 UTC

Requires

Requires (Dev)

Apache-2.0 b368cecb133ffe611bdae11cf17bf9f187d8fc63

  • tioncico <1067197739.woop@qq.com>

This package is auto-updated.

Last update: 2023-11-16 13:49:23 UTC

README

2.x相对于1.x版本,兼容了easyswoole的最新注解组件,支持了新的easyswoole文档自动生成,以及最新的phpunit版本,同时完善了Model->getList返回参数,以及控制器getOne,getList的response参数注解

code-generation

easyswoole代码生成组件,可使用命令行,代码一键生成业务通用代码,支持代码如下:

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

安装

composer require easyswoole/code-generation

使用

<?php
/**
 * Created by PhpStorm.
 * User: tioncico
 * Date: 2020-05-20
 * Time: 10:26
 */

include "./vendor/autoload.php";
\EasySwoole\EasySwoole\Core::getInstance()->initialize()->globalInitialize();

go(function () {
    //生成基础类

    $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();
    

    $mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
    //获取连接
    $connection = new \EasySwoole\ORM\Db\Connection($mysqlConfig);
    $tableName = 'user_list';

    $codeGeneration = new EasySwoole\CodeGeneration\CodeGeneration($tableName, $connection);
    //生成model
    $codeGeneration->generationModel("\\User");
    //生成controller
    $codeGeneration->generationController("\\Api\\User", null);
    //生成unitTest
    $codeGeneration->generationUnitTest("\\User", null);
});

::: warning EasySwoole\CodeGeneration\CodeGeneration 方法可自行查看,代码很简单.
:::

注册命令

在bootstrap事件Di注入配置项:

<?php
/**
 * Created by PhpStorm.
 * User: tioncico
 * Date: 2020-05-21
 * Time: 11:20
 */

\EasySwoole\EasySwoole\Core::getInstance()->initialize();
$mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
//获取连接
$connection = new \EasySwoole\ORM\Db\Connection($mysqlConfig);
//注入mysql连接
\EasySwoole\Component\Di::getInstance()->set('CodeGeneration.connection',$connection);
//直接注入mysql配置对象
\EasySwoole\Component\Di::getInstance()->set('CodeGeneration.connection',$mysqlConfig);
//直接注入mysql配置项
//\EasySwoole\Component\Di::getInstance()->set('CodeGeneration.connection',\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));

//注入执行目录项,后面的为默认值,initClass不能通过注入改变目录
\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());

执行命令:

php vendor/bin/code-generator

初始化:

php vendor/bin/code-generator init

自定义:

php vendor/bin/code-generator all

参数：

  • --tableName 必须指定
  • --modelPath 必须指定 模型
  • --controllerPath 控制器
  • --unitTestPath 单元测试

示例：

$ php vendor/bin/code-generator all --tableName=test_a --modelPath=\\Api --controllerPath=\\Api --unitTestPath=\\Api
┌────────────┬────────────────────────────────────────────────────────────────────────────┐
│ className  │                                  filePath                                  │
├────────────┼────────────────────────────────────────────────────────────────────────────┤
│ Model      │ /Users/gaobinzhan/Documents/Git/Framework/App/Model/Api/TestAModel.php     │
├────────────┼────────────────────────────────────────────────────────────────────────────┤
│ Controller │ /Users/gaobinzhan/Documents/Git/Framework/App/HttpController/Api/TestA.php │
├────────────┼────────────────────────────────────────────────────────────────────────────┤
│ UnitTest   │ /Users/gaobinzhan/Documents/Git/Framework/UnitTest/Api/TestATest.php       │
└────────────┴────────────────────────────────────────────────────────────────────────────┘

独立使用

生成器流程说明

  • 通过\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

<?php
$mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
//获取连接
$connection = new \EasySwoole\ORM\Db\Connection($mysqlConfig);
$tableName = 'user_list';
//获取数据表结构对象
$tableObjectGeneration = new \EasySwoole\ORM\Utility\TableObjectGeneration($connection, $tableName);
$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生成示例:

<?php
/**
 * Created by PhpStorm.
 * User: tioncico
 * Date: 2020-05-20
 * Time: 10:26
 */
include "./vendor/autoload.php";
\EasySwoole\EasySwoole\Core::getInstance()->initialize()->globalInitialize();

go(function () {
    $mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
    //获取连接
    $connection = new \EasySwoole\ORM\Db\Connection($mysqlConfig);
    $tableName = 'user_list';
    //获取数据表结构对象
    $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);//设置项目运行目录,默认为当前执行脚本目录.
    $modelConfig->setIgnoreString(['list', 'log']);//生成时忽略表名存在的字符,例如user_list将生成=>UserModel

    $modelGeneration = new \EasySwoole\CodeGeneration\ModelGeneration\ModelGeneration($modelConfig);
    $result = $modelGeneration->generate();
    var_dump($result);//生成成功返回生成文件路径,否则返回false
});

Model方法

Model方法默认生成一个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();
    $data = [
        'page'=>$page,
        'pageSize'=>$pageSize,
        'list'=>$list,
        'total'=>$total,
        'pageCount'=>ceil($total / $pageSize)
    ];
    return $data;
}

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

<?php
$modelGeneration = new \EasySwoole\CodeGeneration\ModelGeneration\ModelGeneration($modelConfig);
//注入GetList方法
$modelGeneration->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生成示例

<?php
/**
 * Created by PhpStorm.
 * User: tioncico
 * Date: 2020-05-20
 * Time: 10:26
 */
include "./vendor/autoload.php";
\EasySwoole\EasySwoole\Core::getInstance()->initialize()->globalInitialize();

go(function () {
    $mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
    //获取连接
    $connection = new \EasySwoole\ORM\Db\Connection($mysqlConfig);
    $tableName = 'user_list';
    //获取数据表结构对象
    $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);
});

Controller方法.

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

unitTest

单元测试生成器生成.生成后的文件为作者本人自定义风格代码,需要依赖于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;
	}


	protected function setUp(): void
	{
		if (self::$isInit == 1) {
		    return;
		}
		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();
		self::$isInit = 1;
		$this->curl = new Curl();
	}
}

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生成示例

<?php
/**
 * Created by PhpStorm.
 * User: tioncico
 * Date: 2020-05-20
 * Time: 10:26
 */
include "./vendor/autoload.php";
\EasySwoole\EasySwoole\Core::getInstance()->initialize()->globalInitialize();

go(function () {
    $mysqlConfig = new \EasySwoole\ORM\Db\Config(\EasySwoole\EasySwoole\Config::getInstance()->getConf('MYSQL'));
    //获取连接
    $connection = new \EasySwoole\ORM\Db\Connection($mysqlConfig);
    $tableName = 'user_list';
    //获取数据表结构对象
    $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);
});

UnitTest方法.

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

初始化类

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

Controller

生成方法:

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

类内容:

<?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 则继续判断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();

类内容:

<?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();

类内容:

<?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;
	}


	protected function setUp(): void
	{
		if (self::$isInit == 1) {
		    return;
		}
		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();
		self::$isInit = 1;
		$this->curl = new Curl();
	}
}