Download the PHP package easyswoole/code-generation without Composer
On this page you can find all versions of the php package easyswoole/code-generation. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package code-generation
2.x版本说明
2.x相对于1.x版本,兼容了easyswoole
的最新注解组件,支持了新的easyswoole文档自动生成,以及最新的phpunit
版本,同时完善了Model->getList返回参数
,以及控制器getOne,getList
的response参数注解
code-generation
easyswoole代码生成组件,可使用命令行,代码一键生成业务通用代码,支持代码如下:
- 一键生成项目初始化 baseController,baseModel,baseUnitTest.
- 一键生成 表Model ,自带属性注释
- 一键生成 表 curd控制器,自带5个curd方法
- 一键生成 控制器单元测试用例,测试5个curd方法
安装
使用
::: warning
EasySwoole\CodeGeneration\CodeGeneration
方法可自行查看,代码很简单.
:::
注册命令
在bootstrap事件
Di注入配置项:
执行命令:
初始化:
自定义:
参数:
- --tableName 必须指定
- --modelPath 必须指定 模型
- --controllerPath 控制器
- --unitTestPath 单元测试
示例:
独立使用
生成器流程说明
- 通过
\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
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生成示例:
Model方法
Model方法默认生成一个GetList
方法,用于获取列表.
::: warning
可参考EasySwoole\CodeGeneration\ModelGeneration\Method\GetList
自定义其他方法.再进行注入即可.
:::
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生成示例
Controller方法.
Controller支持了5个方法,Add
,Delete
,GetList
,GetOne
,Update
.
自定义其他方法可参考Model方法自定义.
unitTest
单元测试生成器生成.生成后的文件为作者本人自定义风格代码,需要依赖于BaseUnitTest
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生成示例
UnitTest方法.
UnitTest支持了5个方法,Add
,Delete
,GetList
,GetOne
,Update
.
自定义其他方法可参考Model方法自定义.
初始化类
为了方便开发,提供了Controller,Model,UnitTest的初始化类.
Controller
生成方法:
类内容:
Model
生成方法:
类内容:
UnitTest
生成方法:
类内容:
All versions of code-generation with dependencies
easyswoole/socket Version ^1.0
easyswoole/orm Version ^1.4
nette/php-generator Version ^3.2
easyswoole/http-annotation Version ^2.0
php-curl-class/php-curl-class Version ^8.5
easyswoole/command Version ^1.1