我要评论在spring ai开发中，大模型默认返回自然语言文本，混杂多余描述、代码块标记，业务代码无法直接反序列化使用。本文基于spring ai官方规范，详解结构化输出（structured output）核心概念、两套实现方案、技术选型对比及高频踩坑解决方案，适配日常业务开发与项目落地。
一、结构化输出（structured output）核心概念
1.1 官方定义
引用 spring ai 官方定义：
如果您想从 llm 接收结构化输出，structured output 可以协助将 chatmodel/chatclient 方法的返回类型从 string 更改为其他类型。
llm 生成结构化输出的能力对于依赖可靠解析输出值的下游应用程序非常重要。开发人员希望快速将 ai 模型的结果转换为可以传递给其他应用程序函数和方法的数据类型，例如 json、xml 或 java 类。spring ai 结构化输出转换器可自动将 llm 原始文本输出转为标准化结构化格式。
1.2 传统开发业务痛点
不做结构化约束时，大模型返回的文本通常混杂自然语言描述，并非纯净结构化数据，示例如下：
好的，这是结果：
{
"title":"springai",
"desc":"java ai开发框架"
}这种格式存在严重问题：前端、后端业务代码无法直接反序列化，需要手动编写正则清洗文本，开发效率低、容错性差，极易出现解析异常。
1.3 结构化输出核心目标
强制约束大模型输出规则，让模型稳定输出标准结构化数据（json），由 spring ai 框架自动完成 原始文本 → java 实体对象 的转换，彻底规避手动清洗数据的问题。
1.4 spring ai 两大实现技术路线
- 底层api：chatmodel + outputparser，灵活性最高，支持多角色模板、外部文件prompt，适配复杂场景
- 高层dsl：chatclient 流式调用 call().entity()，代码极简，内置封装转换器，适合快速开发
二、前置准备：定义统一接收pojo
本文所有案例统一使用该实体类接收结构化json结果，简化代码冗余，基于lombok简化开发：
import lombok.data;
/**
* ai结构化输出统一接收实体
*/
@data
public class articledto {
// 文章标题
private string title;
// 文章简介
private string description;
// 文章作者
private string author;
}三、方案一：底层 chatmodel + jsonoutputparser（标准企业方案）
jsonoutputparser 是spring ai官方核心结构化输出转换器，也是复杂项目首选方案。核心具备两大能力：
- getformatinstructions()：自动生成json格式约束提示词，自动注入prompt
- parse()：接收模型原始文本，自动解析转换为对应java实体类
完整可运行代码
import org.springframework.ai.chat.model.chatmodel;
import org.springframework.ai.chat.prompt.prompt;
import org.springframework.ai.chat.prompt.prompttemplate;
import org.springframework.ai.chat.prompt.systemprompttemplate;
import org.springframework.ai.parser.jsonoutputparser;
import org.springframework.web.bind.annotation.getmapping;
import org.springframework.web.bind.annotation.restcontroller;
import java.util.list;
import java.util.map;
@restcontroller
public class structuredoutputcontroller {
private final chatmodel chatmodel;
// 构造器注入，统一spring ai开发规范
public structuredoutputcontroller(chatmodel chatmodel) {
this.chatmodel = chatmodel;
}
@getmapping("/structured/model-parser")
public articledto structuredbymodel(string topic) {
// 1. 创建结构化输出转换器，绑定接收实体类
jsonoutputparser<articledto> parser = new jsonoutputparser<>(articledto.class);
// 2. 定义系统角色模板：基础输出约束 + 自动注入格式规范
systemprompttemplate systemplate = new systemprompttemplate("
禁止输出任何前言、解释、markdown代码块标记。
{format_instructions}
");
// 注入框架自动生成的json格式约束
message sysmsg = systemplate.createmessage(map.of("format_instructions", parser.getformatinstructions()));
// 3. 定义用户角色模板，动态接收业务参数
prompttemplate usertemplate = new prompttemplate("生成一篇关于{topic}的短文信息");
message usermsg = usertemplate.createmessage(map.of("topic", topic));
// 4. 组装多角色prompt消息
prompt prompt = new prompt(list.of(sysmsg, usermsg));
// 5. 调用大模型，自动解析文本为java实体
string rawresult = chatmodel.call(prompt).getresult().getoutput().gettext();
return parser.parse(rawresult);
}
}适用场景：需要手动管理systemprompt、外部txt提示词文件、复杂多角色消息编排的场景；与prompttemplate、多消息角色体系完全无缝衔接，是中大型复杂ai项目的标准方案。
四、方案二：高层 chatclient dsl 流式写法（简洁开发首选）
chatclient 高层dsl内部已封装结构化转换器，提供 call().entity(class<t>) 极简api，底层依旧复用jsonoutputparser，无需手动创建解析器，代码极度简洁，适合快速开发、接口原型搭建。
4.1 基础字符串user写法
适合固定提示词、无复杂参数渲染的简单场景：
@getmapping("/structured/client-simple")
public articledto structuredclientsimple(string topic) {
return chatclient.prompt()
// 系统级输出约束
.system("禁止输出多余文字，不要```json代码块标记")
// 固定用户提示词
.user("生成一篇关于" + topic + "的短文信息")
.call()
// 自动结构化解析为实体
.entity(articledto.class);
}4.2 consumer模板写法（重点推荐）
支持 {key} 占位符模板 + .param() 动态绑定参数，无需手动new prompttemplate，兼顾简洁性与动态性，是轻量级业务接口最优写法。
lambda表达式写法（日常开发主流）
@getmapping("/structured/client-consumer")
public articledto structuredclientconsumer(string topic) {
return chatclient.prompt()
.system("禁止输出多余文字，不要```json代码块标记")
// lambda实现consumer，动态模板传参
.user(spec -> spec
.text("生成一篇关于{topic}的短文信息")
.param("topic", topic)
)
.call()
.entity(articledto.class);
}匿名内部类写法（原理学习参考）
lambda语法糖脱糖后的原生写法，兼容所有java版本，仅用于理解底层原理，项目中统一使用lambda写法：
@getmapping("/structured/client-anonymous")
public articledto structuredclientanonymous(string topic) {
return chatclient.prompt()
.system("禁止输出多余文字，不要```json代码块标记")
// 完整匿名内部类实现consumer接口
.user(new consumer<chatclient.promptuserspec>() {
@override
public void accept(chatclient.promptuserspec spec) {
spec.text("生成一篇关于{topic}的短文信息")
.param("topic", topic);
}
})
.call()
.entity(articledto.class);
}consumer核心原理：consumer是java8函数式接口，仅包含一个抽象方法，支持lambda简化写法：
@functionalinterface
public interface consumer<t> {
void accept(t t);
}开发规范：项目统一使用lambda表达式，代码简洁可读性高；匿名内部类仅用于原理学习。
五、两套api核心选型对比
两套方案底层核心一致，均基于spring ai outputparser，仅封装层级不同，可根据项目复杂度选型：
| 开发方式 | 核心api | 优点 | 局限 | 适用场景 |
|---|---|---|---|---|
| 底层原始api | chatmodel + jsonoutputparser | 高度可控，支持外部文件模板、灵活组装多角色消息，适配复杂提示词工程 | 代码量偏多，需手动处理解析逻辑 | 中大型项目、提示词复杂、多角色消息编排场景 |
| 高层流式dsl | chatclient + call().entity() | 代码极简，内置结构化转换器，开发效率极高 | 外部txt模板编排不够直观 | 小型业务接口、快速原型开发、简单ai功能 |
底层原理：chatclient.prompt().call().entity() 底层会自动创建jsonoutputparser，与底层api本质一致。
六、开发高频踩坑解决方案（必看）
6.1 问题：模型返回markdown json代码块，解析报错
现象：大模型返回内容携带```json标记，导致实体解析失败：
{"title":"xxx","description":"xxx","author":"xxx"}解决方案1（优先）：在系统提示词中强制约束输出规则：
禁止使用markdown代码块包裹返回内容，只输出纯净json字符串。
解决方案2（兜底工具）：封装公共文本清洗工具类，兼容异常场景：
/**
* 清洗大模型返回的markdown json标记
*/
public static string cleanjsonmarkdown(string text) {
return text.replaceall("```json", "")
.replaceall("```", "")
.trim();
}6.2 问题：字段缺失、格式错乱导致解析异常
问题现象：模型返回字段缺失、json格式错误，抛出parseexception，程序直接报错。
解决方案：所有结构化解析逻辑必须捕获异常，打印原始返回文本，方便快速定位问题：
try {
return parser.parse(rawresult);
} catch (parseexception e) {
// 打印模型原始返回内容，精准排查格式问题
log.error("结构化输出解析失败，原始返回：{}", rawresult, e);
throw new runtimeexception("模型返回格式异常，请重试");
}6.3 占位符大小写严格匹配
模板中的占位符名称（如{topic}）与param、map传入的key名称必须大小写完全一致，否则占位符无法渲染，导致提示词失效、输出结果异常。
七、总结
- 结构化输出的核心价值是标准化模型返回值，实现ai结果与业务代码的无缝对接，彻底告别手动文本清洗；
- 复杂项目、自定义提示词工程优先使用 chatmodel + jsonoutputparser，灵活性拉满；
- 简单接口、快速开发优先使用 chatclient dsl + lambda模板传参，代码简洁高效；
- 开发必须做好输出约束、异常捕获、文本兜底清洗，保证接口稳定性。
到此这篇关于spring ai 统一结构化返回：chatmodel / chatclient 两种实现方式的文章就介绍到这了,更多相关spring ai chatmodel chatclient实现方式内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网！
发表评论