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 源码解析

腾讯云短信登录注册

  • 概述
  • 配置短信模板
  • 数据库设计
    • 字段说明
    • 平台字段与历史表迁移
  • 短信发送工具类
    • 引入依赖
    • 环境配置
    • 配置对象 TxSmsConfig
    • Service 层:SystemConfigService
    • 短信工具类:TencentSmsUtils
    • 单元测试:TencentSmsUtilsTest
    • 发送的数据格式
    • 发送成功返回信息
  • 接口实现
    • 枚举定义
    • Service 层:TencentSmsService
    • 测试类:TencentSmsServiceTest
    • 请求参数模型:SmsCodeSendVo
    • Controller 层:SmsController
  • 登录注册逻辑
    • 数据层:SysUserInfoDao
    • 参数模型:LoginVo
    • Service 层:AuthService
    • Controller 层:AuthController
  • 接口文档
    • 手机验证码登录注册
  • 总结

概述

本指南旨在详细介绍如何实现基于短信验证码的用户登录和注册功能。通过使用腾讯云短信服务,系统能够在用户成功登录后自动创建新用户。本文涵盖了从短信模板配置、数据库设计、短信发送工具类开发,到接口实现和验证逻辑的全流程,适用于 Java 开发环境。

配置短信模板

在开始实现短信登录功能之前,首先需要在腾讯云完成短信模板的配置。具体的配置过程请参考腾讯云官方文档,这里假设您已经完成了模板的配置。

数据库设计

为了存储和管理短信验证码信息,需要创建一个专门的数据库表 sys_sms_code。以下是表结构的详细设计:

-- ----------------------------
-- Table structure for sys_sms_code
-- ----------------------------
CREATE TABLE `sys_sms_code` (
  `id` bigint(20) PRIMARY KEY COMMENT '主键',
  `area_code` varchar(8) DEFAULT NULL COMMENT '国家代码',
  `platform` varchar(32) NOT NULL COMMENT '实际短信发送平台:tencent、aliyun等',
  `phone` varchar(16) NOT NULL COMMENT '手机号码',
  `code` varchar(8) NOT NULL COMMENT '验证码',
  `valid_seconds` int(10) unsigned NOT NULL COMMENT '有效时间(秒)',
  `code_type` int(11) NOT NULL COMMENT '验证类型',
  `ip` varchar(32) DEFAULT NULL COMMENT '用户IP地址',
  `remark` VARCHAR(256),
  `creator` VARCHAR(64) DEFAULT '',
  `create_time` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `updater` VARCHAR(64) DEFAULT '',
  `update_time` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `deleted` SMALLINT DEFAULT 0,
  `tenant_id` BIGINT NOT NULL DEFAULT 0
) COMMENT='短信验证码表';

字段说明

  • id: 唯一标识每条验证码记录。
  • area_code: 国家或地区代码,例如中国为 "86"。
  • platform: 后端实际使用的短信发送平台,例如 tencent、aliyun;不接受客户端任意指定。
  • phone: 用户的手机号码。
  • code: 发送的验证码。
  • valid_seconds: 验证码的有效时间,以秒为单位。
  • code_type: 验证码的类型,例如注册、登录等。
  • ip: 请求发送验证码的用户 IP 地址。
  • remark: 备注信息。
  • creator/updater: 创建者和更新者信息。
  • create_time/update_time: 记录的创建和更新时间。
  • deleted: 逻辑删除标识。
  • tenant_id: 租户 ID,用于多租户系统。

平台字段与历史表迁移

sys_sms_code 是通用短信验证码表,增加 platform 可以记录发送来源并隔离不同平台的验证码。它不是用户注册来源,也不是验证码用途:code_type 为 1 注册、2 登录、3 绑定或更换手机号、4 重置密码;verification_type=3 表示采用短信验证。

用户可能先后使用不同平台,不应把短信发送平台覆盖到用户的身份来源字段。如果以后需要记录第三方账号身份,使用独立的账号关联表记录身份平台及该平台用户 ID。

本文沿用 MySQL 表结构与 SQL。已有表由用户手动执行以下增量 SQL,程序启动不自动修改表:

ALTER TABLE sys_sms_code
  ADD COLUMN platform VARCHAR(32) NOT NULL DEFAULT 'unknown'
  COMMENT '实际短信发送平台:tencent、aliyun等';

