gRPC Server with PHP

The easiest approach to implement a gRPC server with PHP is using the grpc/grpc extension. This extension provides the necessary bindings for compiling and running gRPC services. You'll define your service using the Protocol Buffer language (.proto), generate PHP code from the .proto file using the Protocol Buffer compiler (protoc), then implement the server-side logic within the generated PHP classes, handling incoming requests and responding according to your service definition. Finally, you'll create a server instance, register your service implementation, and start listening for connections on a specified port.

Implementing a gRPC server in PHP is straightforward when using the gRPC PHP extension. Here's the easiest approach:

1. Install Prerequisites

• Install PHP: Ensure you have PHP 7.4+ installed.
• Install Composer: PHP’s dependency manager.
• Install gRPC PHP Extension:

  • On Linux:

    pecl install grpc
    

  • On macOS (Homebrew):

    brew install grpc
    pecl install grpc
    

  • Verify the extension:

    php -m | grep grpc
    

2. Install Required Packages

Add the grpc and protobuf packages to your project using Composer:

composer require grpc/grpc google/protobuf

3. Define the .proto File

Create a proto directory and add your .proto definition, e.g., proto/helloworld.proto:

syntax = "proto3";

package helloworld;

// The greeting service definition.
service Greeter {
  rpc SayHello (HelloRequest) returns (HelloReply);
}

// The request message containing the user's name.
message HelloRequest {
  string name = 1;
}

// The response message containing the greetings.
message HelloReply {
  string message = 1;
}

4. Generate PHP Classes from .proto

Install the Protocol Buffers compiler (protoc) and the PHP plugin.

• Install protoc:
  • On macOS: brew install protobuf
  • On Ubuntu: sudo apt install protobuf-compiler

• Install PHP plugin for protoc:

  composer global require grpc/protoc-gen-php-grpc
  

Ensure the plugin is in your $PATH:

export PATH="$PATH:$HOME/.composer/vendor/bin"

• Generate PHP files:

  protoc --proto_path=proto --php_out=./generated --grpc_out=./generated --plugin=protoc-gen-grpc=$(which protoc-gen-php-grpc) proto/helloworld.proto
  

This generates GreeterClient.php and GreeterServer.php in the generated directory.

5. Implement the Server

Create a PHP file (e.g., server.php) and implement the service:

<?php
require 'vendor/autoload.php';
require 'generated/GPBMetadata/Helloworld.php';
require 'generated/Helloworld/GreeterClient.php';
require 'generated/Helloworld/GreeterServer.php';

use Helloworld\GreeterServer;
use Helloworld\HelloReply;
use Helloworld\HelloRequest;
use Grpc\Server;

class GreeterImpl extends GreeterServer
{
    public function SayHello(HelloRequest $request): HelloReply
    {
        $response = new HelloReply();
        $response->setMessage("Hello, " . $request->getName());
        return $response;
    }
}

// Create the server
$server = new Server();
$server->addHttp2Port('0.0.0.0:50051');
$server->handle(new GreeterImpl());

echo "Server running at 0.0.0.0:50051\n";
$server->run();

6. Run the Server

Start the server:

php server.php

You should see:

Server running at 0.0.0.0:50051

7. Implement the Client

Create a PHP file (e.g., client.php) to call the server:

<?php
require 'vendor/autoload.php';
require 'generated/GPBMetadata/Helloworld.php';
require 'generated/Helloworld/GreeterClient.php';
require 'generated/Helloworld/HelloRequest.php';

use Helloworld\GreeterClient;
use Helloworld\HelloRequest;

$client = new GreeterClient('localhost:50051', [
    'credentials' => \Grpc\ChannelCredentials::createInsecure(),
]);

$request = new HelloRequest();
$request->setName('World');

list($response, $status) = $client->SayHello($request)->wait();

if ($status->code === \Grpc\STATUS_OK) {
    echo "Response: " . $response->getMessage() . "\n";
} else {
    echo "Error: " . $status->details . "\n";
}

8. Run the Client

Start the client:

php client.php

You should see:

Response: Hello, World

Summary

• Server: server.php runs the gRPC server.
• Client: client.php calls the gRPC server.
• Tools Used: Composer for dependencies, Protocol Buffers for gRPC definitions, and the gRPC PHP extension for communication.

This is the easiest and cleanest way to set up a gRPC server with PHP!