大概在好几个月前吧,我们准备接入GRPC的接口,当时是某同事负责和服务器对接,所以从那个时候开始有了GRPC v1.0版。
GRPC V1.0
初版选择的是使用Retrofix + protobuf + javaNano 生成了Android客户端的伪GRPC的代码,实现了客户端与服务器的通信。 这里Retrofit用来进行网络通信,protobuf + javanano 可以自动生成供Android端使用的接口代码。 可以看看proto代码构成,以cartsaver.proto为例:
syntax = "proto3";
package cartsaver;
option java_multiple_files = true;
option java_package = "com.daigou.sg.grpc";
service CartSaver {
rpc Action(ActionReq) returns (ActionResp);
}
enum EAction {
None = 0;
AddCart = 1;
Checkout = 2;
Pay = 3;
Invalid = 4;
}
// 若userId小于1,则从cookie 65_customer中获取
message ActionReq {
int64 userId = 1;
EAction action = 2;
}
message ActionResp {
bool ok = 1;
}
javanano不能生成Service,所以在第一版的时候我们手动将service去掉然后再生成代码。 这里Service结构里包含的就是客户端调用的接口 还有两个message都是在通信时用到的,一个是request一个是response。 自动生成代码操作请看此文档 具体调用方法如下:
ArrayList<Protocol> protocolArrayList = new ArrayList<>();
protocolArrayList.add(Protocol.HTTP_1_1);
protocolArrayList.add(Protocol.HTTP_2);
OkHttpClient okHttpClient = new OkHttpClient.Builder()
.protocols(protocolArrayList)
.build();
Retrofit retrofit = new Retrofit.Builder()
.client(okHttpClient)
.addConverterFactory(ProtoConverterFactory.create())
.baseUrl("http://192.168.199.64:14151")
.build();
SimpleService service = retrofit.create(SimpleService.class);
ProductGpid productGpid = new ProductGpid();
productGpid.source = Product.ProductSourceEzbuy;
Call<ProductGpidResp> call = service.Gpid(productGpid);
call.enqueue(new Callback<ProductGpidResp>() {
@Override
public void onResponse(Call<ProductGpidResp> call, Response<ProductGpidResp> response) {
Log.e("asd", response.body().toString());
}
@Override
public void onFailure(Call<ProductGpidResp> call, Throwable t) {
Log.e("asd", "onFailure");
}
});
public interface SimpleService {
@POST("/")
Call<ProductGpidResp> Gpid(@Body ProductGpid impl);
}
GRPC V2.0
第二版在V1.0的基础上实现方式并没有改变,只是我们使用gradle插件自动生成代码,不再使用命令行手动操作。 1.首先在android-ezbuy-rpc这个工程级的gradle文件中添加protobuf的插件:
classpath "com.google.protobuf:protobuf-gradle-plugin:0.8.0"
2.然后在rpcLibrary的gradle文件中添加如下代码:
...
apply plugin: 'com.google.protobuf'
...
protobuf {
protoc {
artifact = 'com.google.protobuf:protoc:3.2.0'
}
plugins {
javalite {
artifact = "com.google.protobuf:protoc-gen-javalite:3.0.0"
}
}
generateProtoTasks {
all().each { task ->
task.plugins {
javalite {}
}
}
}
}
...
compile 'io.grpc:grpc-protobuf-lite:1.2.0'
...
由于protobuf不再支持javanano所以我们后来选择用javalite替代javanano 至此,我们的代码就成功生成并且做成了jar包 调用方法还是跟V1.0一样,使用retrofit调用
GRPC V3.0
我们在V2.0的基础上将GRPC官方调用方式加进去,替换掉retrofit,也就是当前版本V3.0,既然要用官方的实现方法,所以proto里的Service我们还是要生成的。 首先,还是要更改android-ezbuy-rpc中rpcLibrary的gradle文件。因为我们要加入Grpc调用,所以要加入依赖库:
compile 'io.grpc:grpc-okhttp:1.2.0' // CURRENT_GRPC_VERSION
compile 'io.grpc:grpc-stub:1.2.0' // CURRENT_GRPC_VERSION
然后将protobuf更改如下
protobuf {
protoc {
artifact = 'com.google.protobuf:protoc:3.2.0'
}
plugins {
javalite {
artifact = "com.google.protobuf:protoc-gen-javalite:3.0.0"
}
//增加grpc插件
grpc {
artifact = 'io.grpc:protoc-gen-grpc-java:1.2.0' // CURRENT_GRPC_VERSION
}
}
generateProtoTasks {
all().each { task ->
task.plugins {
javalite {}
//grpc
grpc {
// Options added to --grpc_out
option 'lite'
}
}
}
}
}
然后在build.sh文件里添加grpc文件夹及proto文件 [图片上传失败...(image-3a10e6-1524214716120)]
以后只要新增了proto文件只要在buil.sh里加上这段代码,再编译运行就可以生成grpc代码了
cp -f ${API_DOC_PATH}/proto/cartsaver/cartsaver.proto ${Cur_Dir}/rpclibrary/src/main/proto/cartsaver.proto
这样除了之前生成的Request和Response类以外,还会生成一个以Stub结尾的类,这个类相当于服务器在客户端的存根,这里面会自动生成Service里的接口方法,通过stub调用接口,就可以实现和服务器端通信。 具体调用代码如下:
private static class GrpcTask extends AsyncTask<Void, Void, String> {
ActionReq mReq;
private ManagedChannel mChannel;
public GrpcTask(ActionReq req) {
mReq = req;
}
@Override
protected String doInBackground(Void... nothing) {
try {
mChannel = OkHttpChannelBuilder.forAddress("192.168.199.64", 14090)
.usePlaintext(true)
.build();
CartSaverGrpc.CartSaverBlockingStub saverStub = CartSaverGrpc.newBlockingStub(mChannel);
Metadata headers = new Metadata();
Metadata.Key<String> contentType = Metadata.Key.of("content-type", Metadata.ASCII_STRING_MARSHALLER);
headers.put(contentType, "application/grpc");
saverStub = MetadataUtils.attachHeaders(saverStub, headers);
ActionResp resp = saverStub.action(mReq);
return resp.getOk() + "";
} catch (Exception e) {
StringWriter sw = new StringWriter();
PrintWriter pw = new PrintWriter(sw);
e.printStackTrace(pw);
pw.flush();
return String.format("Failed... : %n%s", sw);
}
}
}
...
new GrpcTask(req).execute();