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

sa-token 登录注册

  • 创建表
  • 添加依赖
  • 配置文件
  • 基础配置类
    • 启动类
    • 连接 mysql
    • 连接 reids
  • 整合 sa-token
  • 实体类
  • 数据层
    • SysUserInfoDao
    • 单元测试 SysUserInfoDao
  • 业务层 业务逻辑
    • AuthService
    • UserRegisterService
    • 单元测试 UserRegisterServiceTest
  • 接口层
    • 注册
    • 登录
  • 发送请求测试
    • 注册
    • 登录
    • 验证 token 是否有效
    • 获取用户 id
    • 登出

在本章节中,我们将使用 tio-boot 和 Sa-Token 开发一个用户注册和登录系统。该系统将:

  • 从 MySQL 数据库读取和存储用户信息。
  • 生成用于认证的 JWT 令牌。
  • 将会话数据存储在 Redis 中。

本示例将引导您完成以下步骤:

  • 创建必要的数据库表。
  • 添加项目所需的依赖。
  • 配置应用程序属性。
  • 设置应用程序、数据库、Redis 和 Sa-Token 的基础配置类。
  • 实现数据层、业务逻辑层和接口层。
  • 测试注册和登录功能。

创建表

首先会在 mysql 中创建一张表 然后使用 java-db 连接 mysql sys_user_info

