Spring AI集成：构建编程问题解答智能助手

1. 项目概述

在Spring框架中集成AI能力已经成为现代应用开发的重要趋势。本文将详细介绍如何利用Spring AI的Prompt模板功能，构建一个专注于编程问题解答的智能助手系统。这个系统能够根据用户提供的编程语言和具体问题，生成符合规范的代码解决方案。

1.1 核心功能解析

该系统主要实现以下核心功能：

• 通过Prompt模板定义AI助手的角色和行为规范
• 接收用户输入的编程问题和语言类型
• 生成符合要求的代码解决方案
• 支持多种输出格式和参数配置

提示：在实际开发中，Prompt模板的设计对AI输出质量有决定性影响，需要精心设计模板内容和约束条件。

2. 环境准备与基础配置

2.1 依赖引入

首先需要在项目的pom.xml文件中添加必要的依赖：

xml复制<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

这个验证Starter提供了参数校验功能，确保用户输入符合要求。对于AI交互场景，输入验证尤为重要，可以防止无效或恶意请求影响系统稳定性。

2.2 数据模型定义

我们使用Java Record定义请求和响应模型：

java复制package com.junteam.ai.demo.model;

import jakarta.validation.constraints.NotBlank;

public record ChatQuestion(
        @NotBlank(message = "标题不能为空") String title,
        @NotBlank(message = "问题不能为空") String question) {
}

Record类型简洁高效，特别适合这种简单的数据传输对象。@NotBlank注解确保关键字段不为空，提供了基本的输入验证。

3. Prompt模板设计与实现

3.1 模板文件创建

在resources/promptTemplates目录下创建questionPromptTemplate.st文件：

st复制你是一个有用的助手，负责回答有关"代码编程题"的问题。
如果你对这个编程语言一无所知或不知道答案，请回答"我不知道"。

只给出实现代码。

编程语言是 {title}。

问题是：
{question}

这个模板定义了AI的角色、行为规范和响应格式。关键点包括：

1. 明确AI的职责范围（编程问题解答）
2. 设置未知问题的处理方式（回答"我不知道"）
3. 限定输出格式（只包含实现代码）
4. 使用占位符{title}和{question}接收动态参数

3.2 服务层实现

核心服务类实现如下：

java复制package com.junteam.ai.demo.service.impl;

import org.springframework.ai.chat.client.ChatClient;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.io.Resource;
import org.springframework.stereotype.Service;

import com.junteam.ai.demo.model.ChatAnswer;
import com.junteam.ai.demo.model.ChatQuestion;
import com.junteam.ai.demo.service.ChatService;

@Service
public class OpenAIChatServiceImpl implements ChatService {

    private final ChatClient chatClient;

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

    @Value("classpath:/promptTemplates/questionPromptTemplate.st")
    Resource questionPromptTemplate;

    @SuppressWarnings("null")
    @Override
    public ChatAnswer ask(ChatQuestion chatQuestion) {
        var answer = chatClient.prompt()
                .user(userSpec -> userSpec
                    .text(questionPromptTemplate)
                    .param("title", chatQuestion.title())
                    .param("question", chatQuestion.question())
                )
                .call();
        var answerText = answer.content();
        return new ChatAnswer(chatQuestion.title(), answerText);
    }
}

这段代码实现了：

1. 通过ChatClient.Builder构建AI客户端
2. 加载Prompt模板资源
3. 将用户输入与模板结合生成完整Prompt
4. 调用AI服务获取响应
5. 封装返回结果

4. 系统测试与验证

4.1 测试用例

可以使用curl命令测试接口：

bash复制curl http://localhost:8080/web/ask \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"title": "java", "question": "给定一个非递减排序的整数数组 nums 和一个目标值 target，请编写一个函数，返回 target 在数组中出现的第一个位置和最后一个位置（下标从 0 开始）。​\n  - 如果 target 未在数组中出现，返回 [-1, -1]；​\n  - 要求：时间复杂度不超过 O(logn)，空间复杂度 O(1)。​\n示例​\n  1. 输入：nums = [5,7,7,8,8,10], target = 8 → 输出：[3,4]​\n  2. 输入：nums = [5,7,7,8,8,10], target = 6 → 输出：[-1,-1]​\n  3. 输入：nums = [], target = 0 → 输出：[-1,-1]​\n  4. 输入：nums = [2,2], target = 2 → 输出：[0,1]"}'

