Tio Boot DocsTio Boot Docs
Home
  • java-db
  • api-table
  • Enjoy
  • Tio Boot Admin
  • ai_agent
  • translator
  • knowlege_base
  • ai-search
  • 案例
Abount
  • Github
  • Gitee
Home
  • java-db
  • api-table
  • Enjoy
  • Tio Boot Admin
  • ai_agent
  • translator
  • knowlege_base
  • ai-search
  • 案例
Abount
  • Github
  • Gitee
  • 01_tio-boot 简介

    • tio-boot:新一代高性能 Java Web 开发框架
    • tio-boot 入门示例
    • Tio-Boot 配置 : 现代化的配置方案
    • tio-boot 整合 Logback
    • tio-boot 整合 hotswap-classloader 实现热加载
    • 自行编译 tio-boot
    • 最新版本
    • 开发规范
  • 02_部署

    • 使用 Maven Profile 实现分环境打包 tio-boot 项目
    • Maven 项目配置详解:依赖与 Profiles 配置
    • tio-boot 打包成 FastJar
    • 使用 GraalVM 构建 tio-boot Native 程序
    • 使用 Docker 部署 tio-boot
    • 部署到 Fly.io
    • 部署到 AWS Lambda
    • 到阿里云云函数
    • 使用 Deploy 工具部署
    • 胖包与瘦包的打包与部署
    • 使用 Jenkins 部署 Tio-Boot 项目
    • 使用 Nginx 反向代理 Tio-Boot
    • 使用 Supervisor 管理 Java 应用
  • 03_配置

    • 配置参数
    • 服务器监听器
    • 内置缓存系统 AbsCache
    • 使用 Redis 作为内部 Cache
    • 静态文件处理器
    • 基于域名的静态资源隔离
    • DecodeExceptionHandler
  • 04_原理

    • 生命周期
    • 请求处理流程
    • 重要的类
  • 05_json

    • Json
    • 接受 JSON 和响应 JSON
    • 响应实体类
  • 06_web

    • 概述
    • 文件上传
    • 接收请求参数
    • 接收日期参数
    • 接收数组参数
    • 返回字符串
    • 返回文本数据
    • 返回网页
    • 请求和响应字节
    • 文件下载
    • 返回视频文件并支持断点续传
    • http Session
    • Cookie
    • HttpRequest
    • HttpResponse
    • Resps
    • RespBodyVo
    • /zh/06_web/19.html
    • 全局异常处理器
    • 异步
    • 动态 返回 CSS 实现
    • 返回图片
    • Transfer-Encoding: chunked 实时音频播放
    • Server-Sent Events (SSE)
    • 接口访问统计
    • 接口请求和响应数据记录
    • 自定义 Handler 转发请求
    • 使用 HttpForwardHandler 转发所有请求
    • 跨域
    • 添加 Controller
    • 常用工具类
    • HTTP Basic 认证
    • WebJars
    • JProtobuf
  • 07_validate

    • 数据紧校验规范
    • 参数校验
  • 08_websocket

    • 使用 tio-boot 搭建 WebSocket 服务
    • WebSocket 聊天室项目示例
  • 09_java-db

    • java‑db
    • 操作数据库入门示例
    • SQL 模板
    • 数据源配置与使用
    • ActiveRecord
    • Model
    • 生成器与 Model
    • Db 工具类
    • 批量操作
    • 数据库事务处理
    • Cache 缓存
    • Dialect 多数据库支持
    • 表关联操作
    • 复合主键
    • Oracle 支持
    • Enjoy SQL 模板
    • Java-DB 整合 Enjoy 模板最佳实践
    • 多数据源支持
    • 独立使用 ActiveRecord
    • 调用存储过程
    • java-db 整合 Guava 的 Striped 锁优化
    • 生成 SQL
    • 通过实体类操作数据库
    • java-db 读写分离
    • Spring Boot 整合 Java-DB
    • like 查询
    • 常用操作示例
    • Druid 监控集成指南
    • SQL 统计
  • 10_api-table

    • ApiTable 概述
    • 使用 ApiTable 连接 SQLite
    • 使用 ApiTable 连接 Mysql
    • 使用 ApiTable 连接 Postgres
    • 使用 ApiTable 连接 TDEngine
    • 使用 api-table 连接 oracle
    • 使用 api-table 连接 mysql and tdengine 多数据源
    • EasyExcel 导出
    • EasyExcel 导入
    • TQL(Table SQL)前端输入规范
    • ApiTable 实现增删改查
    • 数组类型
    • 单独使用 ApiTable
  • 11_aop

    • JFinal-aop
    • Aop 工具类
    • 配置
    • 配置
    • 独立使用 JFinal Aop
    • @AImport
    • 原理解析
  • 12_cache

    • Caffine
    • Jedis-redis
    • hutool RedisDS
    • Redisson
    • Caffeine and redis
    • CacheUtils 工具类
    • 使用 CacheUtils 整合 caffeine 和 redis 实现的两级缓存
    • 使用 java-db 整合 ehcache
    • 使用 java-db 整合 redis
    • Java DB Redis 相关 Api
    • redis 使用示例
  • 13_认证和权限

    • hutool-JWT
    • FixedTokenInterceptor
    • 使用内置 TokenManager 实现登录
    • 用户系统
    • 重置密码
    • 匿名登录
    • Google 登录
    • 权限校验注解
    • Sa-Token
    • sa-token 登录注册
    • StpUtil.isLogin() 源码解析
    • 短信登录
    • 移动端微信登录实现指南
    • 移动端重置密码
  • 14_i18n

    • i18n
  • 15_enjoy

    • tio-boot 整合 Enjoy 模版引擎文档
    • 引擎配置
    • 表达式
    • 指令
    • 注释
    • 原样输出
    • Shared Method 扩展
    • Shared Object 扩展
    • Extension Method 扩展
    • Spring boot 整合
    • 独立使用 Enjoy
    • tio-boot enjoy 自定义指令 localeDate
    • PromptEngine
    • Enjoy 入门示例-擎渲染大模型请求体
    • Enjoy 使用示例
  • 16_定时任务

    • Quartz 定时任务集成指南
    • 分布式定时任务 xxl-jb
    • cron4j 使用指南
  • 17_tests

    • TioBootTest 类
  • 18_tio

    • TioBootServer
    • tio-core
    • 内置 TCP 处理器
    • 独立启动 UDPServer
    • 使用内置 UDPServer
    • t-io 消息处理流程
    • tio-运行原理详解
    • TioConfig
    • ChannelContext
    • Tio 工具类
    • 业务数据绑定
    • 业务数据解绑
    • 发送数据
    • 关闭连接
    • Packet
    • 监控: 心跳
    • 监控: 客户端的流量数据
    • 监控: 单条 TCP 连接的流量数据
    • 监控: 端口的流量数据
    • 单条通道统计: ChannelStat
    • 所有通道统计: GroupStat
    • 资源共享
    • 成员排序
    • ssl
    • DecodeRunnable
    • 使用 AsynchronousSocketChannel 响应数据
    • 拉黑 IP
    • 深入解析 Tio 源码:构建高性能 Java 网络应用
  • 19_aio

    • ByteBuffer
    • AIO HTTP 服务器
    • 自定义和线程池和池化 ByteBuffer
    • AioHttpServer 应用示例 IP 属地查询
    • 手写 AIO Http 服务器
  • 20_netty

    • Netty TCP Server
    • Netty Web Socket Server
    • 使用 protoc 生成 Java 包文件
    • Netty WebSocket Server 二进制数据传输
    • Netty 组件详解
  • 21_netty-boot

    • Netty-Boot
    • 原理解析
    • 整合 Hot Reload
    • 整合 数据库
    • 整合 Redis
    • 整合 Elasticsearch
    • 整合 Dubbo
    • Listener
    • 文件上传
    • 拦截器
    • Spring Boot 整合 Netty-Boot
    • SSL 配置指南
    • ChannelInitializer
    • Reserve
  • 22_MQ

    • Mica-mqtt
    • EMQX
    • Disruptor
  • 23_tio-utils

    • tio-utils
    • HttpUtils
    • Notification
    • 邮箱
    • JSON
    • 读取文件
    • Base64
    • 上传和下载
    • Http
    • Telegram
    • RsaUtils
    • EnvUtils 使用文档
    • 系统监控
    • 毫秒并发 ID (MCID) 生成方案
  • 24_tio-http-server

    • 使用 Tio-Http-Server 搭建简单的 HTTP 服务
    • tio-boot 添加 HttpRequestHandler
    • 在 Android 上使用 tio-boot 运行 HTTP 服务
    • tio-http-server-native
    • handler 常用操作
  • 25_tio-websocket

    • WebSocket 服务器
    • WebSocket Client
  • 26_tio-im

    • 通讯协议文档
    • ChatPacket.proto 文档
    • java protobuf
    • 数据表设计
    • 创建工程
    • 登录
    • 历史消息
    • 发消息
  • 27_mybatis

    • Tio-Boot 整合 MyBatis
    • 使用配置类方式整合 MyBatis
    • 整合数据源
    • 使用 mybatis-plus 整合 tdengine
    • 整合 mybatis-plus
  • 28_mongodb

    • tio-boot 使用 mongo-java-driver 操作 mongodb
  • 29_elastic-search

    • Elasticsearch
    • JavaDB 整合 ElasticSearch
    • Elastic 工具类使用指南
    • Elastic-search 注意事项
    • ES 课程示例文档
  • 30_magic-script

    • tio-boot 整合 magic-script
  • 31_groovy

    • tio-boot 整合 Groovy
  • 32_firebase

    • 整合 google firebase
    • Firebase Storage
    • Firebase Authentication
    • 使用 Firebase Admin SDK 进行匿名用户管理与自定义状态标记
    • 导出用户
    • 注册回调
    • 登录注册
  • 33_文件存储

    • 文件上传数据表
    • 本地存储
    • 使用 AWS S3 存储文件并整合到 Tio-Boot 项目中
    • 存储文件到 腾讯 COS
  • 34_spider

    • jsoup
    • 爬取 z-lib.io 数据
    • 整合 WebMagic
    • WebMagic 示例:爬取学校课程数据
    • Playwright
    • Flexmark (Markdown 处理器)
    • tio-boot 整合 Playwright
    • 缓存网页数据
  • 36_integration_thirty_party

    • tio-boot 整合 okhttp
    • 整合 GrpahQL
    • 集成 Mailjet
    • 整合 ip2region
    • 整合 GeoLite 离线库
    • 整合 Lark 机器人指南
    • 集成 Lark Mail 实现邮件发送
    • Thymeleaf
    • Swagger
    • Clerk 验证
  • 37_dubbo

    • 概述
    • dubbo 2.6.0
    • dubbo 2.6.0 调用过程
    • dubbo 3.2.0
  • 38_spring

    • Spring Boot Web 整合 Tio Boot
    • spring-boot-starter-webflux 整合 tio-boot
    • Tio Boot 整合 Spring Boot Starter
    • Tio Boot 整合 Spring Boot Starter Data Redis 指南
  • 39_spring-cloud

    • tio-boot spring-cloud
  • 40_mysql

    • 使用 Docker 运行 MySQL
    • /zh/42_mysql/02.html
  • 41_postgresql

    • PostgreSQL 安装
    • PostgreSQL 主键自增
    • PostgreSQL 日期类型
    • Postgresql 金融类型
    • PostgreSQL 数组类型
    • PostgreSQL 全文检索
    • PostgreSQL 查询优化
    • 获取字段类型
    • PostgreSQL 向量
    • PostgreSQL 优化向量查询
    • PostgreSQL 其他
  • 43_oceanbase

    • 快速体验 OceanBase 社区版
    • 快速上手 OceanBase 数据库单机部署与管理
    • 诊断集群性能
    • 优化 SQL 性能指南
    • /zh/43_oceanbase/05.html
  • 50_media

    • JAVE 提取视频中的声音
    • Jave 提取视频中的图片
    • /zh/50_media/03.html
  • 51_asr

    • Whisper-JNI
  • 54_native-media

    • java-native-media
    • JNI 入门示例
    • mp3 拆分
    • mp4 转 mp3
    • 使用 libmp3lame 实现高质量 MP3 编码
    • Linux 编译
    • macOS 编译
    • 从 JAR 包中加载本地库文件
    • 支持的音频和视频格式
    • 任意格式转为 mp3
    • 通用格式转换
    • 通用格式拆分
    • 视频合并
    • VideoToHLS
    • split_video_to_hls 支持其他语言
    • 持久化 HLS 会话
  • 55_telegram4j

    • 数据库设计
    • /zh/55_telegram4j/02.html
    • 基于 MTProto 协议开发 Telegram 翻译机器人
    • 过滤旧消息
    • 保存机器人消息
    • 定时推送
    • 增加命令菜单
    • 使用 telegram-Client
    • 使用自定义 StoreLayout
    • 延迟测试
    • Reactor 错误处理
    • Telegram4J 常见错误处理指南
  • 56_telegram-bots

    • TelegramBots 入门指南
    • 使用工具库 telegram-bot-base 开发翻译机器人
  • 60_LLM

    • 简介
    • AI 问答
    • /zh/60_LLM/03.html
    • /zh/60_LLM/04.html
    • 增强检索(RAG)
    • 结构化数据检索
    • 搜索+AI
    • 集成第三方 API
    • 后置处理
    • 推荐问题生成
    • 连接代码执行器
    • 避免 GPT 混乱
    • /zh/60_LLM/13.html
  • 61_ai_agent

    • 数据库设计
    • 示例问题管理
    • 会话管理
    • 历史记录
    • 对接 Perplexity API
    • 意图识别与生成提示词
    • 智能问答模块设计与实现
    • 文件上传与解析文档
    • 翻译
    • 名人搜索功能实现
    • Ai studio gemini youbue 问答使用说明
    • 自建 YouTube 字幕问答系统
    • 自建 获取 youtube 字幕服务
    • 通用搜索
    • /zh/61_ai_agent/15.html
    • 16
    • 17
    • 18
    • 在 tio-boot 应用中整合 ai-agent
    • 16
  • 62_translator

    • 简介
  • 63_knowlege_base

    • 数据库设计
    • 用户登录实现
    • 模型管理
    • 知识库管理
    • 文档拆分
    • 片段向量
    • 命中测试
    • 文档管理
    • 片段管理
    • 问题管理
    • 应用管理
    • 向量检索
    • 推理问答
    • 问答模块
    • 统计分析
    • 用户管理
    • api 管理
    • 存储文件到 S3
    • 文档解析优化
    • 片段汇总
    • 段落分块与检索
    • 多文档解析
    • 对话日志
    • 检索性能优化
    • Milvus
    • 文档解析方案和费用对比
    • 离线运行向量模型
  • 64_ai-search

    • ai-search 项目简介
    • ai-search 数据库文档
    • ai-search SearxNG 搜索引擎
    • ai-search Jina Reader API
    • ai-search Jina Search API
    • ai-search 搜索、重排与读取内容
    • ai-search PDF 文件处理
    • ai-search 推理问答
    • Google Custom Search JSON API
    • ai-search 意图识别
    • ai-search 问题重写
    • ai-search 系统 API 接口 WebSocket 版本
    • ai-search 搜索代码实现 WebSocket 版本
    • ai-search 生成建议问
    • ai-search 生成问题标题
    • ai-search 历史记录
    • Discover API
    • 翻译
    • Tavily Search API 文档
    • 对接 Tavily Search
    • 火山引擎 DeepSeek
    • 对接 火山引擎 DeepSeek
    • ai-search 搜索代码实现 SSE 版本
    • jar 包部署
    • Docker 部署
    • 爬取一个静态网站的所有数据
    • 网页数据预处理
    • 网页数据检索与问答流程整合
  • 65_java-linux

    • Java 执行 python 代码
    • 通过大模型执行 Python 代码
    • MCP 协议
    • Cline 提示词
    • Cline 提示词-中文版本
  • 66_manim

    • 简介
    • Manim 开发环境搭建
    • 生成场景提示词
    • 生成代码
    • 完整脚本示例
    • 语音合成系统
    • Fish.audio TTS 接口说明文档与 Java 客户端封装
    • 整合 fishaudio 到 java-uni-ai-server 项目
    • 执行 Python (Manim) 代码
    • 使用 SSE 流式传输生成进度的实现文档
    • 整合全流程完整文档
    • HLS 动态推流技术文档
    • manim 分场景生成代码
    • 分场景运行代码及流式播放支持
    • 分场景业务端完整实现流程
    • Maiim布局管理器
    • 仅仅生成场景代码
    • 使用 modal 运行 manim 代码
    • Python 使用 Modal GPU 加速渲染
    • Modal 平台 GPU 环境下运行 Manim
    • Modal Manim OpenGL 安装与使用
    • 优化 GPU 加速
    • 生成视频封面流程
    • Java 调用 manim 命令 执行代码 生成封面
    • Manim 图像生成服务客户端文档
    • manim render help
    • 显示 中文公式
    • manimgl
    • EGL
    • /zh/66_manim/30.html
    • /zh/66_manim/31.html
    • 成本核算
    • /zh/66_manim/33.html
  • 70_tio-boot-admin

    • 入门指南
    • 初始化数据
    • token 存储
    • 与前端集成
    • 文件上传
    • 网络请求
    • 图片管理
    • /zh/70_tio-boot-admin/08.html
    • Word 管理
    • PDF 管理
    • 文章管理
    • 富文本编辑器
  • 71_tio-boot

    • /zh/71_tio-boot/01.html
    • Swagger 整合到 Tio-Boot 中的指南
    • HTTP/1.1 Pipelining 性能测试报告
  • 80_性能测试

    • 压力测试 - tio-http-serer
    • 压力测试 - tio-boot
    • 压力测试 - tio-boot-native
    • 压力测试 - netty-boot
    • 性能测试对比
    • TechEmpower FrameworkBenchmarks
    • 压力测试 - tio-boot 12 C 32G
  • 99_案例

    • 封装 IP 查询服务
    • tio-boot 案例 - 全局异常捕获与企业微信群通知
    • tio-boot 案例 - 文件上传和下载
    • tio-boot 案例 - 整合 ant design pro 增删改查
    • tio-boot 案例 - 流失响应
    • tio-boot 案例 - 增强检索
    • tio-boot 案例 - 整合 function call
    • tio-boot 案例 - 定时任务 监控 PostgreSQL、Redis 和 Elasticsearch
    • Tio-Boot 案例:使用 SQLite 整合到登录注册系统
    • tio-boot 案例 - 执行 shell 命令

