Tio Boot DocsTio Boot Docs
Home
  • java-db
  • api-table
  • jooq
  • mysql
  • postgresql
  • oceanbase
  • Enjoy
  • Tio Boot Admin
  • LLM
  • voice-agent
  • knowlege_base
  • ai_agent
  • ai-search
  • 案例
Abount
AI 检索
  • Github
  • Gitee
Home
  • java-db
  • api-table
  • jooq
  • mysql
  • postgresql
  • oceanbase
  • Enjoy
  • Tio Boot Admin
  • LLM
  • voice-agent
  • knowlege_base
  • ai_agent
  • ai-search
  • 案例
Abount
AI 检索
  • Github
  • Gitee
  • 01_tio-boot 简介

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

    • 02_部署
    • 使用 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_配置

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

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

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

    • 06_web
    • 概述
    • 接收请求参数
    • 接收日期参数
    • 接收数组参数
    • 返回字符串
    • 返回文本数据
    • 返回网页
    • 请求和响应字节
    • 文件上传
    • 文件下载
    • 返回视频文件并支持断点续传
    • http Session
    • Cookie
    • 重定向和转发
    • HttpRequest
    • HttpResponse
    • Resps
    • RespBodyVo
    • Controller拦截器
    • 请求拦截器
    • LoggingInterceptor
    • 全局异常处理器
    • 异步处理
    • 动态 返回 CSS 实现
    • 返回图片
    • 跨域
    • 添加 Controller
    • Transfer-Encoding: chunked 实时音频播放
    • Server-Sent Events (SSE)
    • handler入门
    • 返回 multipart
    • Handler 的请求方法与错误响应
    • 自定义 Handler 转发请求
    • 使用 HttpForwardHandler 转发所有请求
    • 常用工具类
    • HTTP Basic 认证
    • Http响应加密
    • 使用零拷贝发送大文件
    • 分片上传
    • 接口访问统计
    • 接口请求和响应数据记录
    • WebJars
    • JProtobuf
    • 测速
    • Gzip Bomb:使用压缩炸弹防御恶意爬虫
  • 07_validate

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

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

    • 09_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 业务实践
  • 10_api-table

    • 10_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)前端输入规范
  • 11_aop

    • 11_aop
    • JFinal-aop
    • Aop 工具类
    • 配置
    • 独立使用 JFinal Aop
    • @AImport
    • 自定义注解拦截器
    • 原理解析
  • 12_cache

    • 12_cache
    • Caffeine
    • CacheUtils 工具类
    • 使用 java-db 整合 ehcache
  • 13_认证和权限

    • 13_认证
    • FixedTokenInterceptor
    • TokenManager
    • 数据表
    • 匿名登录
    • 个人中心
    • 权限校验注解
    • Sa-Token
    • sa-token 登录注册
    • StpUtil.isLogin() 源码解析
  • 14_i18n

    • 14_i18n
    • i18n
  • 15_enjoy

    • 15_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 使用示例
  • 16_定时任务

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

    • 17_tests
    • TioBootTest:环境与 AOP 初始化
    • 真实 HTTP 集成测试
    • 数据库集成测试与隔离
  • 18_mybatis

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

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

    • 20_mongodb
    • tio-boot 使用 mongo-java-driver 操作 mongodb
  • 21_elastic-search

    • 21_elastic-search
    • Elasticsearch
    • JavaDB 整合 ElasticSearch
    • Elastic 工具类使用指南
    • Elastic-search 注意事项
    • ES 课程示例文档
  • 22_mq

    • 22_mq
    • Mica-mqtt
    • EMQX
    • Disruptor
  • 23_kafka

    • 23_kafka
    • Kafka
    • AWS MSK
  • 24_postgresql

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

    • 25_mysql
    • 使用 Docker 运行 MySQL
    • 常见问题
  • 26_oceanbase

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

    • 27_oracle
    • Oracle
  • 28_sqlserver

    • 28_sqlserver
    • SQL Server
  • 29_sqlite

    • 29_sqlite
    • SQLite
  • 30_integration_thirty_party

    • 30_integration_thirty_party
    • 整合 okhttp
    • 整合 GrpahQL
    • 集成 Mailjet
    • 整合 ip2region
    • 整合 GeoLite 离线库
    • 整合 Lark 机器人指南
    • 集成 Lark Mail 实现邮件发送
    • Thymeleaf
    • Swagger
    • Clerk 验证
    • 集成datadog
  • 31_tio

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

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

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

    • 34_tio-websocket
    • WebSocket 服务器
    • WebSocket Client
    • TCP数据转发
  • 35_magic-script

    • 35_magic-script
    • tio-boot 与 magic-script 集成指南
  • 36_groovy

    • 36_groovy
    • tio-boot 整合 Groovy
    • 调试常用脚本
  • 37_spider

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

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

    • 39_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 指南
  • 40_spring-cloud

    • 40_spring-cloud
    • tio-boot spring-cloud
  • 41_aio

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

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

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

    • 44_quarkus
    • Quarkus(无 HTTP)整合 tio-boot(有 HTTP)
    • tio-boot + Quarkus + Hibernate ORM Panache
    • tio-boot + Quarkus + Hibernate ORM Panache + jOOQ 整合方案
  • 45_jooq

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

    • 46_media
    • JAVE 提取视频中的声音
    • Jave 提取视频中的图片
    • 待定
  • 47_asr

    • 47_asr
    • Whisper-JNI
  • 48_tts

    • 48_tts
  • 49_ocr

    • 49_ocr
  • 50_native-media

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

    • 51_cv
    • 使用 Java 运行 YOLOv8 ONNX 模型进行目标检测
    • tio-boot整合yolo
    • ONNX Runtime 推理说明
    • Paddle Structure
    • tio-boot 整合 Paddle Structure
    • tio-boot整合Paddle Structure 提取图片
    • U2Net 图片去背景原理
    • tio-boot 整合 U2Net 实现图片去背景
  • 52_telegram4j

    • 52_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 使用指南
  • 53_telegram-bots

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

    • 54_LLM
    • 简介
    • 流式生成
    • 图片多模态输入
    • Google Gemini接入
    • google Vertex AI 接入
    • 请求记录
    • 限流和错误处理
    • 增强检索(RAG)
    • 结构化数据检索
    • AI 问答
    • 连接代码执行器
    • 待定
    • 模型编程能力评测
    • /zh/54_LLM/17.html
  • 55_voice-agent

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

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

    • 57_ai_agent
    • 数据库设计
    • 示例问题管理
    • 会话管理
    • 历史记录
    • Perplexity API
    • 意图识别
    • 智能问答
    • 文件上传与解析文档
    • 翻译
    • 名人搜索功能实现
    • Ai studio gemini youbue 问答使用说明
    • 自建 YouTube 字幕问答系统
    • 自建 获取 youtube 字幕服务
    • 使用 OpenAI ASR 实现语音识别接口(Java 后端示例)
    • 定向搜索
    • 16
    • 17
    • 18
    • 在 tio-boot 应用中整合 ai-agent
    • 接口文档
    • 自定义 ChatAskService
  • 58_ai-search

    • 58_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 部署
    • 爬取一个静态网站的所有数据
    • 网页数据预处理
    • 网页数据检索与问答流程整合
  • 59_ai-coding

    • 59_ai-coding
    • Cline 提示词
    • Cline 提示词-中文版本
  • 60_java-uni-ai-server

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

    • 61_java-llm-proxy
    • 使用tio-boot搭建多模型LLM代理服务
  • 62_java-kit-server

    • 62_java-kit-server
    • Java 执行 python 代码
    • 通过大模型执行 Python 代码
    • 执行 Python (Manim) 代码
    • 待定
    • 待定
    • 待定
    • 视频下载增加水印说明文档
  • 63_ai-brower

    • 63_ai-brower
    • AI Browser:基于用户指令的浏览器自动化系统
    • 提示词
    • dom构建- buildDomTree.js
    • dom构建- 将网页可点击元素提取与可视化
    • 提取网内容
    • 启动浏览器
    • 操作浏览器指令
    • 统一命令接口与人机协作
  • 64_文件存储

    • 64_文件存储
    • 文件上传数据表
    • 本地存储
    • 存储到 亚马逊 S3
    • 存储到 Cloudflare R2
    • 存储到 腾讯 COS
    • 上传文件到阿里云 OSS
  • 65_tio-boot-admin

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

    • 66_第三方登录注册
    • 邮箱登录和注册
    • 邮箱重置密码
    • 腾讯云短信登录注册
    • 腾讯云短信重置密码
    • 阿里云短信登录和注册
    • 阿里云短信重置密码
    • 微信登录与绑定手机号
    • 支付宝登录与绑定手机号
    • 微信小程序手机号快捷登录
    • Google登录
    • 阿里云邮件推送验证邮箱
  • 67_pay

    • 支付集成
    • 微信小程序支付:普通支付
    • 微信支付:Native 扫码支付(PC 网页扫码)
  • 68_firebase

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

    • 69_clerk
    • Clerk
  • 70_tio-im

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

    • 71_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
  • 72_tio-mcp-server

    • 72_tio-mcp-server
    • 实现 MCP Server 开发指南
    • MCP 协议
    • /zh/72_tio-mcp-server/11.html
  • 73_tio-sip

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

    • 74_tio-log-server
    • 简介
    • 收集 docker 日志
    • 入库
  • 75_性能测试

    • 75_性能测试
    • 压力测试 - 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 性能对比测试报告
  • 76_tio-boot

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

    • 77_案例
    • 封装 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/77_%E6%A1%88%E4%BE%8B/11.html
    • /zh/77_%E6%A1%88%E4%BE%8B/12.html
    • /zh/77_%E6%A1%88%E4%BE%8B/13.html

