Tio Boot DocsTio Boot Docs
Home
文档导航
  • java-db
  • api-table
  • jooq
  • mysql
  • postgresql
  • oceanbase
  • Enjoy
  • Tio Boot Admin
  • java-openai
  • ai_agent
  • knowlege_base
  • voice-agent
  • ai-search
  • ai-coding
  • ai-browser
  • 案例
Abount
AI 检索
  • Github
  • Gitee
Home
文档导航
  • java-db
  • api-table
  • jooq
  • mysql
  • postgresql
  • oceanbase
  • Enjoy
  • Tio Boot Admin
  • java-openai
  • ai_agent
  • knowlege_base
  • voice-agent
  • ai-search
  • ai-coding
  • ai-browser
  • 案例
Abount
AI 检索
  • Github
  • Gitee
  • 入门

    • 01 · 入门

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

    • 02 · 部署

      • 02_deployment
      • 使用 Maven Profile 实现分环境打包 tio-boot 项目
      • Maven 项目配置详解:依赖与 Profiles 配置
      • tio-boot 打包成 FatJar
      • 使用 GraalVM 构建 tio-boot Native 程序
      • 使用 Docker 部署 tio-boot
      • 部署到 Fly.io
      • 部署到 AWS Lambda
      • 到阿里云云函数
      • 使用 Deploy 工具部署
      • 使用Systemctl启动项目
      • 使用 Jenkins 部署 Tio-Boot 项目
      • 使用 Nginx 反向代理 Tio-Boot
      • 使用 Supervisor 管理 Java 应用
      • 历史部署页与替代方案
      • 胖包与瘦包的打包与部署
    • 03 · 日志

      • 日志
      • tio-boot 整合 Logback
  • 核心开发

    • 04 · 配置

      • 04_configuration
      • 配置参数
      • 服务器监听器
      • 内置缓存系统 AbsCache
      • 使用 Redis 作为内部 Cache
      • 静态文件处理器
      • 基于域名的静态资源隔离
      • DecodeExceptionHandler
      • 开启虚拟线程(Virtual Thread)
      • 框架级错误通知
    • 05 · JSON

      • 05_json
      • Json
      • 接受 JSON 和响应 JSON
      • 响应实体类
    • 06 · Web 开发

      • Web 开发
      • 路由与参数

        • 概述
        • 添加 Controller
        • handler入门
        • Handler 的请求方法与错误响应
        • 接收请求参数
        • 接收日期参数
        • 接收数组参数
        • HttpRequest
      • 响应与文件

        • 返回字符串
        • 返回文本数据
        • 返回网页
        • 请求和响应字节
        • 文件上传
        • 文件下载
        • 返回视频文件并支持断点续传
        • HttpResponse
        • Resps
        • RespBodyVo
        • 动态 返回 CSS 实现
        • 返回图片
        • 返回 multipart
        • 使用零拷贝发送大文件
        • 分片上传
        • WebJars
      • 会话与请求控制

        • http Session
        • Cookie
        • 重定向和转发
        • Controller拦截器
        • 请求拦截器
        • LoggingInterceptor
        • 全局异常处理器
        • 跨域
        • 自定义 Handler 转发请求
        • 使用 HttpForwardHandler 转发所有请求
        • HTTP Basic 认证
        • Http响应加密
      • 异步与流式输出

        • 异步处理
        • Transfer-Encoding: chunked 实时音频播放
        • Server-Sent Events (SSE)
      • 工具与监控

        • 常用工具类
        • 接口访问统计
        • 接口请求和响应数据记录
        • JProtobuf
        • 测速
        • Gzip Bomb:使用压缩炸弹防御恶意爬虫
    • 07 · 参数校验

      • 07_validation
      • 数据紧校验规范
      • 参数校验
    • 08 · WebSocket 应用开发

      • 08_websocket
      • 使用 tio-boot 搭建 WebSocket 服务
      • WebSocket 聊天室项目示例
    • 09 · AOP

      • 09_aop
      • JFinal-aop
      • Aop 工具类
      • 配置
      • 独立使用 JFinal Aop
      • @AImport
      • 自定义注解拦截器
      • 原理解析
    • 10 · 国际化

      • 10_i18n
      • i18n
    • 11 · Enjoy 模板

      • 11_enjoy
      • tio-boot 整合 Enjoy 模版引擎文档
      • Tio-Boot 整合 Java-DB 与 Enjoy 模板引擎示例
      • 引擎配置
      • 表达式
      • 指令
      • 注释
      • 原样输出
      • Shared Method 扩展
      • Shared Object 扩展
      • Extension Method 扩展
      • Spring boot 整合
      • 独立使用 Enjoy
      • tio-boot enjoy 自定义指令 localeDate
      • PromptEngine
      • Enjoy 入门示例-擎渲染大模型请求体
      • Tio Boot + Enjoy:分页与 SEO 实战指南
      • TioBoot + Enjoy 生成 robots.txt 与 sitemap.xml:实战与SEO指南
      • Enjoy 使用示例
    • 12 · 定时任务

      • 12_scheduling
      • Quartz 定时任务集成指南
      • 分布式定时任务 xxl-jb
      • cron4j 使用指南
    • 13 · 测试

      • 13_testing
      • TioBootTest:环境与 AOP 初始化
      • 真实 HTTP 集成测试
      • 数据库集成测试与隔离
    • 14 · tio-utils

      • 14_tio-utils
      • tio-utils
      • EnvUtils 配置工具
      • Notification
      • Email
      • JSON
      • File
      • Base64
      • 上传和下载
      • Http
      • Telegram
      • RsaUtils
      • HttpUtils
      • ByteBufferUtils
      • 系统监控
      • 线程
      • 虚拟线程
      • 毫秒并发 ID (MCID) 生成方案
  • 数据库与数据访问

    • 15 · java-db

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

      • 16_api-table
      • ApiTable 概述
      • 使用 ApiTable 连接 SQLite
      • 使用 ApiTable 连接 Mysql
      • 使用 ApiTable 连接 Postgres
      • 使用 ApiTable 连接 TDEngine
      • 使用 api-table 连接 oracle
      • 使用 api-table 连接 mysql and tdengine 多数据源
      • EasyExcel 导出
      • EasyExcel 导入
      • ApiTable 的权限与业务边界
      • ApiTable 联调与故障定位
      • ApiTable 实现增删改查
      • 数组类型
      • 单独使用 ApiTable
      • TQL(Table SQL)前端输入规范
    • 17 · MyBatis

      • 17_mybatis
      • Tio-Boot 整合 MyBatis
      • 使用配置类方式整合 MyBatis
      • 整合数据源
      • 使用 mybatis-plus 整合 tdengine
      • 整合 mybatis-plus
    • 18 · jOOQ

      • 18_jooq
      • 使用配置类方式整合 jOOQ
      • tio-boot + jOOQ 事务管理
      • 批量操作与性能优化
      • 整合agroal
      • 代码生成与类型安全
      • 基于 Record / POJO 增删改查
      • UPSERT、批量更新、返回主键与高级 SQL
      • 的多表关联查询、DTO 投影、聚合统计与视图封装
      • 的窗口函数、CTE、JSON 查询与 PostgreSQL 高级 SQL 实战
      • tio-boot + jOOQ 的审计字段、乐观锁、数据权限与企业级 Repository 设计
      • 测试策略、SQL 日志、性能诊断与生产排障
      • 多租户、读写分离与多数据源设计
      • 代码生成治理、数据库迁移与团队协作规范实战
    • 19 · PostgreSQL

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

      • 20_mysql
      • 使用 Docker 运行 MySQL
      • 常见问题
    • 21 · OceanBase

      • 21_oceanbase
      • 快速体验 OceanBase 社区版
      • 快速上手 OceanBase 数据库单机部署与管理
      • 诊断集群性能
      • 优化 SQL 性能指南
      • 待定
    • 22 · Oracle

      • 22_oracle
      • Oracle
    • 23 · SQL Server

      • 23_sqlserver
      • SQL Server
    • 24 · SQLite

      • 24_sqlite
      • SQLite
    • 25 · MongoDB

      • 25_mongodb
      • tio-boot 使用 mongo-java-driver 操作 mongodb
    • 26 · Elasticsearch

      • 26_elasticsearch
      • Elasticsearch
      • JavaDB 整合 ElasticSearch
      • Elastic 工具类使用指南
      • Elastic-search 注意事项
      • ES 课程示例文档
  • 缓存与消息队列

    • 27 · Cache

      • 27_cache
      • Caffeine
      • CacheUtils 工具类
      • 使用 java-db 整合 ehcache
    • 28 · Redis

      • 28_redis
      • 使用 Docker 安装 Redis
      • 使用 java-db 整合 Redis
      • Java DB Redis 相关 Api
      • redis 使用示例
      • 和 RedisTemplate 协作
      • 使用 Jedis 连接池接入 Redis
      • hutool RedisDS
      • Redisson
      • Caffeine 与 Redis 两级缓存
      • 使用 CacheUtils 整合 caffeine 和 redis 实现的两级缓存
    • 29 · 消息队列

      • 29_mq
      • Mica-mqtt
      • EMQX
      • Disruptor
    • 30 · Kafka

      • 30_kafka
      • Kafka
      • AWS MSK
  • 认证与账号体系

    • 31 · 认证与权限

      • 31_authentication
      • FixedTokenInterceptor
      • TokenManager
      • 数据表
      • 匿名登录
      • 个人中心
      • 权限校验注解
      • Sa-Token
      • sa-token 登录注册
      • StpUtil.isLogin() 源码解析
    • 32 · 第三方登录注册

      • 32_third-party-auth
      • 邮箱登录和注册
      • 邮箱重置密码
      • 腾讯云短信登录注册
      • 腾讯云短信重置密码
      • 阿里云短信登录和注册
      • 阿里云短信重置密码
      • 微信登录与绑定手机号
      • 支付宝登录与绑定手机号
      • 微信小程序手机号快捷登录
      • Google登录
      • 阿里云邮件推送验证邮箱
  • 网络通信

    • 33 · AIO

      • 33_aio
      • ByteBuffer
      • AIO HTTP 服务器
      • 自定义和线程池和池化 ByteBuffer
      • AioHttpServer 应用示例 IP 属地查询
      • 手写 AIO Http 服务器
      • Java 21 中的虚拟线程与 AIO
    • 34 · t-io

      • 34_tio
      • 认识 t-io

        • t-io 核心优势与应用价值
        • t-io 消息处理流程
      • 快速上手

        • TioBootServer
        • 独立端口启动 TCP 服务器
        • 内置 TCP 处理器
        • 独立启动 UDPServer
        • 使用内置 UDPServer
      • 核心概念

        • TioConfig
        • ChannelContext
        • Packet
        • Tio 工具类
      • 消息与文件传输

        • 发送数据
        • HTTP 长连接与高效文件传输
        • 使用 AsynchronousSocketChannel 响应数据
      • 连接管理

        • 业务数据绑定
        • 业务数据解绑
        • 关闭连接
        • 资源共享
        • 成员排序
        • 拉黑 IP
      • 加密通信

        • SSL
        • Https建立连接过程
      • 心跳与监控

        • 监控: 心跳
        • 监控: 客户端的流量数据
        • 监控: 单条 TCP 连接的流量数据
        • 监控: 端口的流量数据
        • 单条通道统计: ChannelStat
        • 所有通道统计: GroupStat
      • 深入原理

        • tio-运行原理详解
        • DecodeRunnable
        • t-io 稳定性设计与资源管理
        • 深入解析 Tio 源码:构建高性能 Java 网络应用
        • HTTP、WebSocket 与 TCP 的缓冲区复用
    • 35 · tio-http-server

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

      • 36_tio-websocket
      • WebSocket 服务器
      • WebSocket Client
      • TCP数据转发
    • 37 · Netty

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

      • 38_netty-boot
      • Netty-Boot
      • 原理解析
      • 整合 Hot Reload
      • 整合 数据库
      • 整合 Redis
      • 整合 Elasticsearch
      • 整合 Dubbo
      • Listener
      • 文件上传
      • 拦截器
      • Spring Boot 整合 Netty-Boot
      • SSL 配置指南
      • ChannelInitializer
      • Reserve
  • 集成与扩展

    • 39 · 第三方集成

      • 39_integrations
      • 整合 okhttp
      • 整合 GrpahQL
      • 集成 Mailjet
      • 整合 ip2region
      • 整合 GeoLite 离线库
      • 整合 Lark 机器人指南
      • 集成 Lark Mail 实现邮件发送
      • Thymeleaf
      • Swagger
      • Clerk 验证
      • 集成datadog
    • 40 · Magic Script

      • 40_magic-script
      • tio-boot 与 magic-script 集成指南
    • 41 · Groovy

      • 41_groovy
      • tio-boot 整合 Groovy
      • 调试常用脚本
    • 42 · 爬虫

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

      • 43_dubbo
      • 概述
      • dubbo 2.6.0
      • dubbo 2.6.0 调用过程
      • dubbo 3.2.0
    • 44 · Spring

      • 44_spring
      • Spring Boot Web 整合 Tio Boot
      • spring-boot-starter-webflux 整合 tio-boot
      • tio-boot 整合 spring-boot-starter
      • Tio Boot 整合 Spring Boot Starter db
      • Tio Boot 整合 Spring Boot Starter Data Redis 指南
    • 45 · Spring Cloud

      • 45_spring-cloud
      • tio-boot spring-cloud
    • 46 · Quarkus

      • 46_quarkus
      • Quarkus(无 HTTP)整合 tio-boot(有 HTTP)
      • tio-boot + Quarkus + Hibernate ORM Panache
      • tio-boot + Quarkus + Hibernate ORM Panache + jOOQ 整合方案
    • 47 · Telegram4J

      • 47_telegram4j
      • 数据库设计
      • 基于 HTTP 协议开发 Telegram 翻译机器人
      • 基于 MTProto 协议开发 Telegram 翻译机器人
      • 过滤旧消息
      • 保存机器人消息
      • 定时推送
      • 增加命令菜单
      • 使用 telegram-Client
      • 使用自定义 StoreLayout
      • 延迟测试
      • Reactor 错误处理
      • Telegram4J 常见错误处理指南
      • 处理回调查询
      • Reactor
      • 文档翻译
      • 使用 Tio-Boot 整合 tdlight
      • tio-boot 整合 TelegramBots
      • tio-boot 整合 Telegram-Bot-Utils
      • Telegram-Bot-Utils 使用指南
    • 48 · Telegram Bots

      • 48_telegram-bots
      • TelegramBots 入门指南
      • 使用工具库 telegram-bot-base 开发翻译机器人
    • 49 · 文件存储

      • 49_file-storage
      • 文件上传数据表
      • 本地存储
      • 存储到 亚马逊 S3
      • 存储到 Cloudflare R2
      • 存储到 腾讯 COS
      • 上传文件到阿里云 OSS
    • 50 · 支付

      • 支付集成
      • 微信小程序支付:普通支付
      • 微信支付:Native 扫码支付(PC 网页扫码)
      • 支付宝:电脑网站支付接入指南
  • Firebase 与 Clerk

    • 51 · Firebase

      • 51_firebase
      • 整合 google firebase
      • Firebase Storage
      • Firebase Authentication
      • 使用 Firebase Admin SDK 进行匿名用户管理与自定义状态标记
      • 导出用户
      • 登录注册
      • 注册回调
    • 52 · Clerk

      • 52_clerk
      • Clerk
  • 多媒体

    • 53 · 音视频处理

      • 53_media
      • JAVE 提取视频中的声音
      • Jave 提取视频中的图片
      • 待定
    • 54 · 语音识别

      • 54_asr
      • Whisper-JNI
    • 55 · 语音合成

      • 55_tts
    • 56 · 文字识别

      • 56_ocr
    • 57 · Native Media

      • 57_native-media
      • java-native-media
      • JNI 入门示例
      • mp3 拆分
      • mp4 转 mp3
      • 使用 libmp3lame 实现高质量 MP3 编码
      • Linux 编译
      • macOS 编译
      • 从 JAR 包中加载本地库文件
      • 支持的音频和视频格式
      • 任意格式转为 mp3
      • 通用格式转换
      • 通用格式拆分
      • 视频合并
      • VideoToHLS
      • split_video_to_hls 支持其他语言
      • 持久化 HLS 会话
      • 获取视频长度
      • 保存视频的最后一帧
      • 添加水印
      • linux版本
    • 58 · 计算机视觉

      • 58_computer-vision
      • 使用 Java 运行 YOLOv8 ONNX 模型进行目标检测
      • tio-boot整合yolo
      • ONNX Runtime 推理说明
      • Paddle Structure
      • tio-boot 整合 Paddle Structure
      • tio-boot整合Paddle Structure 提取图片
      • U2Net 图片去背景原理
      • tio-boot 整合 U2Net 实现图片去背景
  • AI 开发

    • 59 · java-openai

      • 59_java-openai
      • 简介
      • 流式生成
      • 图片多模态输入
      • Google Gemini接入
      • google Vertex AI 接入
      • Perplexity API
      • WhisperClient 语音识别
      • SupadataClient 获取视频字幕
      • GiteeClient 文档解析与图片 OCR
      • DeepSeekClient 官方模型查询
      • BailianTTSClient 语音合成
    • 60 · AI Agent

      • 60_ai-agent
      • 数据库设计
      • 示例问题管理
      • 会话管理
      • 历史记录
      • 意图识别
      • 智能问答
      • 文件上传与解析文档
      • 翻译
      • 名人搜索功能实现
      • Ai studio gemini youbue 问答使用说明
      • 自建 YouTube 字幕问答系统
      • 自建 获取 youtube 字幕服务
      • 使用 OpenAI ASR 实现语音识别接口(Java 后端示例)
      • 定向搜索
      • 16
      • 17
      • 18
      • 在 tio-boot 应用中整合 ai-agent
      • 接口文档
      • 自定义 ChatAskService
      • 请求记录
      • 限流和错误处理
      • 增强检索(RAG)
      • 结构化数据检索
      • AI 问答
      • 连接代码执行器
      • 待定
      • 模型编程能力评测
      • 音频会话 SDP 示例
    • 61 · 知识库

      • 61_knowledge-base
      • 学术论文
      • 数据库设计
      • 用户登录实现
      • 模型管理
      • 知识库管理
      • 文档拆分
      • 片段向量
      • 命中测试
      • 文档管理
      • 片段管理
      • 问题管理
      • 应用管理
      • 向量检索
      • 推理问答
      • 问答模块
      • 统计分析
      • 用户管理
      • api 管理
      • 存储文件到 S3
      • 文档解析优化
      • 片段汇总
      • 段落分块与检索
      • 多文档解析
      • 对话日志
      • 检索性能优化
      • Milvus
      • 文档解析方案和费用对比
      • 豫自然资办发〔2021〕18号文档解析实测
      • 离线运行向量模型
      • 爬取网页数据
    • 62 · AI 搜索

      • 62_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 部署
      • 爬取一个静态网站的所有数据
      • 网页数据预处理
      • 网页数据检索与问答流程整合
    • 63 · 语音 Agent

      • 63_voice-agent
      • 整合Gemini realtime模型
      • Voice Agent 前端接入接口文档
      • 整合千问realtime模型
      • 打断支持
      • 主动介入
      • eleven labs
      • 基于 tio-boot + ElevenLabs 构建实时语音 Agent(支持打断与主动介入)
    • 64 · AI Coding

      • 64_ai-coding
      • Cline 提示词
      • Cline 提示词-中文版本
    • 65 · AI Browser

      • deepseek-browser-use:从入门到源码
      • deepseek-browser-use:概念与学习路线
      • 安装、启动与健康检查
      • 第一个任务:打开页面、读取结果与关闭
      • 客户端:dsb 命令行、Python 与 PowerShell
      • 统一命令接口与人机协作
      • 浏览器、profile 与登录态
      • 窗口尺寸与页面视口
      • 接入智能体:观察、执行与验证
      • 表单与多层弹窗排障:防止重复提交
      • 调用追踪、页面留档与文件上传
      • 站点配方、技能与异步作业
      • Windows OCR:本地图片与页面文字识别
      • 配置项与运维自省
      • 命令清单
      • 源码教程:从 HTTP 请求到命令执行
      • DOM 原理:前端如何生成可交互快照
      • DOM 原理:Java 模型与跨 Frame 索引
      • 正文提取与上层结构化处理
      • 源码教程:生命周期、导航与页签
      • 源码教程:DOM、页面状态与元素读取
      • 源码教程:点击、输入、键盘与鼠标
      • 源码教程:等待条件与 JavaScript 执行
      • 源码教程:文件上传、截图、PDF 与 OCR
      • 源码教程:Cookie、存储与页面设置
      • 源码教程:网络记录、请求拦截与控制台
      • 源码教程:原生对话框、DOM 弹窗与人机协作
      • 源码教程:批量、配方、后台作业与维护
      • 源码教程:Chrome 走 CDP 与 CDP 客户端
      • 请求响应关联与线程约束
  • 项目实战

    • 66 · java-uni-ai-server

      • 66_java-uni-ai-server
      • 语音合成系统
      • Fish.audio TTS 接口说明文档与 Java 客户端封装
      • 整合 fishaudio 到 java-uni-ai-server 项目
      • 待定
    • 67 · java-llm-proxy

      • 67_java-llm-proxy
      • 使用tio-boot搭建多模型LLM代理服务
    • 68 · java-kit-server

      • 68_java-kit-server
      • Java 执行 python 代码
      • 通过大模型执行 Python 代码
      • 执行 Python (Manim) 代码
      • 待定
      • 待定
      • 待定
      • 视频下载增加水印说明文档
    • 69 · tio-im

      • 69_tio-im
      • 通讯协议文档
      • ChatPacket.proto 文档
      • java protobuf
      • 数据表设计
      • 创建工程
      • 登录
      • 历史消息
      • 发消息
    • 70 · tio-mail-wing

      • 70_tio-mail-wing
      • tio-mail-wing简介
      • 任务1:实现POP3系统
      • 使用 getmail 验证 tio-mail-wing POP3 服务
      • 任务2:实现 SMTP 服务
      • 数据库初始化文档
      • 用户管理
      • 邮件管理
      • 任务3:实现 SMTP 服务 数据库版本
      • 任务4:实现 POP3 服务(数据库版本)
      • IMAP 协议
      • 拉取多封邮件
      • 任务5:实现 IMAP 服务(数据库版本)
      • IMAP实现讲解
      • IMAP 手动测试脚本
      • IMAP 认证机制
      • 主动推送
      • namesapce
      • CONDSTORE and QRESYNC
    • 71 · tio-mcp-server

      • 71_tio-mcp-server
      • 实现 MCP Server 开发指南
      • MCP 协议
      • /zh/71_tio-mcp-server/11.html
    • 72 · tio-log-server

      • 72_tio-log-server
      • 简介
      • 收集 docker 日志
      • 入库
    • 73 · tio-sip

      • 73_tio-sip
      • SIP Server 第一版原理说明
      • SIP Server 第一版实战
      • 一、Windows 平台测试
      • SIP Server 第二版实战
      • SIP Server 第三版实战
      • 性能优化
      • 基于 MediaProcessor 对接 Realtime 模型说明
      • 对接大语言模型
      • 支持 G722 宽带语音
      • G722编码和解码
      • 会话级采样率转换
      • 增加 9196 回声测试分机
      • 语音系统链路说明
      • 一、Gemini Realtime 的打断机制
    • 74 · tio-boot-admin

      • 74_tio-boot-admin
      • 入门指南:使用框架内置配置
      • 手动初始化数据库
      • 配置职责、生效条件与扩展边界
      • 整合数据库
      • 与前端集成
      • 文件上传
      • 网络请求
      • 单图片管理(只读模式)
      • 多图片管理
      • 布尔值管理
      • 字段联动
      • Word 管理
      • PDF 管理
      • 文章管理
      • 富文本编辑器
      • 整合 Enjoy 模版引擎
      • 历史可选方案:Token 存储与 Sa-Token
      • 业务 API 与 H5 / 小程序联调
      • 方法路由与业务鉴权
      • 整合 Redis
      • 整合 Elasticsearch
      • 后端开发规范:tio-boot、java-db 与 Kv
      • 多表实现文件数据存储
    • 75 · 案例

      • 75_examples
      • 封装 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 命令
      • /zh/75_examples/11.html
      • /zh/75_examples/12.html
      • /zh/75_examples/13.html
  • 性能、原理与源码

    • 76 · 性能测试

      • 76_performance
      • 压力测试 - tio-http-serer
      • 压力测试 - tio-boot
      • 压力测试 - tio-boot-native
      • 压力测试 - netty-boot
      • 性能测试对比
      • TechEmpower FrameworkBenchmarks
      • 压力测试 - tio-boot 12 C 32G
      • HTTP/1.1 Pipelining 性能测试报告
      • tio-boot vs Quarkus 性能对比测试报告
    • 77 · 原理

      • 77_internals
      • 生命周期
      • 请求处理流程
      • 重要的类
    • 78 · 源码解析

      • 78_source-code
      • 源码阅读入口
      • Swagger 整合到 Tio-Boot 中的指南
      • 启动与关闭生命周期
      • HTTP 请求分发与路由优先级
      • 高性能网络编程中的 ByteBuffer 分配与回收策略
      • TioBootServerHandler 源码解析

