imiphp / project-grpc
imi 框架的 Grpc 项目。https://imiphp.com
Installs: 65
Dependents: 0
Suggesters: 0
Security: 0
Stars: 6
Watchers: 2
Forks: 0
Open Issues: 0
Type:project
Requires
- php: >=7.4
- imiphp/imi: ~2.1.0
- imiphp/imi-grpc: ~2.1.0
- imiphp/imi-swoole: ~2.1.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ~3.4.0
- phpstan/phpstan: ~1.8.0
- phpunit/phpunit: ~9.5.0
- swoole/ide-helper: ^4.8
README
这是一个 imi gRPC 项目开发骨架项目,你可以基于这个项目来开发你的项目。
imi 框架:https://www.imiphp.com
imi 文档:https://doc.imiphp.com
内置了 HTTP 代理网关的实现 GrpcServer/Controller/ProxyController.php
。
安装
创建项目:composer create-project imiphp/project-grpc:~2.1.0
配置
项目命名空间
默认是 ImiApp
,可以在 composer.json
中修改:
-
autoload.psr-4.ImiApp
-
imi.namespace
然后替换代码中的命名空间即可。
运行配置
项目配置目录:config
gRPC 服务器配置目录:GrpcServer/config
启动命令
vendor/bin/imi-swoole swoole/start
测试代码
curl --location "http://127.0.0.1:8080/proxy/grpc/grpc.TestService/test" \ --header 'Content-Type: application/json' \ --data '{ "int": 114514 }' \ -vvv
权限
.runtime
目录需要有可写权限
Grpc Protobuf
修改 proto 文件后必须要重新生成。
Grpc 的 protobuf 生成:cd grpc && protoc --php_out=./ grpc.proto
protoc 下载和安装:https://github.com/protocolbuffers/protobuf/releases
生产环境
关闭热更新:config/beans.php
中 hotUpdate.status
设为 false
代码质量
格式化代码
内置 php-cs-fixer
,统一代码风格。
配置文件 .php-cs-fixer.php
,可根据自己实际需要进行配置,文档:https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/master/doc/config.rst
格式化项目: ./vendor/bin/php-cs-fixer fix
格式化指定文件: ./vendor/bin/php-cs-fixer fix test.php
代码静态分析
内置 phpstan
,可规范代码,排查出一些隐藏问题。
配置文件 phpstan.neon
,可根据自己实际需要进行配置,文档:https://phpstan.org/config-reference
分析项目: ./vendor/bin/phpstan
分析指定文件: ./vendor/bin/phpstan test.php
测试用例
内置 phpunit
,可以实现自动化测试。
文档:https://phpunit.readthedocs.io/en/9.5/
测试用例 demo:tests/Module/Test/TestServiceTest.php
运行测试用例:composer test