特定控制器的 JSON 请求正文中的未知字段返回错误

Question

我有 SpringBoot 应用程序 X，它具有面向客户的 API。 这些 API 接收请求主体为 JSON。

应用程序 X 向应用程序 Y 发出 API 调用并接收主体为 JSON 的响应。

我想阻止应用程序 X 在面向客户的控制器上的请求正文中接收未知字段。

我在考虑spring.jackson.deserialization.fail-on-unknown-properties=true但如果我理解正确的话，如果从应用程序 X 到应用程序 Y 的调用将返回具有未知字段的响应主体，那么这种配置也会导致失败。 因此，此配置将使应用程序 X 和应用程序 Y 之间的 API 耦合度更高且鲁棒性更低。

我正在寻找一种方法来仅在面向客户的应用程序控制器中对请求主体进行反序列化，同时允许在应用程序的其他部分进行反序列化以忽略未知字段

示例：我有以下面向 API 的客户。

@PostMapping
public Response updateProduct(@RequestBody Product product) {
.....
}

在哪里

class Product {
    private int id;
    private String name;
    private int price;
}

我想阻止客户通过以下主体进行请求，因为颜色不是已知字段。

{
  "id": 777,
  "name": "apple",
  "price": 2,
  "colour": "red"
}

但是 - 我希望它仅在这个 controller 上执行“失败未知字段”，而不是在 Jackson 用于反序列化从其他应用程序收到的响应的其他地方。

Answer 1

您可以在 controller 中创建一个新的ObjectMapper实例，将其DeserializationFeature#FAIL_ON_UNKNOWN_PROPERTIES显式配置为true值，这将在 json 内的未知属性的情况下强制失败，如下所示：

@PostMapping(value = "/updateproduct")
public Product updateProduct(@RequestBody String productString) throws JsonProcessingException {
    ObjectMapper objectMapper = new ObjectMapper();
    objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, true);
    //it will fail in case of unknown properties inside the json string
    Product product = objectMapper.readValue(productString, Product.class);
    return product;
}

选择将请求主体 json 转换为String ，您可以手动配置ObjectMapper本地实例，同时您必须决定在出现 json 处理异常时如何继续（在我的例子中，我只是决定直接抛出异常，但可以有不同的行为采用）或UnrecognizedPropertyException异常，如您介绍的情况。

编辑：回答下面的 OP 评论

但是我不想接收 String 并显式创建 objectMapper，而是想找到一种方法来保留它 Product 并以某种方式告诉 Spring “将这个 ObjectMapper bean 用于这个特定的控制器”。

我不知道是否可以完全按照您的意愿进行操作，但您可以实现非常相似的效果：您可以在配置 class 中定义一个自定义ObjectMapper bean，因此具有默认的主 bean 和您的自定义 bean：

@Configuration
public class ApplicationConfiguration {

    @Bean
    @Primary
    public ObjectMapper objectMapper() {
        return Jackson2ObjectMapperBuilder
                .json()
                .build();
    }

    @Bean("customObjectMapper")
    public ObjectMapper getCustomObjectMapper() {
        return Jackson2ObjectMapperBuilder
                .json()
                .build()
                .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, true);
    }
}

然后在同一个 controller 中，您可以同时引用这两个 bean，因此一个方法将以成功结束，因为它使用默认主 bean，而另一个将失败：

@RestController
@RequestMapping("/")
public class ExampleController {

    //fine, it is using the default primary bean so it ignores
    //unknown properties in the json 
    @PostMapping(value = "/updateproduct")
    public Product updateProduct(@RequestBody Product product) {
        return product;
    }

    @Autowired
    @Qualifier("customObjectMapper")
    private ObjectMapper objectMapper;

    //it is using the custom bean so it will fail 
    //with unknown properties in the json
    @PostMapping(value = "/updateproductfail")
    public Product updateProductFail(@RequestBody String productString) throws JsonProcessingException {
        Product product = objectMapper.readValue(productString, Product.class);
        return product;
    }
}

Answer 2

要在项目级别更改此设置，您可以在 application.properties 中添加以下内容：

spring.jackson.deserialization.fail-on-unknown-properties=true

或者，如果您使用的是 application.yaml：

spring:
  jackson:
    deserialization:
      fail-on-unknown-properties: true

此配置将影响项目级别，因此您可以在收到的 @RequestBody object 上继续使用正确的 DTO。 这样，您不必对 controller 进行任何更改，但建议您在 @ControllerAdvice 中控制异常。