Skip to content
🚀 Supporting request forwarding and Promise based HTTP client for all JavaScript runtimes.
JavaScript HTML TypeScript
Branch: master
Clone or download

Latest commit

Latest commit fced928 Mar 12, 2019

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
coverage 添加支付宝小程序支持 #175 #176 #177 #189 Jan 25, 2019
demon 修复encode多级数组索引bug Jan 25, 2019
dist fix #194 Mar 12, 2019
imgs update doc Mar 23, 2018
miniprogram_dist
src fix #194 Mar 12, 2019
test
.gitignore build Jun 28, 2018
.npmignore fix #67 May 21, 2018
.travis.yml add group test May 2, 2018
CHANGELOG.md 1. 添加“params”配置项 Sep 6, 2018
LICENSE add license Apr 20, 2018
README-EN.md 1. 添加“params”配置项 Sep 6, 2018
README.md
_.js 添加支付宝小程序支持 #175 #176 #177 #189 Jan 25, 2019
build.js 添加支付宝小程序支持 #175 #176 #177 #189 Jan 25, 2019
fly.png modify doc Sep 24, 2017
index.d.ts export Fly interface Aug 11, 2018
index.js Support execute async task in interceptors Apr 19, 2018
karma.conf.js add group test May 2, 2018
node-index.js
package.json fix #194 Mar 12, 2019
upload.txt fix #56 Apr 26, 2018
v.png add browser entry Sep 21, 2017

README.md

English|中文简体

fly.js

npm version build status coverage size platform

Fly.js

一个支持所有JavaScript运行环境的基于Promise的、支持请求转发、强大的http请求库。可以让您在多个端上尽可能大限度的实现代码复用。

浏览器支持

Chrome Firefox Safari Opera Edge IE
> 8

其它支持的平台

node logo Mini Program logo mpvue logo weex logo quick app logo 支付宝小程序 支付宝小程序

目前Fly.js支持的平台包括:Node.js微信小程序WeexReact NativeQuick App 和浏览器,这些平台的 JavaScript 运行时都是不同的。更多的平台正在持续添加中,请保持关注。

简介

Fly.js 是一个基于 promise 的,轻量且强大的Javascript http 网络库,它有如下特点:

  1. 提供统一的 Promise API。
  2. 浏览器环境下,轻量且非常轻量
  3. 支持多种JavaScript 运行环境
  4. 支持请求/响应拦截器。
  5. 自动转换 JSON 数据。
  6. 支持切换底层 Http Engine,可轻松适配各种运行环境
  7. 浏览器端支持全局Ajax拦截 。
  8. H5页面内嵌到原生 APP 中时,支持将 http 请求转发到 Native。支持直接请求图片

定位与目标

Fly 的定位是成为 Javascript http请求的终极解决方案。也就是说,在任何能够执行 Javascript 的环境,只要具有访问网络的能力,Fly都能运行在其上,提供统一的API。

官网

详细的文档请移步:Flyio官网文档 。 官网http请求使用的正是fly,为了方便大家验证fly功能特性,官网对fly进行了全局引入,您可以在官网页面打开控制台直接验证。

English doc

安装

使用NPM

npm install flyio

使用CDN(浏览器中)

<script src="https://unpkg.com/flyio/dist/fly.min.js"></script>

UMD(浏览器中)

https://unpkg.com/flyio/dist/umd/fly.umd.min.js

引入flyio

不同JavaScript运行时的入口文件不同 ,请查看文档后面相应平台的引入方式,但在浏览器、Node、React Native中引入的方式是一样的,下面是不同平台下的引入的方式:

  1. 浏览器、Node、React Native中引入

    //引入fly实例
    var fly=require("flyio")

    上面方式引入的是Fly的默认实例(浏览器、Node、React Native中相同),你也可以自己创建Fly实例:

    // 浏览器和React Native
    var Fly=require("flyio/dist/npm/fly")
    // Node 入口
    // var Fly=require("flyio/src/node")
    var fly=new Fly;
  2. 在微信小程序中引入

    var Fly=require("flyio/dist/npm/wx") 
    var fly=new Fly

    如果您的微信小程序项目没有使用npm来管理依赖,您可以直接下载源码到您的小程序工程,下载链接wx.jswx.umd.min.js .下载任意一个,保存到本地工程目录,假设在“lib”目录,接下来引入:

    var Fly=require("../lib/wx") //wx.js为您下载的源码文件
    var fly=new Fly; //创建fly实例
  3. 在支付宝小程序中引入

    var Fly=require("flyio/dist/npm/ap") 
    var fly=new Fly

    如果您的支付宝小程序项目没有使用npm来管理依赖,您可以直接下载源码到您的小程序工程,下载链接ap.jsap.umd.min.js .下载任意一个,保存到本地工程目录,假设在“lib”目录,接下来引入:

    var Fly=require("../lib/ap") //ap.js为您下载的源码文件
    var fly=new Fly; //创建fly实例
  4. 快应用中引入

    快应用 中Fly依赖 fetch模块,需要先在 manifest.json中添加引用:

      "features": [
         ...
        {"name": "system.fetch"}
      ]

    然后创建fly实例

     //依赖快应用中的fetch模块,需要在
     var fetch = require("@system.fetch")
     var Fly=require("flyio/dist/npm/hap")
     var fly=new Fly(fetch)
  5. Weex中引入

    var Fly=require("flyio/dist/npm/weex")
    var fly=new Fly

