Show:

bui.ajax Class

Defined in: src/scripts/mix/web/bui.ajax.js:22
Module: Native

数据请求, $.ajax 跟 app.ajax 有的参数, bui.ajax 都有. 可以全局配置所有请求的默认参数: bui.config.ajax = { headers: {} }

预览地址: demo

Constructor

bui.ajax

(
  • option
)

Defined in src/scripts/mix/web/bui.ajax.js:22

Parameters:

  • option Object
    • url String

      [请求的地址]

    • data Object

      传输的数据为json对象 {}

    • [baseUrl] String optional

      请求的域名,可以单独配置,1.5.4新增

    • [method] String optional

      传输的方法 GET | POST

    • [headers] Object optional

      通过header传输的参数 {}

    • [success] Function optional

      成功的回调

    • [fail] Function optional

      失败的回调

    • [async] Boolean optional

      true 是异步 | false 是同步

    • [transformRequest] Function optional

      1.5.4新增,可以在数据请求前,对data做处理,需要返回

    • [transformResponse] Function optional

      1.5.4新增,可以在数据请求成功后,对data做处理,再进行返回

    • [dataType] String optional

      默认 json | jsonp | script | xml | html | text

    • [contentType] String optional

      GET默认 'text/html;charset=UTF-8'（中文会被转码，可以传"",由$.ajax处理 ） | POST默认: 'application/x-www-form-urlencoded'(表单,接口跨域需要设置这个) | 'multipart/form-data'(表单里有file文件) | 'application/json'(后端要用@requestbody接收) 前端传过去的参数要用 JSON.stringify 转换下

    • [cache] String optional

      1.5.6 默认 true | false

    • [timeout] Number optional

      超出这个时间则认为请求失败

    • [needJsonString] Boolean optional

      1.4.6新增,默认 false|true. true时会尝试把数据转换为string. 这个主要配合list控件的特殊请求使用,正常都是一个对象, 如果为true,后台一般以@requestbody 接收,postman的body 是raw 的形式

    • [needNative] Boolean optional

      1.5.1新增,默认 false 使用webajax | true 使用原生, 大部分打包以后支持跨域,如果不支持,再手动切换成原生, 前提是你的bui.js是支持原生版

    • [proxy] String optional

      1.5.5新增, 内部修改接口为相对路径,值为:代理的二级目录,例如: 接口地址 http://easybui.com/api/getUser?id=123 配置 proxy: "/api" 这样接口请求就变成 api/getUser?id=123, 结合工程的 app.json 使用

Example:

    // 例子1. 简单示例:
                                            bui.ajax({
                                                url: "",
                                                data: {}
                                            }).then(function(res){
                                                console.log(res)
                                            },function(res,status){
                                                console.log(status);
                                              // status = "timeout" || "error" || "abort", "parsererror"
                                            })

Item Index

Methods

Methods

readFile

(
  • [option] []
  • [option.content] [ 文件的内容]
  • [option.type] [ 默认 "text/plain"]
  • [option.onSuccess] [成功的回调]
  • [option.onFail] [失败的回调]
)
chainable

Defined in src/scripts/mix/link/bui.native.file.js:570

Available since 1.8.3

读取文本文件

Parameters:

  • [option] [] Object optional
  • [option.content] [ 文件的内容] String optional
  • [option.type] [ 默认 "text/plain"] String optional
  • [option.onSuccess] [成功的回调] Function optional
  • [option.onFail] [失败的回调] Function optional

Example:

       // 会包含文件夹所有的文件, 谨慎使用
                                                       uiFile.getFile({
                                                           folderName: "download",
                                                           fileName: "bui.txt",
                                                           onSuccess: function (file) {
                                                
                                                               this.readFile({
                                                                   file: file,
                                                                   onSuccess(content){
                                                                       bui.alert(content)
                                                                   }
                                                               })
                                                               
                                                           },
                                                           onFail: function (err) {
                                                               bui.alert(err)
                                                           }
                                                       })
                                                   })

writeFile

(
  • [option] []
  • [option.fileName] [ 文件名称,]
  • [option.folderName] [ 哪个文件夹下的文件]
  • [option.content] [ 文件的内容]
  • [option.type] [ 默认 "text/plain"]
  • [option.onSuccess] [成功的回调]
  • [option.onFail] [失败的回调]
)
chainable

Defined in src/scripts/mix/link/bui.native.file.js:504

Available since 1.8.3

写入文本文件

Parameters:

  • [option] [] Object optional
  • [option.fileName] [ 文件名称,] String optional
  • [option.folderName] [ 哪个文件夹下的文件] String optional
  • [option.content] [ 文件的内容] String optional
  • [option.type] [ 默认 "text/plain"] String optional
  • [option.onSuccess] [成功的回调] Function optional
  • [option.onFail] [失败的回调] Function optional

Example:

       // 会包含文件夹所有的文件, 谨慎使用
                                                       uiFile.getFile({
                                                           folderName: "download",
                                                           fileName: "bui.txt",
                                                           create: true,
                                                           onSuccess: function (file) {
                                                               $output.text(file.nativeURL);
                                                
                                                               this.writeFile({
                                                                   file: file,
                                                                   content: "bui is Easy and fast"
                                                               })
                                                           },
                                                           onFail: function (err) {
                                                               bui.alert(err)
                                                           }
                                                       })