Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spiral/php-grpc
:electric_plug: Fast and furious GRPC server for PHP applications
https://github.com/spiral/php-grpc
golang grpc grpc-server php php-grpc php7 roadrunner spiral tls
Last synced: 3 months ago
JSON representation
:electric_plug: Fast and furious GRPC server for PHP applications
- Host: GitHub
- URL: https://github.com/spiral/php-grpc
- Owner: spiral-modules
- License: mit
- Archived: true
- Created: 2018-10-10T07:19:39.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-01-20T20:24:02.000Z (almost 3 years ago)
- Last Synced: 2023-12-20T12:03:09.686Z (11 months ago)
- Topics: golang, grpc, grpc-server, php, php-grpc, php7, roadrunner, spiral, tls
- Language: Go
- Homepage:
- Size: 12.5 MB
- Stars: 477
- Watchers: 27
- Forks: 50
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
⚠️ RRv2 `protoc-gen-php-grpc` releases are here: https://github.com/roadrunner-server/roadrunner/releases ⚠️
⚠️ `PHP Client` for the RRv2 is here: https://github.com/spiral/roadrunner-grpc ⚠️
PHP-GRPC
=================================
[](https://packagist.org/packages/spiral/php-grpc)
[](https://godoc.org/github.com/spiral/php-grpc)
[](https://github.com/spiral/roadrunner-plugins/actions)
[](https://github.com/spiral/roadrunner-plugins/actions)
[](https://goreportcard.com/report/github.com/spiral/php-grpc)
[](https://lgtm.com/projects/g/spiral/php-grpc/alerts/)
[](https://codecov.io/gh/spiral/php-grpc/)
PHP-GRPC is an open-source (MIT) high-performance PHP [GRPC](https://grpc.io/) server build at top of [RoadRunner](https://github.com/spiral/roadrunner).
Server support both PHP and Golang services running within one application.
Note:
-------
For the RoadRunner v2, please use the [RR-GRPC](https://github.com/spiral/roadrunner-grpc) library.
Documentation:
--------
* [Installation and Configuration](https://spiral.dev/docs/grpc-configuration)
* [Service Code](https://spiral.dev/docs/grpc-service)
* [Client SDK](https://spiral.dev/docs/grpc-client)
* [Golang Services](https://spiral.dev/docs/grpc-golang)
* [Data Streaming](https://spiral.dev/docs/grpc-streaming)
Features:
--------
- native Golang GRPC implementation compliant
- minimal configuration, plug-and-play model
- very fast, low footprint proxy
- simple TLS configuration
- debug tools included
- Prometheus metrics
- middleware and server customization support
- code generation using `protoc` plugin (`go get github.com/spiral/php-grpc/cmd/protoc-gen-php-grpc`)
- transport, message, worker error management
- response error codes over php exceptions
- works on Windows
Usage:
--------
Install `rr-grpc` and `protoc-gen-php-grpc` by building it or use [pre-build binaries](https://github.com/spiral/php-grpc/releases).
Define your service schema using proto file. You can scaffold protobuf classes and GRPC [service interfaces](https://github.com/spiral/php-grpc/blob/master/example/server/src/Service/EchoInterface.php) using:
```
$ protoc --php_out=target-dir/ --php-grpc_out=target-dir/ sample.proto
```
> Make sure to install [protoc compiler](https://github.com/protocolbuffers/protobuf) and run `composer require spiral/php-grpc` first
[Implement](https://github.com/spiral/php-grpc/blob/master/example/server/src/EchoService.php) needed classes and create [worker.php](https://github.com/spiral/php-grpc/blob/master/example/server/worker.php) to invoke your services.
Place [.rr.yaml](https://github.com/spiral/php-grpc/blob/master/example/server/.rr.yaml) (or any other format supported by viper configurator) into the root of your project. You can run your application now:
```
$ rr-grpc serve -v -d
```
To reset workers state:
```
$ rr-grpc grpc:reset
```
To show workers statistics:
```
$ rr-grpc grpc:workers -i
```
> See [example](https://github.com/spiral/php-grpc/tree/master/example).
You can find more details regarding server configuration at [RoadRunner Wiki](https://roadrunner.dev/docs).
License:
--------
MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information. Maintained by [SpiralScout](https://spiralscout.com).