https://github.com/danielliu1123/grpc-starter

Offering out-of-the-box, highly scalable Spring Boot starters for the cutting-edge ecosystem of gRPC. Embracing Spring Boot 3!
https://github.com/danielliu1123/grpc-starter

grpc grpc-spring-boot-starter java json-transcoding microservices protobuf protovalidate spring spring-boot springboot3

Last synced: about 2 months ago
JSON representation

Offering out-of-the-box, highly scalable Spring Boot starters for the cutting-edge ecosystem of gRPC. Embracing Spring Boot 3!

• Host: GitHub
• URL: https://github.com/danielliu1123/grpc-starter
• Owner: DanielLiu1123
• License: mit
• Created: 2023-04-29T01:13:44.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-17T14:58:20.000Z (8 months ago)
• Last Synced: 2024-04-17T15:09:34.014Z (8 months ago)
• Topics: grpc, grpc-spring-boot-starter, java, json-transcoding, microservices, protobuf, protovalidate, spring, spring-boot, springboot3
• Language: Java
• Homepage: https://danielliu1123.github.io/grpc-starter/
• Size: 918 KB
• Stars: 15
• Watchers: 2
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
#  gRPC Starter [![Build](https://img.shields.io/github/actions/workflow/status/DanielLiu1123/grpc-starter/build.yml?branch=main)](https://github.com/DanielLiu1123/grpc-starter/actions) [![Maven Central](https://img.shields.io/maven-central/v/io.github.danielliu1123/grpc-starter-dependencies?versionPrefix=3.)](https://central.sonatype.com/artifact/io.github.danielliu1123/grpc-starter-dependencies) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[gRPC](https://grpc.io/) is a high-performance RPC framework that supports multiple languages, concise service definitions, and streaming. It is an ideal choice for building scalable and efficient microservice systems.

This project provides out-of-the-box, highly extensible Spring Boot starters for the gRPC ecosystem, making the integration of Spring Boot and gRPC seamless and native.

## Features

### Core:

- Dependency management for gRPC-related libraries

- gRPC server autoconfiguration

    - [Exception handling](https://danielliu1123.github.io/grpc-starter/docs/server/exception-handing)

    - [Health check](https://danielliu1123.github.io/grpc-starter/docs/server/autoconfiguration#health)

- gRPC client autoconfiguration

    - [`@Autowired` support](https://danielliu1123.github.io/grpc-starter/docs/client/autoconfiguration#inject-client)

    - [Dynamic refreshing](https://danielliu1123.github.io/grpc-starter/docs/client/dynamic-refresh)

### Extensions:

- [gRPC HTTP transcoding](https://danielliu1123.github.io/grpc-starter/docs/extensions/grpc-http-transcoding): Support both gRPC and HTTP/JSON with a single codebase.

- [Protobuf validation](https://danielliu1123.github.io/grpc-starter/docs/extensions/protobuf-validation): Protobuf message validation using [protovalidate](https://github.com/bufbuild/protovalidate-java) and [protoc-gen-validate](https://github.com/bufbuild/protoc-gen-validate).

- [Metrics](https://danielliu1123.github.io/grpc-starter/docs/extensions/metrics): Integrate Spring Boot Actuator with gRPC services.

- [Tracing](https://danielliu1123.github.io/grpc-starter/docs/extensions/tracing): Integrate Spring Boot Actuator with gRPC server and client.

- [Testing](https://danielliu1123.github.io/grpc-starter/docs/extensions/test): Integration with `SpringBootTest`.

## Quick Start

```groovy

implementation(platform("io.github.danielliu1123:grpc-starter-dependencies:"))

implementation("io.github.danielliu1123:grpc-boot-starter")

implementation("io.grpc:grpc-testing-proto")

```

```java

@SpringBootApplication

public class SimpleApp extends SimpleServiceGrpc.SimpleServiceImplBase {

    public static void main(String[] args) {

        new SpringApplicationBuilder(SimpleApp.class)

                .properties("grpc.client.base-packages=io.grpc")

                .properties("grpc.client.authority=127.0.0.1:9090")

                .run(args);

    }

    @Override

    public void unaryRpc(SimpleRequest request, StreamObserver r) {

        var response = SimpleResponse.newBuilder()

                .setResponseMessage("Hello " + request.getRequestMessage())

                .build();

        r.onNext(response);

        r.onCompleted();

    }

    @Bean

    ApplicationRunner runner(SimpleServiceGrpc.SimpleServiceBlockingStub stub) {

        return args -> {

            var response = stub.unaryRpc(SimpleRequest.newBuilder().setRequestMessage("World!").build());

            System.out.println(response.getResponseMessage());

        };

    }

}

```

Refer to [quick-start](examples/quick-start).

## Documentation

Go to [Reference Documentation](https://danielliu1123.github.io/grpc-starter/docs/intro) for more information.

## Code of Conduct

This project is governed by the [Code of Conduct](./CODE_OF_CONDUCT.md).

By participating, you are expected to uphold this code of conduct.

Please report unacceptable behavior to [email protected].

## Contributing

Use the [issue tracker](https://github.com/DanielLiu1123/grpc-starter/issues) for bug reports, feature requests, and submitting pull requests.

If you would like to contribute to the project, please refer to [Contributing](./CONTRIBUTING.md).

## License

The MIT License.