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) 生成方案
  • 数据库与数据访问

    • 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 网页扫码)
      • 支付宝:电脑网站支付接入指南
      • 支付宝:使用 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 MaxKB 知识库文档
      • 学术论文
      • 数据库设计
      • 用户登录实现
      • 模型管理
      • 知识库管理
      • 文档拆分
      • 片段向量
      • 命中测试
      • 文档管理
      • 片段管理
      • 问题管理
      • 应用管理
      • 向量检索
      • 推理问答
      • 问答模块
      • 统计分析
      • 用户管理
      • VL模型文档解析方案和费用对比
      • 文档解析模型实测
      • 文档解析优化
      • 片段汇总
      • 段落分块与检索
      • 多文档解析
      • 检索性能优化
      • 对话日志
      • 创建独立用户与账号资源管理
      • api 管理
      • 独立对话页
      • 嵌入第三方web系统
      • 分段预览
      • 文档预览
      • 上下文压缩
      • 隔离 Python 执行环境配置
      • 离线运行向量模型
      • Milvus
      • 存储文件到云存储
      • /zh/61_knowledge-base/88.html
    • 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 源码解析

函数库与调用接口

  • 一、存储
  • 二、接口
  • 三、参数
    • 调试请求
    • 类型与合并规则
    • 参数来源与校验
    • 初始化参数的保护
  • 四、执行
    • 调试与执行的区别
    • Java 侧调用
  • 五、内置函数模板
  • 六、导出与导入
  • 七、图标
  • 八、返回与错误
  • 九、前端适配
  • 十、验证
  • 相关章节

函数库保存用户自己写的 Python 函数,并提供调试、语法检查、执行、导出导入和图标管理。执行环境与执行器实现分别见隔离 Python 执行环境配置和隔离 Python 执行器。

Java MaxKB 的函数库与前端界面是同一套契约:列表分页、参数定义、初始化参数、内置模板、导出导入都在这一层对齐,官方前端的函数库页面可以整体复用。

函数库列表:创建、导入、搜索、启用开关与更多操作

一、存储

迁移脚本 scripts/012-function-lib-fields.sql 补齐函数类型、图标和模板来源三个字段,scripts/013-function-lib-templates.sql 写入内置函数模板。两个脚本都可以重复执行,已有数据保留:

.\scripts\Initialize-Database.ps1 -PostgresBin '<PostgreSQL安装目录>\bin'
BEGIN;

ALTER TABLE max_kb_function_lib ADD COLUMN IF NOT EXISTS function_type VARCHAR(16) NOT NULL DEFAULT 'PUBLIC';
ALTER TABLE max_kb_function_lib ADD COLUMN IF NOT EXISTS icon VARCHAR(256) NOT NULL DEFAULT '/ui/favicon.ico';
ALTER TABLE max_kb_function_lib ADD COLUMN IF NOT EXISTS template_id BIGINT;

DO $$
BEGIN
  IF NOT EXISTS (SELECT 1 FROM pg_constraint WHERE conname = 'max_kb_function_lib_function_type_check') THEN
    ALTER TABLE max_kb_function_lib
      ADD CONSTRAINT max_kb_function_lib_function_type_check CHECK (function_type IN ('PUBLIC', 'INTERNAL'));
  END IF;
END $$;

CREATE INDEX IF NOT EXISTS idx_function_type ON max_kb_function_lib(function_type) WHERE deleted = false;

COMMIT;
字段含义
id雪花 ID,内置模板用 1001 到 1005 这类固定编号
user_id归属用户;内置模板归系统管理员,只用来标记来源
name / desc名称与描述
code函数源码
input_field_list调用参数定义(名称、类型、是否必填、来源)
init_field_list初始化参数定义,结构交给动态表单渲染
init_params初始化参数值,按函数保存
permission_typePRIVATE 或 PUBLIC
function_typePUBLIC 是用户函数,INTERNAL 是内置模板
icon图标路径,默认 /ui/favicon.ico
template_id从哪个内置模板复制而来,自己创建的函数为空
is_active是否启用
deleted软删除标记

