Spring AI 框架快速入门与核心接口详解

Spring AI 框架快速入门与核心接口详解 | 极客日志

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-openai-spring-boot-starter</artifactId>
    <version>1.0.0-M6</version>
</dependency>

spring:
  ai:
    openai:
      # DeepSeek
      api-key: 申请的 API Key
      base-url: https://api.deepseek.com
      chat:
        options:
          model: deepseek-chat
          temperature: 0.7

@RestController
@RequestMapping("/deepseek")
public class DeepSeekChatController {
    @Autowired
    private OpenAiChatModel deepSeekChatModel;

    @GetMapping("/chat")
    public String generate(String message) {
        return deepSeekChatModel.call(message);
    }
}

@Service
public class ChatService {
    @Autowired
    private ChatModel chatModel; // 例如 OpenAiChatModel

    public String askQuestion(String question) {
        // 1. 构造消息
        UserMessage userMessage = new UserMessage(question);
        // 2. 创建 Prompt
        Prompt prompt = new Prompt(List.of(userMessage));
        // 3. 调用并获得完整响应
        ChatResponse response = chatModel.call(prompt);
        // 4. 从响应中提取内容
        return response.getResult().getOutput().getContent();
    }
}

@Service
public class ChatService {
    @Autowired
    private ChatClient chatClient;

    public String askQuestion(String question) {
        // 一行搞定
        return chatClient.call(question);
    }
}

维度	ChatModel	ChatClient
抽象层级	底层，接近原始模型	高层，面向业务使用
返回值	ChatResponse（包含丰富元数据的完整响应对象）	ChatResponse（直接获得内容的纯文本）或流式响应
使用方法	需要手动构造 Prompt 对象	提供流式的 builder 模式
控制粒度	精细控制	快捷简便

消息类型	对应角色	核心作用
SystemMessage	系统 / 导演	设定 AI 的背景、角色、行为和回复风格。通常在对话开始时提供，为整个会话定下基调。
UserMessage	用户 / 提问者	代表人机交互中的人类一方，是驱动对话前进的源泉。
AssistantMessage	助理 / AI 本身	代表 AI 在之前轮次中做出的回复。是多轮对话连贯性的保障。
FunctionMessage	函数 / 工具	代表 AI 通过函数调用获得的额外信息或操作结果。
ToolMessage	工具	功能与 ToolMessage 完全相同，是 ToolMessage 的别名。
MediaMessage	多媒体	表示除文本外的其他类型消息数据，例如图像。

@RequestMapping("/chat")
@RestController
public class ChatClientController {
    private ChatClient chatClient;

    public ChatClientController(ChatClient.Builder chatClientBuilder) {
        this.chatClient = chatClientBuilder
            .defaultSystem("你叫小小鱼，是一款专业的智能答疑 AI 助手，擅长 Java 和 Python，以友好的态度来回答问题")
            .build();
    }

    @GetMapping("/call")
    public String generation(String userInput) {
        return this.chatClient.prompt()
            .user(userInput) // 用户输入
            .call() // 调用 API
            .content(); // 返回响应
    }
}

@RequestMapping("/chat")
@RestController
public class ChatClientController {
    private ChatClient chatClient;

    public ChatClientController(ChatClient.Builder chatClientBuilder) {
        this.chatClient = chatClientBuilder
            .build();
    }

    @GetMapping("/entity")
    public String entity(String userInput) {
        Recipe entity = this.chatClient.prompt()
            .user(String.format("请帮我生成%s的菜谱", userInput))
            .call()
            .entity(Recipe.class);
        return entity.toString();
    }

    record Recipe(String dis, List<String> ingredients) {}
}

@RequestMapping("/chat")
@RestController
public class ChatClientController {
    private ChatClient chatClient;

    public ChatClientController(ChatClient.Builder chatClientBuilder) {
        this.chatClient = chatClientBuilder
            .build();
    }

    @GetMapping(value = "/stream", produces = "text/html;charset=utf-8")
    public Flux<String> stream(String userInput) {
        return this.chatClient.prompt()
            .user(userInput)
            .stream()
            .content();
    }

    record Recipe(String dis, List<String> ingredients) {}
}

Content-Type: text/event-stream;charset=utf-8
Connection: keep-alive

@Slf4j
@RequestMapping("/sse")
@RestController
public class SseController {
    @RequestMapping("/end")
    public void end(HttpServletResponse response) throws IOException, InterruptedException {
        log.info("发起请求：event");
        response.setContentType("text/event-stream;charset=utf-8");
        PrintWriter writer = response.getWriter();
        for (int i = 0; i < 10; i++) {
            // 事件 foo 事件
            String s = "event: foo\n";
            s += "data: " + new Date() + "\n\n";
            writer.write(s);
            writer.flush();
            Thread.sleep(1000L);
        }
        //定义 end 事件，表示当前流传输结束
        writer.write("event: end\ndata: EOF\n\n");
        writer.flush();
    }
}

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>SSE</title>
</head>
<body>
    <div></div>
    <script>
        let eventSource = new EventSource("/sse/end");
        eventSource.addEventListener("foo", function(event) {
            console.log(event);
            document.getElementById("sse").innerHTML = event.data;
        });
        eventSource.addEventListener("end", function(event) {
            console.log("连接关闭");
            eventSource.close();
        });
    </script>
</body>
</html>

