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 命令

TQL(Table SQL)前端输入规范

  • 基本概念
    • 数据表(Data Table)
    • 数据对象
    • 数据字段
    • 操作指令
  • 操作指令
    • 查询操作符
    • 查找指令示例
    • 数据字段指令
    • 分页指令
    • 排序指令
    • 类型指令
    • 逻辑指令
    • 输入转换指令
    • 综合示例
    • 输出转换指令
  • 综合案例
    • 分页查询

TQL(Table SQL)是一种以 http 请求参数 为载体的结构化查询语言,用于操作数据表。进程 JQL

  • 解析前端输入的 Http 请求 参数
  • 转换为底层数据库可执行的 SQL 语句
  • 执行 SQL
  • 将执行结果返回至前端
  • 支持对表的增删改查操作

基本概念

数据表(Data Table)

例如,以下请求中 system_users 被称为数据表名称(data table name):

http://localhost:10051/table/system_users/get?username=admin

数据对象

数据表实例化后的对象称为数据对象。

数据字段

数据对象的键称为数据字段。以下数据对象包含两个数据字段,分别是 creator 和 sex:

{
  "creator": "admin",
  "sex": 1
}

操作指令

TQL 支持多种操作指令。操作指令支持驼峰命名规则和下划线命名规则,例如 nameOp 或 name_op。

操作指令

查询操作符

查询操作符用于对数据字段进行操作,执行的查询指令如下。具体实现可参考源码 com.litongjava.data.services.OperatorService。

操作符名称请求示例SQL 示例
eq等于"field": "value", "fieldOp": "eq"field = 'value'
ne不等于"field": "value", "fieldOp": "ne"field != 'value'
gt大于"field": "value", "fieldOp": "gt"field > 'value'
ge大于等于"field": "value", "fieldOp": "ge"field >= 'value'
lt小于"field": "value", "fieldOp": "lt"field < 'value'
le小于等于"field": "value", "fieldOp": "le"field <= 'value'
bt之间"field": ["value1", "value2"], "fieldOp": "bt"field BETWEEN 'value1' AND 'value2'
nb不在之间"field": ["value1", "value2"], "fieldOp": "nb"field NOT BETWEEN 'value1' AND 'value2'
ct包含"field": "value", "fieldOp": "ct"field LIKE '%value%'
sw开始于"field": "value", "fieldOp": "sw"field LIKE 'value%'
ew结束于"field": "value", "fieldOp": "ew"field LIKE '%value'
ol或类似于"field": ["value1", "value2"], "fieldOp": "ol"(field LIKE 'value1' OR field LIKE 'value2')
nk不类似于"field": "value", "fieldOp": "nk"field NOT LIKE 'value'
il在列表中"field": ["value1", "value2"], "fieldOp": "il"field IN ('value1', 'value2')
ni不在列表中"field": ["value1", "value2"], "fieldOp": "ni"field NOT IN ('value1', 'value2')
nl为空"fieldOp": "nl"field IS NULL
nn不为空"fieldOp": "nn"field IS NOT NULL
ey空值"fieldOp": "ey"(field IS NULL OR field = '')
ny非空值"fieldOp": "ny"(field IS NOT NULL AND field != '')
nt非真值"fieldOp": "nt"(field IS NOT TRUE)
nf非假值"fieldOp": "nf"(field IS NOT FALSE)

每一行描述了:

  • 操作符:用于标识操作的代码。
  • 名称:操作符的描述。
  • 请求示例:如何在查询中使用该操作符。
  • SQL 示例:操作在 SQL 语句中的等价表示。

查找指令示例

示例 1

请求:

POST /table/rumi_sjsu_professors/page
{
  "name": "Tong",
  "nameOp": "ct"
}

解析:

  • 数据表名称: rumi_sjsu_professors
  • 数据字段:
    • "name": 值为 "Tong"
  • 操作指令:
    • "nameOp": "ct" 表示 name 字段包含 "Tong"

SQL 转换:

SELECT * FROM rumi_sjsu_professors WHERE name LIKE '%Tong%';

示例 2

请求:

POST /table/student/page
{
  "name": "Tong",
  "nameOp": "ct"
}

解析:

  • 数据表名称: student
  • 数据字段:
    • "name": 值为 "Tong"
  • 操作指令:
    • "nameOp": "ct" 表示 name 字段包含 "Tong"

SQL 转换:

SELECT * FROM student WHERE name LIKE '%Tong%';

