commit | 6d28a93e210c0a201e5dea6d45bdbfd3678bc0c2 | [log] [tgz] |
---|---|---|
author | Carl Mastrangelo <notcarl@google.com> | Fri Aug 26 17:32:31 2016 -0700 |
committer | Carl Mastrangelo <notcarl@google.com> | Fri Aug 26 17:32:41 2016 -0700 |
tree | b1c60ff4bb9097661c504dd68ea10475b62b957f | |
parent | 8894769cdf486d001132828973683a0fef770f63 [diff] |
core: simplify timeout header processing Changes slightly improve performance Benchmark (serialized) Mode Cnt Score Error Units GrpcUtilBenchmark.encodeNew 1000n sample 336623 51.718 ± 1.417 ns/op GrpcUtilBenchmark.encodeNew 1000u sample 236574 77.555 ± 20.875 ns/op GrpcUtilBenchmark.encodeNew 1000m sample 224392 71.155 ± 1.600 ns/op GrpcUtilBenchmark.encodeNew 1000S sample 229616 67.269 ± 2.037 ns/op GrpcUtilBenchmark.encodeNew 1000M sample 215301 70.282 ± 1.933 ns/op GrpcUtilBenchmark.encodeNew 1000H sample 225063 73.679 ± 20.430 ns/op GrpcUtilBenchmark.encodeOld 1000n sample 311832 85.519 ± 1.729 ns/op GrpcUtilBenchmark.encodeOld 1000u sample 291613 92.320 ± 1.732 ns/op GrpcUtilBenchmark.encodeOld 1000m sample 271871 93.447 ± 1.872 ns/op GrpcUtilBenchmark.encodeOld 1000S sample 234932 117.956 ± 16.810 ns/op GrpcUtilBenchmark.encodeOld 1000M sample 224636 124.310 ± 20.249 ns/op GrpcUtilBenchmark.encodeOld 1000H sample 226764 130.803 ± 19.211 ns/op GrpcUtilBenchmark.parseNew 1000n sample 320709 60.480 ± 1.303 ns/op GrpcUtilBenchmark.parseNew 1000u sample 316349 64.447 ± 13.673 ns/op GrpcUtilBenchmark.parseNew 1000m sample 318209 61.705 ± 2.580 ns/op GrpcUtilBenchmark.parseNew 1000S sample 319629 59.342 ± 1.758 ns/op GrpcUtilBenchmark.parseNew 1000M sample 305715 59.362 ± 1.489 ns/op GrpcUtilBenchmark.parseNew 1000H sample 314919 60.224 ± 1.563 ns/op GrpcUtilBenchmark.parseOld 1000n sample 279243 64.040 ± 1.510 ns/op GrpcUtilBenchmark.parseOld 1000u sample 278008 71.313 ± 13.620 ns/op GrpcUtilBenchmark.parseOld 1000m sample 272633 67.872 ± 2.967 ns/op GrpcUtilBenchmark.parseOld 1000S sample 280955 63.966 ± 2.490 ns/op GrpcUtilBenchmark.parseOld 1000M sample 257645 71.329 ± 2.117 ns/op GrpcUtilBenchmark.parseOld 1000H sample 282510 68.425 ± 17.650 ns/op
gRPC-Java works with JDK 6. TLS usage typically requires using Java 8, or Play Services Dynamic Security Provider on Android. Please see the Security Readme.
Download the JARs. Or for Maven with non-Android, add to your pom.xml
:
<dependency> <groupId>io.grpc</groupId> <artifactId>grpc-netty</artifactId> <version>1.0.0</version> </dependency> <dependency> <groupId>io.grpc</groupId> <artifactId>grpc-protobuf</artifactId> <version>1.0.0</version> </dependency> <dependency> <groupId>io.grpc</groupId> <artifactId>grpc-stub</artifactId> <version>1.0.0</version> </dependency>
Or for Gradle with non-Android, add to your dependencies:
compile 'io.grpc:grpc-netty:1.0.0' compile 'io.grpc:grpc-protobuf:1.0.0' compile 'io.grpc:grpc-stub:1.0.0'
For Android client, use grpc-okhttp
instead of grpc-netty
and grpc-protobuf-lite
or grpc-protobuf-nano
instead of grpc-protobuf
:
compile 'io.grpc:grpc-okhttp:1.0.0' compile 'io.grpc:grpc-protobuf-lite:1.0.0' compile 'io.grpc:grpc-stub:1.0.0'
Development snapshots are available in Sonatypes's snapshot repository.
For protobuf-based codegen, you can put your proto files in the src/main/proto
and src/test/proto
directories along with an appropriate plugin.
For protobuf-based codegen integrated with the Maven build system, you can use protobuf-maven-plugin:
<build> <extensions> <extension> <groupId>kr.motd.maven</groupId> <artifactId>os-maven-plugin</artifactId> <version>1.4.1.Final</version> </extension> </extensions> <plugins> <plugin> <groupId>org.xolstice.maven.plugins</groupId> <artifactId>protobuf-maven-plugin</artifactId> <version>0.5.0</version> <configuration> <!-- The version of protoc must match protobuf-java. If you don't depend on protobuf-java directly, you will be transitively depending on the protobuf-java version that grpc depends on. --> <protocArtifact>com.google.protobuf:protoc:3.0.0:exe:${os.detected.classifier}</protocArtifact> <pluginId>grpc-java</pluginId> <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.0.0:exe:${os.detected.classifier}</pluginArtifact> </configuration> <executions> <execution> <goals> <goal>compile</goal> <goal>compile-custom</goal> </goals> </execution> </executions> </plugin> </plugins> </build>
For protobuf-based codegen integrated with the Gradle build system, you can use protobuf-gradle-plugin:
apply plugin: 'java' apply plugin: 'com.google.protobuf' buildscript { repositories { mavenCentral() } dependencies { // ASSUMES GRADLE 2.12 OR HIGHER. Use plugin version 0.7.5 with earlier // gradle versions classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.0' } } protobuf { protoc { // The version of protoc must match protobuf-java. If you don't depend on // protobuf-java directly, you will be transitively depending on the // protobuf-java version that grpc depends on. artifact = "com.google.protobuf:protoc:3.0.0" } plugins { grpc { artifact = 'io.grpc:protoc-gen-grpc-java:1.0.0' } } generateProtoTasks { all()*.plugins { grpc {} } } }
If you are making changes to gRPC-Java, see the compiling instructions.
Here's a quick readers' guide to the code to help folks get started. At a high level there are three distinct layers to the library: Stub, Channel & Transport.
The Stub layer is what is exposed to most developers and provides type-safe bindings to whatever datamodel/IDL/interface you are adapting. gRPC comes with a plugin to the protocol-buffers compiler that generates Stub interfaces out of .proto
files, but bindings to other datamodel/IDL should be trivial to add and are welcome.
The Channel layer is an abstraction over Transport handling that is suitable for interception/decoration and exposes more behavior to the application than the Stub layer. It is intended to be easy for application frameworks to use this layer to address cross-cutting concerns such as logging, monitoring, auth etc. Flow-control is also exposed at this layer to allow more sophisticated applications to interact with it directly.
The Transport layer does the heavy lifting of putting and taking bytes off the wire. The interfaces to it are abstract just enough to allow plugging in of different implementations. Transports are modeled as Stream
factories. The variation in interface between a server Stream and a client Stream exists to codify their differing semantics for cancellation and error reporting.
Note the transport layer API is considered internal to gRPC and has weaker API guarantees than the core API under package io.grpc
.
gRPC comes with three Transport implementations:
Tests showing how these layers are composed to execute calls using protobuf messages can be found here https://github.com/google/grpc-java/tree/master/interop-testing/src/main/java/io/grpc/testing/integration