旧记录无法确认来源时保留 unknown,不要批量假定为腾讯云。只有确认历史数据全部由腾讯云发送时,才手动将相应记录更新为 tencent。新发送记录必须显式写入真实平台;同步更新生成的 Model 或使用 set("platform", value)。新建表不设置平台默认值,以便尽早发现漏写。

校验应同时匹配记录 ID、租户、平台、手机号、用途和有效期;platform 不是唯一键。重发限流还应按手机号跨平台统计,避免切换平台绕过限流。验证码消费与账号修改应放在同一事务中,保证一次性使用。

短信发送工具类

为了实现短信的发送功能,我们需要开发一个工具类 TencentSmsUtils,该类封装了与腾讯云短信服务的交互逻辑。

引入依赖

首先,在项目的 pom.xml 中引入腾讯云短信服务的依赖:

<properties>
  <qcloudsms.version>3.1.270</qcloudsms.version>
</properties>
<dependencies>
  <dependency>
    <groupId>com.tencentcloudapi</groupId>
    <artifactId>tencentcloud-sdk-java</artifactId>
    <version>${qcloudsms.version}</version>
  </dependency>
</dependencies>

环境配置

腾讯云将访问凭据命名为 SecretId 和 SecretKey。密钥、应用 ID、签名、各用途模板 ID、区域和有效期均从 EnvUtils 读取,不再从业务配置表读取密钥,也不保留不使用的 appKey 字段。

在本地未提交的 .env 或部署环境中配置以下变量。空值需要替换为自己的配置,模板签名与参数顺序应与实际审核通过的模板一致。

SMS_PLATFORM=tencent
TENCENT_SMS_SECRET_ID=
TENCENT_SMS_SECRET_KEY=
TENCENT_SMS_APP_ID=
TENCENT_SMS_SIGN_NAME=
TENCENT_SMS_REGISTER_TEMPLATE_ID=
TENCENT_SMS_LOGIN_TEMPLATE_ID=
TENCENT_SMS_BIND_PHONE_TEMPLATE_ID=
TENCENT_SMS_RESET_PASSWORD_TEMPLATE_ID=
TENCENT_SMS_REGION=ap-guangzhou
TENCENT_SMS_ENDPOINT=sms.tencentcloudapi.com
SMS_CODE_VALID_SECONDS=300

框架启动时完成环境加载;独立测试在读取前调用 EnvUtils.load()。不要在日志中输出配置对象或密钥。以下腾讯云实现只接受 SMS_PLATFORM=tencent;切换为阿里云还需要对应发送适配器,不能只改平台名称。

配置对象 TxSmsConfig

package com.example.auth.app.model;

import lombok.Data;

@Data
public class TxSmsConfig {
    private String platform;
    private String secretId;
    private String secretKey;
    private String appId;
    private String templateId;
    private String smsSign;
    private Integer validSeconds;
}

Service 层:SystemConfigService

package com.example.auth.app.services.system;

import com.example.auth.app.model.TxSmsConfig;
import nexus.io.tio.utils.environment.EnvUtils;

public class SystemConfigService {
    public TxSmsConfig getLoginSmsConfig() {
        return getSmsConfig(2);
    }

    public TxSmsConfig getSmsConfig(int codeType) {
        String platform = EnvUtils.get("SMS_PLATFORM", "tencent");
        if (!"tencent".equals(platform)) {
            throw new IllegalArgumentException("Unsupported SMS platform for TencentSmsService");
        }
        String templateKey;
        switch (codeType) {
        case 1:
            templateKey = "TENCENT_SMS_REGISTER_TEMPLATE_ID";
            break;
        case 2:
            templateKey = "TENCENT_SMS_LOGIN_TEMPLATE_ID";
            break;
        case 3:
            templateKey = "TENCENT_SMS_BIND_PHONE_TEMPLATE_ID";
            break;
        case 4:
            templateKey = "TENCENT_SMS_RESET_PASSWORD_TEMPLATE_ID";
            break;
        default:
            throw new IllegalArgumentException("Unsupported SMS code type");
        }
        int validSeconds = EnvUtils.getInt("SMS_CODE_VALID_SECONDS", 300);
        if (validSeconds <= 0) {
            throw new IllegalArgumentException("SMS_CODE_VALID_SECONDS must be positive");
        }
        TxSmsConfig config = new TxSmsConfig();
        config.setPlatform(platform);
        config.setSecretId(required("TENCENT_SMS_SECRET_ID"));
        config.setSecretKey(required("TENCENT_SMS_SECRET_KEY"));
        config.setAppId(required("TENCENT_SMS_APP_ID"));
        config.setSmsSign(required("TENCENT_SMS_SIGN_NAME"));
        config.setTemplateId(required(templateKey));
        config.setValidSeconds(validSeconds);
        return config;
    }

