GraphQL iOS Swift5.1详细配置

万里长征行军难,千山万水只等闲。

GraphQL 是一个用于 API 的查询语言,是一个使用基于类型系统来执行查询的服务端运行时(类型系统由你的数据定义)。GraphQL 并没有和任何特定数据库或者存储引擎绑定,而是依靠你现有的代码和数据支撑。
GraphQL 规范特意忽略了一些面向 API 的重要问题,例如处理网络、授权和分页。这并不意味着在使用 GraphQL 时没有针对这些问题的解决方案,只是因为它们并非 GraphQL 定义中的一部分,可代以工程上通行的做法来实现。

那么使用GraphQL有什么好处呢?

1.一次查询,搞定需求,在单个请求中获取许多资源
2.版本之间不会相互影响,版本兼容so easy
3.数据请求无冗余、无冗余、无冗余
4.客户端自定义数据格式,这也算无冗余的原因
5.描述类型系统的可能性
6.功能强大的开发人员工具
7.不同平台可以获取不同数据,不会相互影响

缺点呢

1.缺乏适当的中间件结构
2.学习成本及接手成本

作为一个小兵就要不考虑用不用的问题啦,下面我们介绍一下iOS 的Apollo框架吧。

1、配置电脑环境,方便之后的生成API
安装 node
brew install node
安装apollo
npm install -g apollo

2、cocoapods 导入最新版Apollo(0.16.0)
3、自动生成API控制
在项目TARGETS目录下的Build Phases栏目下新建运行环境
点击+号,选择 New Run Script Phase.
之后修改名称为 Generate Apollo GraphQL API 。

1.png

⚠️:一定要将Generate Apollo GraphQL API 环境拉到Complie Sources 上面


3.png

然后在Shell命令行里面输入如下代码

APOLLO_FRAMEWORK_PATH="$(eval find         
$FRAMEWORK_SEARCH_PATHS -name "Apollo.framework" -maxdepth 1)"

if [ -z "$APOLLO_FRAMEWORK_PATH" ]; then
echo "error: Couldn't find Apollo.framework in 
FRAMEWORK_SEARCH_PATHS; make sure to add the 
framework to your project."
exit 1
fi

cd "${SRCROOT}/${TARGET_NAME}"
$APOLLO_FRAMEWORK_PATH/check-and-run-apollo-cli.sh 
codegen:generate --queries="$(find . -name '*.graphql')" -- 
passthroughCustomScalars --schema=schema.json API.swift


SCRIPT_PATH="${PODS_ROOT}/Apollo/scripts"
cd "${SRCROOT}/${TARGET_NAME}"
"${SCRIPT_PATH}"/run-bundled-codegen.sh 
codegen:generate --target=swift --includes=./**/*.graphql -- 
localSchemaFile="schema.json" API.swift
2.png

这样会自动生成API.swift

再进行Schema 下载

apollo schema:download --endpoint=http://localhost/graphql schema.json

输入服务器的endpoint进行下载schema.json文件
然后把schema.json和*.graphql文件导入项目根目录,尽量在文件比较多的地方。
.graphql里面存放的则是你的查询语句,Xcode会根据查询语句自动生成查询代码,方便调用。


4.png

然后运行项目即可,在项目目录里面找到生成的API.swift拉到项目中,每次运行都会更新API里面的内容。所以不要修改API里面的内容,因为修改也没用,每次都会更新。在项目调试阶段打开自动生成,在项目调试完成后可以关闭。这样就不会更新API了。

到此,项目的简单配置就完成了。
下一篇我们说一下使用情况。
最后附上官方的教程.以及大家心仪的配置demo地址.

你可能感兴趣的:(GraphQL iOS Swift5.1详细配置)