09 Spring AI spring-ai-client-chat模块之ChatClient API源码分析

飞书用户8288

4月27日修改

深入Spring AI，从源码开始

探索Java企业级AI应用框架，理解它的内部机制，带大家从入门到精通​

1 ChatClient基本描述

ChatClient，用于与AI模型进行无状态请求，使用流式(Fluent )API，Spring生态 Fluent API 是一种面向对象的API设计模式。该接口提供了一系列静态方法和嵌套接口，用于构建和发送聊天请求，并处理响应。​

Spring生态框架中，Fluent API是一种通过方法链式调用提升代码可读性和简洁性的设计模式，其核心是通过返回this引用实现链式配置。​

Spring Fluent API 的本质是以建造者模式为逻辑基础，通过链式调用语法实现流畅的接口设计。这种模式在 Spring 生态中广泛应用于复杂对象的构建、配置管理和外部服务通信，显著提升了开发效率和代码可维护性。​

1.1 Fluent API的优势

1.
提高代码可读性：通过方法链，代码逻辑更加清晰，易于理解。​

2.
减少样板代码：通过链式调用，减少了大量的中间变量和方法调用，使代码更加简洁。​

3.
增强类型安全：在编译时期就能发现潜在的错误，提高代码的健壮性​

2 ChatClient源码分析

2.1 主要功能

1.
创建ChatClient实例：通过静态方法create和builder创建ChatClient实例。​

2.
发送聊天请求：通过prompt方法发送聊天请求，可以传递字符串内容、Prompt对象或直接调用无参数的prompt方法。​

3.
配置请求：通过嵌套接口ChatClientRequestSpec配置请求，包括设置顾问（advisors）、消息（messages）、选项（options）、工具（tools）和系统/用户提示（system/user prompts）。​

4.
处理响应：通过嵌套接口CallResponseSpec和StreamResponseSpec处理同步和异步响应。​

2.2 主要接口和类

•
ChatClient接口：主接口，提供创建客户端实例和处理请求的方法。​

•
Builder接口：用于创建和配置ChatClient实例的构建器接口。​

•
ChatClientRequestSpec接口：用于配置和发送聊天请求的规范接口。​

•
CallResponseSpec接口：用于处理同步响应的规范接口。​

•
StreamResponseSpec接口：用于处理异步响应的规范接口。​

•
PromptUserSpec和PromptSystemSpec接口：用于配置用户和系统提示的规范接口。​

•
AdvisorSpec接口：用于配置顾问的规范接口。​

2.3 代码流程

1.
创建ChatClient实例：​
◦
调用create或builder方法，传入ChatModel、ObservationRegistry和可选的ChatClientObservationConvention。​
◦
create方法内部调用builder方法并构建实例。​

2.
配置请求：​
◦
调用prompt方法获取ChatClientRequestSpec实例。​
◦
通过ChatClientRequestSpec配置请求，包括顾问、消息、选项、工具和提示。​

3.
发送请求并处理响应：​
◦
调用call方法发送同步请求，通过CallResponseSpec处理响应。​
◦
调用stream方法发送异步请求，通过StreamResponseSpec处理响应。​

2.4 代码流程图

09 Spring AI spring-ai-client-chat模块之ChatClient API源码分析​