    private String required(String key) {
        String value = EnvUtils.get(key);
        if (value == null || value.trim().isEmpty()) {
            throw new IllegalStateException("Missing configuration: " + key);
        }
        return value;
    }
}

短信工具类:TencentSmsUtils

负责与腾讯云短信服务的交互,包括发送短信的具体实现。

import com.example.auth.app.model.TxSmsConfig;
import nexus.io.tio.utils.json.JsonUtils;
import nexus.io.tio.utils.environment.EnvUtils;
import com.tencentcloudapi.common.Credential;
import com.tencentcloudapi.common.exception.TencentCloudSDKException;
import com.tencentcloudapi.common.profile.ClientProfile;
import com.tencentcloudapi.common.profile.HttpProfile;
import com.tencentcloudapi.sms.v20210111.SmsClient;
import com.tencentcloudapi.sms.v20210111.models.SendSmsRequest;
import com.tencentcloudapi.sms.v20210111.models.SendSmsResponse;

import lombok.extern.slf4j.Slf4j;

/**
 * 腾讯云短信服务工具类
 */
@Slf4j
public class TencentSmsUtils {
    /**
     * 发送短信
     *
     * @param sdkAppId      短信应用ID
     * @param secretId      腾讯云账户SecretId
     * @param secretKey     腾讯云账户SecretKey
     * @param signName      短信签名
     * @param templateId    短信模板ID
     * @param params        模板参数
     * @param phoneNumberSet 接收短信的手机号集合
     * @return SendSmsResponse 发送短信的响应
     */
    public static SendSmsResponse sendSMS(String sdkAppId, String secretId, String secretKey, String signName, String templateId,
                                         String[] params, String[] phoneNumberSet) {
        SmsClient client = buildSmsClient(secretId, secretKey);
        SendSmsRequest req = buildSmsRequest(sdkAppId, signName, templateId, params, phoneNumberSet);
        log.info("发送短信请求:{}", JsonUtils.toJson(req));
        try {
            SendSmsResponse res = client.SendSms(req);
            return res;
        } catch (TencentCloudSDKException e) {
            log.error("发送短信失败: {}", e.getMessage());
            throw new RuntimeException(e);
        }
    }

    /**
     * 构建短信请求对象
     */
    private static SendSmsRequest buildSmsRequest(String sdkAppId, String signName, String templateId, String[] params, String[] phoneNumberSet) {
        SendSmsRequest req = new SendSmsRequest();
        req.setSmsSdkAppId(sdkAppId);
        req.setSignName(signName);
        req.setSenderId("");
        req.setSessionContext("");
        req.setExtendCode("");
        req.setTemplateId(templateId);
        req.setPhoneNumberSet(phoneNumberSet);
        req.setTemplateParamSet(params);
        return req;
    }

    /**
     * 构建短信客户端
     */
    private static SmsClient buildSmsClient(String secretId, String secretKey) {
        Credential cred = new Credential(secretId, secretKey);
        HttpProfile httpProfile = new HttpProfile();
        httpProfile.setReqMethod("POST");
        httpProfile.setConnTimeout(60);
        httpProfile.setEndpoint(EnvUtils.get("TENCENT_SMS_ENDPOINT", "sms.tencentcloudapi.com"));

        ClientProfile clientProfile = new ClientProfile();
        clientProfile.setSignMethod("HmacSHA256");
        clientProfile.setHttpProfile(httpProfile);

        SmsClient client = new SmsClient(cred, EnvUtils.get("TENCENT_SMS_REGION", "ap-guangzhou"), clientProfile);
        return client;
    }

