起源:远程函数
Methods
(static) ajax2Dialog(reference, key, redux) → {function}
「标准2阶」Ux.ajax2Dialog
直接封装 ajaxDialog 的2阶函数,函数参数如下:
参数名 | 类型 | 说明 |
---|---|---|
data | any | 响应的核心数据信息,Object 或 Array |
Parameters:
Name | Type | Default | Description |
---|---|---|---|
reference |
React.Component | React组件引用。 |
|
key |
String | 窗口所消费的资源文件中的 |
|
redux |
boolean |
false
|
是否启用 redux 流程。 |
Returns:
返回函数,该函数会消费响应信息得到 Promise。
- Type
- function
(static) ajax2Message(reference, key, redux) → {function}
「标准2阶」Ux.ajax2Message
直接封装 ajaxMessage 的2阶函数,函数参数如下:
参数名 | 类型 | 说明 |
---|---|---|
data | any | 响应的核心数据信息,Object 或 Array |
Parameters:
Name | Type | Default | Description |
---|---|---|---|
reference |
React.Component | React组件引用。 |
|
key |
String | 窗口所消费的资源文件中的 |
|
redux |
boolean |
false
|
是否启用 redux 流程。 |
Returns:
返回函数,该函数会消费响应信息得到 Promise。
- Type
- function
(static) ajax2True(consumer, content) → {function}
「标准2阶」Ux.ajax2True
当前 ajax 比较特殊,ajax 请求只会响应 true 或 false,根据最终结果执行相关操作
Parameters:
Name | Type | Description |
---|---|---|
consumer |
function | 执行的核心函数,在响应数据为 true 时执行该函数 |
content |
String | 消息中呈现的消息内容 |
Returns:
返回一个函数消费 true | false 的相关结果
- Type
- function
(async, static) ajaxDelete(uri, params, options) → {Promise.<T>}
「标准」Ux.ajaxDelete
安全方法(带token),DELETE开放性方法
Parameters:
Name | Type | Description |
---|---|---|
uri |
String | 远程开放的Api接口路径 |
params |
Object | 调用接口专用参数 |
options |
Object | Http请求头相关信息 |
Returns:
返回调用接口的 Promise
- Type
- Promise.<T>
(static) ajaxDialog(reference, data, key, redux) → {Promise.<T>}
「标准」Ux.ajaxDialog
弹出窗口专用函数,调用 Ant Design 中的 Modal
的弹出框处理,success, error, confirm 专用处理函数。
在传入的 reference 引用中,props 属性中必须包含 config
对象(窗口配置信息),它的结构如下:
1. key 为 String
如果传入的 key
是字符串,config 的配置结果如,这份结果来自资源文件中的 shared.json
{
"dialog": {
"modal": "模式信息",
"title": {
"success": "信息",
"failure": "警告",
"error": "错误",
"confirm": "提示"
}
}
}
执行了计算过后,会处理以下步骤
- 根据 mode 计算窗口标题,从
dialog
中的三种窗口中去读。 - 根据 pattern 数据计算最终的格式,Modal需要的。
计算的最终配置格式如:
{
"mode": "success | confirm | error",
"title": "标题文本",
"content": "内容使用 pattern 计算,执行 formatExpr 的格式化",
"redux": "是否开启 redux 流程"
}
2. key 为 Object
这是第二种配置模式,传入的 key 转换成 configuration 过后的数据格式如:
{
"title": "标题信息",
"pattern": "未解析的模式",
"content": "二选一,是否执行 formatExpr 的格式化操作",
"model": "success | confirm | error",
"redux": "是否开启 redux 流程"
}
3. 最终格式
不论 key 的传入类型是哪种,最终的处理格式如"
{
"title": "",
"content": "",
"mode": ""
"redux": ""
}
Parameters:
Name | Type | Description |
---|---|---|
reference |
React.Component | React组件引用。 |
data |
Object | Array | 响应数据处理格式。 |
key |
String | 窗口所消费的资源文件中的 |
redux |
boolean | 是否启用 redux 流程。 |
Returns:
返回效应窗口之外最终的 Promise。
- Type
- Promise.<T>
(async, static) ajaxDownload(uri, params, options) → {Promise.<T>}
「标准」Ux.ajaxDownload
安全方法(带token),GET
下载专用方法,下载内容会返回二进制数据
Parameters:
Name | Type | Description |
---|---|---|
uri |
String | 远程上传开放的Api接口路径 |
params |
Object | 下载文件的专用参数 |
options |
Object | Http请求头相关信息 |
Returns:
返回上传过后的 Promise
- Type
- Promise.<T>
(static) ajaxError(reference, error, redux)
「标准」Ux.ajaxError
错误信息专用函数,注,这里的 Component 的引用必须是绑定了cab/cn/
中的资源文件的组件,
资源文件中会自动包含 _dialog 的窗口键值,error的数据结构如:
{
"code": "错误代码,整数",
"message": "错误信息",
"info": "前端可读信息"
}
处理最终的响应数据时候还需要考虑 redux 参数
- redux = true,启用 redux 流程
- redux = false,不启用 redux 流程,仅使用当前组件流程,React 中的 state 状态流程
Parameters:
Name | Type | Default | Description |
---|---|---|---|
reference |
React.Component | React组件引用 |
|
error |
Object | Zero 的核心错误响应信息 |
|
redux |
boolean |
false
|
是否启用了 redux 流程写 redux 的树形数据 |
(async, static) ajaxFetch(uri, params, options) → {Promise.<T>}
「标准」Ux.ajaxFetch
非安全方法,GET开放性方法,从远程地址中直接读取远程请求数据的方法。
Parameters:
Name | Type | Description |
---|---|---|
uri |
String | 远程开放的Api接口路径 |
params |
Object | 调用接口专用参数 |
options |
Object | Http请求头相关信息 |
Returns:
返回调用接口的 Promise
- Type
- Promise.<T>
(async, static) ajaxGet(uri, params, options) → {Promise.<T>}
「标准」Ux.ajaxGet
安全方法(带token),GET开放性方法。
Parameters:
Name | Type | Description |
---|---|---|
uri |
String | 远程开放的Api接口路径 |
params |
Object | 调用接口专用参数 |
options |
Object | Http请求头相关信息 |
Returns:
返回调用接口的 Promise
- Type
- Promise.<T>
(static) ajaxMessage(reference, data, key) → {Promise.<T>}
「标准」Ux.ajaxMessage
该函数只支持一种格式,config 的配置结果如,这份结果来自资源文件中的 shared.json
但由于是 message 所以只考虑最终的 pattern 配置,并且使用 data 来执行 formatExpr 得到最终
的 content 相关数据,消息只执行两种模式
- success:成功相关信息
:其他模式,直接执行 failure 的错误消息提示
Parameters:
Name | Type | Description |
---|---|---|
reference |
React.Component | React组件引用。 |
data |
Object | Array | 响应数据处理格式。 |
key |
String | 窗口所消费的资源文件中的 |
Returns:
返回效应窗口之外最终的 Promise。
- Type
- Promise.<T>
(async, static) ajaxPost(uri, params, options) → {Promise.<T>}
「标准」Ux.ajaxPost
安全方法(带token),POST开放性方法
Parameters:
Name | Type | Description |
---|---|---|
uri |
String | 远程开放的Api接口路径 |
params |
Object | 调用接口专用参数 |
options |
Object | Http请求头相关信息 |
Returns:
返回调用接口的 Promise
- Type
- Promise.<T>
(async, static) ajaxPull(uri, params, options) → {Promise.<T>}
「标准」Ux.ajaxPull
安全方法(带token), POST
下载专用方法,下载内容会返回二进制数据
Parameters:
Name | Type | Description |
---|---|---|
uri |
String | 远程上传开放的Api接口路径 |
params |
Object | 下载文件的专用参数,这种模式下一般存储于 Http 请求体 Body 中 |
options |
Object | Http请求头相关信息 |
Returns:
返回上传过后的 Promise
- Type
- Promise.<T>
(async, static) ajaxPush(uri, params, options) → {Promise.<T>}
「标准」Ux.ajaxPush
非安全方法,POST开放性方法,往远程地址推送数据的专用方法。
Parameters:
Name | Type | Description |
---|---|---|
uri |
String | 远程开放的Api接口路径 |
params |
Object | 调用接口专用参数 |
options |
Object | Http请求头相关信息 |
Returns:
返回调用接口的 Promise
- Type
- Promise.<T>
(async, static) ajaxPut(uri, params, options) → {Promise.<T>}
「标准」Ux.ajaxPut
安全方法(带token),PUT开放性方法
Parameters:
Name | Type | Description |
---|---|---|
uri |
String | 远程开放的Api接口路径 |
params |
Object | 调用接口专用参数 |
options |
Object | Http请求头相关信息 |
Returns:
返回调用接口的 Promise
- Type
- Promise.<T>
(async, static) ajaxResource(uri) → {Promise.<T>}
「标准」Ux.ajaxResource
非安全方法,直接从当前站点读取资源相关信息
这种模式只处理当前站点的 uri 路径,不结合 ENDPOINT 的路径执行远程请求
Parameters:
Name | Type | Description |
---|---|---|
uri |
String | 资源路径 |
Returns:
返回最终的 Promise
- Type
- Promise.<T>
(async, static) ajaxUpload(uri, file, options) → {Promise.<T>}
「标准」Ux.ajaxUpload
安全方法(带token),上传专用的 Ajax 函数,文件上传专用的 Ajax 函数。
Parameters:
Name | Type | Description |
---|---|---|
uri |
String | 远程上传开放的Api接口路径 |
file |
FormData | 文件内容相关信息(Html中的数据) |
options |
Object | Http请求头相关信息 |
Returns:
返回上传过后的 Promise
- Type
- Promise.<T>
(async, static) asyncData(config, params, callback, mock)
「标准」Ux.asyncData
异步读取专用函数
-
config 格式
{
method: "get | post | put | fetch | push | delete",
uri: "访问Ajax的路径信息",
}
callback 格式
回调函数,如果成功响应,则直接执行 callback 函数,将响应信息作为回调函数的参数。
mock 格式
该格式目前通常不使用,需要使用则直接传入 mock 完成。
{
mock: "true | false,是否开启mock",
data: "{} Mock的核心数据格式",
processor: "是否执行响应格式的处理专用"
}
Parameters:
Name | Type | Description |
---|---|---|
config |
Object | 异步验证配置信息 |
params |
Object | 核心参数信息,传入 Ajax 的数据信息 |
callback |
function | 回调函数结构,仅在成功时调用 callback,不执行失败处理 |
mock |
JObject | 模拟数据格式信息 |
(async, static) asyncImage(item, blob) → {Promise.<T>}
「标准」Ux.asyncImage
二进制数据在加载图片时专用方法,构造异步Promise,item 的数据结构:
{
"type": "文件的MIME类型,如image/jpeg",
"thumbUrl": "被更改的图片专用Url,该方法需修改此内容"
}
Parameters:
Name | Type | Description |
---|---|---|
item |
Object | 图片文件对象 |
blob |
Blob | 二进制对象流 |
Returns:
返回异步构造好的 Promise
- Type
- Promise.<T>
(async, static) asyncPromise(config, params, mock) → {Promise.<T>}
「标准」Ux.asyncPromise
无回调函数的直接执行,该函数和asyncData
类似,只是是非回调模式,而是直接返回 Promise。
-
config 格式
{
method: "get | post | put | fetch | push | delete",
uri: "访问Ajax的路径信息",
}
mock 格式
该格式目前通常不使用,需要使用则直接传入 mock 完成。
{
mock: "true | false,是否开启mock",
data: "{} Mock的核心数据格式",
processor: "是否执行响应格式的处理专用"
}
Parameters:
Name | Type | Description |
---|---|---|
config |
Object | 异步验证配置信息 |
params |
Object | 核心参数信息,传入 Ajax 的数据信息 |
mock |
JObject | 模拟数据格式信息 |
Returns:
返回异步构造好的 Promise
- Type
- Promise.<T>
(async, static) asyncTrue(config, params, callback, mock)
「标准」Ux.asyncTrue
异步验证专用函数,不返回 Promise,直接使用 callback
模式,主要在 validator
中使用,几个参数的格式如下:
config 格式
{
method: "get | post | put | fetch | push | delete",
uri: "访问Ajax的路径信息",
}
callback 格式
{
success: "成功的回调函数",
failure: "失败的回调函数"
}
如果 callback 返回值是 true,则执行 success;如果 callback 返回值是 false,则执行 failure,二选一的 callback 执行,
而这里其实不分 success / failure
,仅根据成功响应过后的 true/false
选择不同函数执行。
mock 格式
该格式目前通常不使用,需要使用则直接传入 mock 完成。
{
mock: "true | false,是否开启mock",
data: "{} Mock的核心数据格式",
processor: "是否执行响应格式的处理专用"
}
Parameters:
Name | Type | Description |
---|---|---|
config |
Object | 异步验证配置信息 |
params |
Object | 核心参数信息,传入 Ajax 的数据信息 |
callback |
Object | 回调函数结构 |
mock |
JObject | 模拟数据格式信息 |
(async, static) asyncWrap(reference, message, rxRunner) → {Promise.<T>}
「标准」Ux.asyncWrap
专用异步回调,可处理 catch 部分的详细错误信息
Parameters:
Name | Type | Description |
---|---|---|
reference |
Object | React组件引用 |
message |
Object | 二进制对象流 |
rxRunner |
function | 构造 Promise 专用的函数 |
Returns:
返回异步构造好的 Promise
- Type
- Promise.<T>
(async, static) microDelete(service, uri, params, options) → {Promise.<T>}
「标准」Ux.microDelete
安全方法(带token),DELETE开放性方法
Parameters:
Name | Type | Description |
---|---|---|
service |
String | 微服务模式中的服务名称 |
uri |
String | 远程开放的Api接口路径 |
params |
Object | 调用接口专用参数 |
options |
Object | Http请求头相关信息 |
Returns:
返回调用接口的 Promise
- Type
- Promise.<T>
(async, static) microFetch(service, uri, params, options) → {Promise.<T>}
「标准」Ux.microFetch
非安全方法,GET开放性方法,微服务模式下读取远程请求数据的方法。
Parameters:
Name | Type | Description |
---|---|---|
service |
String | 微服务模式中的服务名称 |
uri |
String | 远程开放的Api接口路径 |
params |
Object | 调用接口专用参数 |
options |
Object | Http请求头相关信息 |
Returns:
返回调用接口的 Promise
- Type
- Promise.<T>
(async, static) microGet(service, uri, params, options) → {Promise.<T>}
「标准」Ux.microGet
安全方法(带token),GET开放性方法。
Parameters:
Name | Type | Description |
---|---|---|
service |
String | 微服务模式中的服务名称 |
uri |
String | 远程开放的Api接口路径 |
params |
Object | 调用接口专用参数 |
options |
Object | Http请求头相关信息 |
Returns:
返回调用接口的 Promise
- Type
- Promise.<T>
(async, static) microPost(service, uri, params, options) → {Promise.<T>}
「标准」Ux.microPost
安全方法(带token),POST开放性方法
Parameters:
Name | Type | Description |
---|---|---|
service |
String | 微服务模式中的服务名称 |
uri |
String | 远程开放的Api接口路径 |
params |
Object | 调用接口专用参数 |
options |
Object | Http请求头相关信息 |
Returns:
返回调用接口的 Promise
- Type
- Promise.<T>
(async, static) microPush(service, uri, params, options) → {Promise.<T>}
「标准」Ux.microPush
非安全方法,POST开放性方法,微服务模式下推送数据的专用方法。
Parameters:
Name | Type | Description |
---|---|---|
service |
String | 微服务模式中的服务名称 |
uri |
String | 远程开放的Api接口路径 |
params |
Object | 调用接口专用参数 |
options |
Object | Http请求头相关信息 |
Returns:
返回调用接口的 Promise
- Type
- Promise.<T>
(async, static) microPut(service, uri, params, options) → {Promise.<T>}
「标准」Ux.microPut
安全方法(带token),PUT开放性方法
Parameters:
Name | Type | Description |
---|---|---|
service |
String | 微服务模式中的服务名称 |
uri |
String | 远程开放的Api接口路径 |
params |
Object | 调用接口专用参数 |
options |
Object | Http请求头相关信息 |
Returns:
返回调用接口的 Promise
- Type
- Promise.<T>
(static) sockOn(address, callback)
「标准」Ux.sockOn
Parameters:
Name | Type | Description |
---|---|---|
address |
||
callback |