Sample project for a gRPC (& ReST) web service

A simple project to showcase a gRPC webservice in combination with Spring Boot. For detailed information what gRPC is, see the block quote.

Project contains three submodules, server and the corresponding client to consume the webservice. Definied .proto files have their own module, since either server and client then have the same reference compiling .proto files.

please have a look at gRPC for further information

Modules

Following listing of submodules are beeing used in this project.

Proto

Mainly used to specifiy .proto files, which are beeing used by either servers or clients. Instead of modifying every single .proto file now you can simply modifiy this one in the submodule, and the change is beeing made in all referenced maven projects.

Generating .proto files is os (operating system) independant.

Server

Server side implementation was done with grpc-spring-boot-starter. Alternatively there exists another grpc-spring-boot-starter, but the first one mentioned has more to offer out of the box.

Hint: There is no official grpc-spring-boot-starter supported by the spring-boot team.

Client

As already mentioned in section server, client side implementation was done similarily.

gRPC misc

On my way to exploring, understanding and implement a gRPC service I encountered a very nice tool, similar to postman.

BloomRPC
A very nice introduction to gRPC with spring in Java and hands-on tutorial, I'll recommend grpc-java-example
For a first insight how to throw and handle errors with gRPC, this resource is helpful

kubernetes (& gRPC)

For a detailed setup with gRPC and kubernetes, have a look at gRPC kubernetes setup. If you have a running kubernetes cluster, with some finetuning the current deployment (under root directory) works for the server- & clientside.

server
- exposed with loadbalancer (directly callable)
client
- exposed with loadbalancer
- calls server via dynamic grpclb (see link above)

question GrpcAdvice

hi anjeyy,

I'd like some help @anjeyy, how to set up the GrpcAdvice in my project.
I've realized that you're one of the contributors from the grpc-spring-boot-starter.

I've set up a class with GrpcAdvice to get the exception from the class anotated with @GrpcService.
The problem is, I couldn't get any exception treatment once they never invoke the class anotated with GrpcAdvice

bellow part with the code, and if you can help, I'll appreciate.

@GrpcAdvice
public class GrpcExceptionAdvice {

@GrpcExceptionHandler
public Status handleInvalidArgument(IllegalArgumentException e) {
    return Status.UNAUTHENTICATED.withDescription("Não autenticado").withCause(e);
}

//Service
@GrpcService
public class SearchPersonServiceGrpcImpl extends ReactorPersonServiceGrpc.PersonServiceImplBase implements SearchPersonServiceGrpc {

@Autowired
private JwtUtil jwtUtil;

@Autowired
private PersonDatabaseExternal<PersonOrm, String> repository;

@Autowired
private OrmToResponseAdapter<EnrichmentResponseGrpc, PersonOrm> converter;

private final Log log = LogFactory.getLog(SearchPersonServiceGrpcImpl.class);

@Override
public Mono<EnrichmentResponseGrpc> enrich(Mono<EnrichmentRequestGrpc> request) {
    return request.flatMap(requestGrpc -> {
        if (isValidToken(requestGrpc.getToken())) {
            return Mono.error(new IllegalArgumentException ("error")); //throw an exception but the GrpcAdvice not invoked
        }

}
}

anjeyy / grpc-sample Goto Github PK

grpc-sample's Introduction

Sample project for a gRPC (& ReST) web service

Modules

Proto

Server

Client

gRPC misc

kubernetes (& gRPC)

grpc-sample's People

Contributors

Stargazers

Watchers

grpc-sample's Issues

TODO

Recommend Projects

Recommend Topics

Recommend Org