引入之后,您就可以对fly实例进行全局配置、添加拦截器、发起网络请求了。

例子

下面示例如无特殊说明,则在所有支持的平台下都能执行。

发起GET请求

//通过用户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);
  });

Post请求添加Url参数

fly.get("../package.json", "xxx=5", {
        params: {
            c: 1
        }
    }
)

最终的URL是“package.json?c=1&xxx=5”。

发起多个并发请求

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)
  })

直接通过 request 接口发起请求

//直接调用request函数发起post请求
fly.request("/test",{hh:5},{
    method:"post",
    timeout:5000 //超时设置为5s
 })
.then(d=>{ console.log("request result:",d)})
.catch((e) => console.log("error", e))

发送URLSearchParams

const params = new URLSearchParams();
params.append('a', 1);
fly.post("",params)
.then(d=>{ console.log("request result:",d)})

注:Node环境不存在URLSearchParams。各个浏览器对URLSearchParams的支持程度也不同,使用时务必注意

发送 FormData

 var formData = new FormData();
 var log=console.log
 formData.append('username', 'Chris');
 fly.post("../package.json",formData).then(log).catch(log)

注:Fly目前只在支持 FormData 的浏览器环境中支持 FormData,Node环境下对 FormData 的支持方式稍有不同,详情戳这里 Node 下增强的API

请求二进制数据

fly.get("/Fly/v.png",null,{
	responseType:"arraybuffer"
}).then(d=>{
  //d.data 为ArrayBuffer实例
})

注:在浏览器中时 responseType 值可为 "arraybuffer" 或"blob"之一。在node下只需设为 "stream"即可。

拦截器

Fly支持请求/响应拦截器,可以通过它在请求发起之前和收到响应数据之后做一些预处理。

//添加请求拦截器
fly.interceptors.request.use((request)=>{
    //给所有请求添加自定义header
    request.headers["X-Tag"]="flyio";
  	//打印出请求体
  	console.log(request.body)
  	//终止请求
  	//var err=new Error("xxx")
  	//err.request=request
  	//return Promise.reject(new Error(""))
  
    //可以显式返回request, 也可以不返回,没有返回值时拦截器中默认返回request
    return request;
})

//添加响应拦截器,响应拦截器会在then/catch处理之前执行
fly.interceptors.response.use(
    (response) => {
        //只将请求结果的data字段返回
        return response.data
    },
    (err) => {
        //发生网络错误后会走到这里
        //return Promise.resolve("ssss")
    }
)

请求拦截器中的request对象结构如下:

{
  baseURL,  //请求的基地址
  body, //请求的参数
  headers, //自定义的请求头
  method, // 请求方法
  timeout, //本次请求的超时时间
  url, // 本次请求的地址
  params, //url get参数(post请求或默认的get参数)    
  withCredentials, //跨域请求是否发送第三方cookie
  ... //options中自定义的属性
}

响应拦截器中的response对象结构如下:

{
  data, //服务器返回的数据
  engine, //请求使用的http engine(见下面文档),浏览器中为本次请求的XMLHttpRequest对象
  headers, //响应头信息
  request  //本次响应对应的请求信息,即上面的request结构
}

移除拦截器

如果你想移除拦截器,只需要将拦截器设为null即可:

fly.interceptors.request.use(null)
fly.interceptors.response.use(null,null)

在拦截器中执行异步任务

现在,您可以在拦截器中执行异步任务了!

