All Classes and Interfaces
Class
Description
帮助文档抽象基类
record for action and failed operations
操作日志记录处理
注意：不能在类上注解@Async，否则会获取不到 HttpServletRequest，attributes为空。
human agent, not ai agent
- agent：一对一人工客服，不支持机器人接待
- robot：机器人客服，不支持转人工
- workgroup：工作组，支持机器人接待，支持转人工
分表存储一对一客服消息
同步message中客服消息，包括uid。
接待状态变更记录
阿里云OSS对象存储服务工具类
参考
https://blog.csdn.net/MICHAELKING1/article/details/106058874
https://springdoc.cn/spring/core.html#aop
https://blog.csdn.net/MICHAELKING1/article/details/106058874
Pushy
帮助文档: 文章归档, 历史版本
Controller for "/article_archive".
帮助文档
Controller for "/article".
assistant - 如：文件助手
https://www.baeldung.com/get-user-in-spring-security
客户端扫码授权vip接口
访客端
扫码授权vip接口
访客验证
自动回复-固定自动回复，无匹配规则，直接回复。
自动回复-关键词匹配
头像常量, 可以去这里获取 https://www.iconfont.cn/
用户余额
Date -> ZonedDateTime ？
Date -> ZonedDateTime ？
基础请求类
所有请求类的父类，提供通用字段和方法
时间常用函数
File utilities.
Advisor for logging the request and response of the chat client.
高性能中文拼音转换工具
https://github.com/houbb/pinyin
https://mvnrepository.com/artifact/com.github.houbb/pinyin
https://github.com/houbb/pinyin/blob/master/src/test/java/com/github/houbb/pinyin/test/util/PinyinHelperTest.java
敏感词工具类
https://github.com/houbb/sensitive-word
https://mvnrepository.com/artifact/com.github.houbb/sensitive-word
https://mp.weixin.qq.com/s/7wSy0PuJLTudEo9gTY5s5w
Handles handshakes and messages
Allocate 64 bits for the UID(long)
sign (fixed 1bit) -> deltaSecond -> workerId -> sequence(within the same second)
sign (fixed 1bit) -> deltaSecond -> workerId -> sequence(within the same second)
black list
黑名单
https://github.com/alibaba/easyexcel
黑名单ip拦截器
注意：不能在类上注解@Async，否则会获取不到 HttpServletRequest，attributes为空。
黑名单用户拦截器
注意：不能在类上注解@Async，否则会获取不到 HttpServletRequest，attributes为空。
访客浏览网站记录
visitor website browse record
仅保留48小时内的浏览记录，超时则自动删除
Buffered UID provider(Lambda supported), which provides UID in the same one second
Represents an executor for padding
There are two kinds of executors: one for scheduled padding, the other for padding immediately.
RingBufferThere are two kinds of executors: one for scheduled padding, the other for padding immediately.
统一管理监控指标
缓存 常量
Represents a cached implementation of
UidGeneratorService extends
from DefaultUidGenerator, based on a lock free RingBufferhttps://github.com/alibaba/easyexcel
channel 频道 - 类似公众号
剪贴板
https://github.com/alibaba/easyexcel
ConcatenationDocumentJoiner
Pre-Retrieval: DocumentJoiner
https://java2ai.com/blog/spring-ai-alibaba-module-rag/?
https://dzone.com/articles/how-to-use-cookies-in-spring-boot
创建新策略：
1.
Pre-Retrieval: QueryAugmenter
https://java2ai.com/blog/spring-ai-alibaba-module-rag/?
客户留资，自动提取，手动添加
https://github.com/alibaba/easyexcel
https://docs.spring.io/spring-data/jpa/reference/repositories/projections.html
https://docs.spring.io/spring-ai/reference/api/tools.html#_requiredoptional
Post-Retrieval
处理从联网搜索种获得的 Document，以获得最佳输出。
https://docs.spring.io/spring-ai/reference/api/tools.html
Represents an implementation of
UidGeneratorService部门
Represents an implementation of
WorkerIdAssigner,
the worker id will be discarded after assigned to the UidGenerator抖店相关接口
抖店
https://developer.open-douyin.com/docs/resource/zh-CN/web-app/open-capacity/operation/customer-service/customer-service-introduce
https://developer.open-douyin.com/docs/resource/zh-CN/dop/develop/webhooks/summarize
微语互动
微语互动
https://developer.open-douyin.com/docs/resource/zh-CN/web-app/open-capacity/operation/customer-service/customer-service-introduce
https://developer.open-douyin.com/docs/resource/zh-CN/dop/develop/webhooks/summarize
小程序
对接抖音小程序：微语
https://developer.open-douyin.com/docs/resource/zh-CN/mini-app/open-capacity/operation/customer-service/customer-service-introduce
https://developer.open-douyin.com/docs/resource/zh-CN/dop/develop/webhooks/summarize
邮件模板
EnumUtils provides the operations for
ValuedEnum such as Parse, value of...储存不同VIP等级的答案内容
faq: Frequently Asked Questions
FAQ JSON文件加载器
用于从JSON文件中加载FAQ数据并解析成对象
FAQ实体类
对应JSON文件中的每个FAQ条目
FAQ配置类
对应JSON文件的根节点
简化版FAQ响应，用于相关问题展示，避免循环依赖
https://github.com/alibaba/easyexcel
文件导出Excel实体类
文件Excel导出服务
https://github.com/alibaba/easyexcel
Exception caused by accessing forbidden resources.
https://github.com/alibaba/easyexcel
灰度发布控制器
灰度发布配置
用于控制新功能的逐步放量
灰度发布功能枚举
功能使用统计
灰度发布指标实体
灰度发布指标服务
灰度发布服务
灰度发布状态
灰度发布策略
https://github.com/alibaba/easyexcel
for testing api
http://127.0.0.1:9003/swagger-ui/index.html
发票
发票
https://github.com/lionsoul2014/ip2region/blob/master/binding/java/ReadMe.md
https://github.com/alibaba/easyexcel
https://github.com/alibaba/easyexcel
https://github.com/lionsoul2014/ip2region/blob/master/binding/java/ReadMe.md
https://github.com/alibaba/easyexcel
域名管理，实现主备域名自动切换
for testing api
JMS 错误处理器
将 List 转换为 JSON 数组字符串进行存储
专门用于存储包含 JSON 的列表，避免使用逗号分隔导致的问题
返回结果
https://github.com/jwtk/jjwt#jws-create-key
知识库切面
kbase + space
TODO: delete event 删除相应网页
https://github.com/alibaba/easyexcel
http://127.0.0.1:9003/doc.html#/home
https://doc.xiaominfo.com/docs/quick-start
https://github.com/xiaoymin/knife4j?
功能特性枚举
授权类型枚举
MD5编码相关的类
https://spring.io/guides/tutorials/react-and-spring-data-rest/
https://docs.spring.io/spring-security/reference/
http://127.0.0.1:9003/swagger-ui/index.html
https://www.bezkoder.com/swagger-3-annotations/#Swagger_3_annotations
https://github.com/alibaba/easyexcel
https://github.com/alibaba/easyexcel
留言
https://github.com/alibaba/easyexcel
消息三要素：1.
消息三要素：1.
所有字段跟message.proto中字段一一对应
response for visitor init/request thread
distinguish visitor message from agent view
区分 访客端拉取的消息格式 和 客服端拉取到的消息格式
QuerydslPredicateExecutor
response for visitor init/request thread
distinguish visitor message from agent view
区分 访客端拉取的消息格式 和 客服端拉取到的消息格式
存储未读消息，减少message表查询压力
缓存每个用户该接收的消息，自己发送的消息自己不缓存
收到客户端的回执receipt后，删除该条缓存记录
客户端拉取之后，从表中删除该条记录
https://github.com/alibaba/easyexcel
https://github.com/alibaba/easyexcel
Various utilities for working with channels
存储常量
检测空闲连接和超时是为了及时释放资源: 在规定时间内没有收到来自客户端的任何packet，包括ping
常用的方法：
1.
会话存储
encrypt/security through nginx proxy
QueryExpander
Pre-Retrieval: QueryExpander
https://java2ai.com/blog/spring-ai-alibaba-module-rag/?
Named thread in ThreadFactory.
NetUtils
Resource not found
注意与message类型notice区分
https://github.com/alibaba/easyexcel
Generic handler for optimistic locking retry operations
功能模块购买记录
// @RepositoryRestResource(exported = false) // 隐藏接口
Represents a padded
AtomicLong to prevent the FalseSharing problemController for "/".
http://127.0.0.1:9003/swagger-ui/index.html
only used for development
页面服务，仅用于开发阶段
消费记录
消费记录
https://github.com/google/libphonenumber/
https://www.baeldung.com/java-libphonenumber
基于google的libphonenumber将手机号转成地区及供应商信息
提供基于PKCS7算法的加解密接口.
https://github.com/alibaba/easyexcel
https://github.com/alibaba/easyexcel
async push
https://www.baeldung.com/spring-async
https://spring.io/guides/gs/async-method
https://springdoc.cn/spring-boot-email/
https://springdoc.cn/spring/integration.html#mail
https://mailtrap.io/blog/spring-send-email/
https://www.thymeleaf.org/doc/articles/springmail.html
http://blog.didispace.com/springbootmailsender/
离线推送token
质检申诉
质检方案
质检方案-细分项
质检方案-细分项-评分
质检统计
任务调度通用常量
1天-运行一次，凌晨0点
1天-运行一次，每天8点
5 min job
5分钟定时任务
半小时-运行一次
1小时-运行一次，0分
1 min job
https://cloud.tencent.com/developer/article/1923722
队列成员状态枚举
队列统计信息
队列状态枚举
常用语-快捷回复
充值记录
cache config
https://docs.spring.io/spring-boot/reference/io/caching.html
https://docs.spring.io/spring-data/redis/reference/redis/redis-cache.html
https://docs.spring.io/spring-framework/reference/integration/cache/annotations.html#cache-spel-context
https://docs.spring.io/spring-boot/docs/3.2.0/reference/htmlsingle/#io.caching
https://www.51cto.com/article/753777.html
需要在redis配置文件中添加如下配置，开启过期事件：
notify-keyspace-events Ex
或者，在redis cli中执行如下命令：
CONFIG SET notify-keyspace-events Ex
Spring Data Redis - Pub/Sub Messaging
https://docs.spring.io/spring-data/redis/reference/redis/pubsub.html
https://redis.io/docs/latest/develop/interact/pubsub/
微信客服缓存
appid 添加、取消订阅，保存当前订阅，方便推送
appid 添加、取消订阅，保存当前订阅，方便推送
微信客服缓存
If tail catches the cursor it means that the ring buffer is full, any more buffer put request will be rejected.
If cursor catches the tail it means that the ring buffer is empty, any more buffer take request will be rejected.
https://github.com/alibaba/easyexcel
Re-Reading (Re2) Advisor
https://docs.spring.io/spring-ai/reference/api/advisors.html#_re_reading_re2_advisor
https://arxiv.org/pdf/2309.06275
Generic retry callback interface for database operations
Represents a ring buffer based on array.
Using array could improve read element performance due to the CUP cache line.
Using array could improve read element performance due to the CUP cache line.
- agent：一对一人工客服，不支持机器人接待
- robot：机器人客服，不支持转人工
- workgroup：工作组，支持机器人接待，支持转人工
分表存储一对一客服消息
同步message中客服消息，包括uid。
转化为json存储到message表中content字段
角色类型常量
大模型输出
https://java2ai.com/blog/spring-ai-alibaba-module-rag/?
客服对话统计数据：
组织、工作组、客服、机器人
可监控机器人的服务关键数据，包含解决率、评价满意度、服务转人工率、未知回答率、有效会话、当前生效知识等关键运营指标，可点击“详细指标”快速跳转至数据看板页面。
触发条件配置
示例JSON:
{
"conditions": [
{
"type": "no_response",
"timeout": 300
},
{
"type": "keyword_match",
"keywords": ["价格", "费用"],
"message": "您似乎对价格感兴趣，这里有一些相关信息..."
},
{
"type": "visit_count",
"threshold": 3,
"message": "欢迎您再次访问..."
},
{
"type": "page_stay",
"timeout": 300,
"message": "您似乎在浏览页面，需要帮助吗？"
https://docs.spring.io/spring-session/reference/guides/boot-redis.html
SHA1 class
计算公众平台的消息签名接口.
Split导出Excel实体类
spring ai rag
https://docs.spring.io/spring-ai/reference/api/retrieval-augmented-generation.html
Spring AI Alibaba
https://java2ai.com/docs/dev/get-started/
https://github.com/alibaba/spring-ai-alibaba
https://java2ai.com/docs/dev/tutorials/basics/chat-client/?
阿里通义千问接口
DeepSeek接口
Gitee接口
https://github.com/ollama4j/ollama4j
https://ollama4j.github.io/ollama4j/intro
https://ollama.com/
https://www.promptingguide.ai/
https://docs.spring.io/spring-ai/reference/api/embeddings/ollama-embeddings.html
空的 RedisVectorStore 实现，用于完全降级情况
Ollama接口
Prompt Engineering 提示词工程
AI应用的核心：提示词的好坏直接影响AI的回答质量
Prompt四个核心要点：
1.
AI服务接口
定义所有AI服务的通用方法
工具调用
https://docs.spring.io/spring-ai/reference/api/tools.html
大模型工具支持情况
https://docs.spring.io/spring-ai/reference/api/chat/comparison.html
https://open.bigmodel.cn/dev/api#sdk_install
https://github.com/MetaGLM/zhipuai-sdk-java-v4
https://docs.spring.io/spring-ai/reference/api/chat/zhipuai-chat.html
https://docs.spring.io/spring-ai/reference/api/embeddings/zhipuai-embeddings.html
智谱AI接口
https://open.bigmodel.cn/dev/api#sdk_install
https://github.com/MetaGLM/zhipuai-sdk-java-v4
https://docs.spring.io/spring-ai/reference/api/chat/zhipuai-chat.html
http://127.0.0.1:9003/swagger-ui/index.html
记录客服回复访客消息时间戳
https://github.com/alibaba/easyexcel
https://github.com/alibaba/easyexcel
跟踪记录thread更新链路
记录会话处理链路，从访客进入，接入客服，转接客服，结束会话、监控会话等，全部记录到数据库中
indicates when the broker becomes available/unavailable
https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#websocket-stomp-appplication-context-events
https://docs.spring.io/spring-framework/reference/web/websocket/stomp/enable.html
published shortly after a SessionConnectEvent when the broker has sent a
STOMP CONNECTED frame in response to the CONNECT
https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#websocket-stomp-appplication-context-events
客户端新连接建立通知
published when a new STOMP CONNECT is received indicating the start of a new
client session.
https://docs.spring.io/spring-framework/reference/web/websocket/stomp/handle-annotations.html
published when a STOMP session ends.
published when a new STOMP SUBSCRIBE is received.
published when a new STOMP UNSUBSCRIBE is received.
用于在线程间传递敏感词过滤相关的上下文
敏感词
Exception thrown when sensitive words are detected
敏感词过滤
注意：不能在类上注解@Async，否则会获取不到 HttpServletRequest，attributes为空。
敏感词过滤
注意：不能在类上注解@Async，否则会获取不到 HttpServletRequest，attributes为空。
Service for handling sensitive word filtering
https://github.com/alibaba/easyexcel
https://github.com/alibaba/easyexcel
腾讯云对象存储
文本导出Excel实体类
Handles handshakes and messages
客服会话完成服务
处理客服会话结束时的总结和归档功能
- 生成会话总结
- 记录会话统计数据
- 归档会话记录
thread: 指的是一系列相关的信息或讨论按照时间顺序排列形成的一个连贯的交流脉络.
客服会话流程执行监听器
监听客服会话流程的执行事件：
- 会话开始
- 会话结束
- 流程节点流转
人工客服服务
处理客服会话中的人工服务阶段
- 记录服务开始和结束时间
- 监控服务质量和SLA
- 处理人工服务过程中的事件
客服会话初始化服务
负责在客服会话流程开始时进行初始化操作
- 生成并记录必要的流程变量
- 记录会话开始时间和基本信息
- 设置默认处理策略
记录邀请记录：
客服邀请客服
客服邀请访客
Protobuf type
ThreadProtobuf type
Thread排队等待服务
处理客服会话中的排队机制
- 将访客加入队列
- 计算和更新排队位置
- 判断何时可以分配给客服
for agent client
机器人接待服务
处理客服会话中的机器人自动应答环节
- 接收访客消息
- 调用AI模块进行回复
- 判断是否需要转人工服务
客服会话满意度评价服务
处理客服会话结束时的满意度评价功能
- 发送满意度调查
- 收集满意度评价数据
- 处理评价反馈
SLA超时通知服务
处理客服会话中的SLA超时事件
- 记录超时信息
- 通知相关人员
- 处理升级策略
https://github.com/alibaba/easyexcel
客服会话流程任务监听器
监听客服会话任务的生命周期事件：
- 任务创建
- 任务分配
- 任务完成
- 任务删除
记录转接记录：
人工转接人工
机器人转人工
客服会话转接服务
处理客服会话中的转接功能
- 记录转接信息
- 查找合适的转接目标
- 处理转接过程
会话类型
升级工单
JavaDelegate 用于实现服务任务(Service Task)的业务逻辑，通常用于:
自动化处理
系统集成
外部服务调用
复杂业务规则执行
两种服务任务的区别：
SLA 超时：自动触发，基于时间
工单升级：人工触发，基于状态
用途：实现服务任务的具体业务逻辑
绑定位置：服务任务节点
主要场景：自动化处理、系统集成、规则执行
特点：一次性执行，完成特定业务功能
评估工单优先级
使用 ExecutionListener 处理流程执行和变量相关事件
ExecutionListener (执行监听器):
监听流程执行事件
事件类型：start、end、take
可以绑定到流程、活动、连线上
关注流程执行的生命周期
可以访问和修改流程变量
适合处理流程级别的业务逻辑
用途：监听流程执行的生命周期事件
绑定位置：流程定义、活动节点、连线
主要场景：流程级别的监控和处理
特点：可以访问和修改流程变量
工单表单管理接口
主要功能：
支持内置表单和外部表单
表单属性类型支持：string、long、enum、date等
支持必填校验
支持表单数据的保存和提交
支持动态获取表单定义
支持表单历史数据查询
使用表单的好处：
规范数据录入
方便数据验证
提供统一的表单处理机制
支持表单数据历史记录
工单用户和组管理
使用场景：
用户管理：
同步业务系统用户到 Flowable
管理用户信息和状态
用户认证和授权
组管理：
同步业务系统组织架构
管理工作组和角色
权限分配
关系管理：
维护用户和组的关系
支持多组织架构
灵活的权限控制
这样就能将业务系统的用户和组织架构与 Flowable 的工作流权限体系完美对接。
工单流程
SLA超时通知
两种服务任务的区别：
SLA 超时：自动触发，基于时间
工单升级：人工触发，基于状态
TaskListener (任务监听器):
监听任务相关事件
事件类型：create、assignment、complete、delete
只能绑定到用户任务上
关注任务的生命周期
可以访问和修改任务相关信息
适合处理任务级别的业务逻辑
用途：监听用户任务的生命周期事件
绑定位置：只能绑定到用户任务
主要场景：任务级别的监控和处理
特点：可以访问和修改任务相关信息
https://github.com/alibaba/easyexcel
可用于强制用户重新登录，或者刷新token
access_token or refresh_token
授权验证token时，不只是使用jwt解码验证，还需要跟数据库中进行对比，如果token被禁用或者过期，则拒绝访问
存储第三方access_token，refresh_token，过期时间等，微信，qq等第三方授权登录
日志链路跟踪
https://developer.aliyun.com/article/1581355?
翻译接口
https://fanyi-api.baidu.com/doc/21
翻译记录
https://github.com/wujun234/uid-generator-spring-boot-starter
UID 的自动配置
UidGenerateException
Entity for M_WORKER_NODE
https://github.com/wujun234/uid-generator-spring-boot-starter
Represents a unique id generator.
DAO for M_WORKER_NODE
UID 的配置
https://github.com/wujun234/uid-generator-spring-boot-starter/blob/master/README.md
UidGenerator接口提供了 UID 生成和解析的方法，提供了两种实现:
file upload - 文件上传, https://spring.io/guides/gs/uploading-files
文件上传接口，可匿名访问
短链控制器
https://wankhedeshubham.medium.com/spring-boot-security-with-userdetailsservice-and-custom-authentication-provider-3df3a188993f
Exception caused by disabled user.
SmartInitializingSingleton：适用于需要确保在 ApplicationContext 初始化之后再执行的初始化逻辑。
Protobuf type
UserProtobuf type
User所有字段跟user.proto中字段一一对应
https://spring.io/guides/tutorials/react-and-spring-data-rest/
You do NOT want this repository exposed for REST operations!
ValuedEnum defines an enumeration which is bounded to a value, you
may implements this interface when you defines such kind of enumeration, that
you can use EnumUtils to simplify parse and valueOf operation.filter blocked visitor
visitor no need to login, without login can reduce the press of the database
分表存储客服消息
同步message中客服消息，包括uid。
TODO: 监听message中客服消息，包括uid。
used for agent client
anonymous api, no need to login
同步thread中客服会话，包括uid。
https://docs.spring.io/spring-ai/reference/api/tools.html#_dynamic_specification_bean
DocumentRetriever
Pre-Retrieval: DocumentRetriever 用于在检索之前对查询进行预处理，例如通过自定义逻辑过滤或修改查询。
https://github.com/pengjinning/spring-boot-3-jwt-security
https://github.com/pengjinning/spring-boot-spring-security-jwt-authentication
https://dev.to/jean_claude_van_debug/spring-security-mutliple-authentication-providers-new-spring-boot-3-e1j
网站导出Excel实体类
https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#websocket-server
视频号
微信客服接口
微信公众号
客服消息：https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Service_Center_messages.html#7
小程序
小程序-微信访客
公众号-客服账号
公众号-客服账号
公众号-客服账号
公众号-客服账号
公众号-客服账号
公众号-客服账号
微信公众号
客服消息：https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Service_Center_messages.html#7
直接通过提供URL对接公众号
接口权限说明
https://developers.weixin.qq.com/doc/offiaccount/Getting_Started/Explanation_of_interface_privileges.html
公众号免费测试链接：
https://mp.weixin.qq.com/debug/cgi-bin/sandboxinfo?
公众号：直接通过提供URL对接公众号
测试号：https://mp.weixin.qq.com/debug/cgi-bin/sandboxinfo?
公众号-标签
微信访客
微信授权登录
微信开放平台
对接微信开放平台，授权方式对接, https://open.weixin.qq.com/, 第三方平台
萝卜丝web-配置（萝卜丝公众号）
企业微信
Represents a worker id assigner for
DefaultUidGeneratorWorkerNodeType
CONTAINER: Such as Docker
ACTUAL: Actual machine
WorkgroupEntity和skills的区别主要在于:
- 组织结构 vs 能力标签
- WorkgroupEntity是组织结构层面的分组,比如"售前组"、"售后组"、"技术支持组"等
- Skills是能力标签层面的标识,比如"Java"、"Python"、"数据库"等技术能力
WorkgroupEntity和agent的区别主要在于:
- agent：一对一人工客服，不支持机器人接待
- robot：机器人客服，不支持转人工
- workgroup：工作组，支持机器人接待，支持转人工
分表存储技能组客服消息
同步message中客服消息，包括uid。
每种算法都有其适用场景：
轮询：客服能力相近
最小活动数：负载敏感
随机：简单场景
加权随机：重视服务质量
一致性哈希：需要服务连续性
最快响应：重视响应速度
工作组路由服务
根据工作组路由模式选择客服
提供接收和推送给公众平台消息的加解密接口(UTF8编码的字符串).
常量
交易保障
2018/7/3
XMLParse class
提供提取消息格式中的密文及生成回复消息格式的接口.