网络

my.request

小程序网络请求

基础库 1.11.0 以上才支持, 可以使用 my.canIUse('request') 做兼容性处理。详见 兼容接口说明

注意

支付宝端旧接口my.httpRequest将被废弃，请使用my.request 来代替。钉钉端目前尚未支持my.request，请继续使用my.httpRequest。

重要:my.request 的请求头默认值为 {'content-type': 'application/json'}，而不是{'content-type': 'application/x-www-form-urlencoded'}

入参

data参数说明

传给服务器的数据最终会是 String 类型，如果 data 不是 String 类型，会被转换成 String 。转换规则如下：

• 若方法为GET，会将数据转换成 query string： encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)…
• 若方法为 POST 且 headers['content-type'] 为 application/json ，会对数据进行 JSON 序列化
• 若方法为 POST 且 headers['content-type'] 为 application/x-www-form-urlencoded ，会将数据转换成 query string： encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)…

success返回值

错误码

当入参dataType值为json时，小程序框架会先对返回结果做JSON.prase操作，如果解析失败，则会返回error为14的错误。当入参dataType值为text时，如果返回的内容格式不符，也会返回error为14的错误。遇到此错误时，请先检查dataType的设置是否正确。

返回值

RequestTask

网络请求任务对象

基础库 1.11.0 以上才支持, 可以使用 my.canIUse('request') 做兼容性处理。详见 兼容接口说明

方法

RequestTask.abort()

基础库 1.11.0 以上才支持, 可以使用 my.canIUse('request') 做兼容性处理。详见 兼容接口说明

代码示例

my.request({
  url: 'https://httpbin.org/post',
  method: 'POST',
  data: {
    from: '支付宝',
    production: 'AlipayJSAPI',
  },
  dataType: 'json',
  success: function(res) {
    my.alert({content: 'success'});
  },
  fail: function(res) {
    my.alert({content: 'fail'});
  },
  complete: function(res) {
    my.hideLoading();
    my.alert({content: 'complete'});
  }
});
// 返回RequestTask，可以调用abort方法取消请求
const task = my.request({url: 'https://httpbin.org/post'})
task.abort()

注意：如果 request 调用返回「无权调用该接口」时，则需要在开放平台配置后台的 request 中添加你需要访问的域名地址（小程序详情 > 设置 > 开发设置 > httpRequest接口请求域名白名单）：

my.uploadFile

暂不支持个人开发者使用

上传本地资源到开发者服务器。扫码体验：

入参

success 返回值

错误码

代码示例

my.uploadFile({
  url: '请使用自己服务器地址',
  fileType: 'image',
  fileName: 'file',
  filePath: '...',
  success: (res) => {
    my.alert({
      content: '上传成功'
    });
  },
});

my.downloadFile

暂不支持个人开发者使用

下载文件资源到本地。扫码体验：

入参

success 返回值

错误码

代码示例

my.downloadFile({
      url: 'http://img.alicdn.com/tfs/TB1x669SXXXXXbdaFXXXXXXXXXX-520-280.jpg',
      success({ apFilePath }) {
        my.previewImage({
          urls: [apFilePath],
        });
      },
      fail(res) {
        my.alert({
          content: res.errorMessage || res.error,
        });
      },
    });

my.connectSocket

创建一个 WebSocket 的连接；一个支付宝小程序同时只能保留一个 WebSocket 连接，如果当前已存在 WebSocket 连接，会自动关闭该连接，并重新创建一个新的 WebSocket 连接。

扫码体验：

入参

错误码

示例代码

my.connectSocket({
  url: 'test.php',
  data: {},
  header:{
    'content-type': 'application/json'
  },
  method:"GET",
});

my.onSocketOpen

监听WebSocket连接打开事件。

示例代码

my.connectSocket({
  url: 'test.php',
});
my.onSocketOpen(function(res) {
  console.log('WebSocket 连接已打开！');
});

my.offSocketOpen

取消监听WebSocket连接打开事件。

Page({
  onLoad() {
    this.callback = this.callback.bind(this);
    my.onSocketOpen(this.callback);
  },
  onUnload() {
    my.offSocketOpen(this.callback);
  },
  callback(res) {
  },
})

my.onSocketError

监听WebSocket错误。

示例代码

my.connectSocket({
  url: '开发者的服务器地址'
});
my.onSocketOpen(function(res){
  console.log('WebSocket 连接已打开！');
});
my.onSocketError(function(res){
  console.log('WebSocket 连接打开失败，请检查！');
});

my.offSocketError

取消监听WebSocket错误。

Page({
  onLoad() {
    this.callback = this.callback.bind(this);
    my.onSocketError(this.callback);
  },
  onUnload() {
    my.offSocketError(this.callback);
  },
  callback(res) {
  },
})

my.sendSocketMessage

通过 WebSocket 连接发送数据，需要先使用 my.connectSocket 发起建连，并在 my.onSocketOpen 回调之后再发送数据。

入参

示例代码

my.sendSocketMessage({
    data: this.data.toSendMessage, // 需要发送的内容
    success: (res) => {
        my.alert({content: '数据发送！' + this.data.toSendMessage});
    },
});

my.onSocketMessage

监听WebSocket接受到服务器的消息事件。

回调返回值

示例代码

my.connectSocket({
  url: '服务器地址'
})
my.onSocketMessage(function(res) {
  console.log('收到服务器内容：' + res.data)
})

my.offSocketMessage

取消监听WebSocket接受到服务器的消息事件。

my.closeSocket

入参

代码示例

关闭WebSocket连接。

my.onSocketOpen(function() {
  my.closeSocket()
})
my.onSocketClose(function(res) {
  console.log('WebSocket 已关闭！')
})

my.onSocketClose

代码示例

监听WebSocket关闭。

onLoad() {
    // 注意： 回调方法的注册在整个小程序启动阶段只要做一次，调多次会有多次回调
    my.onSocketClose((res) => {
      my.alert({content: '连接已关闭！'});
      this.setData({
        sendMessageAbility: false,
        closeLinkAbility: false,
      });
    });
    // 注意： 回调方法的注册在整个小程序启动阶段只要做一次，调多次会有多次回调
    my.onSocketOpen((res) => {
      my.alert({content: '连接已打开！'});
      this.setData({
        sendMessageAbility: true,
        closeLinkAbility: true,
      });
    });
    my.onSocketError(function(res){
      my.alert('WebSocket 连接打开失败，请检查！' + res);
    });
    // 注意： 回调方法的注册在整个小程序启动阶段只要做一次，调多次会有多次回调
    my.onSocketMessage((res) => {
      my.alert({content: '收到数据！' + JSON.stringify(res)});
    });
  }
connect_start() {
    my.connectSocket({
      url: '服务器地址', // 开发者服务器接口地址，必须是 wss 协议，且域名必须是后台配置的合法域名
      success: (res) => {
        my.showToast({
          content: 'success', // 文字内容
        });
      },
      fail:()=>{
        my.showToast({
          content: 'fail', // 文字内容
        });
      }
    });
  },

my.offSocketClose

取消监听WebSocket关闭。

原文: https://docs.alipay.com/mini/api/network