单独使用 ApiTable

在现代应用开发中,简化数据库操作、提高代码复用性和维护性是每个开发者追求的目标。ApiTable 作为一个基于 java-db 框架的通用数据表操作工具,旨在实现这一目标。本文将详细介绍如何封装 ApiTableService 以及如何在控制器中使用 ApiTableService,以实现高效、灵活的增删改查(CRUD)操作。

目录

  1. 前言
  2. 项目结构与依赖配置
  3. 封装 ApiTableService
  4. 创建 ApiPostController
  5. 使用 ApiTableService
  6. 测试接口
  7. 总结

前言

在实际开发过程中,频繁的数据库操作往往导致大量重复代码的出现,增加了维护难度。通过封装 ApiTableService,可以将常用的数据库操作集中管理,提升代码的可读性和可维护性。同时,结合 tio-boot 框架的特性,可以进一步简化开发流程,实现高效的接口管理。

项目结构与依赖配置

在开始封装 ApiTableService 之前,确保项目已经正确配置了所需的依赖。以下是 pom.xml 文件中需要添加的依赖项:

<dependencies>
  <dependency>
    <groupId>com.alibaba.fastjson2</groupId>
    <artifactId>fastjson2</artifactId>
    <version>2.0.12</version>
  </dependency>

  <dependency>
    <groupId>com.litongjava</groupId>
    <artifactId>tio-boot</artifactId>
    <version>${tio.boot.version}</version>
  </dependency>

  <dependency>
    <groupId>com.litongjava</groupId>
    <artifactId>api-table</artifactId>
    <version>${tio.boot.version}</version>
  </dependency>

  <dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>4.0.3</version>
  </dependency>

  <!-- 连接池 -->
  <dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.1.10</version>
  </dependency>

  <!-- 数据库驱动 -->
  <dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.46</version>
  </dependency>
