程序包 net.sohelp.boot.engine.web.controller

类 EngineExportController

java.lang.Object

net.sohelp.boot.admin.core.base.BaseController

net.sohelp.boot.engine.web.controller.EngineExportController

@RestController("engine-web-export")
@RequestMapping("/engine/web/export")
@ConditionalOnExpression("${sohelp-boot.engine.enabled:true} && ${sohelp-boot.engine.export.enabled:true}")
public class EngineExportController
extends BaseController

批量导出

从以下版本开始:

2023/8/17 20:06

作者:

AaronFung

字段概要

从类继承的字段 net.sohelp.boot.admin.core.base.BaseController

request, response

构造器概要

构造器

构造器	说明
EngineExportController()

方法概要

修饰符和类型	方法	说明
ApiResult<Map<String,Object>>	download(Map<String,Object> params)	批量导出接口（3.2.3合规）
void	downloadByToken(String token)	凭临时Token下载导出文件（3.2.3合规）
ApiResult<Object>	history(String refid)	获取导出历史接口 该接口用于获取指定引用ID的导入历史记录

从类继承的方法 net.sohelp.boot.admin.core.base.BaseController

error, error, fail, fail, fail, getLoginID, getLoginName, getLoginOrgID, getLoginOrgName, getLoginUser, getNickname, getTenantId, getUserName, getUserNo, i18n, i18n, isAdministrator, isDeveloper, limit, offset, ok, ok, response, response, responseStream, success, success, success, success, validateToken

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

EngineExportController

public EngineExportController()

方法详细资料

download

@PostMapping("/download")
@Permission("")
public ApiResult<Map<String,Object>> download(@RequestBody
 Map<String,Object> params)
                                       throws BusiException,
TokenAuthenticationException,
AccessPermissionException,
SQLException

批量导出接口（3.2.3合规）

导出流程：

1. 验证登录用户权限（batch.export）
2. 将Excel写入服务端 {resource.location}/export/ 目录
3. 生成5分钟有效的一次性下载Token
4. 返回Token，前端凭Token调用 GET /engine/web/export/file?token=xxx 下载

导出文件由 FileRetentionService 每日清理超过7天的文件（3.2.1合规）。

抛出:

BusiException

TokenAuthenticationException

AccessPermissionException

SQLException

downloadByToken

@GetMapping("/file")
public void downloadByToken(@RequestParam("token")
 String token)
                     throws BusiException,
IOException

凭临时Token下载导出文件（3.2.3合规）

此接口无需携带登录Session，但必须提供有效的临时Token。 Token为一次性令牌，下载成功后立即失效，防止URL被重放或未授权转发。

参数:

token - 由 POST /download 接口返回的临时下载Token

抛出:

BusiException

IOException

history

@GetMapping("/history")
@Permission("")
public ApiResult<Object> history(@RequestParam(required=false)
 String refid)
                          throws BusiException,
TokenAuthenticationException,
AccessPermissionException,
SQLException

获取导出历史接口 该接口用于获取指定引用ID的导入历史记录

参数:

refid - 引用ID，用于标识需要查询的导出历史记录，非必填参数

返回:

返回ApiResult对象，包含导出历史记录信息

抛出:

BusiException - 如果refid为空，则抛出BusiException异常

TokenAuthenticationException - 如果令牌认证失败，则抛出TokenAuthenticationException异常

AccessPermissionException - 如果访问权限验证失败，则抛出AccessPermissionException异常

SQLException - 如果数据库查询出现异常，则抛出SQLException异常