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 应用
      • 历史部署页与替代方案
      • 胖包与瘦包的打包与部署
      • 使用 JDK 8 构建基础库与验证运行环境
    • 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) 生成方案
      • Base64 输入与锁等待
      • Gzip 与字节缓冲区
      • 字符串查找与随机整数
      • 日期转换与文件名解析
      • JSON 泛型转换与输出配置
      • JWT 签发与校验
      • 集合分页 PageUtils
      • URL 与流复制工具
  • 数据库与数据访问

    • 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 业务实践
      • 查询资源自动管理
      • Row 展示转换与表格导出
      • 支付回执与权益事务
      • 商业库存与按量履约事务
    • 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 网页扫码)
      • 支付宝:电脑网站支付接入指南
      • 支付宝:使用 page.pay 二维码前置模式实现网页内扫码支付
  • 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 · 知识库

      • Java MossKB 知识库文档
      • 学术论文
      • 数据库设计
      • 用户登录实现
      • 模型管理
      • 知识库管理
      • 文档拆分
      • 片段向量
      • 命中测试
      • 文档管理
      • 片段管理
      • 问题管理
      • 应用管理
      • 向量检索
      • 推理问答
      • 问答模块
      • 统计分析
      • 用户管理
      • VL模型文档解析方案和费用对比
      • 文档解析模型实测
      • 文档解析优化
      • 片段汇总
      • 段落分块与检索
      • 多文档解析
      • 检索性能优化
      • 对话日志
      • 创建独立用户与账号资源管理
      • api 管理
      • 独立对话页
      • 嵌入第三方web系统
      • 分段预览
      • 文档预览
      • 多轮检索
      • 上下文压缩
      • 支持自定义模型
      • 爬取网页数据
      • 隔离 Python 执行环境配置
      • 隔离 Python 执行器
      • 函数库与调用接口
      • Windows 与 Linux 部署
      • 离线运行向量模型
      • Milvus
      • 存储文件到云存储
      • 文档解析异步化
    • 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 客户端
      • 请求响应关联与线程约束
      • DeepSeek Harness 插件开发入门:从入口到第一个工具
      • 开发 dsh-plugin-deepseek-browser-use:HTTP 客户端与基础工具
      • 开发 dsh-plugin-deepseek-browser-use:会话、作业、文件与图片
      • 把 dsh-plugin-deepseek-browser-use 构建并安装到 DeepSeek Harness
      • DeepSeek Harness 原生浏览器插件:安装、配置与使用
      • DeepSeek Harness 原生浏览器插件:源码、生命周期与测试
      • 后端自动管理:安装 Java 与 Git、更新源码、编译和启动
      • 页面正在导航与主 Frame 缺失:PAGE_NAVIGATING
  • 项目实战

    • 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 源码解析
      • HTTP 请求与连接生命周期

独立对话页

  • 一、这个页面是什么
  • 二、公开链接从哪里来
  • 三、一次访客对话的完整流程
  • 四、访客身份与鉴权
  • 五、接口清单
    • 认证接口
    • 应用公开信息
    • 开始新会话
    • 提问
    • 会话与记录
  • 六、公开链接配置接口
  • 七、对话语言
  • 八、隔离与安全
  • 九、数据表
  • 十、前端对应实现
  • 十一、实际验证
  • 十二、已知边界
  • 十三、部署提示

本章说明如何把一个应用以公开链接的形式发给外部访客使用:访客打开分享地址即可直接对话,不需要注册、不需要登录,也看不到后台的任何管理入口。这条链路在代码里对应「公开访问链接 + 访客会话」,本章只讲这一条链路;对话日志的写入、检索与导出见对话日志。

一、这个页面是什么

应用管理里有两种「能对话的页面」,它们的数据完全隔离,不要混为一谈:

页面打开方式会话类型谁在用
应用调试页应用详情页里点演示 / Preview,地址栏停在应用详情上,会话由创建接口临时建立chat_type = 1应用所有者,用来验证提示词与知识库效果
独立对话页应用概览里复制公开链接发给他人,地址形如 /ui/#/chat/{访问令牌}chat_type = 0拿到链接的任何人(访客)

两者的问答界面长得很像,区别在会话类型:调试会话把应用配置整体快照写进临时表,改配置立即生效但不进日志;正式会话只记应用 ID,读的是应用表里的当前配置,会进入对话日志、统计与清理策略。对外分享请只用公开链接,调试页是给应用作者自己看的。

