Files
aibridge/docs/datainterface/05-pagination.md
T
2026-05-18 09:28:15 +08:00

3.2 KiB
Raw Blame History

分页配置

启用分页

字段 值 说明
hasPage 1 启用分页

SQL分页配置

启用分页后,需要配置两个SQL:

  1. 数据配置:查询分页数据
  2. 数量统计:查询总条数

配置结构

{
  "dataConfigJson": {
    "sqlData": {
      "sql": "SELECT * FROM base_user LIMIT {@offsetSize}, {@pageSize}"
    }
  },
  "dataCountJson": {
    "sqlData": {
      "sql": "SELECT COUNT(*) FROM base_user WHERE ..."
    }
  }
}

分页变量

变量 说明
{@pageSize} 每页条数(系统变量,自动从 pageSize 参数填充)
{@offsetSize} 开始条数 = (当前页-1) × 每页条数(系统计算)
{@currentPage} 当前页码(前端传递,非系统变量)
{@keyword} 关键词搜索(前端传递)

注意:hasPage=1 时,@pageSize/@offsetSize 是系统变量,后端自动计算。但 currentPage 和 keyword 是用户参数,需前端传递。

SQL分页示例

-- 数据SQL
SELECT * FROM base_user
WHERE f_real_name LIKE CONCAT('%', @keyword, '%')
LIMIT @offsetSize, @pageSize

-- 数量SQL
SELECT COUNT(*) FROM base_user
WHERE f_real_name LIKE CONCAT('%', @keyword, '%')

参考接口

ID 名称 说明
469125798494792965 SQL真分页 使用LIMIT分页

SQL真分页配置:

-- 数据SQL
select * from base_user
where f_real_name like concat('%', @keyword, '%')
limit @offsetSize, @pageSize

-- 数量SQL (需要在数量统计配置中设置)
select count(*) from base_user
where f_real_name like concat('%', @keyword, '%')

API分页配置

API分页URL参数

{
  "apiData": {
    "url": "/api/list?currentPage={currentPage}&pageSize={pageSize}&keyword={keyword}"
  }
}

参考接口

ID 名称 说明
469125039078305029 API真分页 URL参数分页

API真分页配置:

{
  "apiData": {
    "method": 1,
    "url": "/api/system/DataInterface?sort=desc&hasPage=0",
    "header": [],
    "query": [],
    "body": "",
    "bodyType": 0
  }
}

分页返回格式

{
  "code": 200,
  "msg": "success",
  "data": {
    "list": [...],
    "pagination": {
      "currentPage": 1,
      "pageSize": 20,
      "total": 100
    }
  }
}

分页参数

参数 说明
currentPage 当前页码
pageSize 每页条数
keyword 关键词(可选)

执行预览

# execute() 方式(使用 sourceType=3,参数值直接生效)
result = di.execute(di_id, {
    "currentPage": "1",
    "pageSize": "20",
    "keyword": "张三"
})

# preview() 方式(可选择 sourceType)
result = di.preview(di_id, {
    "paramList": [
        {"field": "currentPage", "defaultValue": "1", "dataType": "int", "sourceType": 3},
        {"field": "pageSize", "defaultValue": "20", "dataType": "int", "sourceType": 3},
        {"field": "keyword", "defaultValue": "张三", "dataType": "varchar", "sourceType": 3}
    ]
})

注意事项

  1. hasPage=1时,isPostPosition自动设为0
  2. 分页SQL需要同时配置数据SQL和数量SQL
  3. 使用@offsetSize而非@pageSize计算分页起点