net.sohelp.boot.dev.web.ops.resource

类 WorkspaceResourceController

java.lang.Object

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

net.sohelp.boot.dev.web.ops.resource.WorkspaceResourceController

@RestController(value="dev-resource-sohelp-boot")
 @RequestMapping(value="/dev/resource/workspace")
public class WorkspaceResourceController
extends BaseController

工作环境资源管理

从以下版本开始:

2024/9/28 10:04

作者:

AaronFung

字段概要

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

request, response

构造器概要

构造器

构造器和说明
WorkspaceResourceController()

方法概要

限定符和类型	方法和说明
ApiResult<String>	changeFileName(Map<String,Object> paramMap) 修改文件名 将指定路径下的旧文件名修改为新文件名
ApiResult<String>	createFile(Map<String,Object> paramMap) 创建文件接口 该接口用于根据传入的参数创建一个新的文件，并返回操作结果
ApiResult<String>	createFolder(Map<String,Object> paramMap) 创建文件夹接口 根据传入的路径和文件名创建文件夹，如果上级目录不存在或目录已存在则返回失败信息。
Object	image(String fileName, String path) 读取并返回指定路径下的图片文件 该接口通过文件名和路径读取服务器上的图片资源，并返回图片的字节流
String	preview(Map<String,Object> paramMap) 获取文件Base64编码 读取指定文件并将其转换为Base64字符串返回
ApiResult<List<ResourceFileVO>>	read(Map<String,Object> paramMap) 读取资源文件列表 支持按文件名过滤、排序等操作，返回文件列表信息
ApiResult<String>	removeFile(Map<String,Object> paramMap) 删除文件或目录 可删除多个文件或目录，支持递归删除目录
ApiResult<String>	uploadFile(String path, org.springframework.web.multipart.MultipartFile file) 上传文件 将上传的文件保存到指定路径下
ApiResult<String>	view(Map<String,Object> paramMap) 预览文件内容 通过输出流将文件内容直接写入响应体中

从类继承的方法 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

构造器详细资料

WorkspaceResourceController

public WorkspaceResourceController()

方法详细资料

createFile

@PostMapping(value="/createFile")
 @Permission(value="DEVELOPER")
public ApiResult<String> createFile(@RequestBody
                                                                                                        Map<String,Object> paramMap)
                                                                                                 throws IOException

创建文件接口 该接口用于根据传入的参数创建一个新的文件，并返回操作结果

参数:

paramMap - 包含文件路径和文件名的参数Map，其中key为"path"和"fileName"

返回:

返回ApiResult对象，其中包含操作结果的字符串信息

抛出:

IOException - 如果文件操作过程中出现IO异常，则抛出IOException异常

createFolder

@PostMapping(value="/createFolder")
 @Permission(value="DEVELOPER")
public ApiResult<String> createFolder(@RequestBody
                                                                                                            Map<String,Object> paramMap)
                                                                                                     throws IOException

创建文件夹接口 根据传入的路径和文件名创建文件夹，如果上级目录不存在或目录已存在则返回失败信息。

参数:

paramMap - 包含路径和文件名的参数Map - path: 文件夹路径（可选，默认为根目录；如果不以"/"开头，则自动添加"/"） - fileName: 文件夹名称

返回:

ApiResult 包含操作结果的ApiResult对象 - 成功时返回"文件创建成功！" - 失败时返回对应错误信息

抛出:

IOException - 如果文件操作发生I/O错误，则抛出IOException异常

image

@GetMapping(value="/image")
public Object image(@RequestParam
                                                 String fileName,
                                                 @RequestParam
                                                 String path)
                                          throws IOException

读取并返回指定路径下的图片文件 该接口通过文件名和路径读取服务器上的图片资源，并返回图片的字节流

参数:

fileName - 文件名，包括扩展名

path - 文件所在路径

返回:

返回图片的字节流，封装在ResponseEntity中

抛出:

IOException - 如果文件读取过程中发生IO异常，则抛出该异常

read

@GetMapping(value="/read")
 @Permission(value="DEVELOPER")
public ApiResult<List<ResourceFileVO>> read(@RequestParam(required=false)
                                                                                                         Map<String,Object> paramMap)
                                                                                                  throws IOException

读取资源文件列表 支持按文件名过滤、排序等操作，返回文件列表信息

参数:

paramMap - 请求参数Map，支持以下参数： - path: 路径（可选） - fileName: 文件名过滤条件（可选） - sort: 排序字段（name/length/lastModified） - order: 排序方式（asc/desc）

返回:

返回包含文件信息的ResourceFileVO列表

抛出:

IOException - 如果文件读取过程中发生IO异常，则抛出该异常

changeFileName

@PostMapping(value="/changeFileName")
 @Permission(value="DEVELOPER")
public ApiResult<String> changeFileName(@RequestBody
                                                                                                                Map<String,Object> paramMap)

修改文件名 将指定路径下的旧文件名修改为新文件名

参数:

paramMap - 请求参数Map，包含以下字段： - path: 文件所在路径（可选） - oldFileName: 原始文件名 - newFileName: 新文件名

返回:

返回操作结果信息

removeFile

@Permission(value="DEVELOPER")
 @PostMapping(value="/removeFile")
public ApiResult<String> removeFile(@RequestBody
                                                                                                        Map<String,Object> paramMap)

删除文件或目录 可删除多个文件或目录，支持递归删除目录

参数:

paramMap - 请求参数Map，包含以下字段： - path: 目录路径 - files: 待删除的文件名列表，用逗号分隔

返回:

返回操作结果信息

uploadFile

@PostMapping(value="/uploadFile")
 @Permission(value="DEVELOPER")
public ApiResult<String> uploadFile(@RequestParam(required=false)
                                                                                                        String path,
                                                                                                        @RequestParam
                                                                                                        org.springframework.web.multipart.MultipartFile file)
                                                                                                 throws IOException

上传文件 将上传的文件保存到指定路径下

参数:

path - 文件保存路径（可选）

file - 上传的文件对象

返回:

返回操作结果信息

抛出:

IOException - 如果文件写入过程中发生IO异常，则抛出该异常

view

@GetMapping(value="/view")
 @Permission(value="ADMIN")
public ApiResult<String> view(@RequestParam
                                                                                       Map<String,Object> paramMap)
                                                                                throws IOException

预览文件内容 通过输出流将文件内容直接写入响应体中

参数:

paramMap - 请求参数Map，包含以下字段： - path: 文件路径 - fileName: 文件名

返回:

返回null，实际内容通过输出流返回

抛出:

IOException - 如果文件读取或输出过程中发生IO异常，则抛出该异常

preview

@GetMapping(value="/preview")
 @Permission(value="ADMIN")
public String preview(@RequestParam
                                                                                  Map<String,Object> paramMap)
                                                                           throws IOException

获取文件Base64编码 读取指定文件并将其转换为Base64字符串返回

参数:

paramMap - 请求参数Map，包含以下字段： - path: 文件路径 - fileName: 文件名

返回:

返回文件的Base64编码字符串

抛出:

IOException - 如果文件读取过程中发生IO异常，则抛出该异常