独立对话页的现成例子:http://127.0.0.1:3000/ui/#/chat/7335647387278176,其中 7335647387278176 就是该应用的访问令牌。

二、公开链接从哪里来

公开链接在应用概览页维护:

  • 地址 = 当前站点根地址 + /ui/#/chat/ + 该应用的访问令牌;
  • 右上角的开关控制这条链接是否可用,关掉后访客访问会拿到错误提示;
  • 令牌右侧的复制按钮用于把链接发给别人,刷新按钮用于作废旧链接并换一个新的令牌;
  • 公开链接与 API Key 是两套凭证:前者给网页访客用,后者给第三方程序调用接口用,见 api 管理。

公开访问链接入口

链接里的令牌是应用自己的不透明数字串,与登录令牌无关,泄露了也不会拿到后台权限;真泄露了就点刷新换一个,旧令牌立刻失效。

三、一次访客对话的完整流程

sequenceDiagram
    participant V as 访客浏览器
    participant B as 服务端
    V->>B: POST /api/application/authentication(短令牌)
    B->>B: 校验短令牌有效、应用公开访问开启
    B->>B: 首次访问登记访客,签发长期令牌
    B-->>V: 长期令牌(JWT)
    V->>B: GET /api/application/profile(长期令牌)
    B-->>V: 应用公开信息:名称、欢迎语、显示来源、对话语言
    V->>B: GET /api/application/{应用}/chat/client/1/20
    B-->>V: 该访客自己的历史会话
    V->>B: GET /api/application/{应用}/chat/open
    B-->>V: 新的会话 ID
    V->>B: POST /api/application/chat_message/{会话}
    B-->>V: SSE:进度事件 + 回答增量 + 结束事件

页面上的效果:

独立对话页

左侧是访客自己的历史会话,可以新建、重命名、删除;右侧是问答区,回答下方带知识来源、消耗 tokens 与耗时;页面顶部只有应用名称,没有任何后台菜单。来源里的文档卡片可以直接点开,按分段查看该文档的正文,访客身份同样可用,见分段预览。

四、访客身份与鉴权

访客没有账号,服务端用「一次登记、长期复用」的方式给他一个身份:

  1. 页面带上链接里的短令牌请求认证接口;
  2. 服务端校验短令牌:记录存在、未删除、公开访问处于启用状态;
  3. 浏览器里若已有可用的长期令牌,且该访客与本应用已经建立过关系,直接沿用;
  4. 否则新建一个访客身份,签发长期令牌并写入访客表,返回长期令牌。
package nexus.io.mosskb.service.kb;

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.mosskb.model.MossKbApplicationPublicAccessClient;
import nexus.io.mosskb.service.MossKbAuthService;
import nexus.io.model.result.ResultVo;
import nexus.io.tio.boot.admin.utils.TioAdminEnvUtils;
import nexus.io.tio.utils.jwt.JwtUtils;
import nexus.io.tio.utils.snowflake.SnowflakeIdUtils;
import nexus.io.tio.utils.token.TokenManager;

/** 公开链接的认证入口:短令牌换长期令牌,首次访问时登记访客。 */
public ResultVo authentication(Long shortToken, String longToken) {
  Row token = Db.findFirst(FIND_BY_TOKEN, shortToken);
  if (token == null) {
    return ResultVo.fail("not found applicaiton id:" + shortToken);
  }
  Long applicationId = token.getLong("application_id");
  Long clientId = Aop.get(MossKbAuthService.class).getIdByToken(longToken);
  if (clientId != null && Db.queryLong("select count(*) from moss_kb_application_public_access_client where application_id=? and client_id=?",
      applicationId, clientId) > 0) {
    return ResultVo.ok(longToken);
  }
  return ResultVo.ok(bindClient(applicationId, token.getStr("language")));
}

长期令牌由服务端的密钥签发,带上它就能访问分享页用到的那几个接口;令牌里的身份是访客 ID,不是后台账号,因此拿不到任何管理接口。访客记录只用于统计与后续的访问控制,不保存姓名、手机号这类资料。

请求拦截器按路径放行分享页需要的最小集合,其余一律拒绝:

package nexus.io.mosskb.inteceptor;

import java.util.regex.Pattern;

/** 没有本地账号的令牌仍可访问的路径,用于分享对话。 */
private static final String[] PUBLIC_PATHS = {"/api/application/profile"};

