commit | 4168f67e38179dad6f2be47ef802ad454fb8b0c2 | [log] [tgz] |
---|---|---|
author | Eric Anderson <ejona@google.com> | Tue Aug 04 16:37:00 2015 -0700 |
committer | Eric Anderson <ejona@google.com> | Tue Jan 26 12:41:50 2016 -0800 |
tree | 8332000fe899f5b61a9d507d559e5c7253ed8755 | |
parent | f59e04f310c927557afe2894487dbc684ecebd2c [diff] |
Optimize blocking calls to avoid app thread pool This reduces the necessary number of threads in the application executor and provides a small improvement in latency (~15μs, which is normally in the noise, but would be a 5% improvement). Benchmark (direct) (transport) Mode Cnt Score Error Units Before: TransportBenchmark.unaryCall1024 true INPROCESS avgt 10 1566.168 ± 13.677 ns/op TransportBenchmark.unaryCall1024 false INPROCESS avgt 10 35769.532 ± 2358.967 ns/op After: TransportBenchmark.unaryCall1024 true INPROCESS avgt 10 1813.778 ± 19.995 ns/op TransportBenchmark.unaryCall1024 false INPROCESS avgt 10 18568.223 ± 1679.306 ns/op The benchmark results are exactly what we would expect, assuming that half of the benefit of direct is on server and half on client: 1566 + (35769 - 1566) / 2 = 18668 ns --vs-- 18568 ns It is expected that direct=true would get worse, because SerializingExecutor is now used instead of SerializeReentrantCallsDirectExecutor plus the additional cost of ThreadlessExecutor. In the future we could try to detect the ThreadlessExecutor and ellide Serializ*Executor completely (as is possible for any single-threaded executor). We could also optimize the queue used in ThreadlessExecutor to be single-producer, single-consumer. I don't expect to do those optimizations soon, however.
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 JAR. Or for Maven, add to your pom.xml
:
<dependency> <groupId>io.grpc</groupId> <artifactId>grpc-all</artifactId> <version>0.9.0</version> </dependency>
Or for Gradle, add to your dependencies:
compile 'io.grpc:grpc-all:0.9.0'
For Android client, you only need to depend on the needed sub-projects, such as:
compile 'io.grpc:grpc-okhttp:0.9.0' compile 'io.grpc:grpc-protobuf-nano:0.9.0' compile 'io.grpc:grpc-stub:0.9.0'
Development snapshots are available in Sonatypes's snapshot repository.
For protobuf-based codegen integrated with the Maven build system, you can use maven-protoc-plugin:
<pluginRepositories> <pluginRepository> <releases> <updatePolicy>never</updatePolicy> </releases> <snapshots> <enabled>false</enabled> </snapshots> <id>central</id> <name>Central Repository</name> <url>https://repo.maven.apache.org/maven2</url> </pluginRepository> <pluginRepository> <id>protoc-plugin</id> <url>https://dl.bintray.com/sergei-ivanov/maven/</url> </pluginRepository> </pluginRepositories> <build> <extensions> <extension> <groupId>kr.motd.maven</groupId> <artifactId>os-maven-plugin</artifactId> <version>1.4.0.Final</version> </extension> </extensions> <plugins> <plugin> <groupId>com.google.protobuf.tools</groupId> <artifactId>maven-protoc-plugin</artifactId> <version>0.4.2</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-beta-1:exe:${os.detected.classifier}</protocArtifact> <pluginId>grpc-java</pluginId> <pluginArtifact>io.grpc:protoc-gen-grpc-java:0.9.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 { classpath 'com.google.protobuf:protobuf-gradle-plugin:0.6.1' } } 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-beta-1" } plugins { grpc { artifact = 'io.grpc:protoc-gen-grpc-java:0.9.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