zan-pc-ajax v5.1.0

zan-pc-ajax

用于 PC 端的 ajax 请求库, 基于 Promise 的 ajax 实现，支持 browser 和 node 环境，jsonp 不支持 node。

使用时请确保存在全局的Promise实现。推荐 es6-promise

和zan-ajax的关系

zan-ajax 是通用的包，不包含任何业务相关的处理逻辑(比如对非零 code 的处理)，zan-pc-ajax 是在 zan-ajax 基础上加上了 PC 端的业务逻辑。

PC 端都应该使用这个库来发请求。

代码演示

import ajax from "zan-pc-ajax";

// get
ajax({
  url: "http://youzan.com/some.json",
  data: {
    quux: 2,
  },
})
  .then((data) => {})
  .catch((msg) => {});

// post
ajax({
  url: "http://youzan.com/some.json",
  method: "POST",
  data: {
    foobar: 1,
  },
});

// 通过 rawResponse 获取请求的原始数据
ajax({
  url: "http://youzan.com/some.json",
  data: {
    quux: 2,
  },
  rawResponse: true,
})
  .then((resp) => {
    const { code, data } = resp;
  })
  .catch((resp) => {
    const { code, msg } = resp;
  });

// jsonp
ajax({
  url: "http://youzan.com/some.jsonp",
  dataType: "jsonp",
  data: {
    foobar: 2,
  },
});

// Node 端假如需要处理一些 Java 的长整数类型的 JSON 字段，可以使用 allowBigNumberInJSON 将这些数字存储为字符串
ajax({
  url: "http://youzan.com/some-java-api-with-long-long-in-json",
  allowBigNumberInJSON: true,
});

API

函数原型 ajax(ajaxOptions): Promise

ajaxOptions 是请求的参数。返回值是一个 Promise，请求成功会 resolve，请求失败会 reject。

ajax

jsonp

dataType 是 jsonp 的时候这些参数有效。

rawResponse 的说明

// 对于下面这个请求返回值
// rawResponse为true，resolve/reject拿到的是后端返回的原始数据
// rawResponse为false, resolve拿到的是data字段下的值；reject拿到的是msg下的值
{
  "code": 0,
  "msg": "",
  "data": {
    "id": "63077",
    "shop_id": "63077",
    "team_name": "\u8d77.\u7801\u8fd0\u52a8\u9986a",
  }
}

取消请求

使用 ajax 上的 CancelToken 创建 token，有两种使用方式。

不同的请求可以使用同一个 token，调用这个 token 的 cancel 方法时会同时取消所有使用这个 token 的请求。

jsonp 请求不支持取消操作。

var CancelToken = ajax.CancelToken;
var source = CancelToken.source();

ajax({
  url: "/user/12345",
	cancelToken: source.token,
	
	// 使用 isCancel 必须是  rawResponse 模式
	// 只是使用 source.cancel 的话则没有这个限制
  rawResponse: true,
}).catch(function (thrown) {
  if (ajax.isCancel(thrown)) {
    console.log("Request canceled", thrown.message);
  } else {
    // handle error
  }
});

// cancel the request (the message parameter is optional)
source.cancel("Operation canceled by the user.");

var CancelToken = ajax.CancelToken;
var cancel;

ajax({
  url: "/user/12345",
  cancelToken: new CancelToken(function executor(c) {
    // An executor function receives a cancel function as a parameter
    cancel = c;
  }),
});

// cancel the request
cancel();

URL 参数序列化

内部使用的序列化函数等价于 jQuery.param(value, false)

多域名支持

为了支持多域名请求 Host，默认从 runtime 中获取由 pc-shared 下发的 zan-pc-ajax，兜底使用原始 Ajax。

使用者无需感知这个改动，正常引用就好。如果需要强制使用非 runtime 版本，可以 import { rawPcAjax } from 'zan-pc-ajax' 导入原始 Ajax（99.99% 没有使用的场景）。