/** 没有本地账号的令牌仍可访问的路径,用于分享对话。 */
private static final Pattern[] PUBLIC_PATH_PATTERNS = {
    Pattern.compile("/api/application/\\d+/chat/open"),
    Pattern.compile("/api/application/chat_message/\\d+"),
    Pattern.compile("/api/application/\\d+/chat/\\d+/context(/compact)?"),
    Pattern.compile("/api/application/\\d+/chat/client/\\d+(/\\d+)?"),
    Pattern.compile("/api/application/\\d+/chat/\\d+/chat_record/\\d+/\\d+"),
    Pattern.compile("/api/application/\\d+/chat/\\d+/chat_record/\\d+(/vote)?")};

放行的只是「路径形状」,不是「谁都能读」:每个业务方法内部还会做一次会话归属校验,访客只能读写 client_id 属于自己的会话。

五、接口清单

方法与路径认证行为
POST /api/application/authentication短令牌短令牌换长期令牌,首次访问登记访客
GET /api/application/profile长期令牌应用公开信息,含显示来源开关与对话语言
GET /api/application/{应用ID}/access_token登录令牌读取公开链接配置
PUT /api/application/{应用ID}/access_token登录令牌修改公开链接配置:启停、重置令牌、来源显示、语言
GET /api/application/{应用ID}/chat/open长期令牌新建一个访客会话,返回会话 ID
POST /api/application/chat_message/{会话ID}长期令牌提问,SSE 流式返回
GET /api/application/{应用ID}/chat/client/{页}/{条}长期令牌该访客的会话分页
GET /api/application/{应用ID}/chat/{会话}/chat_record/{页}/{条}长期令牌会话内的问答分页
GET /api/application/{应用ID}/chat/{会话}/chat_record/{记录}长期令牌单条回答详情,含引用与检索轨迹
PUT /api/application/{应用ID}/chat/{会话}/chat_record/{记录}/vote长期令牌点赞 / 点踩
PUT /api/application/{应用ID}/chat/client/{会话}长期令牌重命名会话
DELETE /api/application/{应用ID}/chat/client/{会话}长期令牌删除会话(只作用于访客自己的会话)

认证与授权是两步:拦截器负责「这个令牌能不能到这条路径」,业务方法负责「这条会话是不是你的」。第二节的路径放行列表只解决第一步。

认证接口

curl -X POST "http://127.0.0.1:10060/api/application/authentication" \
  -H "Content-Type: application/json" \
  -d '{"access_token": 7335647387278176}'
{
  "code": 200,
  "message": null,
  "data": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…"
}

应用公开信息

curl "http://127.0.0.1:10060/api/application/profile" \
  -H "authorization: ${GUEST_TOKEN}"
{
  "code": 200,
  "message": null,
  "data": {
    "id": "695640157413023744",
    "name": "政法多轮问答验证",
    "desc": "依据上传的行政复议法文档回答问题,验证连续追问与引用",
    "prologue": "您好,我是 XXX 小助手,您可以向我提出 XXX 使用问题。\n- XXX 主要功能有什么?\n- XXX 如何收费?",
    "dialogue_number": 5,
    "icon": null,
    "type": "SIMPLE",
    "work_flow": null,
    "show_source": true,
    "language": "zh-CN",
    "multiple_rounds_dialogue": true,
    "stt_model_enable": false,
    "tts_model_enable": false,
    "tts_type": "BROWSER"
  }
}

dialogue_number 决定追问时带入多少轮历史,prologue 是首次进入的欢迎语与推荐问题,show_source 决定回答下方是否展示知识来源,language 决定界面语言(为空时跟随访客浏览器语言)。

开始新会话

curl "http://127.0.0.1:10060/api/application/695640157413023744/chat/open" \
  -H "authorization: ${GUEST_TOKEN}"
{ "code": 200, "message": null, "data": "695954186705608704" }

提问

curl -N -X POST "http://127.0.0.1:10060/api/application/chat_message/695954186705608704" \
  -H "authorization: ${GUEST_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{"message": "行政复议的一般申请期限是多久", "re_chat": false, "form_data": {}}'

流里先给过程事件,再给回答增量,最后给结束事件:

event:agent_status
data:{"phase":"context","message":"正在读取会话上下文"}

event:agent_status
data:{"phase":"retrieving","round":1,"query":"行政复议的一般申请期限是多久"}