4.2 预期响应

系统应返回类似以下结构的响应：

json复制{
  "title":"JAVA",
  "answer":"```java\nclass Solution {\n public int findMin(int[] nums) {\n ...```"
}

实际解析后的代码示例：

java复制class Solution {
    public int findMin(int[] nums) {
        int left = 0;
        int right = nums.length - 1;
        while (left < right) {
            int mid = left + (right - left) / 2;
            if (nums[mid] > nums[right]) {
                left = mid + 1;
            } else {
                right = mid;
            }
        }
        return nums[left];
    }
}

5. 高级功能扩展

5.1 规则集成

可以在模板中集成编程语言规范，提升代码质量。例如创建langRules/java.txt文件：

code复制- java中尽量使用基本数据、而非封装类型。
- java中尽量使用静态方法实现代码。

然后修改模板引入规则：

st复制你是一个有用的助手，负责回答有关"代码编程题"的问题。
如果你对这个编程语言一无所知或不知道答案，请回答"我不知道"。
如果可能，使用规则：{rules}。

只给出实现代码。

编程语言是 {title}。

问题是：
{question}

5.2 模型参数配置

5.2.1 Temperature参数

Temperature参数控制输出的随机性：

java复制ChatOptions chatOptions = ChatOptions.builder()
  .temperature(0.7)
  .build();

String answerText = chatClient.prompt()
  .user(question.question())
  .options(chatOptions)
  .call()
  .content();

不同场景推荐值：

• 代码生成：0.3-0.7（精确性优先）
• 创意写作：0.7-1.2（平衡创意与逻辑）
• 头脑风暴：1.2-2.0（最大化多样性）

5.2.2 其他重要参数

java复制ChatOptions.builder()
  .topP(0.8)  // 从排名前80%的结果中选择
  .topK(0.2)  // 排除排名后20%的结果
  .build();

5.3 输出格式控制

5.3.1 流式响应

支持SSE协议实现流式响应：

java复制return chatClient.prompt()
  .system(systemSpec -> systemSpec
    .text(promptTemplate)
    .param("title", question.title())
    .param("rules", langRules))
    .user(question.question())
  .stream() // 启用流式
  .content();

5.3.2 结构化输出

在Prompt中指定输出格式为JSON：

st复制请以JSON格式返回答案，包含以下字段：
- code: 实现代码
- complexity: 时间复杂度分析
- explanation: 简要说明

5.4 元数据获取

可以获取AI响应的元数据信息：

java复制var responseEntity = chatClient.prompt()
  .system(systemSpec -> systemSpec
    .text(promptTemplate)
    .param("gameTitle", question.gameTitle())
    .param("rules", gameRules))
    .user(question.question())
  .call()
.responseEntity(Answer.class);

var response = responseEntity.response();
var metadata = response.getMetadata();
log.info(metadata.getUsage()); // 记录Token使用量

典型元数据结构：

json复制{
  "token_usage": {
    "completion_tokens": 164,
    "prompt_tokens": 17,
    "total_tokens": 181
  },
  "model_name": "gpt-4-turbo",
  "system_fingerprint": "fp_76f018034d",
  "finish_reason": "stop",
  "logprobs": null
}

6. 实践经验与优化建议

6.1 Prompt设计技巧

1. 明确约束条件：在Prompt开始处定义清晰的边界和限制
2. 结构化输出：指定具体的响应格式要求
3. 示例驱动：提供输入输出示例指导AI行为
4. 分步思考：鼓励AI展示推理过程（对调试有帮助）

6.2 性能优化

1. 缓存常见回答：对高频问题实现本地缓存
2. 请求合并：批量处理相关查询减少API调用
3. 响应预处理：在返回前验证和过滤AI输出
4. 限流保护：防止突发流量导致服务过载

6.3 安全注意事项

1. 输入验证：严格校验用户输入防止Prompt注入
2. 输出过滤：移除可能有害的代码或建议
3. 访问控制：限制敏感接口的调用权限
4. 日志审计：记录关键操作便于问题追踪

在实际项目中，我们发现Prompt模板需要持续迭代优化。初期可以设置较严格的约束，随着对AI行为的了解逐步调整。同时建议建立自动化测试套件，确保Prompt修改不会导致关键功能退化。