DROP TABLE IF EXISTS `sys_user_info`;
CREATE TABLE `sys_user_info`  (
  `id` bigint(20) COMMENT '主键',
  `app_id` int(11) COMMENT '应用id',
  `username` varchar(32) COMMENT '用户名称',
  `password` varchar(64) COMMENT '登录密码',
  `area_code` varchar(8) COMMENT '手机区号',
  `phone` varchar(16) COMMENT '手机号码',
  `email` varchar(64) COMMENT '邮箱',
  `wx_open_id` varchar(32) COMMENT '微信openid',
  `wx_user_info` json NULL COMMENT '微信用户信息',
  `facebook_id` varchar(64),
  `facebook_user_info` json NULL,
  `user_channel` int(11) COMMENT '用户注册渠道,网页,安卓APP,IOS APP,小程序等',
  `user_from` int(11) COMMENT '用户来源,email,手机号,第三方授权等',
  `user_level` int(11) COMMENT '用户级别',
  `name` varchar(32) COMMENT '名字',
  `nick_name` varchar(32) COMMENT '昵称',
  `sex` int(11) NULL DEFAULT NULL COMMENT '性别',
  `header_image_url` varchar(255) COMMENT '头像图片url',
  `config_info` json NULL COMMENT '配置信息',
  `status` int(11) default 0 COMMENT '账号状态',
  `v` int(11) default 0 COMMENT '版本号',
  `locale` varchar(6) COMMENT '语系编码',
  `remark` varchar(256) DEFAULT NULL,
  `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(6) DEFAULT 0,
  `tenant_id` bigint(20) NOT NULL DEFAULT 0,
  PRIMARY KEY (`id`) USING BTREE
) COMMENT = '用户表'

添加依赖

添加的依赖有

  • tio-boot
  • slf4j-api
  • lombok
  • hotswap-classloader
  • api-table
  • mysql-connector-java
  • HikariCP
  • sa-token-core
  • sa-token-jwt
  • java-db
  • jedis
  • fst
  • junit
  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <java.version>1.8</java.version>
    <maven.compiler.source>${java.version}</maven.compiler.source>
    <maven.compiler.target>${java.version}</maven.compiler.target>
    <graalvm.version>23.1.1</graalvm.version>

    <lombok-version>1.18.44</lombok-version>
    <java-model.version>1.1.2</java-model.version>
    <tio.version>3.7.3.v20241008-RELEASE</tio.version>
    <tio-boot.version>2.1.4</tio-boot.version>
    <hotswap-classloader.version>1.2.9</hotswap-classloader.version>
    <jfinal-aop.version>1.3.3</jfinal-aop.version>
    <java-db.version>1.5.9</java-db.version>
    <api-table.version>1.4.5</api-table.version>
    <java-openai.version>1.2.9</java-openai.version>
    <qcloudsms.version>3.1.270</qcloudsms.version>
    <final.name>maliang-pen-app-backend</final.name>
    <main.class>com.example.auth.app.AppServer</main.class>
  </properties>
  <dependencies>

    <dependency>
      <groupId>nexus.io</groupId>
      <artifactId>java-model</artifactId>
      <version>${java-model.version}</version>
    </dependency>

    <dependency>
      <groupId>nexus.io</groupId>
      <artifactId>tio-utils</artifactId>
      <version>${tio.version}</version>
    </dependency>

    <dependency>
      <groupId>nexus.io</groupId>
      <artifactId>tio-boot</artifactId>
      <version>${tio-boot.version}</version>
    </dependency>

    <dependency>
      <groupId>nexus.io</groupId>
      <artifactId>hotswap-classloader</artifactId>
      <version>${hotswap-classloader.version}</version>
    </dependency>


    <dependency>
      <groupId>nexus.io</groupId>
      <artifactId>api-table</artifactId>
      <version>${api-table.version}</version>
    </dependency>

    <dependency>
      <groupId>nexus.io</groupId>
      <artifactId>jfinal-aop</artifactId>
      <version>${jfinal-aop.version}</version>
    </dependency>

    <dependency>
      <groupId>nexus.io</groupId>
      <artifactId>java-db</artifactId>
      <version>${java-db.version}</version>
    </dependency>

    <dependency>
      <groupId>nexus.io</groupId>
      <artifactId>java-openai</artifactId>
      <version>${java-openai.version}</version>
    </dependency>

    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>1.3.3</version>
    </dependency>

    <dependency>
      <groupId>com.alibaba.fastjson2</groupId>
      <artifactId>fastjson2</artifactId>
      <version>2.0.52</version>
    </dependency>
    <dependency>
      <groupId>com.squareup.okhttp3</groupId>
      <artifactId>okhttp</artifactId>
      <version>4.12.0</version>
    </dependency>

    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>1.7.25</version>
    </dependency>
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>${lombok-version}</version>
      <optional>true</optional>
      <scope>provided</scope>
    </dependency>

    <dependency>
      <groupId>net.sf.ehcache</groupId>
      <artifactId>ehcache-core</artifactId>
      <version>2.6.11</version>
    </dependency>

    <dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>druid</artifactId>
      <version>0.2.9</version>
    </dependency>

    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>5.1.46</version>
    </dependency>

    <dependency>
      <groupId>com.zaxxer</groupId>
      <artifactId>HikariCP</artifactId>
      <version>4.0.3</version>
    </dependency>

    <!-- Sa-Token 核心库 -->
    <dependency>
      <groupId>cn.dev33</groupId>
      <artifactId>sa-token-core</artifactId>
      <version>1.37.0</version>
    </dependency>

    <dependency>
      <groupId>cn.dev33</groupId>
      <artifactId>sa-token-jwt</artifactId>
      <version>1.37.0</version>
    </dependency>

    <!-- Jedis,Redis 的 Java 客户端 -->
    <dependency>
      <groupId>redis.clients</groupId>
      <artifactId>jedis</artifactId>
      <version>4.3.1</version>
    </dependency>

    <!-- FST 序列化工具,用于对象和字节流间的转换 -->
    <dependency>
      <groupId>de.ruedigermoeller</groupId>
      <artifactId>fst</artifactId>
      <version>2.57</version> <!-- 注意:更高版本不支持 JDK 8 -->
    </dependency>
  </dependencies>

配置文件

app.properties

app.env=dev
server.port=9204
server.context-path=/pen-api
sa.token.jwt.secret.key=xxxx
sa.token.admin.token=xxxx

app-dev.properties

jdbc.url=jdbc:mysql://192.168.3.9/enote?characterEncoding=UTF-8&allowMultiQueries=true&serverTimezone=UTC
jdbc.user=root
jdbc.pswd=robot_123456#
jdbc.MaximumPoolSize=2

redis.host=127.0.0.1
redis.port=6379
redis.password=
redis.database=2
redis.timeout=15000

i18n_en_US.properties

The_username_or_password_cannot_be_empty=The username or password cannot be empty
The_locale_cannot_be_empty=The locale cannot be empty
The_userChannel_cannot_be_empty=The userChannel cannot be empty
The_appId_cannot_be_empty=The appId cannot be empty
The_userFrom_cannot_be_empty=The userFrom cannot be empty
The_v_cannot_be_empty=The v cannot be empty
The_username_at_least_6_characters=The username at least 6 characters
The_password_at_least_8_characters=The password at least 8 characters
The_password_should_contain_uppercase_letters,_lowercase_letters_and_numbers=The password should contain uppercase letters, lowercase letters and numbers
The_locale_at_least_5_characters=The locale at least 5 characters
The_username_exists=The username exists

i18n_zh_CN.properties

The_username_or_password_cannot_be_empty=用户名或者密码不能为空
The_locale_cannot_be_empty=locale不能为空
The_userChannel_cannot_be_empty=The userChannel不能为空
The_appId_cannot_be_empty=The appId不能为空
The_userFrom_cannot_be_empty=The userFrom不能为空
The_v_cannot_be_empty=The v不能为空
The_username_at_least_6_characters=username至少6个字符
The_password_at_least_8_characters=password至少8个字符
The_password_should_contain_uppercase_letters,_lowercase_letters_and_numbers=password需要包含大写字母,小写字母和数字
The_locale_at_least_5_characters=locale至少5个字符
The_username_exists=用户名已经存在

基础配置类

启动类

package com.example.auth.app;

import nexus.io.annotation.AComponentScan;
import nexus.io.hotswap.watcher.HotSwapResolver;
import nexus.io.hotswap.wrapper.tio.boot.TioApplicationWrapper;

@AComponentScan
public class AppServer {
  public static void main(String[] args) {
    long start = System.currentTimeMillis();
    // 支持fastjson2
    HotSwapResolver.addHotSwapClassPrefix("com.alibaba.fastjson2.");
    TioApplicationWrapper.run(AppServer.class, args);

    // TioApplication.run(MaLiangPenAiServerApp.class, args);
    long end = System.currentTimeMillis();
    System.out.println((end - start) + "ms");
  }
}

连接 mysql

package com.example.auth.app.config;

import com.example.auth.app.db.model._MappingKit;
import com.jfinal.template.Engine;
import com.jfinal.template.source.ClassPathSourceFactory;
import nexus.io.annotation.AConfiguration;
import nexus.io.annotation.Initialization;
import nexus.io.db.activerecord.ActiveRecordPlugin;
import nexus.io.db.activerecord.OrderedFieldContainerFactory;
import nexus.io.tio.boot.server.TioBootServer;
import nexus.io.tio.boot.utils.TioRequestParamUtils;
import nexus.io.tio.utils.environment.EnvUtils;
import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;

import lombok.extern.slf4j.Slf4j;

@AConfiguration
@Slf4j
public class EnoteMysqlDbConfig {

  /*
   *
   * config ActiveRecordPlugin
   */
  @Initialization
  public void config() {
    String jdbcUrl = EnvUtils.get("jdbc.url");
    log.info("jdbcUrl:{}", jdbcUrl);
    String jdbcUser = EnvUtils.get("jdbc.user");
    String jdbcPswd = EnvUtils.get("jdbc.pswd");
    int maximumPoolSize = EnvUtils.getInt("jdbc.MaximumPoolSize", 2);

    HikariConfig config = new HikariConfig();
    // 设定基本参数
    config.setJdbcUrl(jdbcUrl);
    config.setUsername(jdbcUser);
    config.setPassword(jdbcPswd);
    config.setMaximumPoolSize(maximumPoolSize);
    config.setConnectionTimeout(30000);

    HikariDataSource hikariDataSource = new HikariDataSource(config);
    HookCan.me().addDestroyMethod(hikariDataSource::close);

    ActiveRecordPlugin mysqlArp = new ActiveRecordPlugin(hikariDataSource);
    mysqlArp.setContainerFactory(new OrderedFieldContainerFactory());

    Engine engine = mysqlArp.getEngine();
    engine.setSourceFactory(new ClassPathSourceFactory());
    engine.setCompressorOn(' ');
    engine.setCompressorOn('\n');

    if (EnvUtils.isDev()) {
      mysqlArp.setDevMode(true);
      engine.setDevMode(true);
      mysqlArp.setShowSql(true);
    }

    mysqlArp.addSqlTemplate("/sql/all_sqls.sql");
    _MappingKit.mapping(mysqlArp);
    mysqlArp.start();
    HookCan.me().addDestroyMethod(mysqlArp::stop);
    // add
    TioRequestParamUtils.types.add("bigint");
  }
}

连接 reids

package com.example.auth.app.config;

import nexus.io.annotation.AConfiguration;
import nexus.io.annotation.Initialization;
import nexus.io.redis.Redis;
import nexus.io.redis.RedisDb;
import nexus.io.redis.RedisPlugin;
import nexus.io.tio.boot.server.TioBootServer;
import nexus.io.tio.utils.environment.EnvUtils;

@AConfiguration
public class RedisDbConfig {

  @Initialization
  public RedisPlugin redisPlugin() {
    String redisHost = EnvUtils.get("redis.host", "127.0.0.1");
    int redisPort = EnvUtils.getInt("redis.port", 6379);
    String redisPassword = EnvUtils.getStr("redis.password");
    int redistimeout = EnvUtils.getInt("redis.timeout", 60);
    int redisDatabase = EnvUtils.getInt("redis.database", 0);

    // 创建并启动 Redis 插件
    RedisPlugin redisPlugin = new RedisPlugin("main", redisHost, redisPort, redistimeout, redisPassword, redisDatabase);
    redisPlugin.start();
    HookCan.me().addDestroyMethod(redisPlugin::stop);

    // 测试连接
    RedisDb redisDb = Redis.use("main");
    redisDb.getJedis().connect();

    return redisPlugin;
  }
}

整合 sa-token

SaTokenConfiguration

package com.example.auth.app.config;

import nexus.io.annotation.AConfiguration;
import nexus.io.annotation.Initialization;
import nexus.io.satoken.SaTokenDaoRedis;
import nexus.io.tio.boot.satoken.SaTokenContextForTio;
import nexus.io.tio.utils.environment.EnvUtils;

import cn.dev33.satoken.SaManager;
import cn.dev33.satoken.config.SaCookieConfig;
import cn.dev33.satoken.config.SaTokenConfig;
import cn.dev33.satoken.context.SaTokenContext;
import cn.dev33.satoken.jwt.StpLogicJwtForSimple;
import cn.dev33.satoken.stp.SaLoginModel;
import cn.dev33.satoken.stp.StpUtil;
import cn.dev33.satoken.util.SaTokenConsts;

@AConfiguration
public class SaTokenConfiguration {

  @Initialization
  public void config() {
    // 初始化 Sa-Token 上下文
    SaTokenContext saTokenContext = new SaTokenContextForTio();

    // 设置 Cookie 配置,例如启用 HttpOnly 属性
    SaCookieConfig saCookieConfig = new SaCookieConfig();
    saCookieConfig.setHttpOnly(true);

    // 初始化和配置 Sa-Token 主配置
    SaTokenConfig saTokenConfig = new SaTokenConfig();
    saTokenConfig.setTokenStyle(SaTokenConsts.TOKEN_STYLE_SIMPLE_UUID);
    saTokenConfig.setActiveTimeout(50 * 60); // 设置活动超时时间为 50 分钟

    saTokenConfig.setIsShare(false);
    saTokenConfig.setTokenName("token"); // 设置 token 的名称
    saTokenConfig.setIsWriteHeader(true); // 将 token 写入响应头
    saTokenConfig.setIsReadHeader(true); // 从请求头中读取 token
    //设置不将cookie信息存入到cookie
    saTokenConfig.setIsReadCookie(false);
    saTokenConfig.setCookie(saCookieConfig);

    String secretKey = EnvUtils.get("sa.token.jwt.secret.key");
    saTokenConfig.setJwtSecretKey(secretKey);
    //saTokenConfig.setTokenPrefix("Bearer");
    StpLogicJwtForSimple stpLogicJwtForSimple = new StpLogicJwtForSimple();
    StpUtil.setStpLogic(stpLogicJwtForSimple);

    // 应用配置到 Sa-Token 管理器
    SaManager.setConfig(saTokenConfig);
    SaManager.setSaTokenContext(saTokenContext);
    SaManager.setSaTokenDao(new SaTokenDaoRedis("main"));

    // 增加一个Api用户设置token永不过期
    SaLoginModel loginModel = new SaLoginModel();
    loginModel.setTimeout(-1);

    String adminToken = EnvUtils.get("sa.token.admin.token");
    loginModel.setToken(adminToken);
    StpUtil.createLoginSession("1", loginModel);
  }
}

InterceptorConfiguration

package com.example.auth.app.config;

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

import nexus.io.annotation.AConfiguration;
import nexus.io.annotation.Initialization;
import nexus.io.tio.boot.http.interceptor.HttpInteceptorConfigure;
import nexus.io.tio.boot.http.interceptor.HttpInterceptorModel;
import nexus.io.tio.boot.satoken.UserTokenInterceptor;
import nexus.io.tio.boot.server.TioBootServer;

@AConfiguration
public class InterceptorConfiguration {

  @Initialization
  public void config() {
    // 创建 SaToken 拦截器实例
    Map<String, Object> data = new HashMap<>();
    data.put("msg", "please login");
    UserTokenInterceptor saTokenInterceptor = new UserTokenInterceptor(data);
    HttpInterceptorModel model = new HttpInterceptorModel();
    model.setInterceptor(saTokenInterceptor);
    model.addblockeUrl("/**"); // 拦截所有路由

    // 设置例外路由
    model.addAllowUrls("/exception/*", "/status", "/user/register", "/auth/login", "/auth/logout");
    model.addAllowUrls("/sms/send");
    // model.addAlloweUrl("/enote/puma/*");
    //
    model.addAllowUrls("/license/get");

    //
    model.addAllowUrls("/version");

    HttpInteceptorConfigure serverInteceptorConfigure = new HttpInteceptorConfigure();
    serverInteceptorConfigure.add(model);
    // 将拦截器配置添加到 Tio 服务器
    TioBootServer.me().setHttpInteceptorConfigure(serverInteceptorConfigure);
  }
}

实体类

UserRegisterVO

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

@NoArgsConstructor
@AllArgsConstructor
@Data
@Builder
public class UserRegisterVO {
  private String username;
  private String password;
  private String locale;
  private Integer appId;
  //1 Android App,2 IOS App 3 小程序 4 网页
  private Integer userChannel;
  //用户来源:1:手机号,2:email,3:第三方授权等,4:用户名
  private Integer userFrom;
  //版本号
  private Integer v;

}

数据层

SysUserInfoDao

import nexus.io.db.activerecord.Db;

public class SysUserInfoDao {

  /**
   * 判断用户是否存在
   * @param username
   * @return
   */
  public boolean existsUsername(String username) {
    //String sql = "select count(1) from sys_user_info where username=?";
    //return Db.exists(sql, username);
    String tableName="sys_user_info";
    return Db.exists(tableName,"username",username);
  }
}

单元测试 SysUserInfoDao

SysUserInfoDaoTest

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

import org.junit.Test;

import com.example.auth.app.config.EnoteMysqlDbConfig;
import com.example.auth.app.dao.SysUserInfoDao;
import nexus.io.jfinal.aop.Aop;
import nexus.io.tio.boot.tesing.TioBootTest;

public class SysUserInfoDaoTest {

  @Test
  public void test() {
    TioBootTest.runWith(EnoteMysqlDbConfig.class);
    boolean existsUsername = Aop.get(SysUserInfoDao.class).existsUsername("litong");
    System.out.println(existsUsername);
  }
}

业务层 业务逻辑

AuthService

package com.example.auth.app.services;

import com.example.auth.app.model.LoginVo;
import com.jfinal.kit.Kv;
import nexus.io.db.TableResult;
import nexus.io.db.activerecord.Db;
import nexus.io.db.activerecord.Row;
import nexus.io.model.body.RespBodyVo;

import cn.dev33.satoken.stp.StpUtil;

public class AuthService {

  public TableResult<Kv> doLogin(String username, String password) {
    String sql = "select id from sys_user_info where username=? and password=?";
    Long result = Db.queryLong(sql, username, password);
    if (result != null && result > 0) {
      // 登录
      StpUtil.login(result);
      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", result);
      kv.set(row.toMap());
      return TableResult.ok(kv);
    } else {
      return TableResult.fail("username or password is not correct");
    }
  }

  public RespBodyVo loginByPhone(LoginVo vo) {
    // TODO Auto-generated method stub
    return null;
  }
}

UserRegisterService

package com.example.auth.app.services;

import com.example.auth.app.constants.ENoteTableNames;
import com.example.auth.app.model.UserRegisterVO;
import com.example.auth.app.utils.UserIdUtils;
import com.jfinal.kit.Kv;
import nexus.io.annotation.Inject;
import nexus.io.db.TableResult;
import nexus.io.db.activerecord.Db;
import nexus.io.db.activerecord.Row;

import cn.hutool.core.util.RandomUtil;
import lombok.extern.slf4j.Slf4j;

@Slf4j
public class UserRegisterService {

  @Inject
  private AuthService authService;

  public TableResult<Kv> index(UserRegisterVO reqVo) {
    Integer appId = reqVo.getAppId();
    String username = reqVo.getUsername();
    String password = reqVo.getPassword();
    Integer userChannel = reqVo.getUserChannel();
    Integer userFrom = reqVo.getUserFrom();
    Integer userLevel = 1;
    Integer status = 1;
    Integer v = reqVo.getV();
    String locale = reqVo.getLocale();

    boolean success = false;
    long userId = UserIdUtils.random();
    while (Db.exists(ENoteTableNames.SYS_USER_INFO, "id", userId)) {
      log.info("user id alread exits,random again:{}", userId);
      userId = UserIdUtils.random();
    }

    try {
      Row row = new Row();
      row.set("id", userId);
      row.set("app_id", appId).set("username", username).set("password", password).set("user_channel", userChannel);
      row.set("user_from", userFrom).set("user_level", userLevel).set("locale", locale);
      row.set("status", status).set("v", v);

      success = Db.tx(() -> {
        boolean save = Db.save(ENoteTableNames.SYS_USER_INFO, row);
        log.info("update result:{}", save);
        return save;
      });
    } catch (Exception e) {
      e.printStackTrace();
      return TableResult.fail(e.getMessage());
    }

    if (!success) {
      return TableResult.fail(-1, "register user fail");
    }

    TableResult<Kv> doLogin = authService.doLogin(username, password);
    return doLogin;

  }

}

单元测试 UserRegisterServiceTest

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

import org.junit.Test;

import com.example.auth.app.config.EnoteMysqlDbConfig;
import com.example.auth.app.config.RedisDbConfig;
import com.example.auth.app.config.SaTokenConfiguration;
import com.example.auth.app.model.UserRegisterVO;
import com.example.auth.app.services.UserRegisterService;
import com.jfinal.kit.Kv;
import nexus.io.db.TableResult;
import nexus.io.jfinal.aop.Aop;
import nexus.io.tio.boot.http.TioRequestContext;
import nexus.io.tio.boot.mock.TioMock;
import nexus.io.tio.boot.tesing.TioBootTest;
import nexus.io.tio.http.common.HttpRequest;
import nexus.io.tio.utils.json.JsonUtils;

public class UserRegisterServiceTest {

  @Test
  public void test() {
    //basic config
    TioBootTest.runWith(EnoteMysqlDbConfig.class, RedisDbConfig.class, SaTokenConfiguration.class);
    // mock http request
    HttpRequest request = TioMock.mockGetHttpRequest();
    TioRequestContext.hold(request);

    UserRegisterService userRegisterService = Aop.get(UserRegisterService.class);
    UserRegisterVO reqVo = UserRegisterVO.builder().username("litong").password("Litong2516")
        //
        .locale("zh_CN").userChannel(1).appId(1).userFrom(4).v(1)
        //
        .build();
    TableResult<Kv> result = userRegisterService.index(reqVo);
    System.out.println(JsonUtils.toJson(result));
  }

}

接口层

注册

注册的业务逻辑是获取请求信息,验证请求信息,验证通过插入到数据库

UserRegisterController

package com.example.auth.app.controller;

import com.example.auth.app.model.UserRegisterVO;
import com.example.auth.app.services.UserRegisterService;
import com.example.auth.app.validator.UserRegisteValidator;
import com.jfinal.kit.Kv;
import nexus.io.annotation.Inject;
import nexus.io.annotation.RequestPath;
import nexus.io.db.TableResult;
import nexus.io.tio.boot.http.TioRequestContext;
import nexus.io.tio.http.common.HttpResponse;
import nexus.io.tio.http.server.util.Resps;

@RequestPath("/user/register")
public class UserRegisterController {

  @Inject
  private UserRegisteValidator userRegisteValidator;
  @Inject
  private UserRegisterService userRegisterService;

  @RequestPath
  public HttpResponse index(UserRegisterVO reqVo) {
    TableResult<Kv> respVo = userRegisteValidator.index(reqVo);
    HttpResponse response = TioRequestContext.getResponse();
    if (respVo != null) {
      return Resps.json(response, respVo);
    }

    return Resps.json(response, userRegisterService.index(reqVo));
  }
}

UserRegisteValidator

package com.example.auth.app.validator;

import com.example.auth.app.model.UserRegisterVO;
import com.example.auth.app.dao.SysUserInfoDao;
import com.jfinal.kit.Kv;
import com.jfinal.kit.StrKit;
import nexus.io.annotation.Inject;
import nexus.io.db.TableResult;
import nexus.io.tio.boot.i18n.I18n;
import nexus.io.tio.boot.i18n.I18nLocale;
import nexus.io.tio.boot.i18n.Res;

public class UserRegisteValidator {

  @Inject
  private SysUserInfoDao SysUserInfoDao;

  public TableResult<Kv> index(UserRegisterVO reqVo) {
    String username = reqVo.getUsername();
    String password = reqVo.getPassword();
    String locale = reqVo.getLocale();
    Integer userChannel = reqVo.getUserChannel();
    Integer appId = reqVo.getAppId();
    Integer userFrom = reqVo.getUserFrom();
    Integer v = reqVo.getV();
    Res res = null;
    if (I18nLocale.ZH_CN.equals(locale)) {
      res = I18n.use(I18nLocale.ZH_CN);
    } else {
      res = I18n.use(I18nLocale.EN_US);
    }

    // 验证username
    if (StrKit.isBlank(username)) {
      String string = res.get("The_username_or_password_cannot_be_empty");
      return TableResult.fail(string);
    }

    if (StrKit.isBlank(password)) {
      return TableResult.fail(res.get("The_username_or_password_cannot_be_empty"));
    }

    if (StrKit.isBlank(locale)) {
      return TableResult.fail(res.get("The_locale_cannot_be_empty"));
    }

    if (userChannel == null) {
      return TableResult.fail(res.get("The_userChannel_cannot_be_empty"));
    }
    if (appId == null) {
      return TableResult.fail(res.get("The_appId_cannot_be_empty"));
    }

    if (userFrom == null) {
      return TableResult.fail(res.get("The_userFrom_cannot_be_empty"));
    }

    if (v == null) {
      return TableResult.fail(res.get("The_v_cannot_be_empty"));
    }

    if (username.length() < 6) {
      return TableResult.fail("The_username_at_least_6_characters");
    }

    if (password.length() < 8) {
      return TableResult.fail("The_password_at_least_8_characters");
    }

    // 至少包含大小,小写和数字
    if (!PasswordValidator.validatePassword(password)) {
      return TableResult.fail(res.get("The_password_should_contain_uppercase_letters,_lowercase_letters_and_numbers"));
    }

    if (locale.length() < 5) {
      return TableResult.fail(res.get("The_locale_at_least_5_characters"));
    }

    // 判断用户名是否存在
    if (SysUserInfoDao.existsUsername(username)) {
      return TableResult.fail(res.get("The_username_exists"));
    }
    return null;
  }
}

UserRegisteValidatorTest

package com.example.auth.app.validator;
import org.junit.Test;

import com.jfinal.kit.StrKit;
import nexus.io.tio.boot.i18n.I18n;
import nexus.io.tio.boot.i18n.I18nLocale;
import nexus.io.tio.boot.i18n.Res;

public class UserRegisteValidatorTest {

  @Test
  public void test() {
    String locale = I18nLocale.ZH_CN;
    String username = null;
    Res res = null;
    if (I18nLocale.ZH_CN.equals(locale)) {
      res = I18n.use(I18nLocale.ZH_CN);
    } else {
      res = I18n.use(I18nLocale.EN_US);
    }

    // 验证username
    String string = null;
    if (StrKit.isBlank(username)) {
      string = res.get("The_username_or_password_cannot_be_empty");
    }
    System.out.println(string);
  }
}

登录

AuthController

package com.example.auth.app.controller;

import com.example.auth.app.model.LoginVo;
import com.example.auth.app.services.AuthService;
import com.example.auth.app.validator.AuthValidator;
import com.jfinal.kit.Kv;
import nexus.io.annotation.Inject;
import nexus.io.annotation.RequestPath;
import nexus.io.db.TableResult;
import nexus.io.model.body.RespBodyVo;
import nexus.io.tio.boot.http.TioRequestContext;
import nexus.io.tio.http.common.HttpResponse;
import nexus.io.tio.http.server.util.Resps;

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

@RequestPath("/auth")
@Slf4j
public class AuthController {
  @Inject
  private AuthValidator authValidator;
  @Inject
  private AuthService authService;

  public HttpResponse login(String username, String password, String locale) {
    log.info("username:{}", username);
    RespBodyVo respVo = authValidator.doLogin(username, password, locale);
    if (respVo != null) {
      return Resps.json(TioRequestContext.getResponse(), TableResult.fail(-1, respVo.getMsg()));
    }
    TableResult<Kv> result = authService.doLogin(username, password);
    return Resps.json(TioRequestContext.getResponse(), result);
  }

  public HttpResponse logout() {
    StpUtil.logout();
    HttpResponse response = TioRequestContext.getResponse();
    return Resps.json(response, RespBodyVo.ok());
  }

  public RespBodyVo validateToken() {
    try {
      StpUtil.checkActiveTimeout();
      return RespBodyVo.ok();
    } catch (Exception e) {
      return RespBodyVo.fail();
    }
  }
}

AuthValidator

package com.example.auth.app.validator;

import com.jfinal.kit.StrKit;
import nexus.io.model.body.RespBodyVo;
import nexus.io.tio.boot.i18n.I18n;
import nexus.io.tio.boot.i18n.I18nLocale;
import nexus.io.tio.boot.i18n.Res;

public class AuthValidator {

  public RespBodyVo doLogin(String username, String password,String locale) {
    Res res = null;
    if (I18nLocale.ZH_CN.equals(locale)) {
      res = I18n.use(I18nLocale.ZH_CN);
    } else {
      res = I18n.use(I18nLocale.EN_US);
    }

    if (StrKit.isBlank(locale)) {
      return RespBodyVo.fail(res.get("The_locale_cannot_be_empty"));
    }

    if(StrKit.isBlank(username) || StrKit.isBlank(password)) {
      String string = res.get("The_username_or_password_cannot_be_empty");
      return RespBodyVo.fail(string);
    }
    return null;
  }

}

发送请求测试

注册

curl --location --request POST 'http://localhost:9204/pen-api/user/register' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Accept: */*' \
--header 'Host: localhost:9204' \
--header 'Connection: keep-alive' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=litong' \
--data-urlencode 'password=Litong2516' \
--data-urlencode 'locale=zh_CN' \
--data-urlencode 'userChannel=1' \
--data-urlencode 'appId=1' \
--data-urlencode 'userFrom=4' \
--data-urlencode 'v=1'

响应体如下

{
  "data": {
    "tenant_id": "0",
    "wx_user_info": null,
    "locale": "zh_CN",
    "config_info": null,
    "header_pic_id": null,
    "password": "Litong2516",
    "id": "58880372218307226",
    "add_time_long": "1729540045700",
    "app_id": 1,
    "email": null,
    "area_code": null,
    "sex": null,
    "user_from": 4,
    "tokenTimeout": "2592000",
    "facebook_user_info": null,
    "wx_open_id": null,
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJsb2dpblR5cGUiOiJsb2dpbiIsImxvZ2luSWQiOjU4ODgwMzcyMjE4MzA3MjI2LCJyblN0ciI6InFzSkVBTzRVUGdHck1RMVRqQUo1eW9YbmR5SEFVSnY0In0.meLVvKv0STYpw-gHco_l0z_avwdUj1uySP6XQv5hgUY",
    "facebook_id": null,
    "update_time_long": "1729540045700",
    "deleted": 0,
    "user_channel": 1,
    "phone": null,
    "v": 1,
    "nick_name": null,
    "name": null,
    "user_level": 1,
    "username": "litong2",
    "status": 1
  },
  "code": 1,
  "msg": null,
  "ok": true
}

登录

curl --location --request POST 'http://localhost:9204/pen-api/auth/doLogin' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Accept: */*' \
--header 'Host: localhost:9204' \
--header 'Connection: keep-alive' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=litong2' \
--data-urlencode 'password=Litong2516' \
--data-urlencode 'locale=zh_CN'

响应体如下

{
  "data": {
    "tenant_id": "0",
    "wx_user_info": null,
    "locale": "zh_CN",
    "config_info": null,
    "header_pic_id": null,
    "password": "Litong2516",
    "id": "28597511211391080",
    "add_time_long": "1729424379475",
    "app_id": 1,
    "email": null,
    "area_code": null,
    "sex": null,
    "user_from": 4,
    "tokenTimeout": "2591995",
    "facebook_user_info": null,
    "wx_open_id": null,
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJsb2dpblR5cGUiOiJsb2dpbiIsImxvZ2luSWQiOjI4NTk3NTExMjExMzkxMDgwLCJyblN0ciI6Ik05S2JuZ0ZwR2U3cFFpTUdLMnZTRms4bUw2cEhpVWJvIn0.aUxyQAIGhtGgO8IRi7_uLPaEeI3kHdkZLy7zeNInixw",
    "facebook_id": null,
    "update_time_long": "1729424379475",
    "deleted": 0,
    "user_channel": 1,
    "phone": null,
    "v": 1,
    "nick_name": null,
    "name": null,
    "user_level": 1,
    "username": "litong2",
    "status": 1
  },
  "msg": null,
  "code": 1,
  "ok": true
}

验证 token 是否有效

curl --location --request GET 'http://localhost:9204/pen-api/auth/validateToken' \
--header 'token: 4eb6ac726a7d4f42bb10fe365823f9f7' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Accept: */*' \
--header 'Host: localhost:9204' \
--header 'Connection: keep-alive' \

获取用户 id

curl --location --request GET 'http://localhost:9204/pen-api/auth/getUserId' \
--header 'token: 4eb6ac726a7d4f42bb10fe365823f9f7' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Accept: */*' \
--header 'Host: localhost:9204' \
--header 'Connection: keep-alive'
{
  "data": {
    "tokenTimeout": 2591819,
    "userId": "35",
    "token": "4eb6ac726a7d4f42bb10fe365823f9f7"
  },
  "ok": true
}

登出

curl --location --request GET 'http://localhost:9204/pen-api/auth/logout' \
--header 'token: 4eb6ac726a7d4f42bb10fe365823f9f7' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Accept: */*' \
--header 'Host: localhost:9204' \
--header 'Connection: keep-alive'
Edit this page
Last Updated: 10/1/26, 4:55 AM
Contributors: litongjava
Prev
Sa-Token
Next
StpUtil.isLogin() 源码解析