binhtv/grpc-base-laravel

Package help you implement grpc easier

v1.0.5 2022-04-01 00:49 UTC

This package is not auto-updated.

Last update: 2022-06-24 02:16:38 UTC


README

68747470733a2f2f73756e2d617374657269736b2e766e2f77702d636f6e74656e742f75706c6f6164732f323032302f31302f6c6f676f2d73756e4032782e706e67

About package

This is a product of programmer sun*.

This package has some class and method help yan can implement Grpc to Laravel easier. So improve system performance thanks to Grpc

How to use

composer require binhtv/grpc-base-laravel

then run command to publish config.

php artisan vendor:publish --tag=binhtv-grpc-config

You need know how to compile files proto with php

Client

  • Autoload file proto generated:
"autoload": {
        "psr-4": {
        ...
            "": "protos/generated/"
        },
        ...
    },
  • Quick call to server (recommend using)

    step 1: create class extend BaseGrpcApi;
<?php

namespace App\Services\MicroserviceGrpc;

use binhtv\GrpcLaravel\Client\Contracts\BaseGrpcApi;
use Google\Protobuf\Internal\Message;
use Illuminate\Http\Request;
use Protobuf\Company\ExampleServiceClient;

/**
 * @method Message ExampleMethod(array|Request $request)
 */

class ExampleGrpcClient extends BaseGrpcApi
{
    public function grpcClient(): string
    {
        return ExampleServiceClient::class;
    }
}

step 2: call method in that class;

<?php
 ...
// ExampleMethod is a method of ExampleServiceClient;
 (new ExampleGrpcClient())->ExampleMethod($request);
 ...
  • Or create new client Grpc
$clientGrpc = (new GrpcFactory)->make(ExampleServiceClient::class);
  • Use traits;
 ...
 use binhtv\GrpcLaravel\Client\Traits\HandleDataRequest;
 ...
 class ExampleController extends Controller
 {
    use HandleDataRequest;
 }
  • methods:
Name Params Return Description
mergeRequestToGrpcRequest - An object instance of Illuminate\Http\Request;
- Path of GRPC request class
object: grpc request Convert laravel request to grpc request
dataGrpc - An object instance of request or response GRPC Array: Array have a key is 'data' Create a array have key is 'data' and value is data grpc
prepareDataRequestFromGrpc - An object instance of request or response GRPC object: instance of Illuminate\Http\Request Convert grpc request to laravel request
removeLinkPagination - An array array Remove key 'links' and 'path' in array

Serve

  • Start serve:
./vendor/binhtv/grpc-base-laravel/rr-grpc serve -v -d
  • Example worker file:
<?php

declare(strict_types=1);

use App\Grpc\ExampleGrpcController;
use Spiral\Goridge\StreamRelay;
use Spiral\RoadRunner\Worker;

ini_set('display_errors', 'stderr');

require __DIR__.'/vendor/autoload.php';

$app = require_once __DIR__.'/bootstrap/app.php';

$app->singleton(
    binhtv\GrpcLaravel\Server\Contracts\Kernel::class,
    binhtv\GrpcLaravel\Server\Kernel::class
);

$app->singleton(
    binhtv\GrpcLaravel\Server\Contracts\ServiceInvoker::class,
    binhtv\GrpcLaravel\Server\LaravelServiceInvoker::class
);

$kernel = $app->make(binhtv\GrpcLaravel\Server\Kernel::class);

$kernel->registerService(ExampleGrpcController::class);

$w = new Worker(new StreamRelay(STDIN, STDOUT));

$kernel->serve($w);