删除是软删除(deleted=true),同时清掉 template_id;已保存的函数可以随时重新启用。

列表和详情都按同一条可见性规则筛选,SQL 直接写成一段文本块,参数按占位符顺序绑定:

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

/** 列表和详情共用的查询条件:自己的函数加上别人公开的函数。 */
private static final String VISIBLE_WHERE = """
    from max_kb_function_lib
     where deleted = false
       and (user_id = ? or permission_type = 'PUBLIC')
    """;

/** 查询条件按占位符顺序累积,分页和列表共用。 */
private static final class Query {
  private String where;
  private final List<Object> params = new ArrayList<>();

  private Query(String where) {
    this.where = where;
  }
}

二、接口

接口都要求登录,并且只允许操作自己的函数;别人的公开函数只能读、复制、执行:

方法与路径功能
GET /api/function_lib函数列表,最多 100 条
GET /api/function_lib/{page}/{size}分页函数列表,size 上限 100
POST /api/function_lib创建函数,新建后默认停用
GET /api/function_lib/{id}查看函数
PUT /api/function_lib/{id}修改自己的函数
DELETE /api/function_lib/{id}软删除自己的函数
POST /api/function_lib/debug调试尚未保存的代码
POST /api/function_lib/pylint语法检查,返回行列诊断
POST /api/function_lib/{id}/execute执行自己保存且已启用的函数
POST /api/function_lib/{id}/add_internal_fun把内置模板复制成自己的函数
GET /api/function_lib/{id}/export导出 .fx 文件
POST /api/function_lib/import导入 .fx 文件
PUT /api/function_lib/{id}/edit_icon上传图标
GET /api/function_lib/icon/{name}读取图标,不要求登录

列表接口支持三个查询参数,可以组合使用:

参数含义
name按名称模糊匹配(ilike)
function_typePUBLIC 或 INTERNAL,界面上的两个页签就是靠它区分
select_user_id只看某个用户的函数

pylint 只在执行环境里做语法检查,返回前端可用的行列信息,不等同于完整 Pylint 规则集。保存函数时也接受部分字段:只提交 is_active、只提交 permission_type 或只提交 init_params 时,其余字段沿用库里的原值,界面上的启用开关和权限弹窗就是这么用的。

三、参数

调试请求

编辑器里的"调试"按钮打开的是一个独立抽屉:上面按 init_field_list 渲染启动参数,下面按 input_field_list 渲染输入参数,点"运行"就调一次调试接口,结果直接显示返回值或原始异常。

函数调试:填 2 和 40,运行成功并返回 42

POST /api/function_lib/debug 的请求体沿用原版前端的字段结构:

{
  "code": "def add(a, b):\n    return a + b",
  "entrypoint": "add",
  "init_params": { "a": 1, "b": 1 },
  "input_field_list": [
    { "name": "a", "type": "int", "is_required": true },
    { "name": "b", "type": "int", "is_required": true }
  ],
  "debug_field_list": [
    { "name": "a", "value": "2" },
    { "name": "b", "value": "40" }
  ]
}

init_params 是保存函数时带下来的初始值;debug_field_list 是这次调试输入的值,按字段名覆盖初始值;input_field_list 决定字段类型和必填校验。上例返回 42。

合并规则在 Java 侧完成,必填校验也放在这里,缺参数时根本不会启动执行环境:

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

/** 调试未保存的代码:先合并参数,再交给执行器,异常信息直接返回给界面。 */
public Object debug(JSONObject input) {
  JSONObject params = input.getJSONObject("init_params");
  params = params == null ? new JSONObject() : new JSONObject(params);
  JSONObject debug = new JSONObject();
  JSONArray values = input.getJSONArray("debug_field_list");
  if (values != null) {
    for (Object item : values) {
      JSONObject field = (JSONObject) item;
      debug.put(field.getString("name"), field.get("value"));
    }
  }
  JSONArray fields = input.getJSONArray("input_field_list");
  if (fields != null) {
    for (Object item : fields) {
      JSONObject field = (JSONObject) item;
      String name = field.getString("name");
      Object value = debug.get(name);
      if (value instanceof String text && text.isBlank()) {
        value = null;
      }
      if (value == null) {
        if (field.getBooleanValue("is_required")) {
          throw new IllegalArgumentException("缺少函数参数:" + name);
        }
        params.remove(name);
        continue;
      }
      params.put(name, convert(value, field.getString("type")));
    }
  }
  return Aop.get(IsolatedPythonExecutor.class).execute(input.getString("code"), params, input.getString("entrypoint"), false);
}