    /**
     * 批量发送短信
     */
    public static SendSmsResponse sendSmsBat(TxSmsConfig config, String[] phoneList, String[] params) {
        return sendSMS(config.getAppId(), config.getSecretId(), config.getSecretKey(),
                config.getSmsSign(), config.getTemplateId(), params, phoneList);
    }

    /**
     * 发送单条短信
     */
    public static SendSmsResponse sendSms(TxSmsConfig config, String areaCode, String phone, String code) {
        String[] phoneList = new String[]{areaCode + phone};
        String[] params = {code};
        return sendSMS(config.getAppId(), config.getSecretId(), config.getSecretKey(),
                config.getSmsSign(), config.getTemplateId(), params, phoneList);
    }
}

单元测试:TencentSmsUtilsTest

通过单元测试验证短信发送功能。

import org.junit.Test;

import com.example.auth.app.config.EnoteMysqlDbConfig;
import com.example.auth.app.model.TxSmsConfig;
import com.example.auth.app.services.system.SystemConfigService;
import com.example.auth.app.utils.TencentSmsUtils;
import nexus.io.jfinal.aop.Aop;
import nexus.io.tio.boot.tesing.TioBootTest;
import nexus.io.tio.utils.json.JsonUtils;
import nexus.io.tio.utils.environment.EnvUtils;
import com.tencentcloudapi.sms.v20210111.models.SendSmsResponse;

public class TencentSmsUtilsTest {

    @Test
    public void testSendSms() {
        TioBootTest.runWith(EnoteMysqlDbConfig.class);
        SystemConfigService systemConfigService = Aop.get(SystemConfigService.class);
        TxSmsConfig txSmsConfig = systemConfigService.getLoginSmsConfig();
        SendSmsResponse sendSms = TencentSmsUtils.sendSms(txSmsConfig, "86", "15836475191", "123456");
        System.out.println(JsonUtils.toJson(sendSms));
    }
}

发送的数据格式

发送短信时,数据格式如下:

{
  "templateId": "1339563",
  "phoneNumberSet": ["8615836475191"],
  "templateParamSet": ["123456"],
  "sessionContext": "enote",
  "smsSdkAppId": "1400646561",
  "extendCode": "",
  "signName": "牛加技术",
  "senderId": ""
}

发送成功返回信息

成功发送短信后,返回的信息格式如下:

{
  "sendStatusSet": [
    {
      "message": "send success",
      "code": "Ok",
      "sessionContext": "enote",
      "phoneNumber": "+8615836475191",
      "isoCode": "CN",
      "serialNo": "4412:45808295717294761577817519",
      "fee": "1"
    }
  ],
  "requestId": "fbac04a7-bc02-49e4-954c-8ce939103696"
}

接口实现

在实现短信发送功能时,需要考虑以下两个关键点:

  1. 防止重复发送:通过查询数据库中已存在的未过期的验证码记录,避免频繁发送短信。
  2. 生成验证码并存储数据库:生成随机验证码并将其存储至数据库,以便后续验证。

枚举定义

定义验证码类型和手机类型的枚举,便于代码中的类型管理和可读性。

SmsCodeType

import java.util.HashMap;
import java.util.Map;

public enum SmsCodeType {
    REGISTER(1, "注册"),
    LOGIN(2, "登录"),
    CHANGE_PHONE(3, "更换手机号码"),
    RESET_PWD(4, "重置登录密码");

    private Integer type;
    private String desc;

    SmsCodeType(Integer type, String desc) {
        this.type = type;
        this.desc = desc;
    }

    public Integer getType() {
        return type;
    }

    public String getDesc() {
        return desc;
    }

    public static String getDesc(int type) {
        for (SmsCodeType item : SmsCodeType.values()) {
            if (item.getType().equals(type)) {
                return item.getDesc();
            }
        }
        return "";
    }

    public static Map<Integer, String> getMap() {
        Map<Integer, String> map = new HashMap<>();
        for (SmsCodeType item : SmsCodeType.values()) {
            map.put(item.getType(), item.getDesc());
        }
        return map;
    }
}

PhoneType

package com.example.auth.app.enums;

public enum PhoneType {
    MAIN_LAND("86", "大陆手机号码"),
    HK("852", "香港手机号码");

