程序包 net.sohelp.boot.dev.web.code

类 GridBuilderController

java.lang.Object
net.sohelp.boot.admin.core.base.BaseController
net.sohelp.boot.dev.web.code.GridBuilderController
@RestController("dev-code-grid-builder") @RequestMapping("/dev/code/grid") public class GridBuilderController extends BaseController
列表设计器控制器 提供用于管理、配置和预览表格列表的功能接口。
从以下版本开始:
2024/5/22 17:48
作者:
AaronFung

  • 构造器详细资料

    • GridBuilderController

      public GridBuilderController()

  • 方法详细资料

    • getDatasourceTree

      @GetMapping("/getDatasourceTree") @Permission("ADMIN") public ApiResult<List<Map<String,Object>>> getDatasourceTree() throws SQLException
      获取数据源及其对应的表结构树形结构 返回一个包含所有可用数据源及对应数据库表的树状结构列表。
      返回:
      包含数据源与表结构信息的树形结构列表
      抛出:
      SQLException - 当访问数据库失败时抛出异常

    • saveConfig

      @PostMapping("/saveConfig") @Permission("ADMIN") public ApiResult<EntityVO> saveConfig(@RequestBody com.alibaba.fastjson.JSONObject jsonObject) throws Exception
      保存指定表的网格配置信息 将传入的 JSON 配置对象转换为 GridVO 对象并持久化存储到资源服务中。
      参数:
      jsonObject - 前端传递的配置参数（包括表名、数据源名称等）
      返回:
      操作结果状态码和消息
      抛出:
      Exception - 若操作过程中发生错误将抛出异常

    • clearAll

      @PostMapping("/clearAll") @Permission("ADMIN") public ApiResult<String> clearAll() throws SQLException, BusiException
      清除所有的网格配置文件 删除 GRID_PATH 路径下所有以 /grid/*.json 结尾的配置文件。
      返回:
      操作结果状态码和消息
      抛出:
      SQLException - 数据库相关异常
      BusiException - 自定义业务逻辑异常

    • batchDelete

      @PostMapping("/batchDelete") @Permission("ADMIN") public ApiResult<String> batchDelete(@RequestBody Map<String,Object> paramMap) throws SQLException, BusiException
      批量删除多个表的网格配置文件 根据提供的数据源名称和一组表名，逐个删除其对应的配置文件。
      参数:
      paramMap - 请求参数映射，应包含 datasourceName 和 tableNames 字段
      返回:
      操作结果状态码和消息
      抛出:
      SQLException - 数据库相关异常
      BusiException - 自定义业务逻辑异常

    • delete

      @PostMapping("/delete") @Permission("ADMIN") public ApiResult<String> delete(@RequestBody Map<String,Object> paramMap) throws SQLException, BusiException
      删除单个表的网格配置文件 根据给定的数据源名称和表名删除该表的配置文件。
      参数:
      paramMap - 请求参数映射，应包含 datasourceName 和 name 字段
      返回:
      操作结果状态码和消息
      抛出:
      SQLException - 数据库相关异常
      BusiException - 自定义业务逻辑异常

    • getConfig

      @GetMapping("/getConfig") @Permission("ADMIN") public ApiResult<?> getConfig(@RequestParam String datasourceName, @RequestParam String tableName) throws Exception
      获取指定表的网格配置信息 查询并返回某个特定表的网格配置，并根据实体信息补充标题、长度等字段属性。
      参数:
      datasourceName - 数据源名称
      tableName - 表名
      返回:
      包含网格配置的对象或错误提示
      抛出:
      Exception - 若查询过程出现异常则抛出

    • preview

      @GetMapping("/preview") @Permission("ADMIN") public ApiResult<List<Map<String,Object>>> preview(@RequestParam(required=false) String datasourceName, @RequestParam String tableName) throws IOException
      预览生成的前端 Vue 组件代码 使用 Beetl 模板引擎渲染 ele-pro-table.vue.html 文件，生成最终的前端组件代码。
      参数:
      datasourceName - 可选参数：数据源名称，默认使用 default
      tableName - 必填参数：表名
      返回:
      包含生成代码结构的树形数据集合
      抛出:
      IOException - IO 异常处理

    • list

      @GetMapping("/list") @Permission("ADMIN") public ApiResult<Pager<com.alibaba.fastjson.JSONObject>> list(@RequestParam Map<String,Object> paramMap) throws Exception
      分页获取指定数据源下的表列表 支持通过标签筛选表名，并排除 pb_ 开头的系统保留表。
      参数:
      paramMap - 请求参数映射，支持 page、limit、datasourceName 和 label 参数
      返回:
      分页后的表信息列表
      抛出:
      Exception - 若查询过程出现异常则抛出

    • download

      @GetMapping("/download") @Permission("ADMIN") public ApiResult<Map<String,Object>> download(@RequestParam String[] tableNames)
      下载指定表的相关代码包 目前仅作为占位方法，实际功能待实现。
      参数:
      tableNames - 多个需要下载代码的表名数组
      返回:
      操作结果状态码和消息