详细步骤

  1. 解析 JSON 输入:服务器接收到 JSON 格式的查询请求。
  2. 识别数据表、数据字段和操作指令:解析 JSON 对象中的数据字段(如 "name")和对应的操作指令(如 "nameOp": "ct")。
  3. 生成 SQL 语句:根据操作符表,将 "nameOp": "ct" 转换为 SQL 的 LIKE '%value%' 语法,生成 name LIKE '%Tong%'。
  4. 执行查询:执行生成的 SQL 查询,并返回符合条件的记录。

通过上述步骤,系统可以将前端输入的结构化 JSON 查询转换为底层数据库可执行的 SQL 语句,实现对数据表的查询操作。

数据字段指令

数据字段指令 columns 用于指定查询结果中需要返回的数据字段。默认情况下,如果不指定 columns,查询会返回数据表中包含的所有数据字段。通过使用 columns 指令,可以明确指出需要的特定字段,从而优化查询结果和性能。

指令说明

名称描述示例
columns指定需要返回的数据字段,默认返回所有字段"columns": "name,id"
  • columns:
    • 描述: 指定查询结果中要返回的数据字段。默认情况下,查询会返回数据表中的所有字段。如果使用 columns 指定了特定字段,查询将只返回这些指定字段。
    • 示例: "columns": "name,id"
    • 说明: 查询结果中将只包含 name 和 id 字段。

示例解析

假设有一个查询请求,希望只返回 name 和 id 字段:

{
  "columns": "name,id"
}

生成的 SQL 语句为:

SELECT name, id FROM table_name;

分页指令

分页指令用于控制查询结果的分页显示,指定要返回的页码和每页的记录数。以下是分页指令的描述:

名称描述示例
pageNo要返回的页码,从 1 开始计数"pageNo": 1
current当前页码,与 pageNo 含义相同"current": 1"
pageSize每页的记录数,指定返回的最大记录数"pageSize": 20"

示例解析

  • pageNo:

    • 描述: 指定要返回的页码,页码从 1 开始计数。
    • 示例: "pageNo": 1
    • 说明: 请求第 1 页的记录。
  • current:

    • 描述: 当前页码,与 pageNo 含义相同,指定要返回的页码。
    • 示例: "current": 1
    • 说明: 请求第 1 页的记录。
  • pageSize:

    • 描述: 每页的记录数,指定每页返回的最大记录数。
    • 示例: "pageSize": 20
    • 说明: 每页返回 20 条记录。

综合示例

假设有一个查询请求,分页显示,每页 20 条记录,返回第 1 页的数据:

{
  "pageNo": 1,
  "pageSize": 20,
  "columns": "name,id",
  "name": "Tong",
  "nameOp": "ct"
}

生成的 SQL 语句为:

SELECT name, id FROM users WHERE name LIKE '%Tong%' LIMIT 20 OFFSET 0;

如果请求第 2 页的数据,将 pageNo 改为 2,OFFSET 变为 20:

{
  "pageNo": 2,
  "pageSize": 20,
  "columns": "name,id",
  "name": "Tong",
  "nameOp": "ct"
}

生成的 SQL 语句为:

SELECT name, id FROM users WHERE name LIKE '%Tong%' LIMIT 20 OFFSET 20;

排序指令

排序指令用于指定查询结果的排序方式,包括要排序的列和排序的顺序(升序或降序)。

指令说明

名称描述示例
orderBy排序字段"orderBy": "update_time"
isAsc是否升序排序"isAsc": "false"
  • orderBy:

    • 描述: 指定用于排序的列名。
    • 示例: "orderBy": "update_time"
    • 说明: 以 update_time 列进行排序。
  • isAsc:

    • 描述: 指定排序顺序。true 表示升序 (ASC),false 表示降序 (DESC)。
    • 示例: "isAsc": "false"
    • 说明: 降序排列。

综合示例

假设有一个查询请求,希望根据 update_time 列进行降序排序:

{
  "columns": "name,id",
  "name": "Tong",
  "nameOp": "ct",
  "orderBy": "update_time",
  "isAsc": "false"
}

生成的 SQL 语句为:

SELECT name, id FROM users WHERE name LIKE '%Tong%' ORDER BY update_time DESC;

如果希望升序排列,则将 isAsc 设置为 true:

{
  "columns": "name,id",
  "name": "Tong",
  "nameOp": "ct",
  "orderBy": "update_time",
  "isAsc": "true"
}

生成的 SQL 语句为:

SELECT name, id FROM users WHERE name LIKE '%Tong%' ORDER BY update_time ASC;

类型指令