下面我们看一个例子:由于安全原因,我们需要所有的请求都需要在header中设置一个csrfToken,如果csrfToken不存在时,我们需要先请求一个csrfToken,然后再发起网络请求,由于请求csrfToken是异步的,所以我们需要在拦截器中执行异步请求,代码如下:

var csrfToken="";
var tokenFly=new Fly();
var fly=new Fly();
fly.interceptors.request.use(function (request) {
  log(`发起请求:path:${request.url},baseURL:${request.baseURL}`)
  if (!csrfToken) {
    log("没有token,先请求token...");
    //锁定当天实例,后续请求会在拦截器外排队
    fly.lock();
    return newFly.get("/token").then((d) => {
      request.headers["csrfToken"] = csrfToken = d.data.data.token;
      log("token请求成功,值为: " + d.data.data.token);
      log(`继续完成请求:path:${request.url},baseURL:${request.baseURL}`)
      return request; //只有最终返回request对象时,原来的请求才会继续
    }).finally(()=>{
      //fly.clear(); //clear the request queue
      fly.unlock();//解锁后,会继续发起请求队列中的任务
    }) 
  } else {
    request.headers["csrfToken"] = csrfToken;
  }
})

注意:

  1. 当前Fly实例会在调用fly.lock时会被锁定,fly实例锁定后,接下来的请求在进入请求拦截器前会进入一个队列排队,当解锁后(通过调用fly.unlock),才会进入拦截器,这提供一种同步多个任务的方式。如果你想取消队列里的所有请求,可以调用fly.clear()
  2. 只有当最终返回request对象时(拦截器传递给你的回调参数),请求才会继续(如代码中注释), 否则将会把返回的值作为本次请求。

有关拦截器的详细信息和示例,请参阅flyio interceptor

错误处理

请求失败之后,catch 捕获到的 err 是一个对象,它的字段如下:

{
  message:"Not Find 404", //错误消息
  status:404, //如果服务器可通,则为http请求状态码。网络异常时为0,网络超时为1
  request:{...}, //对应的请求信息
  response:{}, //响应信息
  engine:{}//请求使用的http engine(见下面文档),浏览器中为本次请求的XMLHttpRequest对象
}

错误码

错误码 含义
0 网络错误
1 请求超时
2 文件下载成功,但保存失败,此错误只出现node环境下
>=200 http请求状态码

示例

fly.get('/user/12345')
  .catch(function (error) {
    console.log('Error', error.message);
    console.log('Error engine:', error.engine)
    // The request was made but no response was received
    // `error.request` holds the request info.
    console.log('Error request info:',error.request);
    if (error.response) {
      // The request was made and the server responded with a status code
      // that falls out of the range of 2xx and 304
      console.log(error.response.data);
      console.log(error.response.status);
      console.log(error.response.statusText);
      console.log(error.response.headers);
    }
  });

请求配置选项

可配置选项:

{
  headers:{}, //http请求头,
  baseURL:"", //请求基地址
  timeout:0,//超时时间,为0时则无超时限制
  //是否自动将Content-Type为“application/json”的响应数据转化为JSON对象,默认为true    
  parseJson:true,
  params:{}, //默认公共的url get参数     
  withCredentials:false //跨域时是否发送cookie
}

配置支持实例级配置单次请求配置

实例级配置

实例级配置可用于当前Fly实例发起的所有请求

//定义公共headers
fly.config.headers={xx:5,bb:6,dd:7}
//设置超时
fly.config.timeout=10000;
//设置请求基地址
fly.config.baseURL="https://wendux.github.io/"
//设置公共的Get参数
fly.config.params={"token":"testtoken"};

单次请求配置

需要对单次请求配置时,配置只对当次请求有效。

fly.request("/test",{hh:5},{
    method:"post",
    timeout:5000 //超时设置为5s
})

注:若单次配置和实例配置冲突,则会优先使用单次请求配置

详细的配置请参考 Fly请求配置

API

fly.get(url, data, options)

发起 get 请求,url请求地址,data为请求数据,在浏览器环境下类型可以是:

String|Json|Object|Array|Blob|ArrayBuffer|FormData

options为请求配置项。

fly.post(url, data, options)

发起post请求,参数含义同fly.get。

fly.request(url, data, options)

发起请求,参数含义同上,在使用此API时需要指定options 的method:

//GET请求
fly.request("/user/8" null, {method:"get"})
//DELETE 请求
fly.request("/user/8/delete", null, {method:"delete"})
//PUT请求
fly.request("/user/register", {name:"doris"}, {method:"PUT"})
......