腾讯云短信重置密码

  • 环境配置与平台字段
  • 重置密码流程概述
  • API 接口详解
    • /sms/send 发送短信验证码
    • /user/bindPhone 绑定手机号
    • /user/resetPassword 重置密码
  • 实现细节
    • 接口层实现
    • 业务层实现
  • 注意事项与最佳实践
  • 结语

环境配置与平台字段

配置读取方式如下;完整服务还会检查必填项和有效期,避免空配置进入发送流程:

import nexus.io.tio.utils.environment.EnvUtils;

String secretId = EnvUtils.get("TENCENT_SMS_SECRET_ID");
String secretKey = EnvUtils.get("TENCENT_SMS_SECRET_KEY");
String appId = EnvUtils.get("TENCENT_SMS_APP_ID");
String signName = EnvUtils.get("TENCENT_SMS_SIGN_NAME");
String resetTemplateId = EnvUtils.get("TENCENT_SMS_RESET_PASSWORD_TEMPLATE_ID");
int validSeconds = EnvUtils.getInt("SMS_CODE_VALID_SECONDS", 300);

重置密码使用 TENCENT_SMS_RESET_PASSWORD_TEMPLATE_ID,绑定手机号使用 TENCENT_SMS_BIND_PHONE_TEMPLATE_ID;应用 ID、签名、区域、接口地址和有效期也由 EnvUtils 读取。发送服务按用途获取配置:

