GRPC Android客戶端演化史

大概在好幾個月前吧，我們準備接入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();