https://github.com/imiphp/project-grpc
这是一个 imi gRPC 项目开发骨架项目，你可以基于这个项目来开发你的项目。
https://github.com/imiphp/project-grpc
Last synced: about 1 year ago
JSON representation
这是一个 imi gRPC 项目开发骨架项目，你可以基于这个项目来开发你的项目。
- Host: GitHub
- URL: https://github.com/imiphp/project-grpc
- Owner: imiphp
- Created: 2022-08-12T07:42:50.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-17T06:19:05.000Z (almost 3 years ago)
- Last Synced: 2024-05-23T01:31:30.172Z (about 2 years ago)
- Language: PHP
- Homepage: https://www.imiphp.com/
- Size: 22.5 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 说明
这是一个 imi gRPC 项目开发骨架项目，你可以基于这个项目来开发你的项目。
imi 框架：
imi 文档：
内置了 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`
## 测试代码
```shell
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 下载和安装：
## 生产环境
**关闭热更新：**`config/beans.php` 中 `hotUpdate.status` 设为 `false`
## 代码质量
### 格式化代码
内置 `php-cs-fixer`，统一代码风格。
配置文件 `.php-cs-fixer.php`，可根据自己实际需要进行配置，文档：
**格式化项目：** `./vendor/bin/php-cs-fixer fix`
**格式化指定文件：** `./vendor/bin/php-cs-fixer fix test.php`
### 代码静态分析
内置 `phpstan`，可规范代码，排查出一些隐藏问题。
配置文件 `phpstan.neon`，可根据自己实际需要进行配置，文档：
**分析项目：** `./vendor/bin/phpstan`
**分析指定文件：** `./vendor/bin/phpstan test.php`
### 测试用例
内置 `phpunit`，可以实现自动化测试。
**文档：**
**测试用例 demo：**`tests/Module/Test/TestServiceTest.php`
**运行测试用例：**`composer test`