SystemConfigService configService = Aop.get(SystemConfigService.class);
TxSmsConfig resetConfig = configService.getSmsConfig(4);
TxSmsConfig bindConfig = configService.getSmsConfig(3);

配置缺失应在发送前报错,不使用示例密钥或固定验证码兜底。独立测试先调用 EnvUtils.load();应用启动已加载时不必重复加载。

验证码表 sys_sms_code 增加 platform VARCHAR(32),用于记录实际发送平台。本章发送与校验均使用后端确定的 tencent,不让请求参数决定平台。新增建表与历史表增量 SQL 见平台字段与历史表迁移,需手动执行。

platform 记录短信发送服务商;code_type 记录用途;verification_type 记录验证方式。三个概念分开。用户表不需要因为切换短信服务商而增加或修改身份来源字段。

下面的 id 是 /sms/send 返回的验证码记录 ID,不是用户 ID。绑定手机号的目标用户来自登录上下文,密码找回的目标用户根据已经验证的手机号查询。示例固定租户为 0,多租户应用需要从可信上下文取得租户并统一用于发送、校验与用户查询。

重置密码流程概述

在用户需要重置密码之前,系统要求用户先绑定手机号。未绑定手机号的用户无法进行密码重置操作。整个重置密码的流程如下:

  1. 发送短信验证码:
    • 调用 /sms/send 接口,向用户的手机发送短信验证码。
  2. 绑定手机号:
    • 调用 /user/bindPhone 接口,将用户的手机号与账号进行绑定。
  3. 重置密码:
    • 调用 /user/resetPassword 接口,使用短信验证码验证后,允许用户重置密码。