data:{"is_end":false,"chat_id":"695954186705608704","content":"根据","node_type":"ai-chat-node"}
data:{"is_end":false,"chat_id":"695954186705608704","content":"《中华人民共和国行政复议法》","node_type":"ai-chat-node"}
data:{"is_end":true,"chat_id":"695954186705608704","chat_record_id":"695954187593580544","content":""}

前端的处理要点是「一个中文字符可能被网络切成多个数据块」,因此不能按块解析,要先把数据攒起来再按事件边界切分:

const decoder = new TextDecoder('utf-8')
const write_stream = ({ done, value }: { done: boolean; value: any }) => {
  let str = decoder.decode(value, { stream: true })
  tempResult += str
  // 一次网络数据块不保证正好是一个完整事件,按 data:…\n\n 的边界切
  const split = tempResult.match(/(?:event:[^\n]*\r?\n)?data:[^\n]*\r?\n\r?\n/g)
  if (split) {
    str = split.join('')
    tempResult = tempResult.replace(str, '')
  } else {
    return reader.read().then(write_stream)
  }
  // …
}

会话与记录

# 该访客的历史会话
curl "http://127.0.0.1:10060/api/application/695640157413023744/chat/client/1/20" \
  -H "authorization: ${GUEST_TOKEN}"

# 会话内的问答(升序取第一页)
curl "http://127.0.0.1:10060/api/application/695640157413023744/chat/695954186705608704/chat_record/1/20?order_asc=true" \
  -H "authorization: ${GUEST_TOKEN}"

会话分页只返回 client_id 为当前访客、且 chat_type = 0 的记录,所以同一个应用的两个访客互相看不到对方的对话;换一个应用 ID 去读同一会话同样会被拒绝。

六、公开链接配置接口

前端在应用概览上做的三件事——拨动开关、刷新令牌、修改显示设置——都会落到同一个写入接口上。请求体里出现哪个字段就改哪个字段,没出现的保持原值:

package nexus.io.mosskb.controller;

import com.alibaba.fastjson2.JSONObject;

import nexus.io.annotation.Get;
import nexus.io.annotation.Put;
import nexus.io.annotation.RequestPath;
import nexus.io.jfinal.aop.Aop;
import nexus.io.mosskb.service.kb.MossKbApplicationAccessTokenService;
import nexus.io.model.result.ResultVo;
import nexus.io.tio.boot.http.TioRequestContext;
import nexus.io.tio.http.common.HttpRequest;
import nexus.io.tio.utils.hutool.StrUtil;
import nexus.io.tio.utils.json.FastJson2Utils;

@RequestPath("/api/application")
public class ApiApplicationController {

  @Get("/{applicationId}/access_token")
  public ResultVo getAccessToken(Long applicationId) {
    if (!nexus.io.mosskb.service.kb.ApplicationAccess.owns(TioRequestContext.getUserIdLong(), applicationId)) {
      return ResultVo.fail("无权访问应用");
    }
    return Aop.get(MossKbApplicationAccessTokenService.class).getById(applicationId);
  }

  /** 公开访问链接配置:启停、重置短令牌、访问次数、白名单与对话语言。 */
  @Put("/{applicationId}/access_token")
  public ResultVo updateAccessToken(Long applicationId, HttpRequest request) {
    return Aop.get(MossKbApplicationAccessTokenService.class).update(TioRequestContext.getUserIdLong(), applicationId,
        body(request));
  }

  private JSONObject body(HttpRequest request) {
    String bodyString = request.getBodyString();
    return StrUtil.isBlank(bodyString) ? new JSONObject() : FastJson2Utils.parseObject(bodyString);
  }
}

可写字段:

字段类型说明
is_active布尔公开链接是否可用;关闭后短令牌立即失效
access_token_reset布尔置为 true 时换一个新的访问令牌,旧链接立刻作废
show_source布尔回答下方是否展示知识来源
language字符串对话语言,取值 en-US、zh-CN、zh-Hant,传空表示跟随浏览器
access_num整数允许的访问次数,0 表示不限
white_active布尔是否启用来源白名单
white_list字符串数组白名单条目,最多 32 条

服务层的写入沿用「请求里有什么就改什么」的写法,条件永远是应用 ID:

package nexus.io.mosskb.service.kb;

import java.util.ArrayList;
import java.util.List;

import com.alibaba.fastjson2.JSONArray;
import com.alibaba.fastjson2.JSONObject;