类型与合并规则

支持 string、int、float、dict、array 五种类型,转换在 Java 侧完成:

类型转换结果
intLong
floatDouble
dictJSON 对象
arrayJSON 数组
其它/string字符串
static Object convert(Object value, String type) {
  if (value == null) {
    return null;
  }
  return switch (type == null ? "string" : type) {
    case "int" -> Long.valueOf(value.toString().trim());
    case "float" -> Double.valueOf(value.toString().trim());
    case "dict" -> JSON.parseObject(value.toString());
    case "array" -> JSON.parseArray(value.toString());
    default -> value.toString();
  };
}

保存函数的初始化参数与调用参数合并后一起传入 Python,调用参数优先。必填字段缺失时直接拒绝,返回 缺少函数参数:<名称>,不会进入执行环境。公开函数的列表接口不会向其他用户返回 init_params 的值。

入口函数规则:请求里给了 entrypoint 就用它,否则取源码中最后一个顶层函数;两者都取不到时返回"代码需要至少一个顶层函数"。

参数来源与校验

调用参数除了名称、类型、是否必填,还有 source 字段:custom 表示调用时手填,reference 表示由上游节点传入。保存前的校验集中在 validate 里,返回 null 表示通过:

/** 保存前的字段校验,返回 null 表示通过。 */
static String validate(JSONObject data) {
  String name = data.getString("name");
  if (name == null || name.isBlank() || name.trim().length() > MAX_NAME_LENGTH) {
    return "函数名称不能为空且不能超过 64 个字符";
  }
  String code = data.getString("code");
  if (code == null || code.isBlank()) {
    return "函数代码不能为空";
  }
  if (code.getBytes(java.nio.charset.StandardCharsets.UTF_8).length > MAX_CODE_LENGTH) {
    return "函数代码不能超过 64 KiB";
  }
  JSONArray fields = data.getJSONArray("input_field_list");
  if (fields != null) {
    for (Object item : fields) {
      if (!(item instanceof JSONObject field)) {
        return "调用参数格式无效";
      }
      String type = field.getString("type");
      String source = field.getString("source");
      if (type != null && !FIELD_TYPES.contains(type)) {
        return "参数类型只支持 string、int、float、dict、array";
      }
      if (source != null && !FIELD_SOURCES.contains(source)) {
        return "参数来源只支持 custom、reference";
      }
    }
  }
  return null;
}
限制项取值
函数名称最长 64 个字符
函数描述最长 128 个字符
函数代码最长 64 KiB(按 UTF-8 字节数)
参数类型string、int、float、dict、array
参数来源custom、reference
权限类型PRIVATE、PUBLIC
图标不超过 10 MB,支持 png、jpg、gif、webp、bmp

初始化参数的保护

初始化参数里经常放 API Key 和数据库口令,所以界面拿到的密码类字段是打过码的,只保留首尾片段:

/** 保留前 2 位和后 4 位,中间用固定长度的星号占位。 */
static String mask(String secret) {
  String prefix = secret.substring(0, Math.min(2, secret.length()));
  String suffix = secret.length() > 4 ? secret.substring(secret.length() - 4) : "";
  return prefix + "********" + suffix;
}

详情里的打码值会被界面原样回传(例如只切换启用开关、只改权限时)。提交值和当前值的打码结果一致,说明用户没有改动,继续沿用库里的真实值,不会把星号写回库:

/**
 * 详情里的密码类初始化参数是打过码的,界面原样回传时不能把星号写回库。
 *
 * <p>提交值和当前值的打码结果一致,说明用户没有改动,继续沿用库里的原值。
 */
private void restoreMaskedSecrets(Row existing, JSONObject data) {
  if (!(data.get("init_params") instanceof JSONObject submitted) || submitted.isEmpty()) {
    return;
  }
  JSONObject current = parseObject(existing.getObject("init_params"));
  for (String key : submitted.keySet()) {
    Object value = submitted.get(key);
    Object stored = current.get(key);
    if (stored != null && value != null && mask(stored.toString()).equals(value.toString())) {
      submitted.put(key, stored);
    }
  }
}

初始化字段被删掉后,库里残留的同名值不会再传给 Python:

/** 初始化参数只保留仍在初始化字段列表里的键。 */
static JSONObject normalizeInitParams(JSONObject data, String initFieldsJson) {
  JSONObject params = data.getJSONObject("init_params");
  params = params == null ? new JSONObject() : new JSONObject(params);
  JSONArray fields = JSON.parseArray(initFieldsJson);
  List<String> keys = new ArrayList<>();
  for (Object item : fields) {
    if (item instanceof JSONObject field && field.getString("field") != null) {
      keys.add(field.getString("field"));
    }
  }
  params.keySet().removeIf(key -> !keys.contains(key));
  return params;
}

四、执行

POST /api/function_lib/{id}/execute 执行自己保存且启用的函数,请求体是调用参数对象,内部合并该函数的 init_params 后交给执行器。函数不存在、已停用或不属于当前用户时直接拒绝。

/**
 * 执行自己保存且启用的函数,请求体是调用参数,内部会合并函数自己的初始化参数。
 *
 * <p>同时作为 Java 侧工作流函数节点的共享入口。
 */
public Object execute(Long user, Long id, JSONObject arguments) {
  Row row = Db.findFirst("select * from max_kb_function_lib where id=? and user_id=? and deleted=false", id, user);
  if (row == null || !Boolean.TRUE.equals(row.getBoolean("is_active"))) {
    throw new IllegalArgumentException("函数不存在、已停用或无权执行");
  }
  JSONObject params = parseObject(row.getObject("init_params"));
  if (arguments != null) {
    params.putAll(arguments);
  }
  return Aop.get(IsolatedPythonExecutor.class).execute(row.getStr("code"), params, null, false);
}

请求体就是调用参数本身,没有外层包装:

{ "a": 2, "b": 40 }

返回 {"code":200,"data":42}。

调试与执行的区别

两条路径共用同一个执行器,但入口参数不同,出错时的文案来源也不同:

调试接口执行接口
代码来源请求体里的 code库里保存的 code
必填校验Java 侧校验,缺失直接拒绝不校验,缺参数由 Python 抛 TypeError
初始化参数请求体的 init_params库里保存的 init_params
启用状态不要求必须启用
权限只要求登录只允许函数归属用户
入口函数请求体的 entrypoint,缺省取最后一个顶层函数始终取最后一个顶层函数

调试路径的必填校验更严格,是为了让编辑者在界面上立刻看到"缺少函数参数:a";执行路径面向已经配好的函数,直接把 Python 的原生异常信息透出来更有助于排查(实测缺 b 时返回 add() missing 1 required positional argument: 'b')。

Java 侧调用

保存的函数也可以被后续工作流节点复用:共享入口是 PythonFunctionService.execute,由节点传入应用侧参数。节点实现里按 id 取函数、把上游节点的输出组装成 arguments 即可,不需要再走 HTTP:

import com.alibaba.fastjson2.JSONObject;
import nexus.io.jfinal.aop.Aop;
import nexus.io.maxkb.service.kb.PythonFunctionService;

/** 把上游节点的输出当作调用参数,直接调函数。 */
JSONObject arguments = new JSONObject();
arguments.put("query", upstreamNode.getStr("query"));
Object result = Aop.get(PythonFunctionService.class).execute(userId, functionId, arguments);