类型指令用于解析数据字段的值。例如,如果数据库的主键类型是雪花 ID(Snowflake ID),前端通常会以字符串(string)类型传递该值,后端在获取值后将其转换为长整型(long)类型。类型指令通过指定字段类型,确保前端、后端和数据库的数据字段类型一致。

指令说明

名称描述示例
type指定字段类型{"id": "395190726650089472", "idType": "long"}

示例解析

type:

  • 描述: 指定字段的类型,确保数据在前端和后端之间正确传递和转换。
  • 示例:
{
  "id": "395190726650089472",
  "idType": "long"
}
  • 说明: id 字段在前端以字符串形式传递,后端接收后将其转换为长整型(long)类型。

支持的数据类型

类型描述示例
int整数类型"ageType": "int"
long长整型"idType": "long"
int[]整数数组"idsType": "int[]"
long[]长整型数组"idsType": "long[]"
string[]字符串数组"namesType": "string[]"
ISO8601日期时间类型(ISO 8601 格式){"dateType": "ISO8601", "date": "2024-04-14T03:23:37.899Z"}

类型指令示例

假设有一个查询请求,希望使用 id 字段,并指定其类型为长整型:

{
  "id": "395190726650089472",
  "idType": "long"
}

在后端,id 字段将被解析为长整型(long),确保与数据库中的数据表一致。

综合示例

假设有一个复杂的查询请求,包含分页、排序和类型指令:

{
  "pageNo": 1,
  "pageSize": 20,
  "columns": "name,id",
  "name": "Tong",
  "nameOp": "ct",
  "orderBy": "update_time",
  "isAsc": "false",
  "id": "395190726650089472",
  "idType": "long"
}

生成的 SQL 语句为:

SELECT name, id FROM table_name WHERE id = 395190726650089472 AND name LIKE '%Tong%' ORDER BY update_time DESC LIMIT 20 OFFSET 0;

并且在后端,id 字段会被正确解析为长整型(long)。

逻辑指令

逻辑指令用于在指定字段前添加逻辑运算符(如 OR 和 AND),以构建更复杂的查询条件。通过逻辑指令,可以灵活地组合多个查询条件,满足不同的查询需求。

指令说明

名称描述示例备注
logic在指定字段前添加逻辑运算符(OR, AND)"deleted": 0, "deletedLogic": "or", "deletedOp": "nl"logic 可选 or 或 and

示例解析

  • logic:

    • 描述: 指定逻辑运算符,用于连接不同的查询条件。可选值为 or 或 and。
    • 示例:
    {
      "deleted": 0,
      "deletedLogic": "or",
      "deletedOp": "nl"
    }
    
    • 说明: deleted 字段的查询条件使用 or 逻辑运算符,并且操作符为 nl(为空)。

示例解释

假设有一个查询请求,要求 deleted 字段为空(IS NULL)或等于某个值:

{
  "deleted": 0,
  "deletedLogic": "or",
  "deletedOp": "nl"
}

生成的 SQL 语句为:

SELECT * FROM posts WHERE deleted IS NULL OR deleted = 0;

详细步骤

  1. 解析 JSON 输入:服务器接收到 JSON 格式的查询请求。
  2. 识别逻辑运算符和操作符:解析 JSON 对象中的逻辑运算符(如 "deletedLogic": "or")和操作符(如 "deletedOp": "nl")。
  3. 生成 SQL 条件:
    • deletedLogic 为 or,表示条件之间使用 OR 运算符。
    • deletedOp 为 nl,表示 deleted 字段为空(IS NULL)。
    • 因此,生成的 SQL 条件为 deleted IS NULL OR deleted = 0。
  4. 生成完整 SQL 语句:将生成的条件添加到 SQL 语句中,并根据其他指令(如排序、分页等)生成完整的 SQL 语句。

综合示例

假设有一个复杂的查询请求,包含分页、排序、字段选择和逻辑指令:

{
  "pageNo": 1,
  "pageSize": 10,
  "columns": "name,id",
  "name": "Tong",
  "nameOp": "ct",
  "orderBy": "created_at",
  "isAsc": "false",
  "deleted": 0,
  "deletedLogic": "or",
  "deletedOp": "nl"
}

生成的 SQL 语句为:

SELECT name, id
FROM posts
WHERE name LIKE '%Tong%' AND (deleted IS NULL OR deleted = 0)
ORDER BY created_at DESC
LIMIT 10 OFFSET 0;

输入转换指令

输入转换指令用于将数据字段的值转换为其他类型或格式,以确保数据在处理过程中符合预期的类型和格式要求。