阿里云邮件推送验证邮箱

  • 1. 控制台准备
    • 1.1 创建发信域名
    • 1.2 创建发信地址
    • 1.3 控制台发信与限额
  • 2. 配置与依赖
  • 3. SMTP 方式发送
  • 4. SDK / OpenAPI 方式发送
  • 5. 与注册流程对接
    • 5.1 SMTP 能发不代表 API 能发
  • 6. 常见错误与排查
  • 7. 上线检查清单

本章用阿里云邮件推送(DirectMail)完成邮箱验证的发信环节,覆盖控制台准备、SMTP 与 SDK(OpenAPI)两种发送方式,以及和注册流程的对接点。

验证方式取值见验证类型:verification_type=1 发验证码邮件,2 发验证链接邮件。这两种都是"把验证信息发给用户",发送成功不代表邮箱已验证,只有后端核验通过才能更新验证状态,核验与奖励发放见邮箱登录和注册。

本章所有域名、记录值、账号与密钥均为脱敏示例,实际值以控制台生成的为准。密钥不得写进仓库、前端、接口响应或日志。

1. 控制台准备

控制台入口:https://dm.console.aliyun.com/。账号需完成实名认证。

1.1 创建发信域名

建议用子域名(例如 notice.example.com),不要直接用主域 example.com:验证码邮件的信誉与将来的营销邮件、通知邮件互相隔离,一方退信多不会把另一方拖进垃圾箱。