import nexus.io.db.activerecord.Db;
import nexus.io.model.result.ResultVo;
import nexus.io.tio.utils.hutool.StrUtil;
import nexus.io.tio.utils.mcid.McIdUtils;

  /** 公开链接的写入:只改请求里出现的字段,未出现的保持原值。 */
  public ResultVo update(Long userId, Long applicationId, JSONObject input) {
    if (!ApplicationAccess.owns(userId, applicationId)) {
      return ResultVo.fail("应用不存在或无权访问");
    }
    if (Db.queryLong("select count(*) from moss_kb_application_access_token where application_id=? and deleted=0",
        applicationId) == 0) {
      return ResultVo.fail("公开访问链接不存在");
    }
    List<String> assignments = new ArrayList<>();
    List<Object> args = new ArrayList<>();
    if (input.containsKey("is_active")) {
      assignments.add("is_active = ?");
      args.add(Boolean.TRUE.equals(input.getBoolean("is_active")));
    }
    if (Boolean.TRUE.equals(input.getBoolean("access_token_reset"))) {
      assignments.add("access_token = ?");
      args.add(McIdUtils.id());
    }
    if (input.containsKey("show_source")) {
      assignments.add("show_source = ?");
      args.add(Boolean.TRUE.equals(input.getBoolean("show_source")));
    }
    if (input.containsKey("language")) {
      String language = input.getString("language");
      if (StrUtil.isNotBlank(language) && !SUPPORTED_LANGUAGES.contains(language)) {
        return ResultVo.fail("不支持的语言:" + language);
      }
      assignments.add("language = ?");
      args.add(StrUtil.isBlank(language) ? null : language);
    }
    if (assignments.isEmpty()) {
      return getById(applicationId);
    }
    assignments.add("update_time = now()");
    args.add(applicationId);
    Db.update("update moss_kb_application_access_token set " + String.join(", ", assignments)
        + " where application_id = ? and deleted = 0", args.toArray());
    return getById(applicationId);
  }

语言在白名单里校验,避免把任意文本写进数据库,也避免前端拿到它渲染不出来的取值:

  /** 界面支持的语言,与前端语言包目录同名;留空表示跟随访客浏览器语言。 */
  private static final List<String> SUPPORTED_LANGUAGES = List.of("en-US", "zh-CN", "zh-Hant");

命令行改配置同样方便,改完立即生效:

TOKEN="<登录令牌>"
APP=695640157413023744

# 关闭公开访问(旧链接立刻不可用)
curl -X PUT "http://127.0.0.1:10060/api/application/${APP}/access_token" \
  -H "authorization: ${TOKEN}" -H "Content-Type: application/json" \
  -d '{"is_active": false}'

# 换一个新的访问令牌(旧链接立刻作废)
curl -X PUT "http://127.0.0.1:10060/api/application/${APP}/access_token" \
  -H "authorization: ${TOKEN}" -H "Content-Type: application/json" \
  -d '{"access_token_reset": true}'

# 展示知识来源,并把对话语言固定为简体中文
curl -X PUT "http://127.0.0.1:10060/api/application/${APP}/access_token" \
  -H "authorization: ${TOKEN}" -H "Content-Type: application/json" \
  -d '{"show_source": true, "language": "zh-CN"}'

写入接口返回修改后的完整配置,前端直接拿它刷新界面:

{
  "code": 200,
  "message": null,
  "data": {
    "application_id": "695640157413023744",
    "access_token": "7335647387278176",
    "is_active": true,
    "access_num": 100,
    "white_active": false,
    "white_list": [],
    "show_source": true,
    "language": "zh-CN",
    "create_time": 1790929537923,
    "update_time": 1791004873064
  }
}

非法取值会被挡下,不写库:

{ "code": 400, "message": "不支持的语言:fr-FR", "data": null }

七、对话语言

language 是分享页唯一影响渲染的配置项:

  • 页面加载时先用 language 覆盖界面语言,因此同一条链接对所有人显示同一种语言;
  • 传空值时跟随访客浏览器语言,浏览器是中文就是中文、是英文就是英文;
  • 只改界面文案,不改应用内容:欢迎语、推荐问题、回答语言都属于应用自身配置,切语言不会把它们一起翻译。

前端在拿到应用公开信息后就地切换语言:

import useStore from '@/stores'
import { getBrowserLang } from '@/locales/index'
import { useI18n } from 'vue-i18n'

const { locale } = useI18n({ useScope: 'global' })
const { application, user } = useStore()
const application_profile = ref<any>({})

