简介

saas 服务一般提供了一个文档来描述提供的 OpenAPI,然会每个用户根据文档自己实现签名、调用等功能的封装,这部分会出现各种各样的问题,因此用户更希望平台直接提供一个 SDK。

darabonba

darabonba 是阿里云开源的用于 OpenAPI 的 DSL 语言,编写 darabonba 就可以生成多语言的 SDK 等等。本文不介绍入门(README 比较全)。

编写 SDK

首先是 Config 类,一般包括 appKey 和 secretKey,并定义模块变量,定义如下:

// 引入的依赖见最后的推荐依赖
import Util;
import SignatureUtil;
import OpenApiUtil; type @host = string
type @appKey = string
type @secretKey = string model Config {
appKey: string(description = "appKey"),
secretKey: string(description = "secretKey")
}

接着是 Client 类的初始化方法里初始化:

init(config: Config) {
@host = "www.aliyun.com";
@appKey = config.appKey;
@secretKey = config.secretKey;
}

接着定义请求方法:

// 请求的通用参数封装为一个 model
model Request {
// GET/POST
method: string,
// 请求路径
pathname: string,
// 拼接参数字符串,作为签名的一部分
param: string,
// 参数是否是 Json 格式
isJson?: boolean
} // http 请求,返回一个任意类型的结果
api _requestRAny(request: Request, body: any): any {
__request.pathname = request.pathname;
__request.method = request.method;
// 获取时间戳
var date: string = OpenApiUtil.getTimestamp();
// 计算签名
__request.headers = _header(@appId, date, _sign(request.param, date));
if (request.isJson) {
__request.headers.accept = 'application/json';
__request.body = Util.toJSONString(body);
} else {
__request.query = Util.stringifyMapValue(Util.assertAsMap(body));
}
} returns {
// 处理 http response
return _handle(__response);
} runtime {
// 超时时间 10 s,你也可以配成模块参数
timeout = 10000
} // 调用 api 的函数必须用 async 关键字修饰
async function _requestRObj(request: Request, body: any): object {
// object 等价 map[string]any 等价 $Model,它们之间可以直接转换
return Util.assertAsMap(_requestRAny(request, body));
} // 处理 http response,返回任意类型的结果
function _handle(response: $Response): any {
// 读取响应的数据,通常是一个包含 code、status 和 data 的 Json 串
var result = Util.assertAsMap(Util.readAsJSON(response.body));
if (!Util.equalNumber(response.statusCode, 200) || !Util.assertAsBoolean(result.ok)) {
// 抛异常,通过 throw 关键字仅能抛出一种异常
throw {
message = `httpCode: ${response.statusCode}, serverCode: ${result.code}, reason: ${result.message}`,
code = `${result.code}`
};
}
return result.data;
} // 构建请求头
function _header(appKey: string, signedAt: string, sign: string): map[string]string {
var headers: map[string]string = {
host = @endpoint_host,
app_key = appKey,
signed_at = signedAt,
sign = sign
};
return headers;
} // 签名
function _sign(param: string, date: string): string {
// 模式字符串拼接参数,计算 md5 摘要做签名
var sign: string = OpenApiUtil.hexEncode(SignatureUtil.MD5Sign(`app_key${@appKey}secret_key${@secretKey}signed_at${date}${param}));
return sign;
}

比如一个接入用户接口

model UserRequest {
userId: string(description = "userId", name = "userId", required = true),
nickName?: string(description = "nickName", name = "nickName")
} async function createUser(userRequest: UserRequest): void {
// 校验参数,UserRequest 的 nickName 使用了 ?:,? 表示不会进行校验,如果不调用这个方法那就没有区别
Util.validateModel(userRequest);
// 构建通用参数
var request = new Request {
method = @get,
pathname = "/user/createUser",
// 模式字符串拼接参数做签名
param = `nickName${userRequest.nickName}userId${userRequest.userId}`
};
// 发起 http 请求,如果返回值是基本类型比如数字,那么可以这样:
_requestRAny(request, accessThirdPartyUserRequest);
}

其他

  1. Model 和 Object 和 map[string]any

它们三个是等价的,可以直接转换,不用转换,其他的都需要调用工具类转换,这点很重要

  1. 接口参数很少,不想定义 Model?

直接使用 map[string]any。

_requestRAny(request, {
// 和前面 _header 函数一样构建 map 一样
thirdPartyUserId = thirdPartyUserId
})
  1. 接口参数包含数组,签名怎么计算?

调用 OpenApiUtil.arrayToStringWithSpecifiedStyle() 方法转为为字符串

// 风格自己选,和服务端保持一直就可以
var arrayString: string = OpenApiUtil.arrayToStringWithSpecifiedStyle(null, null, null);
  1. 返回值类型怎么转换?

_requestRAny 函数返回的是任意类型。

  • 基本类型使用 Util.assertAsXXX() 转换
  • 数组类型需要定义一个 model,在 model 里定义一个数组,然后用 map 设置数组再转换为 model
model Response {
items: [ string ](description = "items")
} // 返回 Response 类型,函数其余部分不展示了
return {
items = _requestRAny(request, modelRequest)
};

推荐依赖

saas 服务多语言 SDK的更多相关文章

  1. 一文了解腾讯云数据库SaaS服务

    本文由云+社区发表 作者:邵宗文,2009年加入腾讯,现为腾讯云数据库专家产品经理.之前曾负责为OMG事业群构建数据库平台,部署,规划及运维支持,为腾讯网,新闻客户端,快报,视频,财经,体育等提供了稳 ...

  2. 下一个亿万市场:企业级SaaS服务谁能独领风骚

    注:SaaS是Software-as-a-Service(软件即服务)的简称,一种完全创新的软件应用模式,简单来说SaaS即为提供商基于互联网为企业提供软件服务. ​对中小型企业来说:SaaS是采用先 ...

  3. 编译包含Google Play服务App的SDK版本问题

    编译包含Google Play服务App的SDK版本问题   错误信息:No Resouce identifier found for attribute 'touchscreen BlocksFoc ...

  4. 【阿里云产品公测】消息队列服务MQS java SDK 机器人应用初体验

    [阿里云产品公测]消息队列服务MQS java SDK 机器人应用初体验 作者:阿里云用户啊里新人   初体验 之 测评环境 由于MQS支持外网访问,因此我在本地做了一些简单测试(可能有些业余),之后 ...

  5. [在线Demo]使用Hibernate多租户实现SaaS服务

    上一篇文章 基于Hibernate实现多租户(Multi-Tendency)功能简单介绍了利用Hibernate的多租户功能提供SaaS服务的方法,但其中有很多不足,后来都得到了解决. 我尝试过抽取实 ...

  6. WSDL(Web服务描述语言)详细解析(全文转载学习用)

    WSDL (Web Services Description Language,Web服务描述语言)是一种XML Application,他将Web服务描述定义为一组服务访问点,客户端可以通过这些服务 ...

  7. 基于云端的通用权限管理系统,SAAS服务,基于SAAS的权限管理,基于SAAS的单点登录SSO,企业单点登录,企业系统监控,企业授权认证中心

    基于云端的通用权限管理系统 SAAS服务 基于SAAS的权限管理 基于SAAS的单点登录SSO 基于.Net的SSO,单点登录系统,提供SAAS服务 基于Extjs 4.2 的企业信息管理系统 基于E ...

  8. saas服务提供商

    这段时间接触了不少行业的东西,这里谈几点肤浅的看法.从市场行情上讲,SaaS风口还在,不过热度明显向大数据.物联网.人工智能.区块链等转移. 做得比较好的有这些SaaS提供商,每个领域的都有那么几家的 ...

  9. Traefik 控制面板 SaaS 服务 Pilot

    文章转载自:https://mp.weixin.qq.com/s?__biz=MzU4MjQ0MTU4Ng==&mid=2247485572&idx=1&sn=8ffa2bc7 ...

随机推荐

  1. C语言项目实现顺序表

    #include <stdio.h> #include <stdlib.h> #include "test_顺序表声明.h" /* run this pro ...

  2. 输出以二叉树表示的算术表达式(严6.51)--------西工大noj

    题解 这道题目说的很诡异,其实没有什么把括号补上....仅仅是先序读入,然后中序输出就行了 代码 #include <stdio.h> #include <stdlib.h> ...

  3. OpenWrt之feeds.conf.default详解

    目录 OpenWrt之feeds.conf.default详解 文件内容 命令解释 src-svn与src-gitsvn src-git与src-git-full src-cpy与src-link 其 ...

  4. 前端-关于CORS跨域的解决方案,面向服务端

    最近自己在写后台管理系统的时候,并没有采用jsp.freemaker.叶子等模板技术,而是由后端提供数据api,前端通过AJAX和JQuery来动态操作页面上的一些div.table元素,从而实现报表 ...

  5. mysql 经典案例

    MySQL多表联合查询是MySQL数据库的一种查询方式,下面就为您介绍MySQL多表联合查询的语法,供您参考学习之用. MySQL多表联合查询语法: SELECT * FROM 插入表 LEFT JO ...

  6. 别梦依稀咒逝川,Ruby二十八年前|M1芯片Mac os系统配置Ruby(3.0.0) on Rails(6.1.1)开发环境(2021最新攻略)

    原文转载自「刘悦的技术博客」https://v3u.cn/a_id_188 在每个开发者心里,都会有一门"最好"的语言,在这个世界的某个深处,在一些矫矫不群的人们心中,这门语言的名 ...

  7. Vue $nextTick && 过度与动画

    1 # $nextTick 2 # 1.语法: this.$nextTick(回调函数); 3 # 2.作用:在下一次DOM更新结束后执行其指定的回调. 4 # 3.什么时候用:当改变数据后,要基于更 ...

  8. (原创)[C#] GDI+ 之鼠标交互:原理、示例、一步步深入、性能优化

    一.前言 "GDI+"与"鼠标交互",乍一听好像不可能,也无从下手,但是实现原理比想象中要简单很多. 基于"GDI+"的"交互&q ...

  9. ceph 006 rbd高级特性 rbd快照 镜像克隆 rbd缓存 rbd增量备份 rbd镜像单向同步

    版本 [root@clienta ~]# ceph -v ceph version 16.2.0-117.el8cp (0e34bb74700060ebfaa22d99b7d2cdc037b28a57 ...

  10. java-流的使用完结与异常处理机制

    1.1java.io.objectInputStream 对象输入流:用于将一组字节(通过对象输出流写出对象而转换的一组字节)读取并转换为对应的对象.对象输出流将对象写出时转换为一组字节的过程,称为: ...