    private String code;
    private String desc;

    PhoneType(String code, String desc) {
        this.code = code;
        this.desc = desc;
    }

    public String getCode() {
        return code;
    }

    public String getDesc() {
        return desc;
    }

    public static PhoneType getPhoneType(String areaCode) {
        if (areaCode != null && !areaCode.isEmpty()) {
            if (areaCode.equals("+852") || areaCode.equals("852")) {
                return HK;
            }
        }
        return MAIN_LAND;
    }
}

Service 层:TencentSmsService

负责处理短信发送的业务逻辑,包括防止重复发送和验证码生成。

import com.example.auth.app.db.model.SysSmsCode;
import com.example.auth.app.model.TxSmsConfig;
import com.example.auth.app.services.system.SystemConfigService;
import com.example.auth.app.utils.TencentSmsUtils;
import com.jfinal.kit.Kv;
import nexus.io.db.activerecord.Db;
import nexus.io.jfinal.aop.Aop;
import nexus.io.model.body.RespBodyVo;
import nexus.io.tio.utils.hutool.RandomUtils;
import nexus.io.tio.utils.snowflake.SnowflakeIdUtils;

public class TencentSmsService {

    /**
     * 发送短信验证码
     *
     * @param codeType 验证码类型
     * @param areaCode 国家代码
     * @param phone    手机号码
     * @param ip       用户IP地址
     * @return 响应结果
     */
    public RespBodyVo send(Integer codeType, String areaCode, String phone, String ip) {
        // 防止重复发送:检查是否存在未过期的验证码记录
        String sql = "SELECT 1 FROM sys_sms_code WHERE NOW() <= create_time + INTERVAL valid_seconds SECOND " +
                     "AND area_code=? AND phone=? AND tenant_id=0 AND deleted=0 LIMIT 1";
        boolean exists = Db.existsBySql(sql, areaCode, phone);
        if (exists) {
            return RespBodyVo.fail("请求过于频繁,请稍后再试。");
        }

        // 生成随机验证码
        int code = RandomUtils.nextInt(100000, 999999);

        // 获取短信配置信息
        SystemConfigService systemConfigService = Aop.get(SystemConfigService.class);
        TxSmsConfig loginSmsConfig = systemConfigService.getSmsConfig(codeType);

        // 发送短信
        TencentSmsUtils.sendSms(loginSmsConfig, areaCode, phone, String.valueOf(code));

        // 生成唯一ID并保存验证码记录
        long id = SnowflakeIdUtils.id();
        SysSmsCode sysSmsCode = new SysSmsCode();
        sysSmsCode.setId(id)
                  .setAreaCode(areaCode)
                  .setPhone(phone)
                  .setCode(String.valueOf(code))
                  .setIp(ip)
                  .setValidSeconds(Long.valueOf(loginSmsConfig.getValidSeconds()))
                  .setCodeType(codeType);

        sysSmsCode.set("platform", loginSmsConfig.getPlatform());
        boolean save = sysSmsCode.save();
        if (!save) {
            return RespBodyVo.fail("验证码保存失败,请稍后再试。");
        }

        return RespBodyVo.ok(Kv.by("id", id));
    }
}

测试类:TencentSmsServiceTest

通过测试类验证短信发送服务的正确性和防止重复发送的逻辑。

import org.junit.Test;

import com.example.auth.app.config.EnoteMysqlDbConfig;
import com.example.auth.app.enums.SmsCodeType;
import nexus.io.jfinal.aop.Aop;
import nexus.io.model.body.RespBodyVo;
import nexus.io.tio.boot.tesing.TioBootTest;

public class TencentSmsServiceTest {

    @Test
    public void testSendSms() {
        TioBootTest.runWith(EnoteMysqlDbConfig.class);
        TencentSmsService smsService = Aop.get(TencentSmsService.class);
        RespBodyVo response1 = smsService.send(SmsCodeType.LOGIN.getType(), "86", "15836475191", "192.168.1.2");
        System.out.println(response1);

        // 尝试重复发送,预期失败
        RespBodyVo response2 = smsService.send(SmsCodeType.LOGIN.getType(), "86", "15836475191", "192.168.1.2");
        System.out.println(response2);
    }
}

请求参数模型:SmsCodeSendVo

