2. SpringAI 使用Redis完成会话记忆和会话历史功能

前言SpringAI默认提供的会话记忆功能是基于内存的。如果程序重新启动那么会话记忆和会话历史都会失。但是SpringAI也提供了会话记忆和会话历史的持久化做法只不过只是提供的接口具体需要用户自己实现。这里就使用Redis进行持久化。Maven依赖dependency groupIdorg.springframework.ai/groupId artifactIdspring-ai-starter-model-openai/artifactId version1.0.1/version /dependency dependency groupIdorg.projectlombok/groupId artifactIdlombok/artifactId version1.18.22/version /dependency dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-data-redis/artifactId /dependencyYaml配置spring: application: name: demo-ai ai: openai: base-url: https://api.deepseek.com/ api-key: chat: options: model: deepseek-reasoner temperature: 0.7 data: redis: host: localhost port: 6379这里需要配置openAI的相关配置base-url模型的地址api-keyapply for an API key调用远程模型时一般都是收费的如果是本地模型可以没有这个配置model选择的远程模型种类temperature温度意思就是回答的随机性值越大回答的随机性越大这和Transformer神经网络的推理模式有关根据前文推测出接下来的一个词语后把这个词语加入前文再次交给大模型处理推测下一个字然后不断重复前面的过程就可以生成大段的内容了。redis的相关配置portredis主机地址portredis端口passwordredis密码(如果有配置就写没配置就不用管)SpringBoot配置类Configuration public class CommonConfiguration { Bean(chatClient) public ChatClient chatClient(OpenAiChatModel model, ChatMemory chatMemory) { return ChatClient.builder(model) .defaultSystem(你是可爱且热情、人见人爱花见花开的AI助手你的名字是墩墩请用墩墩的身份回答用户的问题) .defaultAdvisors( new SimpleLoggerAdvisor(), // 如果失去它系统就不再有会话记忆功能了不过这个会话记忆是在内存里的 // 重启项目就会丢失数据 MessageChatMemoryAdvisor.builder(chatMemory).build() ) .build(); } //参数在容器中自动获取无需显式注入 Bean public ChatMemoryRepository chatMemoryRepository(RedisChatMemoryRepositoryDialect dialect) { return new RedisChatMemoryRepository(dialect); } // 重新声明会话记忆类需要指定此时使用redis持久化的实现类 Bean public ChatMemory chatMemory(ChatMemoryRepository chatMemoryRepository) { return MessageWindowChatMemory.builder() .chatMemoryRepository(chatMemoryRepository) .maxMessages(20) .build(); } }配置类里涉及到的RedisChatMemoryRepositoryDialect需要自己实现。RedisChatMemoryRepositoryDialect的实现Slf4j Component public class RedisChatMemoryRepositoryDialect { Autowired private RedisTemplateString, Object redisTemplate; Autowired private ObjectMapper objectMapper; // Redis里存所有活跃会话ID的Set key方便查找所有会话 private static final String JANE_CONVERSATION_KEY chat:conversation_ids; // 每个会话消息列表的key前缀 private static final String JANE_MESSAGE_LIST_PREFIX chat:messages:; /** * 获取所有活跃会话ID * Redis数据结构Set无序且唯一 * 用于快速获取当前所有存在的会话ID */ public ListString findConversationIds() { SetObject members redisTemplate.opsForSet().members(JANE_CONVERSATION_KEY); return Optional.ofNullable(members) .filter(m - !m.isEmpty()) .map(m - m.stream().map(Object::toString).collect(Collectors.toList())) .orElse(Collections.emptyList()); } /** * 根据会话ID获取该会话的所有消息列表多轮对话历史反序列化 * Redis数据结构List有序 * 按消息顺序返回方便构造对话上下文 */ public ListMessage findByConversationId(String conversationId) { String key JANE_MESSAGE_LIST_PREFIX conversationId; Long size redisTemplate.opsForList().size(key); if(size null || size 0L){ return Collections.emptyList(); } ListObject range redisTemplate.opsForList().range(key, size-21, -1); ListMessage messages new ArrayList(); for(Object o:range){ String json JSON.toJSONString(o); try { // 从 JsonParser 中读取 JSON 数据并将其反序列化为 JsonNode树形结构对象 JsonNode jsonNode objectMapper.readTree(json); messages.add(getMessage(jsonNode)); } catch (JsonProcessingException e) { throw new RuntimeException(Error deserializing message, e); } } return messages; } /** * 将一个 JsonNode 转换成对应的 Message 子类实例。 * 根据 messageType 字段决定返回哪种 Message 类型并提取 text 和 metadata 字段。 * 额外会在 metadata 中添加当前时间戳。 * * param jsonNode 传入的 JSON 树节点包含 messageType、text、metadata 等字段 * return 对应类型的 Message 对象实例AssistantMessage、UserMessage、SystemMessage 或 ToolResponseMessage */ private Message getMessage(JsonNode jsonNode) { // 从 jsonNode 中获取 messageType 字段的文本内容默认为 USER 类型 String type Optional.ofNullable(jsonNode) .map(node - node.get(messageType)) // 取 messageType 字段节点 .map(JsonNode::asText) // 转为字符串 .orElse(MessageType.USER.getValue()); // 如果没有该字段默认是 USER 类型 // 根据字符串转换为枚举类型 MessageType MessageType messageType MessageType.valueOf(type.toUpperCase()); // 从 jsonNode 中获取 text 字段的内容 String textContent Optional.ofNullable(jsonNode) .map(node - node.get(text)) // 取 text 字段节点 .map(JsonNode::asText) // 转为字符串 // 如果 text 字段不存在根据消息类型返回默认值 // SYSTEM 和 USER 类型默认返回空字符串 其他类型返回 null .orElseGet(() - (messageType MessageType.SYSTEM || messageType MessageType.USER) ? : null); // 从 jsonNode 中获取 metadata 字段并转换为 MapString, Object MapString, Object metadata Optional.ofNullable(jsonNode) .map(node - node.get(metadata)) // 取 metadata 节点 .map(node - objectMapper.convertValue( // 用 Jackson ObjectMapper 转换成 Map node, new TypeReferenceMapString, Object() {})) .orElse(new HashMap()); // 如果没有 metadata 字段返回空 Map // 在 metadata 中加入当前时间戳key 是 timestamp值是当前 ISO 格式时间字符串 if(!metadata.containsKey(timestamp)){ metadata.put(timestamp, Instant.now().toString()); } // 根据不同的消息类型构造对应的 Message 子类实例并返回 return switch (messageType) { case ASSISTANT - new AssistantMessage(textContent, metadata); // 助手消息 case USER - UserMessage.builder().text(textContent).metadata(metadata).build(); // 用户消息 case SYSTEM - SystemMessage.builder().text(textContent).metadata(metadata).build(); // 系统消息 case TOOL - new ToolResponseMessage(List.of(), metadata); // 工具调用消息 }; } /** * 保存一批消息到指定会话中追加到消息列表末尾 * Redis数据结构List右侧追加 * 并且保证会话ID存在于会话ID集合中 */ public void saveAll(String conversationId, ListMessage messages) { if(CollectionUtils.isEmpty(messages)) return; String keyJANE_MESSAGE_LIST_PREFIXconversationId; deleteByConversationId(conversationId); redisTemplate.opsForSet().add(JANE_CONVERSATION_KEY, conversationId); ListMessage filteredMessages messages.stream() .filter(Objects::nonNull) .filter(m - m.getText() ! null m.getMessageType() ! null).toList(); ListMessage finalMessages new ArrayList(); for(Message message:filteredMessages){ String json JSON.toJSONString(message); try { JsonNode jsonNode objectMapper.readTree(json); finalMessages.add(getMessageWithTime(jsonNode,message.getMessageType(),message.getText())); } catch (JsonProcessingException e) { throw new RuntimeException(e); } } redisTemplate.opsForList().rightPushAll(key, finalMessages.toArray()); int maxHistorySize 100; redisTemplate.opsForList().trim(key, -maxHistorySize, -1); } /** * 在saveall操作时统一添加系统时间 * param jsonNode * param messageType * param textContent * return */ private Message getMessageWithTime(JsonNode jsonNode,MessageType messageType,String textContent){ // 从 jsonNode 中获取 metadata 字段并转换为 MapString, Object MapString, Object metadata Optional.ofNullable(jsonNode) .map(node - node.get(metadata)) .map(node - objectMapper.convertValue( node, new TypeReferenceMapString, Object() {})) .orElse(new HashMap()); if(!metadata.containsKey(timestamp)){ metadata.put(timestamp, Instant.now().toString()); } // 根据不同的消息类型构造对应的 Message 子类实例并返回 return switch (messageType) { case ASSISTANT - new AssistantMessage(textContent, metadata); // 助手消息 case USER - UserMessage.builder().text(textContent).metadata(metadata).build(); // 用户消息 case SYSTEM - SystemMessage.builder().text(textContent).metadata(metadata).build(); // 系统消息 case TOOL - new ToolResponseMessage(List.of(), metadata); // 工具调用消息 }; } /** * 删除指定会话的所有消息以及会话ID集合中的对应ID * Redis数据结构删除List Set中元素 */ public void deleteByConversationId(String conversationId) { String key JANE_MESSAGE_LIST_PREFIX conversationId; redisTemplate.delete(key); redisTemplate.opsForSet().remove(JANE_CONVERSATION_KEY, conversationId); } }RedisChatMemoryRepository的实现Component public class RedisChatMemoryRepository implements ChatMemoryRepository { private final RedisChatMemoryRepositoryDialect dialect; public RedisChatMemoryRepository(RedisChatMemoryRepositoryDialect dialect) { this.dialect dialect; } /** * 查询所有的对话ID列表。 * * return 返回所有存在的对话ID集合。 */ Override public ListString findConversationIds() { return dialect.findConversationIds(); } /** * 根据对话ID查询该对话下的所有消息。 * * param conversationId 对话的唯一标识ID。 * return 返回该对话对应的消息列表。 */ Override public ListMessage findByConversationId(String conversationId) { return dialect.findByConversationId(conversationId); } /** * 保存指定对话ID对应的消息列表支持批量保存。 * * param conversationId 对话的唯一标识ID。 * param messages 需要保存的消息列表。 */ Override public void saveAll(String conversationId, ListMessage messages) { dialect.saveAll(conversationId, messages); } /** * 删除指定对话ID对应的所有消息。 * * param conversationId 需要删除的对话ID。 */ Override public void deleteByConversationId(String conversationId) { dialect.deleteByConversationId(conversationId); } }Controller层实现RequiredArgsConstructor RestController RequestMapping(/ai) public class ChatController { private final Qualifier(chatClient)ChatClient chatClient; private final ChatHistoryService chatHistoryService; private final ChatMemory chatMemory; // 再弄一个流式的但是这里一定要设置字符编码要不然是会乱码的 RequestMapping(value /chat, produces text/html;charsetUTF-8) public FluxString chatStream(String prompt, String chatId) { return chatClient.prompt(prompt) .user(prompt) .advisors(a - a.param(CONVERSATION_ID, chatId)) // 添加一个SpringAAOP环绕增强的配置 用作会话ID记忆这样每次会话的内容就不会串 .stream() .content(); } RequestMapping(/{type}) public ListString getChatIds(PathVariable String type) { return chatHistoryService.getChatIds(type); } RequestMapping(/{type}/{chatId}) public ListMessageVO getChatHistory(PathVariable String type, PathVariable String chatId) { ListMessage messages chatMemory.get(chatId); if (messages null) { return List.of(); } return messages.stream().map(MessageVO::new).toList(); } }Service层实现// 保存会话历史的接口 public interface ChatHistoryService { /** * 从redis中获取会话id列表 * return 会话ID列表 */ ListString getChatIds(); }Service RequiredArgsConstructor public class InMemoryChatHistoryServiceImpl implements ChatHistoryService { private final ChatMemoryRepository chatMemoryRepository; Override public ListString getChatIds(String type) { return chatMemoryRepository.findConversationIds(); } }Redis中的数据格式-会话记忆这里记录的就是每个会话当中的会话历史。这样一来即使服务器重启会话的历史数据也由于进行了持久化因此也不会丢失。