</dependencies>

请确保所有依赖的版本号为最新版本,以获得最佳的功能和安全性。

封装 ApiTableService

ApiTableService 是封装 ApiTable 操作的核心服务类,负责处理与数据库表相关的所有增删改查操作。通过统一的接口,简化了控制器中的代码逻辑。

ApiTableService 代码

以下是 ApiTableService 的完整代码:

package com.litongjava.max.blog.service;

import java.io.IOException;
import java.sql.SQLException;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import com.jfinal.kit.Kv;
import com.litongjava.db.TableInput;
import com.litongjava.db.TableResult;
import com.litongjava.db.activerecord.Db;
import com.litongjava.db.activerecord.Row;
import com.litongjava.model.body.RespBodyVo;
import com.litongjava.model.page.DbPage;
import com.litongjava.model.page.Page;
import com.litongjava.table.services.ApiTable;
import com.litongjava.table.utils.EasyExcelResponseUtils;
import com.litongjava.table.utils.TableInputUtils;
import com.litongjava.table.utils.TableResultUtils;
import com.litongjava.tio.boot.http.TioRequestContext;
import com.litongjava.tio.boot.utils.TioRequestParamUtils;
import com.litongjava.tio.http.common.HttpRequest;
import com.litongjava.tio.http.common.HttpResponse;

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class ApiTableService {

  public RespBodyVo create(String f, HttpRequest request) {
    Map<String, Object> map = TioRequestParamUtils.getRequestMap(request);
    map.remove("f");
    ApiTable.transformType(f, map);
    TableInput kv = TableInputUtils.camelToUnderscore(map);
    log.info("tableName:{},kv:{}", f, kv);
    TableResult<Kv> dbJsonBean = ApiTable.saveOrUpdate(f, kv);
    if (dbJsonBean.getCode() == 1) {
      return RespBodyVo.ok(dbJsonBean.getData()).code(dbJsonBean.getCode()).msg(dbJsonBean.getMsg());
    } else {
      return RespBodyVo.fail(dbJsonBean.getMsg()).code(dbJsonBean.getCode()).data(dbJsonBean.getData());
    }
  }

  public RespBodyVo list(String f, HttpRequest request) {
    Map<String, Object> map = TioRequestParamUtils.getRequestMap(request);
    map.remove("f");
    ApiTable.transformType(f, map);
    TableInput kv = TableInputUtils.camelToUnderscore(map);

    log.info("tableName:{},kv:{}", f, kv);
    TableResult<List<Row>> list = ApiTable.list(f, kv);

    TableResult<List<Kv>> dbJsonBean = TableResultUtils.recordsToKv(list, false);

    return RespBodyVo.ok(dbJsonBean.getData()).code(dbJsonBean.getCode()).msg(dbJsonBean.getMsg());
  }

  public RespBodyVo listAll(String f) {
    log.info("tableName:{}", f);
    TableResult<List<Row>> listAll = ApiTable.listAll(f);
    TableResult<List<Kv>> dbJsonBean = TableResultUtils.recordsToKv(listAll, false);

    return RespBodyVo.ok(dbJsonBean.getData()).code(dbJsonBean.getCode()).msg(dbJsonBean.getMsg());
  }

  public RespBodyVo page(String f, HttpRequest request) {
    Map<String, Object> map = TioRequestParamUtils.getRequestMap(request);
    map.remove("f");
    Object current = map.remove("current");
    if (current != null) {
      // 支持 Ant Design Pro Table
      map.put("pageNo", current);
    }

    ApiTable.transformType(f, map);

    TableInput kv = TableInputUtils.camelToUnderscore(map);

    log.info("tableName:{},kv:{}", f, kv);
    TableResult<Page<Row>> page = ApiTable.page(f, kv);

    TableResult<DbPage<Kv>> dbJsonBean = TableResultUtils.pageToDbPage(page, false);
    return RespBodyVo.ok(dbJsonBean.getData()).code(dbJsonBean.getCode()).msg(dbJsonBean.getMsg());
  }

  public RespBodyVo get(String f, HttpRequest request) {
    Map<String, Object> map = TioRequestParamUtils.getRequestMap(request);
    map.remove("f");
    ApiTable.transformType(f, map);
    TableInput kv = TableInputUtils.camelToUnderscore(map);

    log.info("tableName:{},kv:{}", f, kv);
    TableResult<Row> jsonBean = ApiTable.get(f, kv);
    TableResult<Kv> dbJsonBean = TableResultUtils.recordToKv(jsonBean);

    return RespBodyVo.ok(dbJsonBean.getData()).code(dbJsonBean.getCode()).msg(dbJsonBean.getMsg());
  }

  public RespBodyVo update(String f, HttpRequest request) {
    Map<String, Object> map = TioRequestParamUtils.getRequestMap(request);
    map.remove("f");
    ApiTable.transformType(f, map);
    TableInput kv = TableInputUtils.camelToUnderscore(map);

    log.info("tableName:{},kv:{}", f, kv);
    TableResult<Kv> dbJsonBean = ApiTable.saveOrUpdate(f, kv);

    return RespBodyVo.ok(dbJsonBean.getData()).code(dbJsonBean.getCode()).msg(dbJsonBean.getMsg());
  }

  public RespBodyVo batchUpdate(String f, HttpRequest request) {
    Map<String, Object> map = TioRequestParamUtils.getRequestMap(request);
    map.remove("f");
    ApiTable.transformType(f, map);
    TableInput kv = TableInputUtils.camelToUnderscore(map);

    log.info("tableName:{},kv:{}", f, kv);
    TableResult<Kv> dbJsonBean = ApiTable.batchUpdateByIds(f, kv);

    return RespBodyVo.ok(dbJsonBean.getData()).code(dbJsonBean.getCode()).msg(dbJsonBean.getMsg());
  }

  public RespBodyVo remove(String f, String id) {
    log.info("tableName:{},id:{}", f, id);
    TableResult<Boolean> dbJsonBean = ApiTable.updateFlagById(f, id, "deleted", 1);
    return RespBodyVo.ok(dbJsonBean.getData()).code(dbJsonBean.getCode()).msg(dbJsonBean.getMsg());
  }

  public RespBodyVo delete(String f, String id) {
    log.info("tableName:{},id:{}", f, id);
    TableResult<Boolean> dbJsonBean = ApiTable.delById(f, id);
    return RespBodyVo.ok(dbJsonBean.getData()).code(dbJsonBean.getCode()).msg(dbJsonBean.getMsg());
  }

  public RespBodyVo total(String f) {
    log.info("tableName:{},id:{}", f);
    Long count = Db.count(f);
    return RespBodyVo.ok(count);
  }

  public HttpResponse exportExcel(String f, HttpRequest request) throws IOException {
    Map<String, Object> map = TioRequestParamUtils.getRequestMap(request);
    map.remove("f");
    ApiTable.transformType(f, map);
    Object current = map.remove("current");
    if (current != null) {
      // 支持 Ant Design Pro Table
      map.put("pageNo", current);
    }
    TableInput kv = TableInputUtils.camelToUnderscore(map);

    log.info("tableName:{},kv:{}", f, kv);
    String filename = f + "_export_" + System.currentTimeMillis() + ".xlsx";

    // 获取数据
    List<Row> records = ApiTable.list(f, kv).getData();
    HttpResponse response = TioRequestContext.getResponse();
    return EasyExcelResponseUtils.exportRecords(response, filename, f, records);
  }

  public HttpResponse exportAllExcel(String f, HttpRequest request) throws IOException, SQLException {
    Map<String, Object> map = TioRequestParamUtils.getRequestMap(request);
    map.remove("f");
    map.remove("current");
    map.remove("pageNo");
    map.remove("pageSize");
    ApiTable.transformType(f, map);

    TableInput kv = TableInputUtils.camelToUnderscore(map);

    log.info("tableName:{},kv:{}", f, kv);

    // 导出 Excel
    String filename = f + "-all_" + System.currentTimeMillis() + ".xlsx";

    // 获取数据
    List<Row> records = ApiTable.listAll(f, kv).getData();

    HttpResponse response = TioRequestContext.getResponse();
    EasyExcelResponseUtils.exportRecords(response, filename, f, records);
    log.info("finished");
    return response;
  }

  public HttpResponse exportAllTableExcel(HttpRequest request) throws IOException {
    String filename = "all-table_" + System.currentTimeMillis() + ".xlsx";
    String[] tables = ApiTable.getAllTableNames();
    LinkedHashMap<String, List<Row>> allTableData = new LinkedHashMap<>();

    for (String table : tables) {
      // 获取数据
      List<Row> records = ApiTable.listAll(table).getData();
      allTableData.put(table, records);
    }
    HttpResponse response = TioRequestContext.getResponse();
    EasyExcelResponseUtils.exportAllTableRecords(response, filename, allTableData);
    log.info("finished");
    return response;
  }

  public RespBodyVo pageDeleted(String f, HttpRequest request) {
    Map<String, Object> map = TioRequestParamUtils.getRequestMap(request);
    map.remove("f");
    ApiTable.transformType(f, map);
    TableInput kv = TableInputUtils.camelToUnderscore(map);

    log.info("tableName:{},kv:{}", f, kv);
    TableResult<DbPage<Kv>> dbJsonBean = TableResultUtils.pageToDbPage(ApiTable.page(f, kv), false);

    return RespBodyVo.ok(dbJsonBean.getData()).code(dbJsonBean.getCode()).msg(dbJsonBean.getMsg());
  }

  public RespBodyVo recover(String f, String id) {
    log.info("tableName:{},id:{}", f, id);
    TableResult<Boolean> dbJsonBean = ApiTable.updateFlagById(f, id, "deleted", 0);

    return RespBodyVo.ok(dbJsonBean.getData()).code(dbJsonBean.getCode()).msg(dbJsonBean.getMsg());
  }

  public RespBodyVo tableNames() throws IOException {
    String[] data = ApiTable.tableNames().getData();
    return RespBodyVo.ok(data);
  }

  public RespBodyVo fConfig(String f, String lang) {
    log.info("tableName:{}", f);
    TableResult<Map<String, Object>> dbJsonBean = ApiTable.tableConfig(f, f, lang);
    return RespBodyVo.ok(dbJsonBean.getData()).code(dbJsonBean.getCode()).msg(dbJsonBean.getMsg());
  }

  public RespBodyVo proTableColumns(String f) {
    TableResult<List<Map<String, Object>>> dbJsonBean = ApiTable.columns(f);
    return RespBodyVo.ok(dbJsonBean.getData()).code(dbJsonBean.getCode()).msg(dbJsonBean.getMsg());
  }
}