function getAppProfile() {
  return application.asyncGetAppProfile(loading).then((res: any) => {
    locale.value = res.data?.language || getBrowserLang()
    application_profile.value = res.data
  })
}

八、隔离与安全

访客能做的事被限制在很小的范围内:

边界做法
看不到后台令牌里是访客身份,拦截器只放行分享页的几个路径,其余返回 403
看不到别人的会话会话与问答的读写都带 client_id 与 chat_type = 0 条件
换应用 ID 也读不到会话归属校验同时比对 application_id 与 chat_id
链接可随时作废关掉开关或重置令牌,旧链接立刻失效,无需等缓存
拿不到后台权限访客身份与后台账号是两套体系,不共享角色与权限

会话的归属判断集中在同一处,管理端、分享端、提问接口共用:

package nexus.io.mosskb.service.kb;

import nexus.io.db.activerecord.Db;
import nexus.io.db.activerecord.Row;

public final class ApplicationAccess {

  public static boolean canChat(Long clientId, Long applicationId) {
    if (owns(clientId, applicationId)) {
      return true;
    }
    return clientId != null && Db.queryLong("select count(*) from moss_kb_application_public_access_client c join moss_kb_application_access_token t on t.application_id=c.application_id where c.client_id=? and c.application_id=? and t.is_active=true and t.deleted=0", clientId, applicationId) > 0;
  }

  public static boolean canReadChat(Long clientId, Long applicationId, Long chatId) {
    Row chat = Db.findById("moss_kb_application_chat", chatId);
    return chat != null && !Boolean.TRUE.equals(chat.getBoolean("is_deleted")) && applicationId.equals(chat.getLong("application_id"))
        && (owns(clientId, applicationId) || (canChat(clientId, applicationId) && clientId.equals(chat.getLong("client_id"))));
  }
}

九、数据表

公开链接一个应用一行,主键就是应用 ID:

CREATE TABLE IF NOT EXISTS "public"."moss_kb_application_access_token" (
  "application_id" BIGINT PRIMARY KEY,
  "access_token" BIGINT NOT NULL,
  "is_active" BOOLEAN NOT NULL,
  "access_num" INT NOT NULL,
  "white_active" BOOLEAN NOT NULL,
  "white_list" VARCHAR[] NOT NULL,
  "show_source" BOOLEAN NOT NULL,
  "language" VARCHAR(16),
  "remark" VARCHAR(256),
  "creator" VARCHAR(64) DEFAULT '',
  "create_time" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP,
  "updater" VARCHAR(64) DEFAULT '',
  "update_time" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP,
  "deleted" SMALLINT DEFAULT 0,
  "tenant_id" BIGINT NOT NULL DEFAULT 0
);

CREATE INDEX IF NOT EXISTS "moss_kb_application_access_token_access_token"
  ON "public"."moss_kb_application_access_token" USING btree ("access_token");

访客登记表记录「谁在哪个应用上访问过多少次」,用于统计与后续的访问控制:

CREATE TABLE IF NOT EXISTS "public"."moss_kb_application_public_access_client" (
  "id" BIGINT PRIMARY KEY,
  "access_num" INT NOT NULL,
  "intraday_access_num" INT NOT NULL,
  "application_id" BIGINT NOT NULL,
  "client_id" BIGINT,
  "creator" VARCHAR(64) DEFAULT '',
  "create_time" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP,
  "updater" VARCHAR(64) DEFAULT '',
  "update_time" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP,
  "deleted" SMALLINT DEFAULT 0,
  "tenant_id" BIGINT NOT NULL DEFAULT 0
);

字段取值约定:access_token 是应用级的不透明数字串,随机生成、全局唯一;is_active 关闭后该应用的公开链接整体不可用;language 为空表示跟随浏览器;white_active 与 white_list 保存来源白名单配置;access_num 保存访问次数配置,0 表示不限。

language 列由建表脚本一并创建,重新执行可重复执行的初始化脚本即可给已有库补上:

BEGIN;

ALTER TABLE moss_kb_application_access_token
  ADD COLUMN IF NOT EXISTS language VARCHAR(16);

COMMENT ON COLUMN moss_kb_application_access_token.language IS '公开分享链接的对话语言,为空表示跟随浏览器语言';

COMMIT;

十、前端对应实现

前端不需要为分享页单独写一套页面:同一个对话组件按地址参数决定用哪种布局,PC、移动、嵌入三种模板共用一套逻辑。