添加发信域名后,控制台会给出需要到 DNS 服务商处添加的记录,通常是四类:

1)DKIM 验证(所有权与防伪造)

类型主机记录主域名记录值(示例,控制台会给出完整公钥)
TXTaliyun-cn-hangzhou._domainkey.noticeexample.comv=DKIM1; k=rsa; p=<控制台生成的公钥>

DKIM 用于证明邮件确实由该域名发出,有助于防止域名被伪造、降低被判为垃圾邮件的概率。

2)SPF 验证

类型主机记录主域名记录值
TXTnoticeexample.comv=spf1 include:spf1.dm.aliyun.com -all

如果该域名已有 SPF 记录,不要新增第二条 TXT,而是把 include:spf1.dm.aliyun.com 合并进已有的那条 SPF 值里。一个域名只能有一条 SPF 记录。

3)DMARC 验证

类型主机记录主域名记录值
TXT_dmarc.noticeexample.comv=DMARC1;p=none;rua=mailto:[email protected]

DMARC 让收信方知道"收到伪造该域名的邮件时该怎么处理",p=none 表示先只上报、不拦截,适合刚接入时观察。

4)MX 验证(收信配置)

类型主机记录主域名记录值
MXnoticeexample.commx01.dm.aliyun.com

这条记录要保持存在,否则会影响发信(控制台提示无法发信时优先检查它)。