API 接口详解

/sms/send 发送短信验证码

说明:发送短信验证码的具体实现参见腾讯云短信登录注册。绑定手机号发送 codeType=3,重置密码发送 codeType=4,后端按用途选择不同模板。


/user/bindPhone 绑定手机号

功能:将用户的手机号与其账号进行绑定,以便后续的密码重置操作。

请求方式:POST

请求路径:/user/bindPhone

请求参数:

参数名类型必须描述
idLong是短信验证码记录 ID
codeInt是短信验证码
phoneString是用户的手机号
areaCodeString是手机号的国家/地区码(如 86)
codeTypeInt是验证码类型(绑定手机号为 3)

示例请求数据:

{
  "id": "439252701422661632",
  "code": 265546,
  "phone": "19957680449",
  "areaCode": "86",
  "codeType": 3
}

/user/resetPassword 重置密码

功能:在验证短信验证码后,允许用户重置其账户密码。

请求方式:POST

请求路径:/user/resetPassword

请求参数:

参数名类型必须描述
idLong是短信验证码记录 ID
codeInt是短信验证码
phoneString是用户的手机号
areaCodeString是手机号的国家/地区码(如 86)
codeTypeInt是验证码类型(重置密码为 4)
newPasswordString是用户的新密码(需符合密码策略)