指令说明

名称描述
to_type将数据字段的值转换为其他类型或格式

支持的数据类型转换

类型格式示例
ISO8601将字符串转为 YYYY-MM-DDTHH:mm:ss.sssZ 格式的日期{ "start_time": "2024-06-24 09:00:00", "end_time": "2024-06-24 10:30:00", "start_time_to_type": "ISO8601", "end_time_to_type": "ISO8601" }

示例解析

  1. 单个字段转换:

    假设有一个请求,其中 start_time 和 end_time 字段需要转换为 ISO8601 格式的日期:

    {
      "start_time": "2024-06-24 09:00:00",
      "end_time": "2024-06-24 10:30:00",
      "start_time_to_type": "ISO8601",
      "end_time_to_type": "ISO8601"
    }
    

    后端在接收到数据后会将 start_time 和 end_time 字段转换为 ISO8601 格式:

    {
      "start_time": "2024-06-24T09:00:00.000Z",
      "end_time": "2024-06-24T10:30:00.000Z"
    }
    
  2. 数组字段转换:

    假设有一个查询请求,其中 update_time 字段为数组,并需要转换为 ISO8601 格式:

    {
      "update_time_op": "bt",
      "update_time": ["2024-06-25 00:00:00", "2024-06-25 00:00:07"],
      "update_time_type": "string[]",
      "update_time_to_type": "ISO8601"
    }
    

    后端在接收到数据后会将 update_time 数组中的每个字符串转换为 ISO8601 格式:

    {
      "update_time": ["2024-06-25T00:00:00.000Z", "2024-06-25T00:00:07.000Z"]
    }
    

综合示例

假设有一个复杂的查询请求,包含分页、排序、字段选择和输入转换指令:

{
  "pageNo": 1,
  "pageSize": 10,
  "columns": "name,id,update_time",
  "name": "Tong",
  "nameOp": "ct",
  "orderBy": "created_at",
  "isAsc": "false",
  "update_time_op": "bt",
  "update_time": ["2024-06-25 00:00:00", "2024-06-25 00:00:07"],
  "update_time_type": "string[]",
  "update_time_to_type": "ISO8601"
}

生成的 SQL 语句为:

SELECT name, id, update_time
FROM posts
WHERE name LIKE '%Tong%'
  AND update_time BETWEEN '2024-06-25T00:00:00.000Z' AND '2024-06-25T00:00:07.000Z'
ORDER BY created_at DESC
LIMIT 10 OFFSET 0;

执行步骤

  1. 解析 JSON 输入:服务器接收到 JSON 格式的查询请求。
  2. 识别并处理转换指令:解析 JSON 对象中的 to_type 指令,将指定字段的值转换为目标类型或格式。
  3. 生成 SQL 条件:使用转换后的字段值生成 SQL 条件。
  4. 生成完整 SQL 语句:将生成的条件添加到 SQL 语句中,并根据其他指令(如分页、排序等)生成完整的 SQL 语句。

输出转换指令

输出转换指令用于指定数据字段值的输出格式。

指令说明

名称描述示例
json_fields指定查询结果中需要以 JSON 对象形式返回的字段。如果不指定,默认返回字符串形式的数据"json_fields": ["files"]
  • json_fields:

    • 描述: json_fields 指令用于指定查询结果中需要以 JSON 对象形式返回的字段。默认情况下,数据库中的 JSON 数据表字段在查询结果中会以字符串形式返回。通过使用 json_fields 指令,可以明确指出哪些字段需要以 JSON 对象的形式返回,方便前端处理这些字段。
    • 示例:
    {
      "json_fields": ["files"]
    }
    
    • 说明: files 字段在查询结果中将以 JSON 对象的形式返回,而不是字符串。

示例解析

假设有一个查询请求,希望 files 字段以 JSON 对象形式返回:

{
  "json_fields": ["files"]
}

综合案例

分页查询

输入

{
  "current": 1,
  "pageSize": 20,
  "name": "map",
  "update_time": ["2024-06-24 00:00:00", "2024-06-26 00:00:00"],
  "idType": "long",
  "remarkOp": "ct",
  "orderBy": "update_time",
  "update_time_type": "string[]",
  "update_time_op": "bt",
  "update_time_to_type": "ISO8601",
  "isAsc": "false",
  "deleted": 0,
  "json_fields": ["files"],
  "json_fields_type": "string[]",
  "nameOp": "ct",
  "departmentOp": "ct"
}

输出

