Merge pull request #395 from yidongnan/documentation/stubfactory2

Add extra docs page for the other grpc-java flavors / stub factories

Author: yidongnan

README.md

@@ -15,19 +15,35 @@ README: [English](README.md) | [中文](README-zh-CN.md)
 
 ## Features
 
-* Auto configures and runs the embedded gRPC server with `@GrpcService`-enabled beans as part of your spring-boot
-application
+* Automatically configures and runs the gRPC server with your `@GrpcService` implementations
 
 * Automatically creates and manages your grpc channels and stubs with `@GrpcClient`
 
-* Supports [Spring Cloud](https://spring.io/projects/spring-cloud) (register services to [Consul](https://github.com/spring-cloud/spring-cloud-consul) or [Eureka](https://github.com/spring-cloud/spring-cloud-netflix) or [Nacos](https://github.com/spring-cloud-incubator/spring-cloud-alibaba) and fetch gRPC server information)
-
-* Supports [Spring Sleuth](https://github.com/spring-cloud/spring-cloud-sleuth) as distributed tracing solution (If [brave-instrumentation-grpc](https://mvnrepository.com/artifact/io.zipkin.brave/brave-instrumentation-grpc) is present)
+* Supports other grpc-java flavors (e.g.
+  [Reactive gRPC (RxJava)](https://github.com/salesforce/reactive-grpc/tree/master/rx-java),
+  [grpc-kotlin](https://github.com/grpc/grpc-kotlin), ...)
+  * Server-side: Should work for all grpc-java flavors (`io.grpc.BindableService` based)
+  * Client-side: Requires custom `StubFactory`s\
+    Currently build-in support:
+    * grpc-java
+    * (Please report missing ones, so we can add support for them)
+
+* Supports [Spring-Security](https://github.com/spring-projects/spring-security)
+
+* Supports [Spring Cloud](https://spring.io/projects/spring-cloud)
+  * Server-side: Adds grpc-port information to the service registration details\
+    Currently natively supported:
+    * [Consul](https://github.com/spring-cloud/spring-cloud-consul)
+    * [Eureka](https://github.com/spring-cloud/spring-cloud-netflix)
+    * [Nacos](https://github.com/spring-cloud-incubator/spring-cloud-alibaba)
+    * (Please report missing ones, so we can add support for them)
+  * Client-side: Reads the service's target addresses from spring's `DiscoveryClient` (all flavors)
+
+* Supports [Spring Sleuth](https://github.com/spring-cloud/spring-cloud-sleuth) as distributed tracing solution\
+  (If [brave-instrumentation-grpc](https://mvnrepository.com/artifact/io.zipkin.brave/brave-instrumentation-grpc) is present)
 
 * Supports global and custom gRPC server/client interceptors
 
-* [Spring-Security](https://github.com/spring-projects/spring-security) support
-
 * Automatic metric support ([micrometer](https://micrometer.io/)/[actuator](https://github.com/spring-projects/spring-boot/tree/master/spring-boot-project/spring-boot-actuator) based)
 
 * Also works with (non-shaded) grpc-netty
@@ -129,6 +145,7 @@ dependencies {
   compile 'net.devh:grpc-client-spring-boot-starter:2.9.0.RELEASE'
 }
 ````
+
 Annotate a field of your grpc client stub with `@GrpcClient(serverName)`
 
 * Do not use in conjunction with `@Autowired` or `@Inject`

docs/en/flavors.md

@@ -0,0 +1,46 @@
+# gRPC-Java Flavors
+
+Aside from [grpc-java](https://github.com/grpc/grpc-java/), this library also supports other java based
+grpc-implementations.
+
+| Flavor | Server | Client |
+| ---  | --- | --- |
+| [grpc-java](https://github.com/grpc/grpc-java/) | ✔️ | ✔️ |
+| [Reactive gRPC (Reactor)](https://github.com/salesforce/reactive-grpc/tree/master/reactor) | ✔️ | ✏️ |
+| [Reactive gRPC (RxJava)](https://github.com/salesforce/reactive-grpc/tree/master/rx-java) | ✔️ | ✏️ |
+| [grpc-kotlin](https://github.com/grpc/grpc-kotlin) | ✔️ | ✏️ |
+| [ScalaPB](https://scalapb.github.io/grpc.html) | ✔️ | ✏️ |
+| [akka-grpc](https://github.com/akka/akka-grpc) | ✔️ | ✏️ |
+| ... | ✔️ | ✏️ |
+
+*✔️ = Build-in support* |
+*✏️ = Requires customization*
+
+> **Note:** You might require additional dependencies depending on your grpc java flavor.
+
+## Server side
+
+The server side should work without any additional configuration. Just annotatate your implementation of the generated
+`BindableService` class with `@GrpcService` and it will be picked up automatically.
+
+See also:
+
+- [Server - Getting Started](server/getting-started.md)
+
+## Client side
+
+The client side requires a `StubFactory` for each type of stub.
+
+This library ships the following stub factory beans by default:
+
+- gRPC-Java
+  - `AbstractAsyncStub` -> `AsyncStubFactory`
+  - `AbstractBlockingStub` -> `BlockingStubFactory`
+  - `AbstractFutureStub` -> `FutureStubFactory`
+
+Please report missing stub types so that we can add support for them.
+
+See also:
+
+- [Client - Getting Started](client/getting-started.md)
+- [Client - Configuration - StubFactory](client/configuration.md#stubfactory)

docs/en/index.md

@@ -23,6 +23,7 @@ customization you need for your project.
 - Others setups
 - [Trouble-Shooting](trouble-shooting.md)
 - [Example Projects](examples.md)
+- [gRPC-Java Flavors](flavors.md)
 - [Version Overview](versions.md)
 - [Spring Boot Actuator / Metrics Support](actuator.md)
 - [Brave-Tracing / Spring Cloud Sleuth Support](brave.md)