DNS 记录添加后回到控制台点验证;各地 DNS 生效时间不一致,通常几分钟到几十分钟。

1.2 创建发信地址

在邮件推送控制台选择刚创建的发信域名,新建发信地址:

  • 账号:noreply(按需改成其它前缀)
  • 密码:自己设置,这就是发信地址的 SMTP 密码,与阿里云账号密码无关

创建后得到一个完整发信地址,例如 [email protected],它同时是后面两种发送方式的身份:

  • SMTP 方式:用户名 = 发信地址全称,密码 = 这里设置的 SMTP 密码;
  • SDK/API 方式:作为接口参数 AccountName,不使用 SMTP 密码,改用 AccessKey 鉴权。

1.3 控制台发信与限额

控制台、SMTP、API 三种入口发送的都是同一套信誉与额度:

  • 批量营销邮件走控制台或 BatchSendMail(需要已审核的模板与收件人列表);
  • 单条触发邮件(验证码、验证链接)走 SMTP 或 SingleSendMail;
  • 新账号有信誉等级限制每日发信量,靠低退信率逐级提额,正式放量前先自测。

2. 配置与依赖

配置集中放在部署环境的配置文件或不提交的 .env 中:

# 发送方式:aliyun 走 SMTP,aliyun-sdk 走 OpenAPI(本章两种都可用)
MAIL_PROVIDER=aliyun
# SMTP 方式
MAIL_HOST=smtpdm.aliyun.com
MAIL_PORT=465
MAIL_ACCOUNT=[email protected]
MAIL_PASSWORD=
MAIL_FROM_ALIAS=Example App
# SDK / API 方式
ALIBABA_CLOUD_ACCESS_KEY_ID=
ALIBABA_CLOUD_ACCESS_KEY_SECRET=
MAIL_DM_ENDPOINT=dm.aliyuncs.com
MAIL_DM_REGION=cn-hangzhou

读取配置用 EnvUtils.getStr(...),密钥不要用 System.getenv 散落在业务代码里。独立程序在读取前调用 EnvUtils.load();框架启动时已加载环境,不需要重复调用。

依赖坐标(版本以官方文档为准,下面不写死版本号):

<!-- SDK / API 方式:阿里云 OpenAPI 核心 SDK,用 CommonRequest 调用邮件推送接口 -->
<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>aliyun-java-sdk-core</artifactId>
  <version>以官方文档为准</version>
</dependency>

<!-- SMTP 方式:JavaMail -->
<dependency>
  <groupId>com.sun.mail</groupId>
  <artifactId>javax.mail</artifactId>
  <version>以官方文档为准</version>
</dependency>

如果改用邮件推送的产品 SDK(alibabacloud-dm20151123),依赖以 SDK 文档给出的坐标与版本为准;它内部基于网关异步调用,用法与下面的 CommonRequest 不同。

3. SMTP 方式发送

[email protected] 建好后即可用 SMTP 发信。要点:

  • 服务器 smtpdm.aliyun.com;
  • 端口 465 走隐式 SSL(推荐),587 走 STARTTLS,25 常被云厂商封禁;
  • 用户名是发信地址全称,密码是控制台为这个地址设置的 SMTP 密码;
  • From 用发信地址本身,不要用裸的 no-reply 之类没有域名的值。
Properties props = new Properties();
props.setProperty("mail.transport.protocol", "smtp");
props.setProperty("mail.smtp.host", EnvUtils.getStr("MAIL_HOST"));
props.setProperty("mail.smtp.port", EnvUtils.getStr("MAIL_PORT"));
props.setProperty("mail.smtp.auth", "true");
props.setProperty("mail.smtp.ssl.enable", "true");        // 465 走 SSL;587 改成 starttls.enable
props.setProperty("mail.smtp.connectiontimeout", "5000"); // 发信不能长时间阻塞请求线程
props.setProperty("mail.smtp.timeout", "10000");
props.setProperty("mail.smtp.writetimeout", "10000");

