This project is a pure-Crystal implementation of gRPC.
Add the dependency to your shard.yml
:
dependencies:
grpc:
github: jgaskins/grpc
Run shards install
Make sure you have Google's grpc
tools installed
brew install grpc
Write a protos/hello_world.proto
file that contains a service
entry and any message types it depends on:
syntax = "proto3";
service HelloWorld {
rpc MethodName (TheRequest) returns (TheResponse) {}
}
message TheRequest {
string text = 1;
}
message TheResponse {
string data = 1;
}
Compile the .proto
files. If your messages are defined in protos/hello_world.proto
and you want your code written out to the app's src/protobufs
directory, use the following command:
$ protoc -I protos \
--grpc_out=src/protobufs \
--crystal_out=src/protobufs \
--plugin=protoc-gen-grpc=bin/grpc_crystal \
--plugin=protoc-gen-crystal=bin/protoc-gen-crystal \
protos/hello_world.proto
This compiles both the service and the messages.
To handle gRPC requests for the above service definition, we need 3 things:
Services are compiled into abstract classes with the protoc
command above. To implement a handler for a given service, we subclass the generated abstract class, defining the methods with snake_cased names:
require "./protobufs/hello_world_services.pb"
require "./protobufs/hello_world.pb"
class HelloWorldHandler < HelloWorld
# You can define your own initialize method to inject dependencies
def method_name(request : TheRequest) : TheResponse
unless request.text.presence
raise GRPC::BadStatus.new(:invalid_argument, "Text cannot be blank.")
end
TheResponse.new(data: "Hello #{request.text}")
end
end
The methods defined in the service declaration are required to be implemented by this class. Your program will not compile without them.
require "grpc"
grpc = GRPC::Server.new
grpc << HelloWorldHandler.new
You can add as many service handlers as you like.
The HTTP2::Server
works similarly to HTTP::Server
:
require "grpc/http2"
server = HTTP2::ClearTextServer.new([grpc]) # TLS isn't supported yet
server.listen "0.0.0.0", 50000
And now gRPC requests for your HelloWorld
service will be handled by HelloWorldHandler
.
To write a client to consume the HelloWorld
service, you simply use a Stub
:
# Load the service and message definitions
require "./protobufs/hello_world_services.pb"
require "./protobufs/hello_world.pb"
HelloWorldService = HelloWorld::Stub.new("localhost", 50000)
# from anywhere in your app
pp HelloWorldService.method_name(TheRequest.new(text: "foo"))
# => TheResponse(@data="Hello foo")
This implementation currently only supports "simple gRPC" — send a synchronous request, get a synchronous response. Streaming is not yet implemented.
TODO: Write development instructions here
git checkout -b my-new-feature
)git commit -am 'Add some feature'
)git push origin my-new-feature
)