ssvwsm/grpc-base-laravel

Package help you implement grpc easier

2.0.0 2024-10-25 07:56 UTC

Requires

• php: ^8.2
• google/common-protos: dev-main
• google/protobuf: ^4.29@RC
• grpc/grpc: dev-master
• laravel/octane: 2.x-dev
• spiral/roadrunner: dev-master

MIT

README

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 ssvwsm/grpc-base-laravel

then run command to publish config.

php artisan vendor:publish --tag=ssvwsm-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 SSVWSM\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 SSVWSM\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/ssvwsm/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(
    SSVWSM\GrpcLaravel\Server\Contracts\Kernel::class,
    SSVWSM\GrpcLaravel\Server\Kernel::class
);

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

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

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

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

$kernel->serve($w);