net.sohelp.boot.dev.web.code

类 CodeTemplateController

java.lang.Object

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

net.sohelp.boot.dev.web.code.CodeTemplateController

@RestController(value="dev-code-template")
 @RequestMapping(value="/dev/code/template")
public class CodeTemplateController
extends BaseController

代码模板管理控制器 提供对代码模板的增删改查、导入导出等操作接口。

从以下版本开始:

2024/5/29 10:19

作者:

AaronFung

字段概要

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

request, response

构造器概要

构造器

构造器和说明
CodeTemplateController()

方法概要

限定符和类型	方法和说明
ApiResult<?>	batchExport(List<String> names) 批量导出选中的模板为ZIP压缩包并提供下载
ApiResult<String>	batchImport(org.springframework.web.multipart.MultipartFile file) 导入上传的ZIP格式模板压缩包，并解析其中的JSON模板文件存入系统中
ApiResult<?>	delete(Map<String,Object> paramMap) 删除指定名称的模板文件
ApiResult<Pager<com.alibaba.fastjson.JSONObject>>	page(Map<String,Object> paramMap) 分页查询所有代码模板信息
ApiResult<?>	readTemplateCode(String templateName) 根据模板名称读取其内容(code字段)
ApiResult<?>	save(Map<String,Object> paramMap) 保存或更新一个代码模板
ApiResult<?>	saveTemplateCode(Map<String,Object> dataMap) 更新指定模板的内容(code字段)
ApiResult<?>	upload(String name, org.springframework.web.multipart.MultipartFile file) 上传单个模板文件并保存至资源服务中

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

构造器详细资料

CodeTemplateController

public CodeTemplateController()

方法详细资料

page

@GetMapping(value="/page")
 @Permission(value="ADMIN")
public ApiResult<Pager<com.alibaba.fastjson.JSONObject>> page(@RequestParam
                                                                                                                       Map<String,Object> paramMap)
                                                                                                                throws SQLException

分页查询所有代码模板信息

参数:

paramMap - 请求参数，包括分页参数（page, limit）

返回:

返回分页结果集，包含模板列表数据

抛出:

SQLException - 数据库访问异常时抛出

save

@PostMapping(value="/save")
 @Permission(value="ADMIN")
public ApiResult<?> save(@RequestBody
                                                                                   Map<String,Object> paramMap)
                                                                            throws SQLException,
                                                                                   BusiException

保存或更新一个代码模板

参数:

paramMap - 包含模板名称(template_name)及其他相关字段的数据映射

返回:

成功提示信息

抛出:

SQLException - 数据库访问异常时抛出

BusiException - 业务逻辑错误时抛出

batchExport

@GetMapping(value="/batchExport")
 @Permission(value="ADMIN")
public ApiResult<?> batchExport(@RequestParam
                                                                                                List<String> names)
                                                                                         throws SQLException,
                                                                                                BusiException,
                                                                                                IOException

批量导出选中的模板为ZIP压缩包并提供下载

参数:

names - 要导出的模板名称列表

返回:

响应输出流，直接向客户端发送压缩文件

抛出:

SQLException - 数据库访问异常时抛出

BusiException - 业务处理过程中发生错误时抛出

IOException - 文件IO操作失败时抛出

batchImport

@PostMapping(value="/batchImport")
 @Permission(value="ADMIN")
public ApiResult<String> batchImport(@RequestParam(value="file")
                                                                                                      org.springframework.web.multipart.MultipartFile file)
                                                                                               throws IOException,
                                                                                                      SQLException,
                                                                                                      BusiException

导入上传的ZIP格式模板压缩包，并解析其中的JSON模板文件存入系统中

参数:

file - 用户上传的ZIP压缩包文件

返回:

操作成功提示信息

抛出:

IOException - 文件传输或读取失败时抛出

SQLException - 数据库访问异常时抛出

BusiException - 业务处理过程出现错误时抛出

upload

@PostMapping(value="/upload")
 @Permission(value="ADMIN")
public ApiResult<?> upload(@RequestParam
                                                                                       String name,
                                                                                       @RequestParam
                                                                                       org.springframework.web.multipart.MultipartFile file)
                                                                                throws SQLException,
                                                                                       BusiException,
                                                                                       IOException

上传单个模板文件并保存至资源服务中

参数:

name - 模板名称

file - 上传的模板文件对象

返回:

成功后的模板相关信息

抛出:

SQLException - 数据库访问异常时抛出

BusiException - 业务处理错误时抛出

IOException - 输入输出流异常时抛出

readTemplateCode

@GetMapping(value="/readTemplateCode")
 @Permission(value="ADMIN")
public ApiResult<?> readTemplateCode(@RequestParam
                                                                                                          String templateName)
                                                                                                   throws Exception

根据模板名称读取其内容(code字段)

参数:

templateName - 模板名称

返回:

模板的内容字符串(code字段)

抛出:

Exception - 异常情况统一向上抛出

saveTemplateCode

@PostMapping(value="/saveTemplateCode")
 @Permission(value="ADMIN")
public ApiResult<?> saveTemplateCode(@RequestBody
                                                                                                           Map<String,Object> dataMap)
                                                                                                    throws Exception

更新指定模板的内容(code字段)

参数:

dataMap - 包含模板名称(template_name)与新内容(code)的请求体

返回:

更新成功的模板信息

抛出:

Exception - 异常情况统一向上抛出

delete

@PostMapping(value="/delete")
 @Permission(value="ADMIN")
public ApiResult<?> delete(@RequestBody
                                                                                       Map<String,Object> paramMap)
                                                                                throws SQLException,
                                                                                       BusiException

删除指定名称的模板文件

参数:

paramMap - 请求参数，必须包含templateName字段表示要删除的模板名称

返回:

删除成功的提示信息

抛出:

SQLException - 数据库访问异常时抛出

BusiException - 业务处理错误时抛出