Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/msteinhoff/dropwizard-grpc
A set of classes to use a gRPC server in a Dropwizard service.
https://github.com/msteinhoff/dropwizard-grpc
Last synced: about 2 months ago
JSON representation
A set of classes to use a gRPC server in a Dropwizard service.
- Host: GitHub
- URL: https://github.com/msteinhoff/dropwizard-grpc
- Owner: msteinhoff
- License: apache-2.0
- Archived: true
- Created: 2016-06-10T15:54:07.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-05-03T20:02:59.000Z (over 3 years ago)
- Last Synced: 2024-08-04T01:05:41.670Z (5 months ago)
- Language: Java
- Homepage: http://msteinhoff.github.io/dropwizard-grpc/
- Size: 248 KB
- Stars: 25
- Watchers: 6
- Forks: 9
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-dropwizard - dropwizard-grpc - use a gRPC server in a Dropwizard service (Open Source / Eclipse)
README
# Dropwizard gRPC
**⚠️ THIS PROJECT IS NOT MAINTAINED ANYMORE. ⚠️**
[](https://travis-ci.org/msteinhoff/dropwizard-grpc)
[](https://coveralls.io/r/msteinhoff/dropwizard-grpc)
[](https://bintray.com/msteinhoff/maven/dropwizard-grpc/1.2.3-2)
[](http://search.maven.org/#artifactdetails%7Cio.github.msteinhoff%7Cdropwizard-grpc%7C1.2.3-2%7C)
[](http://www.javadoc.io/doc/io.github.msteinhoff/dropwizard-grpc/1.2.3-2)
A set of classes to use [gRPC](1) server in a [Dropwizard](2) application.
The package provides [lifecycle-management](3) and configuration factory
classes with the most common options for gRPC `Server` and `ManagedChannel`
classes.
# Server
To embed a grpc server, add a `GrpcServerFactory` to your [Configuration](4)
class. This enables configuration of the grpc server port and transport
security files.
**ExampleServiceConfiguration.java**:
```java
class ExampleServiceConfiguration extends Configuration {
@Valid
@NotNull
private GrpcServerFactory grpcServer = new GrpcServerFactory();
@JsonProperty("grpcServer")
public GrpcServerFactory getGrpcServerFactory() {
return grpcServer;
}
@JsonProperty("grpcServer")
public void setGrpcServerFactory(final GrpcServerFactory grpcServer) {
this.grpcServer = grpcServer;
}
}
```
The following configuration settings are supported by `GrpcServerFactory`:
* `port`: Port number the gRPC server should bind on
* `shutdownDuration`: How long to wait before giving up when the server is shutdown
* `certChainFile`: (Optional) Path to the certificate chain file when TLS should be used
* `privateKeyFile`: (Optional) Path to the private key file when TLS should be used
**example-service.yml:**
```yaml
server:
[...]
logging:
[...]
grpcServer:
port: 8000
shutdownDuration: 10 seconds
```
In dropwizard's run method, use the `GrpcServerFactory` class to create a gRPC
`Server` instance. The `GrpcServerFactory` provides a `ServerBuilder` via
`builder()` to configure the Server instance, e.g. to add a custom executor or
to add gRPC service classes. The created server instance is also automatically
added to the dropwizard lifecycle.
**ExampleServiceApplication.java**:
```java
class ExampleServiceApplication extends Application {
[...]
@Override
public void run(final ExampleServiceConfiguration configuration, final Environment environment) throws IOException {
final Server grpcServer;
grpcServer = configuration.getGrpcServerFactory()
.builder(environment)
.addService(new ExampleService())
.build();
}
[...]
}
```
# Client
To embed a grpc channel for a server, add a `GrpcChannelFactory` to your
[Configuration](4) class. This enables configuration of the grpc channel
hostname and port.
**ExampleServiceConfiguration.java**:
```java
class ExampleServiceConfiguration extends Configuration {
@Valid
@NotNull
private GrpcChannelFactory externalService = new GrpcChannelFactory();
@JsonProperty("externalService")
public GrpcChannelFactory getExternalGrpcChannelFactory() {
return externalService;
}
@JsonProperty("externalService")
public void setExternalGrpcChannelFactory(final GrpcChannelFactory externalService) {
this.externalService = externalService;
}
}
```
The following configuration settings are supported by `GrpcChannelFactory`:
* `hostname`: Hostname of the gRPC server to connect to
* `port`: Port of the gRPC server to connect to
* `shutdownDuration`: How long to wait before giving up when the channel is
shutdown
**example-service.yml:**
```yaml
server:
[...]
logging:
[...]
externalService:
hostname: hostname.example.org
port: 8000
shutdownDuration: 10 seconds
```
In dropwizard's run method, use the `GrpcChannelFactory` class to create a gRPC
`ManagedChannel` instance. The created channel instance is also automatically
added to the dropwizard lifecycle. The returned `ManagedChannel` instance can
be used by other application components to send requests to the given server.
**ExampleServiceApplication.java**:
```java
class ExampleServiceApplication extends Application {
[...]
@Override
public void run(final ExampleServiceConfiguration configuration, final Environment environment) throws IOException {
final ManagedChannel externalServiceChannel;
externalServiceChannel = configuration.getExternalGrpcChannelFactory()
.build(environment);
// use externalServiceChannel
}
[...]
}
```
# Artifacts
This project is available on JCenter and Maven Central. To add it to your
project simply add the following dependency to your pom.xml:
io.github.msteinhoff
dropwizard-grpc
1.2.3-2
Or if you are using gradle:
repositories {
jcenter()
}
dependencies {
compile 'io.github.msteinhoff:dropwizard-grpc:1.2.3-2'
}
# Support
Please file bug reports and feature requests in [GitHub issues](5).
# License
Copyright (c) 2016-2018 Mario Steinhoff
This library is licensed under the Apache License, Version 2.0.
See http://www.apache.org/licenses/LICENSE-2.0.html or the LICENSE file in this
repository for the full license text.
[1]: https://www.grpc.io/
[2]: http://dropwizard.io/1.1.3/docs/
[3]: http://dropwizard.io/1.1.3/docs/manual/core.html#managed-objects
[4]: http://dropwizard.io/1.1.3/docs/manual/core.html#configuration
[5]: https://github.com/msteinhoff/dropwizard-grpc/issues/