定义发送验证码接口的请求参数模型。

package com.example.auth.app.model;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;

@Data
@NoArgsConstructor
@AllArgsConstructor
@Accessors(chain = true)
public class SmsCodeSendVo {
    private Integer codeType; // 验证码类型: 1-注册, 2-登录, 3-更换手机号码, 4-重置登录密码
    private String areaCode;  // 国家或地区代码,如中国为 "86"
    private String phone;     // 手机号码
}

Controller 层:SmsController

处理前端发送验证码的请求。

import com.example.auth.app.enums.PhoneType;
import com.example.auth.app.model.SmsCodeSendVo;
import com.example.auth.app.services.sms.TencentSmsService;
import com.example.auth.app.utils.RegexUtil;
import nexus.io.annotation.EnableCORS;
import nexus.io.annotation.RequestPath;
import nexus.io.jfinal.aop.Aop;
import nexus.io.model.body.RespBodyVo;
import nexus.io.tio.boot.http.TioRequestContext;
import nexus.io.tio.http.common.utils.HttpIpUtils;

@RequestPath("/sms")
@EnableCORS
public class SmsController {

    private TencentSmsService smsService = Aop.get(TencentSmsService.class);

    /**
     * 发送验证码接口
     *
     * @param vo SmsCodeSendVo 请求参数
     * @return 响应结果
     */
    public RespBodyVo send(SmsCodeSendVo vo) {
        Integer codeType = vo.getCodeType();
        String areaCode = vo.getAreaCode();
        String phone = vo.getPhone();

        // 参数校验
        if (codeType == null) {
            return RespBodyVo.fail("验证码类型不能为空");
        }
        if (areaCode == null || areaCode.isEmpty()) {
            return RespBodyVo.fail("国家代码不能为空");
        }
        if (phone == null || phone.isEmpty()) {
            return RespBodyVo.fail("手机号码不能为空");
        }

        // 手机号格式校验(针对大陆号码)
        PhoneType phoneType = PhoneType.getPhoneType(areaCode);
        if (phoneType == PhoneType.MAIN_LAND && !RegexUtil.isMobileSimple(phone)) {
            return RespBodyVo.fail("手机号码格式不正确");
        }

        // 获取真实IP
        String realIp = HttpIpUtils.getRealIp(TioRequestContext.getRequest());

        // 发送验证码
        return smsService.send(codeType, areaCode, phone, realIp);
    }
}

登录注册逻辑

实现用户通过短信验证码进行登录或注册的业务逻辑。

数据层:SysUserInfoDao

负责用户信息的数据库操作,包括判断用户是否存在和保存新用户。

package com.example.auth.app.dao;

import com.example.auth.app.utils.UserIdUtils;
import nexus.io.db.activerecord.Db;
import nexus.io.db.activerecord.Row;

public class SysUserInfoDao {

    public static final String tableName = "sys_user_info";

    /**
     * 判断用户名是否存在
     *
     * @param username 用户名
     * @return 存在返回true,否则返回false
     */
    public boolean existsUsername(String username) {
        return Db.exists(tableName, "username", username);
    }

    /**
     * 通过手机号保存新用户信息
     *
     * @param areaCode 国家代码
     * @param phone    手机号码
     * @param username 用户名
     * @param nickName 昵称
     * @return 新用户的ID,保存失败返回null
     */
    public Long saveByPhone(String areaCode, String phone, String username, String nickName) {
        long userId = UserIdUtils.random();
        Row row = new Row();
        row.set("id", userId)
              .set("username", username)
              .set("area_code", areaCode)
              .set("phone", phone)
              .set("nick_name", nickName);
        boolean save = Db.save(tableName, row);
        return save ? userId : null;
    }
}

参数模型:LoginVo

定义提交验证码接口的请求参数模型。

package com.example.auth.app.model;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;

@Data
@NoArgsConstructor
@AllArgsConstructor
@Accessors(chain = true)
public class LoginVo {
    private Long id;         // 验证码ID
    private String areaCode; // 国家代码
    private String phone;    // 手机号码
    private Integer codeType;// 验证码类型
    private Integer code;    // 验证码
}

Service 层:AuthService

负责处理通过验证码进行登录或注册的业务逻辑。