示例请求数据:

{
  "id": "439257704450449408",
  "code": 793131,
  "phone": "19957680449",
  "areaCode": "86",
  "codeType": 4,
  "newPassword": "123456"
}

实现细节

本节将详细介绍实现 /user/bindPhone 和 /user/resetPassword 接口的代码实现,包括控制层和业务层。

接口层实现

文件路径:com.example.auth.app.controller.UserController.java

package com.example.auth.app.controller;

import com.example.auth.app.model.PhoneLoginVo;
import com.example.auth.app.services.UserService;
import com.jfinal.kit.Kv;
import nexus.io.annotation.Inject;
import nexus.io.annotation.RequestPath;
import nexus.io.model.body.RespBodyVo;

import cn.dev33.satoken.stp.StpUtil;

@RequestPath("/user")
public class UserController {

  @Inject
  private UserService userService;

  /**
   * 绑定手机号接口
   * @param vo 包含绑定信息的 VO 对象
   * @return 响应结果
   */
  public RespBodyVo bindPhone(PhoneLoginVo vo) {
    Object userId = StpUtil.getLoginId();
    Long id = vo.getId();
    Integer code = vo.getCode();

    // 参数校验
    if (id == null) {
      return RespBodyVo.fail("验证码记录ID不能为空");
    }

    if (code == null) {
      return RespBodyVo.fail("验证码不能为空");
    }

    return userService.bindPhone(vo, userId);
  }

