net.sohelp.boot.engine.web.controller

类 EngineFileController

java.lang.Object

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

net.sohelp.boot.engine.web.controller.EngineFileController

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

文件管理

从以下版本开始:

2023/12/8

作者:

AaronFung

字段概要

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

request, response

构造器概要

构造器

构造器和说明
EngineFileController()

方法概要

限定符和类型	方法和说明
ApiResult<Object>	delete(Map<String,Object> dataMap) 文件删除接口 根据提供的文件ID和引用ID删除文件，并验证用户操作权限
Object	download(String refid, String id) 文件下载接口 根据提供的文件ID下载对应文件，如果文件不存在或没有权限则返回失败信息。
Object	image(String refid, String id, String fileType) 图片预览接口 根据提供的文件ID和可选的引用ID，预览指定的图片文件。
Object	preview(String refid, String id) 文件预览接口 用于预览指定ID的文件，支持多种文件类型，如PDF等。
ApiResult<Object>	rename(String refid, String id, String newFileName) 文件重命名接口 该接口用于对指定文件进行重命名操作
ApiResult<List<Long>>	upload(String refid, org.springframework.web.multipart.MultipartFile[] files) 文件上传接口 用于上传一个或多个文件，并返回上传文件的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, success, success, success, success, validateToken

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

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

构造器详细资料

EngineFileController

public EngineFileController()

方法详细资料

upload

@PostMapping(value="/upload")
 @Permission(value="")
public ApiResult<List<Long>> upload(@RequestParam(required=false)
                                                                                           String refid,
                                                                                           @RequestParam(value="files")
                                                                                           org.springframework.web.multipart.MultipartFile[] files)
                                                                                    throws IOException,
                                                                                           BusiException,
                                                                                           TokenAuthenticationException,
                                                                                           AccessPermissionException,
                                                                                           SQLException

文件上传接口 用于上传一个或多个文件，并返回上传文件的ID列表

参数:

refid - 关联ID，非必需参数，用于验证地址和模块操作权限

files - 要上传的文件数组，必需参数

返回:

返回包含上传文件ID的列表

抛出:

IOException - 如果文件上传过程中发生I/O错误

BusiException - 如果业务逻辑处理中出现异常

TokenAuthenticationException - 如果令牌认证失败

AccessPermissionException - 如果访问权限验证失败

SQLException - 如果数据库操作中出现异常

download

@GetMapping(value="/download")
public Object download(@RequestParam(required=false)
                                                       String refid,
                                                       @RequestParam(value="id")
                                                       String id)
                                                throws BusiException,
                                                       TokenAuthenticationException,
                                                       AccessPermissionException,
                                                       SQLException

文件下载接口 根据提供的文件ID下载对应文件，如果文件不存在或没有权限则返回失败信息。

参数:

refid - 引用ID，用于验证模块操作权限（可选）

id - 文件ID，用于从数据库中查询文件信息

返回:

下载成功时返回null，失败时返回错误信息

抛出:

BusiException - 业务异常，当业务逻辑出现错误时抛出

TokenAuthenticationException - 令牌认证异常，当令牌认证失败时抛出

AccessPermissionException - 访问权限异常，当没有访问权限时抛出

SQLException - 数据库查询异常，当数据库查询出现错误时抛出

delete

@PostMapping(value="/delete")
 @Permission(value="")
public ApiResult<Object> delete(@RequestBody
                                                                                       Map<String,Object> dataMap)
                                                                                throws BusiException,
                                                                                       TokenAuthenticationException,
                                                                                       AccessPermissionException,
                                                                                       SQLException

文件删除接口 根据提供的文件ID和引用ID删除文件，并验证用户操作权限

参数:

dataMap - 包含文件ID和引用ID等信息的Map - id: 文件ID，用于标识需要删除的文件 - refid: 引用ID，用于验证用户对该文件的操作权限

返回:

ApiResult