import com.example.auth.app.dao.SysUserInfoDao;
import com.example.auth.app.model.LoginVo;
import com.jfinal.kit.Kv;
import nexus.io.db.activerecord.Db;
import nexus.io.db.activerecord.Row;
import nexus.io.jfinal.aop.Aop;
import nexus.io.model.body.RespBodyVo;
import nexus.io.tio.utils.hutool.RandomUtils;

import cn.dev33.satoken.stp.StpUtil;
import lombok.extern.slf4j.Slf4j;

@Slf4j
public class AuthService {

    /**
     * 通过用户名和密码登录
     *
     * @param username 用户名
     * @param password 密码
     * @return 登录结果
     */
    public TableResult<Kv> doLogin(String username, String password) {
        String sql = "SELECT id FROM sys_user_info WHERE username=? AND password=?";
        Long userId = Db.queryLong(sql, username, password);
        if (userId != null && userId > 0) {
            Kv kv = doLogin(userId);
            return TableResult.ok(kv);
        } else {
            return TableResult.fail("用户名或密码不正确");
        }
    }

    /**
     * 执行登录操作
     *
     * @param userId 用户ID
     * @return 登录结果
     */
    public Kv doLogin(Long userId) {
        StpUtil.login(userId);
        String tokenValue = StpUtil.getTokenValue();
        long tokenTimeout = StpUtil.getTokenTimeout();
        Kv kv = new Kv();
        kv.set("token", tokenValue);
        kv.set("tokenTimeout", tokenTimeout);
        Row row = Db.findById("sys_user_info", userId);
        kv.set(row.toMap());
        return kv;
    }

    /**
     * 通过验证码进行登录或注册
     *
     * @param vo LoginVo 请求参数
     * @return 响应结果
     */
    public RespBodyVo loginByPhone(LoginVo 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 != 1 && codeType != 2)) {
            return RespBodyVo.fail("验证码参数无效。");
        }
        String sqlCode = "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(sqlCode, id, "tencent", areaCode, phone, code, codeType)) {
            return RespBodyVo.fail("验证码无效或已过期。");
        }

        // 判断用户是否存在
        String sql = "SELECT id FROM sys_user_info WHERE area_code=? AND phone=? AND deleted=0";
        Long userId = Db.queryLong(sql, areaCode, phone);
        if (userId != null) {
            // 用户存在,执行登录
            Kv loginResult = this.doLogin(userId);
            return RespBodyVo.ok(loginResult);
        } else {
            // 用户不存在,自动注册新用户
            log.info("自动注册新用户:{}", phone);
            SysUserInfoDao sysUserInfoDao = Aop.get(SysUserInfoDao.class);
            userId = sysUserInfoDao.saveByPhone(areaCode, phone, phone, "User_" + RandomUtils.nextInt(1000, 9999));
            if (userId == null) {
                return RespBodyVo.fail("用户注册失败,请稍后再试。");
            }
            Kv loginResult = this.doLogin(userId);
            return RespBodyVo.ok(loginResult);
        }
    }
}

Controller 层:AuthController

处理用户通过验证码进行登录或注册的请求。

import com.example.auth.app.model.LoginVo;
import com.example.auth.app.services.auth.AuthService;
import nexus.io.jfinal.aop.Aop;
import nexus.io.model.body.RespBodyVo;
import nexus.io.annotation.EnableCORS;
import nexus.io.annotation.RequestPath;

@RequestPath("/auth")
@EnableCORS
public class AuthController {

    private AuthService authService = Aop.get(AuthService.class);

    /**
     * 通过验证码登录或注册
     *
     * @param vo LoginVo 请求参数
     * @return 响应结果
     */
    public RespBodyVo loginByPhone(LoginVo vo) {
        Long id = vo.getId();
        Integer code = vo.getCode();

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

        return authService.loginByPhone(vo);
    }
}

接口文档

手机验证码登录注册

本文档详细描述了发送验证码和提交验证码进行登录或注册的接口规范,帮助前端开发人员正确调用相关接口。


发送验证码接口

Endpoint:
POST /sms/send

请求参数:

{
  "codeType": 1, // 验证码类型: 1-注册, 2-登录, 3-更换手机号码, 4-重置登录密码
  "areaCode": "86", // 国家代码,如中国为 "86"
  "phone": "15836475191" // 手机号
}