import reactor.core.publisher.Flux;
// 1.1 从固定值创建
Flux<String> fixedFlux = Flux.just("Hello", "World", "!");
// 1.2 从集合创建
List<String> list = Arrays.asList("A", "B", "C");
Flux<String> fromCollection = Flux.fromIterable(list);
// 1.3 数值范围
Flux<Integer> rangeFlux = Flux.range(1, 5); // 1,2,3,4,5
// 1.4 动态生成
Flux<Long> intervalFlux = Flux.interval(Duration.ofSeconds(1)).take(5);
// 1.5 从数组创建
Flux<String> arrayFlux = Flux.fromArray(new String[]{"X", "Y", "Z"});
// 1.6 空流
Flux<String> emptyFlux = Flux.empty();
// 1.7 从 Future 创建（适配传统异步 API）
CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> "Result");
Flux<String> futureFlux = Flux.fromFuture(future);

// 2.1 map - 一对一转换
Flux<String> original = Flux.just("apple", "banana", "cherry");
Flux<String> uppercased = original.map(String::toUpperCase); // APPLE, BANANA, CHERRY
// 2.2 flatMap - 一对多转换（异步展平）
Flux<String> words = Flux.just("hello world", "spring ai");
Flux<String> splitWords = words.flatMap(word -> Flux.fromArray(word.split(" ")));
// 2.3 cast - 类型转换
Flux<Object> objects = Flux.just("text1", "text2");
Flux<String> strings = objects.cast(String.class);
// 2.4 scan - 累积计算
Flux<Integer> numbers = Flux.range(1, 4);
Flux<Integer> cumulativeSum = numbers.scan((acc, current) -> acc + current); // 1,3,6,10

// 3.1 filter - 条件过滤
Flux<Integer> allNumbers = Flux.range(1, 10);
Flux<Integer> evenNumbers = allNumbers.filter(n -> n % 2 == 0); // 2,4,6,8,10
// 3.2 distinct - 去重
Flux<String> withDuplicates = Flux.just("A", "B", "A", "C");
Flux<String> uniqueItems = withDuplicates.distinct(); // A,B,C
// 3.3 take - 取前 N 个
Flux<String> limited = original.take(2); // apple, banana
// 3.4 skip - 跳过前 N 个
Flux<String> skipped = original.skip(1); // banana, cherry
// 3.5 takeWhile / skipWhile - 条件取/跳
Flux<Integer> sequence = Flux.range(1, 100);
Flux<Integer> firstPart = sequence.takeWhile(n -> n < 10); // 1,2,3,...,9
// 3.6 sample - 采样（定期取最新元素）
Flux<Long> sampled = Flux.interval(Duration.ofMillis(100))
    .sample(Duration.ofSeconds(1))
    .take(3); // 每隔 1 秒取样，共取 3 次

// 4.1 subscribe - 最基本的消费方式
Flux<String> data = Flux.just("one", "two", "three");
data.subscribe(
    item -> System.out.println("Received: " + item),
    error -> System.err.println("Error: " + error),
    () -> System.out.println("Completed!")
);
// 4.2 collectList - 收集所有元素到 List
Mono<List<String>> listMono = data.collectList();
// 4.3 blockFirst / blockLast - 阻塞获取（仅用于测试）
// String first = data.blockFirst();
// 4.4 reduce - 归约操作
Mono<Integer> sum = numbers.reduce(0, Integer::sum);
// 4.5 count - 计数
Mono<Long> count = data.count();
// 4.6 hasElement - 检查是否有元素
Mono<Boolean> hasData = data.hasElements();
// 4.7 then - 忽略元素，只在完成后触发
Mono<Void> completionSignal = data.then();

@RequestMapping("/chat")
@RestController
public class ChatClientController {
    private ChatClient chatClient;

    public ChatClientController(ChatClient.Builder chatClientBuilder) {
        this.chatClient = chatClientBuilder
            .defaultSystem("你叫小小鱼，是一款专业的智能答疑 AI 助手，擅长 Java 和 Python，以友好的态度来回答问题")
            .build();
    }

    @GetMapping("/advisor")
    public String advisor(String userInput) {
        return this.chatClient.prompt()
            .advisors(new SimpleLoggerAdvisor())
            .user(userInput)
            .call()
            .content();
    }

    record Recipe(String dis, List<String> ingredients) {}
}

logging:
  level:
    org.springframework.ai.chat.client.advisor: debug

Spring AI 框架快速入门与核心接口详解

什么是 AI

模型（Model）

大语言模型（LLM）

提示词（Prompt）

词元（Token）

Spring AI 是什么

快速入门

环境要求

申请 API Key

项目创建

接口编写

核心接口

ChatModel

ChatClient

消息类型

SystemMessage

UserMessage

AssistantMessage

输出格式

结构化输出

流式输出

SSE 协议介绍

SSE 数据格式

data

event

id

retry

SSE 使用示例

Flux

Advisors

更多推荐文章

相关免费在线工具

Spring AI 框架快速入门与核心接口详解

什么是 AI

模型（Model）

大语言模型（LLM）

提示词（Prompt）

词元（Token）

Spring AI 是什么

快速入门

环境要求

申请 API Key

项目创建

接口编写

核心接口

ChatModel

ChatClient

消息类型

SystemMessage

UserMessage

AssistantMessage

输出格式

结构化输出

流式输出

SSE 协议介绍

SSE 数据格式

data

event

id

retry

SSE 使用示例

Flux

Advisors

微信扫一扫，关注极客日志

更多推荐文章

相关免费在线工具