https://github.com/kumuluz/kumuluzee-grpc
KumuluzEE gRPC project for enabling gRPC protocol for KumuluzEE microservices.
https://github.com/kumuluz/kumuluzee-grpc
cloud-native ee4j grpc java javaee kumuluzee microprofile microservices
Last synced: about 23 hours ago
JSON representation
KumuluzEE gRPC project for enabling gRPC protocol for KumuluzEE microservices.
- Host: GitHub
- URL: https://github.com/kumuluz/kumuluzee-grpc
- Owner: kumuluz
- License: other
- Created: 2018-04-09T18:56:28.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-05T20:44:11.000Z (almost 2 years ago)
- Last Synced: 2025-04-09T19:55:54.391Z (2 months ago)
- Topics: cloud-native, ee4j, grpc, java, javaee, kumuluzee, microprofile, microservices
- Language: Java
- Size: 71.3 KB
- Stars: 0
- Watchers: 15
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# KumuluzEE gRPC
[](https://travis-ci.org/kumuluz/kumuluzee-grpc)
> KumuluzEE gRPC project for enabling gRPC protocol for KumuluzEE microservices.
## Usage
You can enable the KumuluzEE gRPC extension by adding the following dependency:
```xml
com.kumuluz.ee.grpc
kumuluzee-grpc
${kumuluz-grpc.version}
```
## Server
**@GrpcService annotation**
To enable gRPC communication gRPC services must be implemented and annotated with @GrpcService annotation.
Additionally for each service one or many interceptor(s) can be added. To bind interceptor to service
**@GrpcInterceptor** annotation should be used as @GrpcService "interceptors" parameter e.g.
```java
@GrpcService(interceptors = {
@GrpcInterceptor(name = "full.class.path.name"),
@GrpcInterceptor(name = "full.class.path.name2")
})
public class GrpcServiceImpl extends ServiceGrpc.ServiceGrpcBaseImpl {
// service implementation
}
```
Each service can be secured using JWT tokens. To enable call security, `security` parameter of @GrpcService annotation must be set to
**true** (**false** by default). Public key and issuer must be provided in configuration file as follows:
```yaml
grpc:
server:
auth:
public-key: MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnOTgnGBISzm3pKuG8QXMVm6eEuTZx8Wqc8D9gy7vArzyE5QC/bVJNFwlz...
issuer: http://example.org/auth
```
More about gRPC protocol can be found on [webpage](https://grpc.io).
gRPC implementation, tutorials and samples can be found [here](https://github.com/grpc/grpc-java).
## Client
Helper class is provided to simplify client configuration. GrpcClient class provides
seamless channel creation. Client configuration is done with GrpcClientConf which automatically
reads data from configuration file. To override port and address, overloaded constructor can be used.
*default configuration*
```java
try {
GrpcClientConf clientConf = new GrpcClientConf("localhost", 8080);
GrpcClient client = new GrpcClient(clientConf);
stub = UserGrpc.newStub(client.getChannel());
} catch (ConfigurationException | SSLException e) {
logger.warning(e.getMessage());
}
```
When calling services secured with JWT tokens, token must be provided and applied using JWTCallCredentials class.
```java
stub = UserGrpc.newStub(client.getChannel()).withCallCredentials(new JWTCallCredentials(JWT_TOKEN));
```
## gRPC configuration
Specific server configuration such as port number,
server address, tls options... can be configured in config source (config.yml).
When using GrpcClientConf helper class, configuration for client must also be provided.
Example:
```yaml
kumuluzee:
name: gRPC sample
grpc:
server:
base-url: http://localhost:8080
http:
port: 8081
https:
enable: true
port: 8443
certFile: /path/to/cert/file
keyFile: /path/to/key/file
chainFile: /path/to/chain/file
mutualTLS: optional
auth:
public-key: MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnOTgnGBISzm3pKuG8QXMVm6eEuTZx8Wqc8D9gy7vArzyE5QC/bVJNFwlz...
issuer: http://example.org/auth
clients:
- name: client1
port: 8081
address: localhost
certFile: /path/to/cert/file
keyFile: /path/to/key/file
chainFile: /path/to/chain/file
```
Example shows all available options for extension. Required fields are:
* server
* http
* port
* clients (required if using GrpcClientConf helper class)
* client[i].name
* client[i].port
* client[i].address
When using secure connection via TLS, "certFile" and "keyFile" must be present
in the server section and "chainFile" in client section. If mutual TLS connection
is required "chainFile" path must be set. Default value for "mutualTLS" parameter is "optional".
Additionally "keyFile" and "chainFile" must be set on client side.
Extension can be disabled by setting `enabled` property to `false` (defaults to `true`).
```yaml
kumuluzee:
grpc:
enabled: false
```
### Generate Java classes from Protobuf files
For protobuf code generation with Maven you can use protobuf-maven-plugin.
It will locate .proto files in /src/main/proto and generated Java classes.
```xml
kr.motd.maven
os-maven-plugin
1.5.0.Final
org.xolstice.maven.plugins
protobuf-maven-plugin
0.5.1
com.google.protobuf:protoc:3.5.1-1:exe:${os.detected.classifier}
grpc-java
io.grpc:protoc-gen-grpc-java:1.15.1:exe:${os.detected.classifier}
compile
compile-custom
```
# Issues
* CDI injection does not work on Grpc service implementation *(when implementing service on server side
final ServerServiceDefinition class is used)*. CDI lookup must be explicitly called programmatically using
CDI lookup:
```java
UserBean bean = CDI.current().select(UserBean.class).get();
```