String account = EnvUtils.getStr("MAIL_ACCOUNT");
String password = EnvUtils.getStr("MAIL_PASSWORD");

Session session = Session.getInstance(props, new Authenticator() {
  @Override
  protected PasswordAuthentication getPasswordAuthentication() {
    return new PasswordAuthentication(account, password);
  }
});

MimeMessage message = new MimeMessage(session);
message.setFrom(new InternetAddress(account, EnvUtils.getStr("MAIL_FROM_ALIAS"), "UTF-8"));
message.setRecipient(Message.RecipientType.TO, new InternetAddress(to));
message.setSubject(subject, "UTF-8");
message.setContent(html, "text/html; charset=UTF-8");
Transport.send(message);

SMTP 方式的优点是配置直观、不需要 AccessKey;缺点是拿不到 RequestId,排障时只能依赖 SMTP 返回码,也更容易被"账号迁移"这类问题掩盖(见 5.1 的说明)。

4. SDK / OpenAPI 方式发送

邮件推送的 OpenAPI 版本是 2015-11-23,单条发信接口是 SingleSendMail,域名 dm.aliyuncs.com。单次请求最多 100 个收件地址,验证码场景一次发一个即可。

官方 SDK 提供两种调用方式:产品 SDK 与 CommonRequest(泛化调用)。用 CommonRequest 不需要额外引入产品 SDK,且是同步调用,适合放在现有 EmailSender 实现里:

CommonRequest request = new CommonRequest();
request.setSysMethod(MethodType.POST);
request.setSysProtocol(ProtocolType.HTTPS);
request.setSysDomain("dm.aliyuncs.com");
request.setSysVersion("2015-11-23");
request.setSysAction("SingleSendMail");
request.setSysConnectTimeout(5000);
request.setSysReadTimeout(10000);
// 参数放在 Body 提交,必须声明 Body 格式,否则 SDK 直接抛 "Content type may not be null"
request.setHttpContentType(FormatType.FORM);

request.putBodyParameter("AccountName", "[email protected]"); // 发信地址
request.putBodyParameter("AddressType", "1");                          // 1 使用发信地址发信
request.putBodyParameter("ReplyToAddress", "false");                   // 是否需要回信地址
request.putBodyParameter("ToAddress", to);                             // 多个收件人用逗号分隔,最多 100 个
request.putBodyParameter("Subject", subject);
request.putBodyParameter("HtmlBody", html);
request.putBodyParameter("FromAlias", "Example App");                  // 收件人看到的发信人昵称
// 可选:邮件标签,配了才能在控制台按标签查看发信统计
request.putBodyParameter("TagName", "verify-code");

IAcsClient client = new DefaultAcsClient(DefaultProfile.getProfile("cn-hangzhou", accessKeyId, accessKeySecret));
CommonResponse response = client.getCommonResponse(request);
if (response.getHttpStatus() != 200) {
  throw new IllegalStateException("send mail failed, body:" + response.getData());
}

三个容易踩的点:

  1. 必须设置 Body 格式(FormatType.FORM),否则还没发出请求就会抛 Content type may not be null;
  2. 参数走 Body 而不是查询串:验证码邮件的 HTML 正文可能很长,放 URL 里容易被长度限制拦截;
  3. 鉴权用 AccessKey,不是发信地址的 SMTP 密码。官方也支持用环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID / ALIBABA_CLOUD_ACCESS_KEY_SECRET 提供,代码从环境变量读取,不要硬编码。

排障时把接口返回的错误码原样带进异常信息:

} catch (ClientException e) {
  // 例:code:InvalidMailAddress.NotFound, msg:The specified mail address is not found., requestId:xxxx
  throw new IllegalStateException("send mail failed, code:" + e.getErrCode() + ", msg:" + e.getErrMsg()
      + ", requestId:" + e.getRequestId(), e);
}

5. 与注册流程对接

框架的发信入口是 EmailSender 接口,注册与重置密码流程会自动调用它,实现类需要在启动时注册到 TioBootServer:

public class AliyunDmEmailSender implements EmailSender {

  @Override
  public boolean send(String to, String subject, String content) {
    // 普通通知邮件,SMTP 或 SDK 任选一种实现
  }