这只是一个可复用的执行入口,不代表任意原版工作流节点都已经兼容;已经保存的函数需要先启用(is_active=true),否则会直接拒绝。

这个接口目前只面向 Java 侧调用方,前端界面没有对应入口(编辑器走的是调试与语法检查两条路径)。

五、内置函数模板

内置模板是 function_type=INTERNAL 的公开只读函数,界面上的"内置函数"页签读的就是它们。模板本身不允许改动,界面上的"添加"会调用 POST /api/function_lib/{id}/add_internal_fun,把它复制成自己的私有函数,再按需改代码和参数:

内置函数:博查搜索、Google Search、LangSearch、MySQL 与 PostgreSQL 查询

/**
 * 内置函数模板复制一份给自己的函数。
 *
 * <p>复制出来的函数只有名字是新的,代码和参数沿用模板,模板 id 记下来后界面会把它当成模板来源。
 */
public ResultVo addInternal(Long user, Long templateId, String name) {
  String trimmed = name == null ? null : name.trim();
  if (trimmed == null || trimmed.isBlank() || trimmed.length() > MAX_NAME_LENGTH) {
    return ResultVo.fail("函数名称格式无效");
  }
  Row source = Db.findFirst("select * from max_kb_function_lib where id=? and deleted=false", templateId);
  if (source == null || !"INTERNAL".equals(source.getStr("function_type"))) {
    return ResultVo.fail("函数模板不存在");
  }
  long id = SnowflakeIdUtils.id();
  Db.update("""
      insert into max_kb_function_lib(id,user_id,name,"desc",code,input_field_list,init_field_list,init_params,
        permission_type,is_active,icon,function_type,template_id)
      values(?,?,?,?,?,?::jsonb,?::jsonb,'{}'::jsonb,'PRIVATE',false,?,'PUBLIC',?)
      """, id, user, trimmed, source.getStr("desc"), source.getStr("code"),
      Objects.toString(source.getObject("input_field_list"), "[]"),
      Objects.toString(source.getObject("init_field_list"), "[]"), source.getStr("icon"), templateId);
  return get(user, id);
}
模板初始化参数作用
博查搜索apikey调用博查搜索接口,返回网页结果
Google Searchapikey、cx调用 Google 自定义搜索
LangSearchapikey调用 LangSearch 网页搜索
MySQL 查询host、port、user、password、database连接 MySQL 执行 SQL,结果转成 JSON
PostgreSQL 查询host、port、user、password、database连接 PostgreSQL 执行 SQL,结果转成 JSON

复制出来的函数默认是私有、停用的。停用状态下界面会提示先补全初始化参数,填完再启用,避免把没配好密钥的函数暴露给其他用户。

模板里的调用参数沿用上游写法:source 是 reference,表示由上游节点传入查询语句或 SQL,调用方不用手填。

内置模板需要 requests、pymysql、psycopg2 之类的第三方包,是否可用取决于执行镜像;默认镜像只有 Python 标准环境,需要这些模板时要按隔离 Python 执行环境配置准备一个预装依赖的镜像。

六、导出与导入

导出走 GET /api/function_lib/{id}/export,下载一个 .fx 文件,文件名取自函数名。文件里只带函数本身,不带归属、启用状态和图标:

{
  "version": "v1",
  "name": "add",
  "desc": "两数相加",
  "code": "def add(a, b):\n    return a + b",
  "input_field_list": [{ "name": "a", "type": "int", "is_required": true }],
  "init_field_list": []
}

导入走 POST /api/function_lib/import,multipart 的 file 字段带 .fx 文件。导入结果是自己的私有函数,默认停用:

/** 导入 .fx 文件,导入结果是自己的私有函数,默认停用。 */
public ResultVo importFunction(Long user, UploadFile file) {
  if (file == null || file.getData() == null || file.getData().length == 0) {
    return ResultVo.fail("请选择要导入的文件");
  }
  JSONObject payload;
  try {
    payload = JSON.parseObject(new String(file.getData(), java.nio.charset.StandardCharsets.UTF_8));
  } catch (RuntimeException e) {
    return ResultVo.fail("不支持的文件格式");
  }
  if (payload == null || !EXPORT_VERSION.equals(payload.getString("version"))) {
    return ResultVo.fail("不支持的文件格式");
  }
  JSONObject input = new JSONObject();
  input.put("name", payload.getString("name"));
  input.put("desc", payload.getOrDefault("desc", ""));
  input.put("code", payload.getString("code"));
  input.put("input_field_list", payload.getOrDefault("input_field_list", new JSONArray()));
  input.put("init_field_list", payload.getOrDefault("init_field_list", new JSONArray()));
  input.put("permission_type", "PRIVATE");
  input.put("is_active", false);
  return save(user, null, input);
}

导入时会先校验 version 和必需字段,版本不认识或内容不是合法 JSON 时返回"不支持的文件格式",不会写入半条记录。

七、图标

PUT /api/function_lib/{id}/edit_icon 接收 multipart 的 file 字段,图片落到静态资源目录,库里只存访问路径:

/**
 * 保存上传的图标并返回可访问路径。
 *
 * @return 形如 {@code /api/function_lib/icon/<文件名>} 的路径
 */
public String save(UploadFile file) {
  if (file == null || file.getData() == null || file.getData().length == 0) {
    throw new IllegalArgumentException("请选择要上传的图片");
  }
  if (file.getData().length > MAX_ICON_BYTES) {
    throw new IllegalArgumentException("图标不能超过 10 MB");
  }
  String suffix = suffix(file.getName());
  if (!ALLOWED_SUFFIX.contains(suffix)) {
    throw new IllegalArgumentException("图标只支持 png、jpg、gif、webp 格式");
  }
  String name = UUID.randomUUID().toString().replace("-", "") + "." + suffix;
  try {
    Path directory = Paths.get(STATIC_LOCATION, ICON_DIR);
    Files.createDirectories(directory);
    Files.write(directory.resolve(name), file.getData());
  } catch (IOException e) {
    throw new IllegalStateException("图标保存失败:" + e.getMessage(), e);
  }
  return "/api/function_lib/icon/" + name;
}

读取图标走 GET /api/function_lib/icon/{name},不要求登录:图标要出现在函数列表、工作流节点和第三方嵌入页里,登录态不能成为渲染前提。文件名是随机串,读取前先按规则校验,目录穿越和任意文件读取都会被挡掉:

/** 文件名规则:随机十六进制串加白名单后缀,读取时用它挡住目录穿越。 */
private static final String FILE_NAME = "[0-9a-f]{32}\\.(png|jpg|jpeg|gif|webp|bmp)";

/**
 * 读取图标内容。
 *
 * @return 文件不存在或名称不合法时返回 null
 */
public byte[] read(String name) {
  if (name == null || !name.matches(FILE_NAME)) {
    return null;
  }
  Path path = Paths.get(STATIC_LOCATION, ICON_DIR, name);
  try {
    return Files.exists(path) ? Files.readAllBytes(path) : null;
  } catch (IOException e) {
    return null;
  }
}

静态资源目录由 server.resources.static-locations 指定,图标存在它的 ui/fx/upload 子目录下。内置模板的图标是前端自带的 /ui/fx/<模板名>/icon.png,两者都按普通图片路径使用,不需要额外接口。

八、返回与错误

调试接口返回函数返回值本身,执行单元内部的异常会作为失败信息返回,便于前端直接展示:

情况返回
正常返回{"code":200,"data":<返回值>}
函数内异常division by zero 之类的原始信息
缺少必填参数缺少函数参数:a
没有顶层函数代码需要至少一个顶层函数
入口函数不存在入口函数不存在
返回值超过 256 KiB函数返回结果超过 256 KiB
代码超过 64 KiBPython 代码不能为空且不能超过 64 KiB
语法检查命中错误行列诊断列表(不是失败响应)
情况返回
函数不存在或无权访问函数不存在或无权访问
修改别人的函数函数不存在或无权修改
执行停用或不存在的函数函数不存在、已停用或无权执行
名称或代码格式无效函数名称不能为空且不能超过 64 个字符 / 函数代码不能为空
参数类型或来源不支持参数类型只支持 string、int、float、dict、array / 参数来源只支持 custom、reference
权限类型不支持无效的函数权限类型
模板不存在函数模板不存在
导入文件格式不对不支持的文件格式
图标格式或大小不对图标只支持 png、jpg、gif、webp 格式 / 图标不能超过 10 MB