主要方法解析

  1. create:用于创建新记录。接收请求参数,转换类型后调用 ApiTable.saveOrUpdate 方法保存数据。
  2. list:根据条件查询符合的记录列表。
  3. listAll:查询表中所有记录。
  4. page:实现分页查询,支持前端分页参数(如 current)。
  5. get:根据唯一条件(如主键)获取单条记录。
  6. update:根据主键更新单条记录。
  7. batchUpdate:批量更新多条记录。
  8. remove:逻辑删除,通过更新 deleted 字段标记记录。
  9. delete:物理删除,直接从数据库中移除记录。
  10. total:获取指定表的记录总数。
  11. exportExcel:导出当前查询的数据为 Excel 文件,不包含已删除的数据。
  12. exportAllExcel:导出符合条件的所有数据为 Excel 文件,包括逻辑删除的数据。
  13. exportAllTableExcel:导出数据库中所有表的数据为一个 Excel 文件。
  14. pageDeleted:分页查询已逻辑删除的数据。
  15. recover:恢复已逻辑删除的记录。
  16. tableNames:获取数据库中所有表名。
  17. fConfig:获取指定表的配置,用于前端展示等。
  18. proTableColumns:获取指定表的字段信息。

创建 ApiPostController

ApiPostController 作为控制器,负责处理前端发送的请求,并调用 ApiTableService 中对应的方法完成具体操作。以下是 ApiPostController 的完整代码:

ApiPostController 代码

package com.litongjava.max.blog.controller;

import java.io.IOException;
import java.sql.SQLException;

import com.litongjava.annotation.EnableCORS;
import com.litongjava.annotation.RequestPath;
import com.litongjava.db.activerecord.Db;
import com.litongjava.jfinal.aop.Aop;
import com.litongjava.max.blog.consts.TableNames;
import com.litongjava.max.blog.service.ApiTableService;
import com.litongjava.model.body.RespBodyVo;
import com.litongjava.tio.http.common.HttpRequest;
import com.litongjava.tio.http.common.HttpResponse;

import lombok.extern.slf4j.Slf4j;

@RequestPath("/api/post")
@Slf4j
@EnableCORS
public class ApiPostController {

  ApiTableService apiTableService = Aop.get(ApiTableService.class);
  String f = TableNames.tio_boot_admin_article;

  @RequestPath("/index")
  public String index() {
    return "ApiPostController";
  }

  @RequestPath("/create")
  public RespBodyVo create(HttpRequest request) {
    return apiTableService.create(f, request);
  }

  @RequestPath("/list")
  public RespBodyVo list(HttpRequest request) {
    return apiTableService.list(f, request);
  }

  @RequestPath("/listAll")
  public RespBodyVo listAll() {
    return apiTableService.listAll(f);
  }