  @Override
  public boolean sendVerificationCodeEmail(String to, String origin, String code) {
    // verification_type=1:把 6 位验证码填进模板后发送
  }

  @Override
  public boolean sendVerificationEmail(String to, String origin, String code) {
    // verification_type=2:把 origin + "/verification/email?email=..&code=.." 拼成链接后发送
  }
}
// 启动配置里注册,否则框架取不到发信实现
TioBootServer.me().setEmailSender(new AliyunDmEmailSender());

模板渲染、验证码记录表、核验接口与重发限制见邮箱登录和注册;那章第 8 节讲的是框架侧的 EmailSender 与模板,本章讲的是"用阿里云把信真正发出去"。

几个业务上的要点:

  • 发送成功不等于验证完成:只有核验通过才更新 app_users.email_verified 之类的验证状态;
  • 别把敏感动作放在注册成功时:注册即可发放的奖励、邀请返利等,建议延后到邮箱验证通过后再发放,否则可以用不存在或不属于自己的邮箱批量注册刷奖励;
  • 重发限流:发信接口通常是免登录放行的,按邮箱做重发间隔(例如 60 秒)与每日上限,避免被刷验证码邮件;
  • 验证码有效期:签发时写入过期时间,核验时同时判断"未使用 + 未过期"。

5.1 SMTP 能发不代表 API 能发

两条通道的鉴权维度不同:

  • SMTP 只认"发信地址 + SMTP 密码",地址配好就能发;
  • OpenAPI 是按 AccessKey 所属账号隔离配置的。

所以用 A 账号的发信地址配 SMTP、却用 B 账号的 AccessKey 调 API,会出现"SMTP 正常、API 报发信地址不存在/用户不存在"的现象。AccessKey 必须来自已开通邮件推送的那个账号,建议单独建只授予邮件推送权限的 RAM 子账号。

6. 常见错误与排查

现象 / 错误码原因与处理
InvalidUser.NotFoundAccessKey 所属账号没有开通邮件推送,或 AccessKey 与邮件推送配置不在同一账号
InvalidMailAddress.NotFound发信地址不存在:控制台还没建该地址,或发信域名未验证通过
InvalidAccountName发信地址格式不对,必须是完整邮箱
Forbidden / NoPermission当前 AccessKey 没有邮件推送权限,给对应 RAM 用户授权
InvalidAccessKeyId.NotFoundAccessKey 错误或已被禁用
SignatureDoesNotMatchAccessKey Secret 错误,或服务器时间与北京时间相差超过 15 分钟
发信量被限制新账号信誉等级(每日发信量)限制,控制台可查看当前等级与额度
SDK 抛 Content type may not be null用 Body 传参时没有设置 Body 格式,补上 FormatType.FORM
SMTP 认证失败用户名不是发信地址全称,或用了账号密码而不是发信地址的 SMTP 密码
收件人收不到、进了垃圾箱检查 DKIM/SPF/DMARC 是否生效、是否用了主域发信、正文是否像营销内容

排查顺序建议:先用控制台的"发送测试"确认账号与地址没问题,再用代码发一封给自己,最后才接入注册流程。代码侧每次发信都记录收件人、主题与接口返回的 RequestId(不要记录验证码明文与密钥),便于对账。

7. 上线检查清单

  • 发信域名四项 DNS 记录(DKIM、SPF、DMARC、MX)都已验证通过,且 MX 记录保持存在;
  • 发信域名用的是子域名,与主域隔离;
  • 发信地址已创建,SMTP 密码只存在部署环境,未进仓库;
  • 走 SDK/API 时,AccessKey 来自已开通邮件推送的账号,且只授予必要权限;
  • 真实发一封验证码邮件确认能收到、模板渲染正确、链接或验证码可用;
  • 已确认当前信誉等级的每日发信量,并配置了重发限流;
  • 邮件里的品牌名、站点地址、logo 图片等外部资源地址都是正式域名(图片地址若指向接口域名,确认该接口可公网访问)。

官方参考:邮件推送控制台、SDK 手册、SMTP 参考、SingleSendMail 接口。

Edit this page
Last Updated: 9/22/26, 10:01 AM
Contributors: Tong Li
Prev
Google登录