iRESP 文档中心

# Java增强 API

通过配置一个请求地址，在新增、编辑、删除、查询、导出的时候，支持发起http请求，处理相关的业务。

# 分类

按照操作数据分类，可分为两类：

  • 表单类
  • 列表类

# 配置

配置方式与原版增强保持一致，只不过在选择类型时需要选择http-api， 内容输入框里填写请求地址，可以填写http(s) 开头的绝对地址，也可以填写项目相对地址。

TIP

注意：请求方式为POST

请求本地：

请求其他服务：

# 表单类

# 功能描述

http-api表单类java增强，适用于导出、查询。

# 定义请求处理方法

/**
 * online api增强 表单
 * @param params
 * @return
 */
@PostMapping("/testhttpapi")
public Result enhanceJavaFormHttp(@RequestBody JSONObject params) {
    log.info(" =========================================================== ");
    log.info("params: " + params.toJSONString());
    log.info("params.tableName: " + params.getString("tableName"));
    log.info("params.record: " + params.getJSONObject("record").toJSONString());
    log.info(" =========================================================== ");
    return Result.OK(params.getJSONObject("record").toJSONString()));
}

注意

请求方式：post

请求参数：params，表单数据信息具体属性见下方描述

请求返回值：类路径org.jeecg.common.api.vo.Result该类是jeecgboot通用返回结果类。可以不使用该对象，但是返回对象的属性需和下面描述保持一致。

# 返回值对象Result属性说明

属性 类型 说明
success boolean version3.1之后系统会判断该状态值是否为true，为true则表示请求处理正常，为false则认为当前请求处理失败，整个操作(新增、编辑、删除)会回滚
message string 当success为false的时候，需要设置一个错误信息
result object 表单数据对象，当success为true，请传该参数

# 请求方法参数params说明

属性 类型 说明
tableName string 表名
record JSONObject 当前操作(新增、编辑、删除)的表单数据

# 增强配置

# 列表类

# 功能描述

http-api列表类java增强，适用于导出、查询。

# 定义请求处理方法

/**
 * online api增强 列表
 * @param params
 * @return
 */
@PostMapping("/enhanceJavaListHttp")
public Result enhanceJavaListHttp(@RequestBody JSONObject params) {
    log.info(" =========================================================== ");
    log.info("params: " + params.toJSONString());
    log.info("params.tableName: " + params.getString("tableName"));
    log.info("params.dataList: " + params.getJSONArray("record").toJSONString());
    log.info(" =========================================================== ");
    return Result.OK(params.getJSONArray("record").toJSONString());
}

注意

请求方式：post

请求参数：params，表单数据信息具体属性见下方描述

请求返回值：类路径org.jeecg.common.api.vo.Result该类是jeecgboot通用返回结果类。可以不使用该对象，但是返回对象的属性需和下面描述保持一致。

# 返回值对象Result属性说明

属性 类型 说明
success boolean 状态值，true表示当前数据需要转换，必须传入对应的数据列表到result中
result JSONArray/List 当前查询或导出的数据集合，当success为true，请传该参数

# 请求方法参数params说明

属性 类型 说明
tableName string 表名
dataList JSONArray 当前查询或导出的数据集合

# 增强配置

← SQL增强 →