参数说明:

  • codeType: 指定验证码的用途类型,具体如下:
    1. 注册
    2. 登录
    3. 更换手机号码
    4. 重置登录密码
  • areaCode: 国家或地区的代码,例如中国为 "86"。
  • phone: 用户的手机号码。

响应示例:

{
  "data": {
    "id": "437986347671658496" // 验证码ID,用于提交验证码时关联
  },
  "msg": null,
  "code": 1, // 1 表示成功
  "ok": true // 请求成功标识
}

响应参数说明:

  • data.id: 唯一的验证码 ID,后续验证时需要使用。
  • code: 状态码,1 表示成功,其他值表示失败。
  • ok: 请求是否成功的布尔标识。

提交验证码接口

Endpoint:
POST /auth/loginByPhone

请求参数:

{
  "id": "437986347671658496", // 验证码ID
  "code": 440263, // 发送到手机的验证码
  "phone": "15836475191", // 手机号
  "areaCode": "86", // 国家代码
  "codeType": 1 // 验证码类型: 1-注册, 2-登录, 3-更换手机号码, 4-重置登录密码
}

参数说明:

  • id: 发送验证码时返回的唯一验证码 ID。
  • code: 用户收到的验证码。
  • phone: 用户的手机号码。
  • areaCode: 国家或地区的代码,例如中国为 "86"。
  • codeType: 验证码的用途类型,与发送验证码时的类型保持一致。

逻辑说明:
loginByPhone 接口会根据手机号码判断用户是否存在,若不存在,则自动创建新用户。不设置永久有效的测试验证码,测试时使用隔离的短信发送适配器和真实的验证码校验流程。

响应示例:

{
  "data": {
    "tenant_id": "0",
    "wx_user_info": null,
    "remark": null,
    "locale": null,
    "config_info": null,
    "updater": "",
    "header_pic_id": null,
    "password": null,
    "update_time": 1729589458000,
    "id": "52317188646659035", // 用户ID
    "app_id": null,
    "email": null,
    "creator": "",
    "create_time": 1729589458000,
    "area_code": "86",
    "sex": null,
    "user_from": null,
    "tokenTimeout": "2592000", // Token 有效期(秒)
    "facebook_user_info": null,
    "wx_open_id": null,
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJsb2dpblR5cGUiOiJsb2dpbiIsImxvZ2luSWQiOjUyMzE3MTg4NjQ2NjU5MDM1LCJyblN0ciI6ImNRSWRlWG4yUGQwT2h5NkRZUzRnb2kxbWlkQ2ZQb01sIn0.Rc2ieAAIt6JchEVRp_tQ22MtAye3Gh20sg_3ooAFkPg", // 登录 Token
    "facebook_id": null,
    "deleted": 0,
    "user_channel": null,
    "phone": null,
    "v": 0,
    "nick_name": "User_3990", // 用户昵称
    "name": null,
    "user_level": null,
    "username": "15836475191", // 用户名(手机号)
    "status": 0
  },
  "code": 1, // 1 表示成功
  "msg": null,
  "ok": true // 请求成功标识
}

响应参数说明:

  • data: 包含用户信息和登录 Token。
    • id: 用户唯一 ID。
    • token: 登录后的 Token,用于后续的认证。
    • tokenTimeout: Token 的有效期,单位为秒。
    • username: 用户名,即手机号码。
    • nick_name: 用户昵称。
    • 其他字段为用户的相关信息,可根据需要进行扩展。
  • code: 状态码,1 表示成功,其他值表示失败。
  • ok: 请求是否成功的布尔标识。

总结

通过本指南,您已经了解了如何使用腾讯云短信服务实现基于短信验证码的用户登录和注册功能。整个流程包括短信模板配置、数据库设计、短信发送工具类开发、业务逻辑实现以及接口文档编写。确保各个环节正确配置和实现,可以有效提升用户体验和系统的安全性。

在实际应用中,建议根据具体需求进一步优化和扩展功能,例如增加验证码的复杂度、实现多语言支持、加强安全性措施等。

Edit this page
Last Updated: 10/1/26, 4:55 AM
Contributors: litongjava
Prev
邮箱重置密码
Next
腾讯云短信重置密码