request 适合在 RESTful API 的场景下使用,为了方便使用,fly提供了响应的别名方法

别名方法

fly.put(url, data, options)

fly.delete(url,data,options)

fly.patch(url,data,options)

fly.all([])

fly.spread([])

发起多个并发请求,参数是一个promise 数组;当所有请求都成功后才会调用then,只要有一个失败,就会调 catch

使用application/x-www-form-urlencoded 编码

Fly默认会将JavaScript objects 序列化为 JSON 发送(RequestBody),如果想以 application/x-www-form-urlencoded 编码格式发送,你可以使用如下方式:

通过设置请求头

将请求头content-type设置为"application/x-www-form-urlencoded"后fly会自动对请求数据进行编码,如:

fly.post("../package.json",{aa:8,bb:9,tt:{xx:5}},{headers:{
    "content-type":"application/x-www-form-urlencoded"
}})
.then(console.log)

这种方法是通用的,意味着在任何JavaScript运行环境下都能正常工作,还有一些其它特定平台的方法:

其它方法

浏览器中

在浏览器中, 你可以使用 URLSearchParams ,如下:

var params = new URLSearchParams();
params.append('param1', 'value1');
params.append('param2', 'value2');
fly.post('/foo', params);

注意,现在不是所有浏览器都支持 URLSearchParams (参考 caniuse.com), 但是有一个 polyfill 可用 (确保polyfill为全局变量).

另一种方法,你可以使用 qs 库:

var qs = require('qs');
fly.post('/foo', qs.stringify({ 'bar': 123 }));

Node.js

在node中,你可以使用 querystring 模块,如:

var querystring = require('querystring');
fly.post('http://something.com/', querystring.stringify({ foo: 'bar' }));

你仍然可以使用 qs 库.

Promises

Fly 依赖 ES6 Promise 支持情况. 如果你的环境不支持 ES6 Promises, 你需要 polyfill.

TypeScript

Fly 提供了 TypeScript 描述文件.你可以在TypeScript中方便使用:

import fly from 'flyio';
fly.get('/user?ID=12345');

创建Fly实例

为方便使用,在引入flyio库之后,会创建一个默认实例,一般情况下大多数请求都是通过默认实例发出的,但在一些场景中需要多个实例(可能使用不同的配置请求),这时你可以手动new一个:

//npm、node环境下
var  Fly=require("flyio/dist/npm/fly") //注意!此时引入的是 "flyio/dist/npm/fly"
var nFly=new Fly();

//CDN引入时直接new
var nFly=new Fly();

Http engine

Fly 引入了Http engine 的概念,所谓 Http engine,就是真正发起http请求的引擎,这在浏览器中一般都是XMLHttpRequest,而在 node 环境中,可以用任何能发起网络请求的库/模块实现,Fly 可以自由更换底层 http engine ,Fly 正是通过更换 engine 而实现同时支持 node 和 browser 。值得注意的是,http engine 不局限于node 和 browser 环境中,也可以是 android、ios、electron,正是由于这些,Fly 才有了一个非常强大的功能——请求重定向。基于请求重定向,我们可以实现一些非常有用的功能,比如将内嵌到 APP 的所有 http 请求重定向到 Native ,然后在端上( android、ios )统一发起网络请求、进行 cookie 管理、证书校验。详情请戳 Fly Http Engine

全局Ajax拦截

在浏览器中,可以通过用 Fly engine 替换 XMLHttpRequest 的方式拦截全局的的 Ajax 请求,无论上层使用的是何种网络库。详细的内容请参考 Fly拦截全局Ajax

Node

无论是在浏览器环境,还是在 Node 环境,Fly在上层提供了统一的 Promise API。这意味着无论您是 web 开发还是 node 开发,您都可以以相同的调用方式来发起http请求。不过,由于node和浏览器环境本身的差异,在Node环境下,Fly除了支持基本的API之外,还提供了一些增强的API,这些 API 主要涉及文件下载、多文件上传、http代理等众多强大的功能,详情请参考 Node下增强的API

体积

在浏览器环境下,一个库的大小是非常重要的。这方面 Fly 做的很好,它在保持强大的功能的同时,将自己的身材控制到了最好。min 只有 4.6K 左右,GZIP 压缩后不到 2K,体积是 axios 的四分之一。

工程目录结构

工程目录结构及文件说明请参照 fly源码目录说明

最后

如果感觉 Fly 对您有用,欢迎 star 。

You can’t perform that action at this time.