  /**
   * 重置密码接口
   * @param vo 包含重置信息的 VO 对象
   * @return 响应结果
   */
  public RespBodyVo resetPassword(PhoneLoginVo vo) {
    Long id = vo.getId();
    Integer code = vo.getCode();

    // 参数校验
    if (id == null) {
      return RespBodyVo.fail("验证码记录ID不能为空");
    }

    if (code == null) {
      return RespBodyVo.fail("验证码不能为空");
    }

    return userService.resetPassword(vo);
  }
}

说明:

  • @RequestPath("/user"):标识此控制器处理以 /user 开头的请求路径。
  • bindPhone 方法:
    • 获取当前登录用户的 userId。
    • 校验必要参数是否存在。
    • 调用业务层的 bindPhone 方法处理绑定逻辑。
  • resetPassword 方法:
    • 校验必要参数是否存在。
    • 调用业务层的 resetPassword 方法处理密码重置逻辑。

业务层实现

文件路径:com.example.auth.app.services.UserService.java

package com.example.auth.app.services;

import com.example.auth.app.dao.SysUserInfoDao;
import com.example.auth.app.model.PhoneLoginVo;
import com.jfinal.kit.Kv;
import nexus.io.db.activerecord.Db;
import nexus.io.jfinal.aop.Aop;
import nexus.io.model.body.RespBodyVo;

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class UserService {

  /**
   * 绑定手机号
   * @param vo 包含绑定信息的 VO 对象
   * @param userId 当前用户的ID
   * @return 响应结果
   */
  public RespBodyVo bindPhone(PhoneLoginVo vo, Object userId) {
    Long id = vo.getId();
    Integer code = vo.getCode();
    String areaCode = vo.getAreaCode();
    String phone = vo.getPhone();
    Integer codeType = vo.getCodeType();

    // 用途由接口固定,不能使用其他用途的验证码。
    if (id == null || code == null || codeType == null || codeType != 3) {
      return RespBodyVo.fail("验证码参数无效。");
    }
    String codeSql = "SELECT 1 FROM sys_sms_code WHERE id=? AND tenant_id=0 AND platform=? "
        + "AND area_code=? AND phone=? AND code=? AND code_type=? AND deleted=0 "
        + "AND TIMESTAMPDIFF(SECOND, create_time, NOW()) BETWEEN 0 AND valid_seconds LIMIT 1";
    if (!Db.existsBySql(codeSql, id, "tencent", areaCode, phone, code, 3)) {
      return RespBodyVo.fail("验证码无效或已过期。");
    }

    // 判断用户是否存在
    if (userId == null) {
      return RespBodyVo.fail("未找到用户,请先登录。手机号:" + phone);
    }

    SysUserInfoDao sysUserInfoDao = Aop.get(SysUserInfoDao.class);

    // 更新用户的手机号
    boolean ok = sysUserInfoDao.updatePhoneByUserId(userId, areaCode, phone);
    if (ok) {
      return RespBodyVo.ok("手机号绑定成功。");
    } else {
      return RespBodyVo.fail("手机号绑定失败,请稍后重试。");
    }
  }

  /**
   * 重置密码
   * @param vo 包含重置信息的 VO 对象
   * @return 响应结果
   */
  public RespBodyVo resetPassword(PhoneLoginVo vo) {
    Long id = vo.getId();
    Integer code = vo.getCode();
    String areaCode = vo.getAreaCode();
    String phone = vo.getPhone();
    Integer codeType = vo.getCodeType();

    // 用途由接口固定,不能使用其他用途的验证码。
    if (id == null || code == null || codeType == null || codeType != 4) {
      return RespBodyVo.fail("验证码参数无效。");
    }
    String codeSql = "SELECT 1 FROM sys_sms_code WHERE id=? AND tenant_id=0 AND platform=? "
        + "AND area_code=? AND phone=? AND code=? AND code_type=? AND deleted=0 "
        + "AND TIMESTAMPDIFF(SECOND, create_time, NOW()) BETWEEN 0 AND valid_seconds LIMIT 1";
    if (!Db.existsBySql(codeSql, id, "tencent", areaCode, phone, code, 4)) {
      return RespBodyVo.fail("验证码无效或已过期。");
    }

    // 查询用户是否存在
    String sql = "SELECT id FROM sys_user_info WHERE tenant_id=0 AND area_code=? AND phone=? AND deleted=0";
    Long userId = Db.queryLong(sql, areaCode, phone);
    if (userId == null) {
      return RespBodyVo.fail("未找到用户,请先注册。手机号:" + phone);
    }

    SysUserInfoDao sysUserInfoDao = Aop.get(SysUserInfoDao.class);

    log.info("正在为用户重置密码:{}, {}", vo.getAreaCode(), vo.getPhone());

    // 更新用户密码
    boolean ok = sysUserInfoDao.updatePasswordById(userId, vo.getNewPassword());
    if (ok) {
      return RespBodyVo.ok("密码重置成功。");
    } else {
      return RespBodyVo.fail("密码重置失败,请稍后重试。");
    }
  }
}

