graphql for android 客户端apollo入门

转载请注明：https://www.jianshu.com/p/135edb8cf588

最近公司的项目后端选择使用graphql，既然后端选择了graphql，那么客户端也要跟上脚步才行。初接触apollo，除了官方文档，网上能找到的资料很少，写一篇学习过程心得体会，即是对自己学习的总结记录，也希望能帮到其他朋友。

graphql介绍

我的理解，传统的rest形式的api，参数和返回值在设计后便已固定，客户端只需要按照协议调用。但是对于graphql，参数和返回值都可以自定义，除了用“!”定义的字段，其他字段都是按需添加，api接口都十分灵活。

android客户端使用apollo

graphql支持多种语言多种，graphql for client可统称为apollo，后端包括java，springboot，nodejs等。这里附送github地址： https://github.com/apollographql/apollo-android

1.添加project级别的依赖,目前apollo最新版本为1.0.1

./apollo-demo-project/build.gradle文件添加：

buildscript {
    repositories {
        google()

        #新增
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.4.0'
        
        #新增
        classpath 'com.apollographql.apollo:apollo-gradle-plugin:1.0.1'

    }
}

2.添加app级别的依赖

./apollo-demo-project/app/build.gradle文件添加：

此处必须添在apply plugin: 'com.android.application'后面添加

apply plugin: 'com.android.application'
#新增
apply plugin: 'com.apollographql.android'

添加库

android {
    repositories {
        //新增
        jcenter()
    }
}

添加依赖

dependencies {
    //新增 阿波罗库
    implementation 'com.apollographql.apollo:apollo-runtime:1.0.1'
}

到此，依赖添加完毕，Sync Project将下载依赖到本地，但是要想真正使用，还必须添加配置文件，包括schema.graphql， schema.json这两个文件

3.添加配置文件schema.graphql, schema.json

在工程./apollo-demo-project/app/src/main/目录下创建目录名为graphql的目录，虽然官方说可以随意命名，但是实践发现如果命名为其他名称，框架将读取不到配置文件，这里就不展开讨论了。将schema.grapql文件和schema.json文件添加到此目录中，build一波。build成功后，./apollo-demo-project/app/build/generated/source/classes目录下将会出现更具配置文件生成的java类，这些类将在发起请求中使用到，我们后面再将如何发起请求。

schema.graphql文件
这个文件的命名，需要保证后缀名为graphql，前缀可以任意命名，这个文件是前后端通用的，可以有多个，只需要保证后缀名正确即可。在实践中，我发现如果xxx.grapqhl文件在./apollo-demo-project/app/src/main/graphql目录中，动态生成的文件无法在其他类中被import到，解决方法是在graphql目录中新建com/graphql/data目录,将xxx.graphql文件添加到这个目录中。那么生成的文件将在build/generated/apollo/classes/com/graphql/data/目录中。如果你们有更好的方法，欢迎讨论。
xxx.graphql文件，请让后端的同事提供给你，并且前后端要保持一致。如果你暂时没有，可以到官方demo中找到 *.graphql文件

 graphql文件语法介绍

type Book{
  id:String
  name: String
 author:String
}
type Query {
       findBookById(id: String):Book
       findAllBooks:[Book]
}

说明1：type Book {
              ........
          }
定义了一个实体Book,有三个属性，id，书名，作者，都是String类型

说明2：
findBookById(id: String):Book
定义一个根据id查询book的接口，参数为id，返回值为Book

说明3：
findAllBooks:[Book]
定义一个查询所有书本的接口，没有参数，返回值为Book数组

graphql文件的配置用法比较多，我这里只介绍了query查询方法，还有一个大类叫mutation，用于增删改，不多作介绍了，有空专门写一篇介绍graphql文件的文章

schema.json文件

这个文件名时固定的，不能有任何变化，且必须放在./apollo-demo-project/app/src/main/graphql/schema.json必须由后端同事提供，后端部署成功后，会自动生成schema.json文件。这个文件自己写大概是不太可能了，经过实践，哪怕是最近简单的一个接口，生成的json文件也在20K左右（未格式化的情况下），手写不太现实。或者先使用官方demo里面的json文件。

实际使用中，后端以java-springboot为例，schema.json文件默认的访问地址为

http://x.x.x.x:8080/graphql/schema.json

或者可以通过apollo-codegen工具或者apollo工具获取，当然数据来源依旧来自源于后端服务器

apollo-codegen使用方法

npm install -g apollo-codegen
apollo-codegen introspect-schema http://xxxx:8080/graphql --output ./schema.json

apollo使用方法

npm install -g apollo
使用方法差不多，语法可能有些差异，下次再写吧

让后端小伙伴提供schema.json，就酱：）

提醒：schema.json文件和xxx.graphql文件必须是对应的，否则将无法通过编译。

3. 发起请求

Retrofit+okhttp+rxjava框架，在android开发中使用的相当普遍，而apollo将代替Retrofit，其他的不变，上代码

//apollo本身没有get方式的请求，同样支持三级缓存。
OkHttpClient okHttpClient = new OkHttpClient.Builder().build();
ApolloClient apolloClient = ApolloClient.builder()
                .serverUrl("https://www.baidu.com")
                .okHttpClient(okHttpClient)
                .build(); 
apolloClient.query(ListPostsQuery.builder().build()).enqueue(new ApolloCall.Callback() {
            @Override
            public void onResponse(@NotNull Response response) {
              //TODO:成功
            }

            @Override
            public void onFailure(@NotNull ApolloException e) {
               //TODO:失败
            }
        });

apollo框架的使用介绍到这里就结束了，有空再写一篇文章展开一些细节，欢迎大家留言讨论。

参考资料：

apollo github https://github.com/apollographql/apollo-android
graphql中文官网 https://graphql.cn/