如何通过Spring REST调整Rest Controller的JSON输出格式以匹配预期？

嘿，我来帮你解决Spring REST里调整JSON输出格式的问题！结合你提到的有Category和Subcategory模型的场景，这里有几种实用的方案，你可以根据需求选择：

这是最推荐的做法，因为它能让你的业务模型（Category、Subcategory）和接口返回的JSON结构完全解耦，后续维护起来更灵活。

步骤很简单：

• 先根据你预期的JSON格式创建对应的DTO类，只保留需要返回的字段和结构
• 在Controller里把业务模型对象转换成DTO对象，再返回给前端

举个例子，假设你预期的JSON是这样的：

[
  {
    "categoryName": "电子产品",
    "subcategories": [
      {"subName": "手机"},
      {"subName": "电脑"}
    ]
  }
]

那你可以创建这两个DTO类：

// 分类响应DTO
public class CategoryResponseDTO {
    private String categoryName;
    private List<SubcategoryDTO> subcategories;

    // 构造方法、getter和setter
    public CategoryResponseDTO(String categoryName, List<SubcategoryDTO> subcategories) {
        this.categoryName = categoryName;
        this.subcategories = subcategories;
    }

    // 省略getter和setter
}

// 子分类DTO
public class SubcategoryDTO {
    private String subName;

    public SubcategoryDTO(String subName) {
        this.subName = subName;
    }

    // 省略getter和setter
}

然后在Controller里做转换：

@RestController
@RequestMapping("/api/categories")
public class CategoryController {

    @Autowired
    private CategoryService categoryService;

    @GetMapping
    public List<CategoryResponseDTO> getAllCategories() {
        List<Category> categories = categoryService.findAll();
        // 把Category转成DTO
        return categories.stream()
                .map(category -> {
                    List<SubcategoryDTO> subDTOs = category.getSubcategories().stream()
                            .map(sub -> new SubcategoryDTO(sub.getSubName()))
                            .collect(Collectors.toList());
                    return new CategoryResponseDTO(category.getName(), subDTOs);
                })
                .collect(Collectors.toList());
    }
}

如果只是对现有模型做小调整（比如重命名字段、忽略某些字段），不想新建DTO的话，可以直接在Category和Subcategory类上添加Jackson注解来控制JSON序列化：

常用的注解包括：

• @JsonProperty("newFieldName")：给字段重命名，让JSON里显示你想要的键名
• @JsonIgnore：忽略某个字段，不把它序列化到JSON里
• @JsonUnwrapped：把嵌套对象的字段“展开”到上层JSON中
• @JsonInclude(JsonInclude.Include.NON_NULL)：只序列化非空的字段

比如给你的模型加注解：

public class Category {
    @JsonIgnore // 忽略id字段，不返回给前端
    private Long id;
    @JsonProperty("categoryName") // 把name字段重命名为categoryName
    private String name;
    @JsonProperty("subcategories")
    private List<Subcategory> subcategories;

    // 省略getter和setter
}

public class Subcategory {
    @JsonIgnore
    private Long id;
    @JsonIgnore
    private Long categoryId;
    @JsonProperty("subName")
    private String subName;

    // 省略getter和setter
}

这样你直接返回Category对象时，Spring的Jackson序列化器就会按照注解生成你想要的JSON格式。

如果你的JSON结构调整非常复杂（比如需要动态生成字段、特殊的嵌套逻辑），上面两种方法满足不了需求，可以自定义序列化器：

1. 先写一个自定义序列化器类，继承StdSerializer：

public class CategoryCustomSerializer extends StdSerializer<Category> {

    // 无参构造
    public CategoryCustomSerializer() {
        this(null);
    }

    public CategoryCustomSerializer(Class<Category> t) {
        super(t);
    }

    @Override
    public void serialize(Category category, JsonGenerator jgen, SerializerProvider provider) throws IOException {
        // 手动构建JSON结构
        jgen.writeStartObject();
        jgen.writeStringField("categoryName", category.getName());
        jgen.writeArrayFieldStart("subcategories");
        
        for (Subcategory sub : category.getSubcategories()) {
            jgen.writeStartObject();
            jgen.writeStringField("subName", sub.getSubName());
            // 可以添加更多自定义字段逻辑
            jgen.writeEndObject();
        }
        
        jgen.writeEndArray();
        jgen.writeEndObject();
    }
}

2. 在Category类上标注使用这个序列化器：

@JsonSerialize(using = CategoryCustomSerializer.class)
public class Category {
    // 原有字段和方法
}

这样当你返回Category对象时，就会用你自定义的逻辑生成JSON了。

内容的提问来源于stack exchange，提问作者Saurabh Kumar Singh