  @RequestPath("/page")
  public RespBodyVo page(HttpRequest request) {
    return apiTableService.page(f, request);
  }

  @RequestPath("/get")
  public RespBodyVo get(HttpRequest request) {
    return apiTableService.get(f, request);
  }

  @RequestPath("/update")
  public RespBodyVo update(HttpRequest request) {
    return apiTableService.update(f, request);
  }

  @RequestPath("/batchUpdate")
  public RespBodyVo batchUpdate(HttpRequest request) {
    return apiTableService.batchUpdate(f, request);
  }

  @RequestPath("/remove/{id}")
  public RespBodyVo remove(String id) {
    return apiTableService.remove(f, id);
  }

  @RequestPath("/delete/{id}")
  public RespBodyVo delete(String id) {
    return apiTableService.delete(f, id);
  }

  @RequestPath("/total")
  public RespBodyVo total(String f) {
    log.info("tableName:{},id:{}", f);
    Long count = Db.count(f);
    return RespBodyVo.ok(count);
  }

  /**
   * 导出当前数据
   */
  @RequestPath("/export-excel")
  public HttpResponse exportExcel(HttpRequest request) throws IOException {
    return apiTableService.exportExcel(f, request);
  }

  /**
   * 导出所有数据
   */
  @RequestPath("/export-table-excel")
  public HttpResponse exportAllExcel(HttpRequest request) throws IOException, SQLException {
    return apiTableService.exportAllExcel(f, request);
  }