分享地址由当前站点地址拼出来,不写死主机名,因此换域名或换端口后链接自动跟着变:

import { defineStore } from 'pinia'

const useApplicationStore = defineStore({
  id: 'application',
  state: () => ({
    // 分享地址前缀:当前站点 + /ui/#/chat/
    location: `${window.location.origin}/ui/#/chat/`
  })
})

应用概览把令牌拼到前缀后面,构成最终分享地址:

import { computed, ref } from 'vue'
import { useRoute } from 'vue-router'
import useStore from '@/stores'

const { user, application } = useStore()
const route = useRoute()
const { params: { id } } = route as any
const accessToken = ref<any>({})

const shareUrl = computed(() => application.location + accessToken.value.access_token)

访客令牌的保存位置与登录令牌分开,互不覆盖:

async asyncAppAuthentication(token: string, loading?: Ref<boolean>, authentication_value?: any) {
  return new Promise((resolve, reject) => {
    applicationApi
      .postAppAuthentication(token, loading, authentication_value)
      .then((res) => {
        localStorage.setItem(`${token}-accessToken`, res.data)
        sessionStorage.setItem(`${token}-accessToken`, res.data)
        resolve(res)
      })
      .catch((error) => reject(error))
  })
}

请求时按令牌来源自动选取:后台页面用登录令牌,分享页用该访问令牌对应的长期令牌:

import useStore from '@/stores'

getToken(): String | null {
  if (this.token) {
    return this.token
  }
  return this.userType === 1 ? localStorage.getItem('token') : this.getAccessToken()
}

十一、实际验证

验证在浏览器里完成,应用为公开政法资料问答应用,公开链接为 http://127.0.0.1:3000/ui/#/chat/7335647387278176。

操作观察结果
用无痕身份打开公开链接直接进入对话页,未出现登录或认证弹窗
页面信息标题为应用名,界面文案为简体中文(配置的对话语言),欢迎语与应用内配置的推荐问题保持应用自身的原文
提问「行政复议的一般申请期限是多久」回答引用《中华人民共和国行政复议法》第二十条,给出「六十日内」,显示检索过程 1 轮、引用分段 5、消耗 tokens 10559、耗时 1.71 秒
刷新页面左侧历史记录仍在,当轮问答与引用完整恢复,说明访客身份被复用而不是新建
关闭公开访问后重新打开链接页面提示服务暂不可用,提问入口不可用
重新开启公开访问链接恢复可用,历史记录仍在
重置访问令牌后访问旧链接认证接口返回「找不到应用」,旧链接失效
配置文件写入中文以外的语言取值返回「不支持的语言」,库内记录不变
越权写入用另一个普通账号读写他人应用的链接配置返回 403,管理员侧配置保持不变
越权提问用访客令牌请求管理接口返回 403,请求他人会话由会话归属校验拒绝

浏览器实测的问答页见本章第三节的截图,公开链接入口见第二节的截图。

十二、已知边界

  • 访客之间互不可见:同一个应用的两个访客各自只看到自己的会话,这是隔离的代价,也是打开公开链接时的预期行为。
  • 公开链接不绑定账号:拿到链接的人都能对话,需要限制时用白名单与访问次数配置;需要更强的准入时,应在反向代理或网关层再加一层校验。这两项配置的落地方式见嵌入第三方web系统。
  • 对话语言是界面语言:它不改变回答语言,回答语言由应用配置的模型与提示词决定。
  • 访客会话同样计入日志与清理策略:分享页产生的会话会出现在对话日志里,也会被保留天数策略清理,见对话日志。
  • 应用被删除后链接失效:访客名单与公开链接记录仍在库里,需要清理时可以按应用 ID 一并删除。

十三、部署提示

  • 分享地址使用浏览器当前地址拼接,因此用域名访问时分享出去的链接就是域名,不需要改配置;反向代理需要同时转发 /api 与 /ui/。
  • 公开链接的写入接口只允许应用所有者调用,越权请求在归属校验处被拒绝,不需要额外配置。
  • 数据库初始化脚本已包含 language 列的迁移,可重复执行;已有库执行一次即可。
  • 前端沿用官方界面即可对接上述接口,无需为分享页单独发布一个站点。
Edit this page
Last Updated: 10/6/26, 10:53 AM
Contributors: litongjava
Prev
api 管理
Next
嵌入第三方web系统