SDK接口是什么?

SDK(Software Development Kit)是用于创建特定软件应用的工具集合,包括API接口、文档、示例代码和开发工具。它提供给开发者预封装的功能,简化开发过程,如涂鸦AppSDK。SDK通常包含接口文件、帮助文档、开发示例和实用工具。通过SDK,开发者可以快速实现特定功能,例如创建家庭信息,接口如`createHome()`,并提供回调处理成功或错误情况。

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
		}
	});
步骤一:引入JS文件 在需要调用JS接口的页面引入如下JS文件,(支持https):http://res.wx.qq.com/open/js/jweixin-1.2.0.js 备注:支持使用 AMD/CMD 标准模块加载方法加载 步骤二:通过config接口注入权限验证配置 所有需要使用JS-SDK的页面必须先注入配置信息,否则将无法调用(同一个url仅需调用一次,对于变化url的SPA的web app可在每次url变化时进行调用,目前Android微信客户端不支持pushState的H5新特性,所以使用pushState来实现web app的页面会导致签名失败,此问题会在Android6.2中修复)。 wx.config({ debug: true, // 开启调试模式,调用的所有api的返回值会在客户端alert出来,若要查看传入的参数,可以在pc端打开,参数信息会通过log打出,仅在pc端时才会打印。 appId: '', // 必填,企业号的唯一标识,此处填写企业号corpid timestamp: , // 必填,生成签名的时间戳 nonceStr: '', // 必填,生成签名的随机串 signature: '',// 必填,签名,见附录1 jsApiList: [] // 必填,需要使用的JS接口列表,所有JS接口列表见附录2 }); 步骤三:通过ready接口处理成功验证 wx.ready(function(){ // config信息验证后会执行ready方法,所有接口调用都必须在config接口获得结果之后,config是一个客户端的异步操作,所以如果需要在页面加载时就调用相关接口,则须把相关接口放在ready函数中调用来确保正确执行。对于用户触发时才调用的接口,则可以直接调用,不需要放在ready函数中。 }); 步骤四:通过error接口处理失败验证 wx.error(function(res){ // config信息验证失败会执行error函数,如签名过期导致验证失败,具体错误信息可以打开config的debug模式查看,也可以在返回的res参数中查看,对于SPA可以在这里更新签名。 }); 接口调用说明 所有接口通过wx对象(也可使用jWeixin对象)来调用,参数是一个对象,除了每个接口本身需要传的参数之外,还有以下通用参数: success:接口调用成功时执行的回调函数。 fail:接口调用失败时执行的回调函数。 complete:接口调用完成时执行的回调函数,无论成功或失败都会执行。 cancel:用户点击取消时的回调函数,仅部分有用户取消操作的api才会用到。 trigger: 监听Menu中的按钮点击时触发的方法,该方法仅支持Menu中的相关接口
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

IoT砖家涂拉拉

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值