  @RequestPath("/pageDeleted")
  public RespBodyVo pageDeleted(HttpRequest request) {
    return apiTableService.pageDeleted(f, request);
  }

  @RequestPath("/recover")
  public RespBodyVo recover(String id) {
    return apiTableService.recover(f, id);
  }

  @RequestPath("/config")
  public RespBodyVo fConfig(String lang) {
    return apiTableService.fConfig(f, lang);
  }

  @RequestPath("/columns")
  public RespBodyVo proTableColumns(String f) {
    return apiTableService.proTableColumns(f);
  }
}

主要方法解析

  1. create:处理创建新文章的请求。
  2. list:处理获取文章列表的请求。
  3. listAll:处理获取所有文章的请求。
  4. page:处理分页获取文章的请求。
  5. get:处理获取单篇文章详情的请求。
  6. update:处理更新文章的请求。
  7. batchUpdate:处理批量更新文章的请求。
  8. remove:处理逻辑删除文章的请求。
  9. delete:处理物理删除文章的请求。
  10. total:获取文章表的总记录数。
  11. exportExcel:导出当前查询的文章数据为 Excel 文件。
  12. exportAllExcel:导出符合条件的所有文章数据为 Excel 文件。
  13. pageDeleted:分页查询已逻辑删除的文章。
  14. recover:恢复已逻辑删除的文章。
  15. fConfig:获取文章表的配置,用于前端展示等。
  16. proTableColumns:获取文章表的字段信息。

使用 ApiTableService

通过 ApiPostController,前端可以发送 HTTP 请求来完成文章的增删改查操作,而控制器则通过 ApiTableService 来处理具体的业务逻辑。以下是使用流程的简要说明:

  1. 发送请求:前端通过 HTTP 请求(如 POST、GET、DELETE)发送数据到相应的接口。
  2. 控制器处理:ApiPostController 接收请求,并调用 ApiTableService 中对应的方法。
  3. 服务层操作:ApiTableService 通过 ApiTable 提供的静态方法,执行数据库操作。
  4. 返回响应:操作结果通过 RespBodyVo 封装后返回给前端。

示例:创建新文章

前端请求:

  • 请求方式:POST

  • URL:/api/post/create

  • 请求体:

    {
      "title": "新文章标题",
      "content": "这是文章的内容。",
      "author": "admin",
      "status": "published"
    }
    

控制器处理:

  1. ApiPostController 的 create 方法接收请求,并调用 ApiTableService 的 create 方法。
  2. ApiTableService 的 create 方法解析请求参数,转换字段名,并调用 ApiTable.saveOrUpdate 方法保存数据。
  3. 保存成功后,返回包含新记录 ID 的响应。

响应示例:

{
  "data": {
    "id": "361177594135064576"
  },
  "code": 1,
  "msg": null,
  "ok": true
}

测试接口

为了确保 ApiTableService 和 ApiPostController 的功能正常,需对各个接口进行详细测试。以下是各个接口的测试说明,包括请求方式、URL、参数及预期响应。

测试 create

  • 功能:添加一条新数据。

  • 请求方式:POST

  • URL:/api/post/create

  • 请求体:

    {
      "title": "测试文章",
      "content": "这是一篇测试文章。",
      "author": "admin",
      "status": "draft"
    }
    
  • 响应示例:

    {
      "data": {
        "id": "361177594135064576"
      },
      "code": 1,
      "msg": null,
      "ok": true
    }
    

测试 list

  • 功能:查询文章列表。

  • 请求方式:GET

  • URL:/api/post/list

  • 请求参数:可选,如 author=admin。

  • 响应示例:

    {
      "data": [
        {
          "title": "测试文章",
          "content": "这是一篇测试文章。",
          "author": "admin",
          "status": "draft",
          "id": "361177594135064576"
        }
        // 其他记录...
      ],
      "msg": null,
      "code": 1,
      "ok": true
    }
    

测试 listAll

  • 功能:查询所有文章。

  • 请求方式:GET

  • URL:/api/post/listAll

  • 响应示例:

    {
      "data": [
        {
          "title": "测试文章",
          "content": "这是一篇测试文章。",
          "author": "admin",
          "status": "draft",
          "id": "361177594135064576"
        }
        // 其他记录...
      ],
      "code": 1,
      "msg": null,
      "ok": true
    }
    

