Fly.js 的定位是成为 Javascript http请求的终极解决方案,也就是说,在任何能够执行 Javascript 的环境,只要具有访问网络的能力,Fly都能运行在其上,并提供统一的Promise based API。
Github: github.com/wendux/fly
已支持的平台
Fly.js 官方支持的Javascript运行时包括:浏览器、node、微信小程序。这意味着你可以在这些平台使用同一份代码来发起http请求。值得一提是集成到web应用时(浏览器环境), fly.js的大小只有4.7KB, 非常轻量。
统一的用户层API
Fly.js 支持的JavaScript运行时是不同的,但提供的用户层API是统一的,API是基于Promise的,风格和 axios 很像(但不完全相同),下面看几个例子:
发起GET请求
var fly=require("flyio")
//通过用户id获取信息,参数直接写在url中
fly.get('/user?id=133')
.then(function (response) {
console.log(response);
})
.catch(function (error) {
console.log(error);
});
//query参数通过对象传递
fly.get('/user', {
id: 133
})
.then(function (response) {
console.log(response);
})
.catch(function (error) {
console.log(error);
});
复制代码
发起POST请求
fly.post('/user', {
name: 'Doris',
age: 24
phone:"18513222525"
})
.then(function (response) {
console.log(response);
})
.catch(function (error) {
console.log(error);
});
复制代码
发起多个并发请求
function getUserRecords() {
return fly.get('/user/133/records');
}
function getUserProjects() {
return fly.get('/user/133/projects');
}
fly.all([getUserRecords(), getUserProjects()])
.then(fly.spread(function (records, projects) {
//两个请求都完成
}))
.catch(function(error){
console.log(error)
})
复制代码
…….
上面只是Fly.js的简单使用,Fly.js 除了支持Promise风格的API之外,另外还支持:
- 支持请求/响应拦截器。
- 自动转换 JSON 数据。
- 浏览器端支持全局Ajax拦截。
- API支持typeScript。
- 支持请求配置
- H5页面内嵌到原生 APP 中时,支持将 http 请求转发到 Native,支持直接请求图片。
详细的文档请参考 github fly .
支持多平台的原理
Fly 引入了Http Engine 的概念,所谓 Http Engine,就是真正发起 http 请求的引擎,这在浏览器中一般都是XMLHttpRequest
,而在其它JavaScript运行时下,需要提供相应平台的Http Engine,Fly 正是通过切换不同平台的 Http Engine 而实现同时支持不同JavaScript运行时的 。
Http Engine 是一个标准的接口协议,内部实现了真正的HTTP请求逻辑,不同JavaScript运行时只需要实现Http Engine的接口协议,就可以无缝集成到Fly.js中。
如何支持新的JavaScript运行时
如上所述,要支持新的JavaScript运行时时,我们需要实现该平台下的Http Engine即可,但是从头实现一个Http Engine 是非常复杂的,为此,Fly 官方提供了一个 EngineWrapper 帮助工具,它可以通过一个adapter(适配器)生成一个完整的 Http Engine,所以,我们只需要实现一个adapter就行。
一个简单的例子
var engine= EngineWrapper(function (request,responseCallback) {
responseCallback({
statusCode:200,
responseText:"你变或者不变,我都不变😜。",
extraFeild:"自定义字段"
})
})
fly.engine=engine;
fly.get("../package.json").then(d=>{
log(d.data)
log(d.extraFeild)
})
控制台输出
> 你变或者不变,我都不变😜。
> 自定义字段
复制代码
EngineWrapper的参数就是adapter, 在这个例子中,adapter 并没有真正发起 http 请求,而是直接返回了固定内容,这样 fly 上层请求任何接口收到的内容永远都是相同的。完整的示例请移步:Fly.js-Http Engine .
远程Http Engine
我们说过,在浏览器环境中,fly 使用的默认engine 就是 XMLHttpRequest
。现在我们想想混合APP, 如果能在 Native(Android、IOS) 上实现一个engine,然后供浏览器中的 fly 使用,那么也就会将原本应该在浏览器中发起的请求重定向到了 Native 上。而这个在 Native 上实现的 engine,我们称其为远程 Http Engine,这是因为调用者和执行者并不在同一个环境。
通过远程Http Engine, Fly.js可以实现一个逆天的功能–请求重定向。它可以将本来会在浏览器中发起的http请求重定向到Native, 这样就可以在Native 上进行统一的请求管理、cookie同步、证书检验、缓存和访问控制等,详细的内容请参考: Fly.js 请求重定向 。
最后
贴出Fly.js的Github源码地址:github.com/wendux/fly , 详细的文档请移步github, 如果你喜欢Fly.js,欢迎star.