grpc-spring-boot-starter源码，可以学习下spring的starter怎么来实现

# gRPC Spring Boot Starter [](https://github.com/yidongnan/grpc-spring-boot-starter/actions) [](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22net.devh%22%20grpc) [](LICENSE) [](https://crowdin.com/project/grpc-spring-boot-starter) [](https://www.javadoc.io/doc/net.devh/grpc-client-spring-boot-autoconfigure) [](https://www.javadoc.io/doc/net.devh/grpc-server-spring-boot-autoconfigure) [](https://www.javadoc.io/doc/net.devh/grpc-common-spring-boot) README: [English](README.md) | [中文](README-zh-CN.md) **Documentation:** [English](https://yidongnan.github.io/grpc-spring-boot-starter/en/) | [中文](https://yidongnan.github.io/grpc-spring-boot-starter/zh-CN/) ## Features * Automatically configures and runs the gRPC server with your `@GrpcService` implementations * Automatically creates and manages your grpc channels and stubs with `@GrpcClient` * 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 * 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 ## Versions The latest version is `2.13.1.RELEASE` it was compiled with spring-boot `2.5.8` and spring-cloud `2020.0.5` but it is also compatible with a large variety of other versions. An overview of all versions and their respective library versions can be found in our [documentation](https://yidongnan.github.io/grpc-spring-boot-starter/en/versions.html). **Note:** This project can also be used without Spring-Boot, however that requires some manual bean configuration. ## Usage ### gRPC Server + Client To add a dependency using Maven, use the following: ````xml <dependency> <groupId>net.devh</groupId> <artifactId>grpc-spring-boot-starter</artifactId> <version>2.13.1.RELEASE</version> </dependency> ```` To add a dependency using Gradle: ````gradle dependencies { implementation 'net.devh:grpc-spring-boot-starter:2.13.1.RELEASE' } ```` ### gRPC Server To add a dependency using Maven, use the following: ````xml <dependency> <groupId>net.devh</groupId> <artifactId>grpc-server-spring-boot-starter</artifactId> <version>2.13.1.RELEASE</version> </dependency> ```` To add a dependency using Gradle: ````gradle dependencies { implementation 'net.devh:grpc-server-spring-boot-starter:2.13.1.RELEASE' } ```` Annotate your server interface implementation(s) with ``@GrpcService`` ````java @GrpcService public class GrpcServerService extends GreeterGrpc.GreeterImplBase { @Override public void sayHello(HelloRequest req, StreamObserver<HelloReply> responseObserver) { HelloReply reply = HelloReply.newBuilder().setMessage("Hello ==> " + req.getName()).build(); responseObserver.onNext(reply); responseObserver.onCompleted(); } } ```` By default, the grpc server will listen to port `9090`. These and other [settings](grpc-server-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/server/config/GrpcServerProperties.java) can be changed via Spring's property mechanism. The server uses the `grpc.server.` prefix. Refer to our [documentation](https://yidongnan.github.io/grpc-spring-boot-starter/) for more details. ### gRPC Client To add a dependency using Maven, use the following: ````xml <dependency> <groupId>net.devh</groupId> <artifactId>grpc-client-spring-boot-starter</artifactId> <version>2.13.1.RELEASE</version> </dependency> ```` To add a dependency using Gradle: ````gradle dependencies { compile 'net.devh:grpc-client-spring-boot-starter:2.13.1.RELEASE' } ```` Annotate a field of your grpc client stub with `@GrpcClient(serverName)` * Do not use in conjunction with `@Autowired` or `@Inject` ````java @GrpcClient("gRPC server name") private GreeterGrpc.GreeterBlockingStub greeterStub; ```` **Note:** You can use the same grpc server name for multiple channels and also different stubs (even with different interceptors). Then you can send queries to your server just like this: ````java HelloReply response = stub.sayHello(HelloRequest.newBuilder().setName(name).build()); ```` It is possible to configure the target address for each client individually. However in some cases, you can just rely on the default configuration. You can customize the default url mapping via `NameResolver.Factory` beans. If you don't configure that bean, then the default uri will be guessed using the default scheme and the name (e.g.: `dns:/<name>`): These and other [settings](grpc-client-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/client/config/GrpcChannelProperties.java) can be changed via Spring's property mechanism. The clients use the `grpc.client.(serverName).` prefix. Refer to our [documentation](https://yidongnan.github.io/grpc-spring-boot-starter/) for more details. ## Running with (non-shaded) grpc-netty This library supports both `grpc-netty` and `grpc-netty-shaded`. The later one might prevent conflicts with incompatible grpc-versions or conflicts between libraries that require different versions of netty. **Note:** If the shaded netty is present on the classpath, then this library will always favor it over the non-shaded grpc-netty one. You can use it with Maven like this: ````xml <dependency> <groupId>io.grpc</groupId> <artifactId>grpc-netty</artifactId> <version>${grpcVersion}</version> </dependency> <!-- For both --> <dependency> <groupId>net.devh</groupId> <artifactId>grpc-spring-boot-starter</artifactId> <version>...</version> <exclusions> <exclusion> <groupId>io.grpc</groupId> <artifactId>grpc-netty-shaded</artifactId> </exclusion> </exclusions> </dependency> <!-- For the server (only) --> <dependency> <groupId>net.devh</groupId> <artifactId>grpc-server-spring-boot-starter</artifactId> <version>...</version>