测试 page

  • 功能:分页查询文章。

  • 请求方式:GET

  • URL:/api/post/page

  • 请求参数:current=1&pageSize=10

  • 响应示例:

    {
      "data": {
        "total": 17,
        "list": [
          {
            "title": "测试文章",
            "content": "这是一篇测试文章。",
            "author": "admin",
            "status": "draft",
            "id": "361177594135064576"
          }
          // 其他记录...
        ]
      },
      "code": 1,
      "msg": null,
      "ok": true
    }
    

测试 get

  • 功能:根据条件获取单条数据。

  • 请求方式:GET

  • URL:/api/post/get?title=测试文章

  • 响应示例:

    {
      "data": {
        "title": "测试文章",
        "content": "这是一篇测试文章。",
        "author": "admin",
        "status": "draft",
        "id": "361177594135064576"
      },
      "code": 1,
      "msg": null,
      "ok": true
    }
    

测试 update

  • 功能:根据 ID 更新数据。

  • 请求方式:POST

  • URL:/api/post/update

  • 请求体:

    {
      "id": "361177594135064576",
      "title": "更新后的文章标题",
      "status": "published"
    }
    
  • 响应示例:

    {
      "data": null,
      "code": 1,
      "msg": "更新成功",
      "ok": true
    }
    

测试 batchUpdate

  • 功能:批量更新多条记录。

  • 请求方式:POST

  • URL:/api/post/batchUpdate

  • 请求体:

    {
      "ids": ["361177594135064576", "361177594135064577"],
      "status": "archived"
    }
    
  • 响应示例:

    {
      "data": null,
      "code": 1,
      "msg": "批量更新成功",
      "ok": true
    }
    

测试 remove

  • 功能:逻辑删除数据。

  • 请求方式:DELETE

  • URL:/api/post/remove/361177594135064576

  • 响应示例:

    {
      "data": null,
      "code": 1,
      "msg": "逻辑删除成功",
      "ok": true
    }
    

测试 delete

  • 功能:物理删除数据。

  • 请求方式:DELETE

  • URL:/api/post/delete/361177594135064576

  • 响应示例:

    {
      "data": null,
      "code": 1,
      "msg": "删除成功",
      "ok": true
    }
    

测试 total

  • 功能:获取指定表的记录总数。

  • 请求方式:GET

  • URL:/api/post/total

  • 响应示例:

    {
      "data": 17,
      "code": 1,
      "msg": null,
      "ok": true
    }
    

测试 exportExcel

  • 功能:导出当前查询的数据为 Excel 文件,不包含已删除的数据。
  • 请求方式:GET
  • URL:/api/post/export-excel
  • 响应:下载 .xlsx 文件。

测试 exportAllExcel

  • 功能:导出符合条件的所有数据为 Excel 文件,包括逻辑删除的数据。
  • 请求方式:GET
  • URL:/api/post/export-table-excel
  • 响应:下载 .xlsx 文件。

测试 exportAllTableExcel

  • 功能:导出数据库中所有表的数据为一个 Excel 文件,慎用。
  • 请求方式:GET
  • URL:/api/post/export-all-table-excel
  • 响应:下载 .xlsx 文件。

测试 pageDeleted

  • 功能:分页查询已逻辑删除的数据。

  • 请求方式:GET

  • URL:/api/post/pageDeleted

  • 响应示例:

    {
      "data": {
        "total": 1,
        "list": [
          {
            "title": "测试文章",
            "content": "这是一篇测试文章。",
            "author": "admin",
            "status": "archived",
            "id": "361177594135064576"
          }
        ]
      },
      "code": 1,
      "msg": null,
      "ok": true
    }
    

测试 recover

  • 功能:恢复已逻辑删除的数据。

  • 请求方式:POST

  • URL:/api/post/recover

  • 请求体:

    {
      "id": "361177594135064576"
    }
    
  • 响应示例:

    {
      "data": null,
      "code": 1,
      "msg": "恢复成功",
      "ok": true
    }
    

测试 tableNames

  • 功能:获取数据库中所有表名。

  • 请求方式:GET

  • URL:/api/post/tableNames

  • 响应示例:

    {
      "data": [
        "system_users",
        "tio_boot_admin_article"
        // 其他表名...
      ],
      "code": 1,
      "msg": null,
      "ok": true
    }
    

测试 fConfig

  • 功能:获取指定表的配置,用于前端展示等。

  • 请求方式:GET

  • URL:/api/post/config?lang=en

  • 请求参数:

    • lang=en (可选,用于指定语言)
  • 响应示例:

    {
      "code": 1,
      "data": {
        // 配置信息
      },
      "msg": null,
      "ok": true
    }
    

测试 proTableColumns

  • 功能:获取指定表的字段信息。

  • 请求方式:GET

  • URL:/api/post/columns

  • 响应示例:

    {
      "code": 1,
      "data": [
        {
          "title": "Id",
          "dataIndex": "id",
          "valueType": "text"
        },
        {
          "title": "Title",
          "dataIndex": "title",
          "valueType": "text"
        },
        {
          "title": "Content",
          "dataIndex": "content",
          "valueType": "textarea"
        }
        // 其他字段信息...
      ],
      "ok": true
    }
    

总结

通过封装 ApiTableService,实现了对 ApiTable 操作的集中管理,极大地简化了控制器中的代码逻辑,提高了代码的可读性和可维护性。结合 tio-boot 框架的特性,进一步提升了开发效率和系统的稳定性。

在实际项目中,开发者可以根据业务需求,扩展 ApiTableService 的功能,或者创建更多的控制器来处理不同的数据表操作。同时,合理配置数据库连接池和优化查询条件,可以进一步提升系统的性能和响应速度。

Edit this page
Last Updated:
Contributors: Tong Li
Prev
数组类型