{
  "code": 1,
  "data": {
    "list": [
      {
        "tenant_id": "0",
        "creator": "",
        "create_time": "2024-06-25 06:26:51.525374",
        "description": "printstatioin map form",
        "url": "https://www.sjsu.edu/it/docs/print/wepaPrintStationMap.pdf",
        "updater": "",
        "update_time": "2024-06-25 06:26:51.525374",
        "deleted": 0,
        "name": "printstatioin map form",
        "files": [
          {
            "uid": "rc-upload-1719296816565-2",
            "size": 469981,
            "name": "1719296814911.png",
            "id": "395190747793575936",
            "type": "image/png",
            "url": "https://rumiapp.s3.us-west-1.amazonaws.com/sjsu/documents/395190740868780032.png",
            "status": "done"
          }
        ],
        "id": "395190726650089472"
      }
    ],
    "total": 1
  },
  "ok": true
}

输入解释

该输入 JSON 请求定义了一次复杂的查询操作,包含分页、排序、字段选择、逻辑运算和类型转换指令。以下是对每个字段的详细解释:

  • current: 当前页码,表示要查询的页数。

    "current": 1
    
  • pageSize: 每页返回的数据条数。

    "pageSize": 20
    
  • name: 需要查询的名字字段。

    "name": "map"
    
  • update_time: 时间范围,用于查询在指定时间范围内的数据。

    "update_time": ["2024-06-24 00:00:00", "2024-06-26 00:00:00"]
    
  • idType: 指定 id 字段的数据类型为 long。

    "idType": "long"
    
  • remarkOp: 对 remark 字段使用 ct(包含)操作符。

    "remarkOp": "ct"
    
  • orderBy: 排序字段,这里指定为 update_time。

    "orderBy": "update_time"
    
  • update_time_type: 指定 update_time 字段的类型为 string[]。

    "update_time_type": "string[]"
    
  • update_time_op: 对 update_time 字段使用 bt(之间)操作符。

    "update_time_op": "bt"
    
  • update_time_to_type: 将 update_time 字段转换为 ISO8601 格式。

    "update_time_to_type": "ISO8601"
    
  • isAsc: 指定排序为降序。

    "isAsc": "false"
    
  • deleted: 查询未删除的数据。

    "deleted": 0
    
  • json_fields: 指定需要以 JSON 对象形式返回的字段,这里是 files 字段。

    "json_fields": ["files"]
    
  • json_fields_type: 指定 json_fields 的数据类型为 string[]。

    "json_fields_type": "string[]"
    
  • nameOp: 对 name 字段使用 ct(包含)操作符。

    "nameOp": "ct"
    
  • departmentOp: 对 department 字段使用 ct(包含)操作符。

    "departmentOp": "ct"
    

输入解释总结

该输入定义了一次查询操作:

  • 分页参数: current 和 pageSize 用于分页。
  • 查询条件:
    • name 字段包含 "map"。
    • update_time 字段在 2024-06-24 至 2024-06-26 之间,并转换为 ISO8601 格式。
    • remark、name 和 department 字段的查询操作符为 ct(包含)。
  • 排序: 根据 update_time 字段降序排序。
  • 过滤: 过滤掉 deleted 为 0 的数据。
  • 字段选择: 指定 files 字段以 JSON 对象形式返回。

输出解释

该输出 JSON 表示查询的结果,包含查询数据的列表和元数据。以下是对每个字段的详细解释:

  • code: 状态码,表示查询结果的状态。1 表示成功。

    "code": 1
    
  • data: 包含查询结果的主要数据对象。

    • list: 查询结果的列表。

      "list": [
        {
          "id": "395190726650089472",
          ...
        }
      ]
      
      • id: 数据的唯一标识符。
      • 其他字段如 tenant_id、creator、create_time、description、url、updater、update_time、deleted、name 和 files。
    • total: 满足查询条件的总数据条数。

      "total": 1
      
  • ok: 操作是否成功,true 表示成功。

    "ok": true
    

输出解释总结

该输出表示:

  • 查询成功(code 为 1)。
  • 返回的数据列表中有一条数据。
  • 数据包含 tenant_id、creator、create_time、description、url、updater、update_time、deleted、name 和 files 字段。
  • files 字段以 JSON 对象形式返回,包含文件的详细信息。
  • total 表示满足查询条件的总记录数为 1。
  • 查询操作成功(ok 为 true)。

Edit this page
Last Updated:
Contributors: Tong Li
Prev
EasyExcel 导入
Next
ApiTable 实现增删改查