Skip to content
Mr.HopeMr.Hope
主页
  • 小程序
    • 小程序教程

      • 小程序指南
        • 代码构成
          • 宿主环境
            • 配置

              • 配置
                • 全局配置文档
                  • 页面配置
                    • 小程序内索引
                    • 框架

                      • 框架
                        • 场景值
                          • 小程序的运行环境
                            • 小程序运行机制
                              • 小程序更新机制
                              • 逻辑层

                                • 逻辑层
                                  • 生命周期 <Badge text="不需要立即掌握" />
                                    • 页面路由
                                      • 注册
                                        • App
                                          • Page
                                            • 小程序运行机制
                                              • 模块化
                                                • API

                                                  • API <Badge text="重要" type="error" />
                                                    • 路由 API
                                                      • 数据缓存 API
                                                        • 页面交互 API
                                                          • 网络 API
                                                            • wx.request(Object object)
                                                              • request 参数
                                                                • request 返回值
                                                                  • data 参数说明
                                                                  • wx.downloadFile(Object object)
                                                                    • downloadFile 参数
                                                                      • downloadFile 返回值
                                                                      • wx.uploadFile(Object object)
                                                                        • uploadFile 参数
                                                                          • uploadFile 返回值
                                                                        • 系统相关 API
                                                                      • 视图层

                                                                        • 视图层 View
                                                                          • WXSS
                                                                            • 事件
                                                                              • 基础组件
                                                                                • 动画
                                                                                  • WXS
                                                                                    • WXS 事件
                                                                                      • 简易双向绑定
                                                                                        • 获取界面上的节点信息
                                                                                          • 初始渲染缓存
                                                                                          • 能力

                                                                                            • 小程序能力
                                                                                              • 网络
                                                                                                • 存储
                                                                                                  • 文件系统
                                                                                                    • 调试
                                                                                                  • 开发者工具

                                                                                                    • 工具使用
                                                                                                      • 界面
                                                                                                        • 调试
                                                                                                          • npm 支持
                                                                                                            • 体验评分
                                                                                                            • 小程序框架

                                                                                                              • 小程序框架说明
                                                                                                                • 小程序简易开发指南
                                                                                                                  • 小程序页面参数表
                                                                                                                    • Page 插件
                                                                                                                      • YAML 文件案例
                                                                                                                      • 小程序分享

                                                                                                                        网络 API

                                                                                                                        Mr.Hope2020年11月8日
                                                                                                                        • 小程序
                                                                                                                        大约 4 分钟

                                                                                                                        此页内容
                                                                                                                        • wx.request(Object object)
                                                                                                                          • request 参数
                                                                                                                          • request 返回值
                                                                                                                          • data 参数说明
                                                                                                                        • wx.downloadFile(Object object)
                                                                                                                          • downloadFile 参数
                                                                                                                          • downloadFile 返回值
                                                                                                                        • wx.uploadFile(Object object)
                                                                                                                          • uploadFile 参数
                                                                                                                          • uploadFile 返回值

                                                                                                                        # wx.request(Object object)

                                                                                                                        发起 HTTPS 网络请求。使用前请注意阅读相关说明。

                                                                                                                        # request 参数

                                                                                                                        Object object

                                                                                                                        属性类型默认值必填说明最低版本
                                                                                                                        urlstring是开发者服务器接口地址
                                                                                                                        datastring/object/ArrayBuffer否请求的参数
                                                                                                                        headerObject否设置请求的 header,header 中不能设置 Referer。
                                                                                                                        content-type 默认为 application/json
                                                                                                                        methodstringGET否HTTP 请求方法
                                                                                                                        dataTypestringjson否返回的数据格式
                                                                                                                        responseTypestringtext否响应的数据类型1.7.0
                                                                                                                        successfunction否接口调用成功的回调函数
                                                                                                                        failfunction否接口调用失败的回调函数
                                                                                                                        completefunction否接口调用结束的回调函数(调用成功、失败都会执行)

                                                                                                                        object.method 的合法值

                                                                                                                        值说明
                                                                                                                        OPTIONSHTTP 请求 OPTIONS
                                                                                                                        GETHTTP 请求 GET
                                                                                                                        HEADHTTP 请求 HEAD
                                                                                                                        POSTHTTP 请求 POST
                                                                                                                        PUTHTTP 请求 PUT
                                                                                                                        DELETEHTTP 请求 DELETE
                                                                                                                        TRACEHTTP 请求 TRACE
                                                                                                                        CONNECTHTTP 请求 CONNECT

                                                                                                                        object.dataType 的合法值

                                                                                                                        值说明
                                                                                                                        json返回的数据为 JSON,返回后会对返回的数据进行一次 JSON.parse
                                                                                                                        其他不对返回的内容进行 JSON.parse

                                                                                                                        object.responseType 的合法值

                                                                                                                        值说明
                                                                                                                        text响应的数据为文本
                                                                                                                        arraybuffer响应的数据为 ArrayBuffer

                                                                                                                        object.success 回调函数

                                                                                                                        参数

                                                                                                                        Object res

                                                                                                                        属性类型说明最低版本
                                                                                                                        datastring/Object/Arraybuffer开发者服务器返回的数据
                                                                                                                        statusCodenumber开发者服务器返回的 HTTP 状态码
                                                                                                                        headerObject开发者服务器返回的 HTTP Response Header1.2.0

                                                                                                                        # request 返回值

                                                                                                                        RequestTask

                                                                                                                        请求任务对象

                                                                                                                        # data 参数说明

                                                                                                                        最终发送给服务器的数据是 String 类型,如果传入的 data 不是 String 类型,会被转换成 String 。转换规则如下:

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

                                                                                                                        示例代码

                                                                                                                        wx.request({
                                                                                                                          url: "test.php", //仅为示例,并非真实的接口地址
                                                                                                                          data: {
                                                                                                                            x: "",
                                                                                                                            y: "",
                                                                                                                          },
                                                                                                                          header: {
                                                                                                                            "content-type": "application/json", // 默认值
                                                                                                                          },
                                                                                                                          success: (res) => {
                                                                                                                            console.log(res.data);
                                                                                                                          },
                                                                                                                        });
                                                                                                                        

                                                                                                                        # wx.downloadFile(Object object)

                                                                                                                        下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求,返回文件的本地临时路径,单次下载允许的最大文件为 50MB。使用前请注意阅读相关说明。

                                                                                                                        提示

                                                                                                                        请在服务端响应的 header 中指定合理的 Content-Type 字段,以保证客户端正确处理文件类型。

                                                                                                                        # downloadFile 参数

                                                                                                                        Object object

                                                                                                                        属性类型必填说明最低版本
                                                                                                                        urlstring是下载资源的 url
                                                                                                                        headerObject否HTTP 请求的 Header,Header 中不能设置 Referer
                                                                                                                        filePathstring否指定文件下载后存储的路径1.8.0
                                                                                                                        successfunction否接口调用成功的回调函数
                                                                                                                        failfunction否接口调用失败的回调函数
                                                                                                                        completefunction否接口调用结束的回调函数(调用成功、失败都会执行)

                                                                                                                        object.success 回调函数

                                                                                                                        参数

                                                                                                                        Object res

                                                                                                                        属性类型说明
                                                                                                                        tempFilePathstring临时文件路径。没传入 filePath 指定文件存储路径时会返回,下载后的文件会存储到一个临时文件
                                                                                                                        filePathstring用户文件路径。传入 filePath 时会返回,跟传入的 filePath 一致
                                                                                                                        statusCodenumber开发者服务器返回的 HTTP 状态码

                                                                                                                        # downloadFile 返回值

                                                                                                                        DownloadTask

                                                                                                                        一个可以监听下载进度变化事件和取消下载的对象

                                                                                                                        示例代码

                                                                                                                        wx.downloadFile({
                                                                                                                          url: "https://example.com/audio/123", //仅为示例,并非真实的资源
                                                                                                                          success: (res) => {
                                                                                                                            // 只要服务器有响应数据,就会把响应内容写入文件并进入 success 回调,业务需要自行判断是否下载到了想要的内容
                                                                                                                            if (res.statusCode === 200)
                                                                                                                              wx.playVoice({
                                                                                                                                filePath: res.tempFilePath,
                                                                                                                              });
                                                                                                                          },
                                                                                                                        });
                                                                                                                        

                                                                                                                        # wx.uploadFile(Object object)

                                                                                                                        将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求,其中 content-type 为 multipart/form-data。使用前请注意阅读相关说明。

                                                                                                                        # uploadFile 参数

                                                                                                                        Object object

                                                                                                                        属性类型必填说明
                                                                                                                        urlstring是开发者服务器地址
                                                                                                                        filePathstring是要上传文件资源的路径
                                                                                                                        namestring是文件对应的 key,开发者在服务端可以通过这个 key 获取文件的二进制内容
                                                                                                                        headerObject否HTTP 请求 Header,Header 中不能设置 Referer
                                                                                                                        formDataObject否HTTP 请求中其他额外的 form data
                                                                                                                        successfunction否接口调用成功的回调函数
                                                                                                                        failfunction否接口调用失败的回调函数
                                                                                                                        completefunction否接口调用结束的回调函数(调用成功、失败都会执行)

                                                                                                                        object.success 回调函数

                                                                                                                        参数

                                                                                                                        Object res

                                                                                                                        属性类型说明
                                                                                                                        datastring开发者服务器返回的数据
                                                                                                                        statusCodenumber开发者服务器返回的 HTTP 状态码

                                                                                                                        # uploadFile 返回值

                                                                                                                        UploadTask

                                                                                                                        一个可以监听上传进度进度变化的事件和取消上传的对象

                                                                                                                        示例代码

                                                                                                                        wx.chooseImage({
                                                                                                                          success: (res) => {
                                                                                                                            const tempFilePaths = res.tempFilePaths;
                                                                                                                        
                                                                                                                            wx.uploadFile({
                                                                                                                              url: "https://example.weixin.qq.com/upload", //仅为示例,非真实的接口地址
                                                                                                                              filePath: tempFilePaths[0],
                                                                                                                              name: "file",
                                                                                                                              formData: { user: "test" },
                                                                                                                              success: (res) => {
                                                                                                                                const data = res.data;
                                                                                                                                //do something
                                                                                                                              },
                                                                                                                            });
                                                                                                                          },
                                                                                                                        });
                                                                                                                        
                                                                                                                        编辑此页open in new window
                                                                                                                        上次编辑于: 2021/1/19 13:09:25
                                                                                                                        贡献者: Mr.Hope
                                                                                                                        上一页
                                                                                                                        页面交互 API
                                                                                                                        下一页
                                                                                                                        系统相关 API

                                                                                                                        预览:

                                                                                                                        0  字
                                                                                                                        评论
                                                                                                                        Powered by Waline v2.5.1
                                                                                                                        Copyright © 2019-present Mr.Hope