SDK接口概述

SDK接口,全称为Software Development Kit,即“软件开发工具包”,一般都是软件工程师为特定的软件包、软件框架、硬件平台、操作系统等建立应用软件时的开发工具的集合,广义上指辅助开发某一类软件的相关文档、范例和工具的集合。

它可以简单的为某个程序设计语言提供应用程序接口 API 的一些文件,但也可能包括能与某种嵌入式系统通讯的复杂的硬件。一般的工具包括用于调试和其他用途的实用工具。SDK 还经常包括示例代码、支持性的技术注解或者其他的为基本参考资料澄清疑点的支持文档。

简单讲,就是通过第三方服务商实现产品功能的软件工具包。SDK和API都是类似于公共服务的东西,都代表的是一种封装。

SDK的封装是在客户端层面的一个library(也叫做“包”或者“库”),这个library提供一些客户端API接口,类似于已经写好了的函数,你只需要调用它就好了。

为什么使用 SDK?

通常,SDK会由专业的公司提供专业的服务的集合,比如涂鸦 App SDK,为开发者提供了丰富组件和示例代码。开发者不需要对产品的每一项功能进行开发,使用合适的SDK,可以花费较少的时间,实现产品的功能。

SDK 可协助软件开发人员面向特定的平台、系统或编程语言创建应用。它就像是购买梳妆台时随板材一同提供的工具包,让购买者能够自行组装,只是对象是应用开发而已。开发者所需的构建块或开发工具它都有,而具体所含的内容则因制造商而异。

一个基本的 SDK 通常由编译器、调试器和应用编程接口(API)组成,但也可能包含以下任意内容:

  • 文档
  • 编辑器
  • 运行时/开发环境
  • 测试/分析工具
  • 驱动程序
  • 网络协议

一个完整的SDK由哪几部分组成

一个完整的SDK应该包括以下内容:

1.接口文件和库文件

笼统地说就是先前提到过的API。通过将底层的代码进行封装保护,提供给用户一个调用底层代码的接口。

2.帮助文档

用来解释接口文件和库文件(即API)的功能,以及介绍相关的开发工具,操作示例等。

3.开发示例

即简单的成品DEMO展示,包括源代码。

4.实用工具

通常是指用来协助用户进行二次开发的工具,比如二次开发向导、API 搜索工具、软件打包工具等。

SDK示例

SDK暴露出来的接口都是和语言相关的,如果SDK是用Java写的,就需要用Java去调用那个函数;如果是SDK是用Objective-C写的,就需要用Objective-C去调用那个函数。 

下面以智能生活App SDK家庭信息管理下的【创建家庭】接口为例:

接口说明

void createHome(String name, double lon, double lat, String geoName, List<String> rooms, ITuyaHomeResultCallback callback)

参数说明

参数

说明

name

家庭名称,最多支持 25 个字符

lon

经度,如果不设置家庭位置信息,请设置为 0

lat

纬度,如果不设置家庭位置信息,请设置为 0

geoName

家庭地理位置名称

rooms

房间列表

callback

查询结果的回调

Java 示例

TuyaHomeSdk.getHomeManagerInstance().createHome(name, lon, lat, geoName, rooms, new ITuyaHomeResultCallback() {
		@Override
		public void onSuccess(HomeBean bean) {
			// do something
		}
		@Override
		public void onError(String errorCode, String errorMsg) {
			// do something
		}
	});