AndroidgRPCSSL/TLSDemo(Android上带有SSL/TLS加密的gRPC使用详解)

最近项目有用到gRPC来发起请求，并且需要用到加密。做的过程中也是各种坑，官网文档也不详细，网上资料也不多。我把过程都记录一下，希望能帮助到有需要的朋友。

1、gRPC介绍

定义介绍就不说了网上一大堆，简单理解就是google新推出的一种通信协议，定义好proto文件，客户端和服务端都可以自动生成相关的方法和对象，调用接口时直接使用这些生成好的文件，帮助开发者更多的关注业务。

需要注意的是：官方案例中要各种编译对应语言的文件，编译过程中下载相关的文件速度特别慢，各种坑。其实Android使用时只需要导入插件和lib库，就可以自动编译好相关的java文件供调用。

2、proto文件

拿一段官网的proto案例介绍

这个类名service Greeter编译后会自动生成GreeterGrpc，通过GreeterGrpc调用里面的方法比如SayHello。另外假如类名service User，就会生成UserGrpc
HelloRequest也会自动生成相应的类，到时直接使用。这就省去了建实体类以及请求数据的方法的步骤，省事了很多

这里推荐proto文件（有个P的小图标后文会提到）放在和java同一级目录下：

3、环境配置

首先最好能有翻墙工具，比如免费的蓝灯，收费的土行孙（百度搜索的地址不能用，用这个https://dundi.in ）都挺不错.

其次需要配置protobuf插件和库用来自动生成gRPC文件。
在最外层的build.gradle下加上

apply plugin: 'com.android.application'
apply plugin: 'com.google.protobuf'


android {
    compileSdkVersion 24
    buildToolsVersion "24.0.0"
    defaultConfig {
        applicationId "com.xxx.xxx.xxxxx"
        minSdkVersion 15
        targetSdkVersion 24
        versionCode 1
        versionName "1.0"
    }

    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
    lintOptions {
        disable 'InvalidPackage'
    }
}

protobuf {
    protoc {
        artifact = 'com.google.protobuf:protoc:3.0.0'
    }
    plugins {
        javalite {
            artifact = "com.google.protobuf:protoc-gen-javalite:3.0.0"
        }
        grpc {
            artifact = 'io.grpc:protoc-gen-grpc-java:1.0.0'
        }
    }
    generateProtoTasks {
        all().each { task ->
            task.plugins {
                javalite {}
                grpc {
                    // Options added to --grpc_out
                    option 'lite'
                }
            }
        }
    }
}

dependencies {
    compile fileTree(include: ['*.jar'], dir: 'libs')

    //grpc need
    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'

    compile 'com.google.code.findbugs:jsr305:3.0.0'
    compile 'com.google.guava:guava:18.0'
    compile 'javax.annotation:javax.annotation-api:1.2'
}

注意点
1、grpc { artifact = ‘io.grpc:protoc-gen-grpc-java:1.0.0’}
这句话一定要有，不然自动生成的java文件没有GreeterGrpc，就无法调用方法了

2、配置好gradle，gradle构建时会提示安装插件（顶部的 apply plugin: ‘com.google.protobuf’），就是这个插件

安装后，项目中proto文件前面就会出现个P字的小图标

3、官网案例中的版本都是1.1.0-SNAPSHOT，但是我在实践的过程中发现根本下不了，不存在这个版本，这里建议使用1.0.0
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’

4、另外，gradle版本可能也会影响到构建，最好使用最新的版本

5、如果有疑问交流qq：497555328

特别注意~~~~
gradle构建时下载速度很慢，一定要耐心等待，通过查看gradle日志来跟踪构建过程，我当时一直在running了10来分钟，以为断了就关掉重来，花费了很长时间才搞明白其实它是在下载相关的文件，日志显示正在下载，只是速度非常慢，即使翻墙速度也很慢。

构建好后，rebuild一下项目就会自动根据项目目录中的proto文件生成对应的java文件，我项目的文件如下：

这时就可以进行开发了。

4、gRPC Android使用方法（主要是SSL/TLS加密验证）

官网也有使用案例：

不过它这个没有使用加密

这里说下gRPC的加密，官方文档中也有介绍，分为：
1、服务端认证加密使用的 SSL/TLS
2、通过 Google 进行认证
3、开发者自定义的加密凭证

可以参考官网文档 , 中文版文档

我们项目用的是SSL/TLS协议来加密，这里就有坑了：
官网给了一段java案例：

// With server authentication SSL/TLS
ManagedChannel channel = ManagedChannelBuilder.forAddress("myservice.example.com", 443)
    .build();
GreeterGrpc.GreeterStub stub = GreeterGrpc.newStub(channel);

// With server authentication SSL/TLS; custom CA root certificates; not on Android
ManagedChannel channel = NettyChannelBuilder.forAddress("myservice.example.com", 443)
    .sslContext(GrpcSslContexts.forClient().trustManager(new File("roots.pem")).build())
    .build();
GreeterGrpc.GreeterStub stub = GreeterGrpc.newStub(channel);

这句not on Android就坑爹了，Android端生成的文件中根本没有NettyChannelBuilder这个东西。不过幸好还有一段小字：

If the issuing certificate authority is not known to the client then a properly configured SslContext or SSLSocketFactory should be provided to the NettyChannelBuilder or OkHttpChannelBuilder****, respectively.

还有OkHttpChannelBuilder官方给的案例也没有提到这玩意，其实实例化这里需要这样：

ManagedChannel channel = OkHttpChannelBuilder.forAddress("xxx",yyy)
                        .overrideAuthority("zzz")
                        .sslSocketFactory(sslFactory)
                        .build();

1、千万不要像官网案例那样设置setPlaintext(true)，这个是设置明文，我们用的是密文

2、xxx是服务器的ip，yyy是端口号，zzz是domain（这些参数服务端都会提供给你）
特别注意这个overrideAuthority一定要调用，覆盖hostname来匹配服务器的证书

3、sslSocketFactory这个方法就是设置密钥的方法。一般服务端会提供个.pem的密钥文件，放在raw中。我们把这个密钥设置到OkHttpChannelBuilder中即可以访问服务器了，关于sslSocketFactory 网上可以搜索到很多有关的内容。

如果有什么问题欢迎交流