执行环境不可用时的错误文案见隔离 Python 执行器第五节。

九、前端适配

函数库页面直接复用官方前端,只有两处按 Java 侧的数据结构做了调整:

  • 复制出来的函数可以正常编辑。 从内置模板复制来的函数带 template_id,官方前端会把它当成"模板转换来的、不可编辑",自己的函数反而看不到图标和编辑入口。现在按 user_id 判断归属:自己的函数一律可编辑,别人的公开函数是只读,菜单里只留复制。
  • 开发态代理补上静态资源目录。 知识库原文件由后端静态服务按"目录名加相对路径"提供,开发态的 Vite 配置里补了 /pages 代理;生产部署时由反向代理转发同名路径。函数图标走的是 /api/function_lib/icon/,已经在 /api 代理覆盖范围内,不需要额外配置。

函数编辑抽屉:初始化参数、调用参数、代码与调试入口

十、验证

mvn '-Dtest=PythonFunctionServiceTest' '-Dsurefire.failIfNoSpecifiedTests=false' '-Dmaven.javadoc.skip=true' '-Dgpg.skip=true' test

PythonFunctionServiceTest 覆盖参数类型转换、上游遗留的字段写法还原、初始化参数裁剪、保存前校验和密码打码共 5 项;IsolatedPythonExecutorTest 的 19 项覆盖执行器的隔离、限制与失败路径。

接口层已在运行实例上核对过:按上面的字段结构调试 2 + 40 得到 42;缺少必填参数返回"缺少函数参数";函数内 1/0 返回 division by zero;返回 300000 字符的字符串被拒绝;pylint 对语法错误返回行列信息;无顶层函数被拒绝;执行结束后远程引擎上没有残留的执行容器。这些结果与隔离 Python 执行器记录的失败语义一致。

本轮另外核对了函数库自身的接口:

操作观察结果
GET /api/function_lib?function_type=INTERNAL返回 5 个内置模板,图标与初始化字段数量正确
GET /api/function_lib?function_type=PUBLIC只返回用户函数,且列表里没有 init_params
GET /api/function_lib/{id}详情带 init_params,密码类字段已打码
POST /api/function_lib/{id}/add_internal_fun复制出私有、停用的函数,template_id 指向模板
PUT /api/function_lib/{id}保存初始化参数后启用成功,再次提交打码值不会覆盖真实口令
POST /api/function_lib/pylint正确代码返回空诊断;漏写冒号返回 {"line":1,"column":13,"endLine":1,"endColumn":15,"message":"expected ':'","type":"error"}
POST /api/function_lib/{id}/execute{"a":2,"b":40} 返回 42;缺 b 时返回 add() missing 1 required positional argument: 'b'
GET /api/function_lib/{id}/export200,响应头为 attachment 且文件名按 UTF-8 百分号编码,正文为 v1 结构
POST /api/function_lib/import导入得到私有、停用的函数
PUT /api/function_lib/{id}/edit_icon上传 png 成功,返回 /api/function_lib/icon/<文件名>
GET /api/function_lib/icon/{name}不带令牌也能取到图片,类型为 image/png
界面核对"内置函数"页签显示 5 个模板,图标与"添加"按钮均正常;调试抽屉填 2 和 40 返回 42

相关章节

  • 隔离 Python 执行环境配置:Docker over TCP、宿主沙箱与边界对比。
  • 隔离 Python 执行器:交换协议、资源限制与失败语义。
  • api 管理:应用与账号级 API Key。
  • 对话日志:问答记录、检索轨迹与导出。
Edit this page
Last Updated: 10/3/26, 12:44 PM
Contributors: litongjava