说明:

  • bindPhone 方法:

    • 验证短信验证码的有效性:
      • 查询 sys_sms_code 表,确保验证码存在且未过期。
      • 同时匹配平台、租户及固定用途,不设置万能验证码。
    • 验证用户是否已登录(userId 不为 null)。
    • 调用 SysUserInfoDao 更新用户的手机号。
  • resetPassword 方法:

    • 验证短信验证码的有效性,与绑定手机号类似。
    • 查询用户是否存在于 sys_user_info 表中。
    • 调用 SysUserInfoDao 更新用户的密码。
  • 日志记录:

    • 在重置密码过程中,记录相关操作日志,便于后续审计和问题排查。

注意事项与最佳实践

  1. 安全性:

    • 验证码验证:确保验证码的生成和验证过程安全,防止暴力破解和重放攻击。
    • 密码策略:新密码应符合安全策略,如最小长度、包含字母和数字等,防止弱密码。
    • 数据传输:所有敏感数据(如验证码、新密码)应通过 HTTPS 进行传输,确保数据在传输过程中不被窃取。
    • 错误信息:避免泄露过多错误信息,尤其是与安全相关的详细信息,以防信息泄露。
  2. 验证码管理:

    • 有效期:验证码应有明确的有效期(如 5 分钟),超过有效期后自动失效。
    • 验证码类型:使用 codeType 参数区分不同场景下的验证码,避免混淆。
    • 频率限制:限制用户请求验证码的频率,防止短信轰炸和滥用。
  3. 日志记录:

    • 记录关键操作日志,如验证码发送、绑定手机号、密码重置等,便于后续审计和问题排查。
    • 注意日志中不应记录敏感信息,如密码明文。
  4. 用户体验:

    • 提示信息:提供清晰、友好的提示信息,引导用户完成操作。
    • 错误处理:在验证码失效或输入错误时,给予明确的错误提示,并引导用户重新获取验证码。
    • 输入校验:前端应对用户输入进行初步校验,如手机号格式、密码强度等,提升用户体验并减少服务器压力。
  5. 数据一致性:

    • 在绑定手机号和重置密码过程中,将验证码核验、一次性消费和账号修改放入同一事务,并锁定验证码记录,避免并发重复使用。上方业务示例展示字段匹配,尚未展开事务消费实现;不能直接当作完整生产实现。
  6. 依赖管理:

    • 确保相关依赖(如 SysUserInfoDao、Db)的正确配置和初始化,避免运行时错误。

结语

通过本指南,您可以实现用户密码重置功能,包括发送短信验证码、绑定手机号以及重置密码的完整流程。确保在实际应用中遵循安全性和用户体验的最佳实践,以提升系统的安全性和用户满意度。如在实现过程中遇到问题,建议参考相关技术文档或在技术社区寻求帮助。

Edit this page
Last Updated: 10/1/26, 4:55 AM
Contributors: litongjava
Prev
腾讯云短信登录注册
Next
阿里云短信登录和注册