openapi springboot 生成器 jackson 没有从字符串值反序列化的字符串参数构造函数/工厂方法

Question

我正在使用OpenApi SpringBoot生成器生成控制器接口和模型。这将创建具有JsonNullable<String>可空字段的模型类。但是，我收到一个Jackson类型定义错误，而POST请求是在可空字段中存在值的情况下发送的。

com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Cannot construct instance of `org.openapitools.jackson.nullable.JsonNullable` (no Creators, like default construct, exist): no String-argument constructor/factory method to deserialize from String value ('TG')
 at [Source: (PushbackInputStream); line: 3, column: 19] (through reference chain: com.example.rest.CreateRequest["displayName"])
    at com.fasterxml.jackson.databind.exc.InvalidDefinitionException.from(InvalidDefinitionException.java:67) ~[jackson-databind-2.9.7.jar:2.9.7]
    at com.fasterxml.jackson.databind.DeserializationContext.reportBadDefinition(DeserializationContext.java:1452) ~[jackson-databind-2.9.7.jar:2.9.7]
    at com.fasterxml.jackson.databind.DeserializationContext.handleMissingInstantiator(DeserializationContext.java:1028) ~[jackson-databind-2.9.7.jar:2.9.7]
    at com.fasterxml.jackson.databind.deser.ValueInstantiator._createFromStringFallbacks(ValueInstantiator.java:371) ~[jackson-databind-2.9.7.jar:2.9.7]
    at com.fasterxml.jackson.databind.deser.std.StdValueInstantiator.createFromString(StdValueInstantiator.java:323) ~[jackson-databind-2.9.7.jar:2.9.7]
    at com.fasterxml.jackson.databind.deser.BeanDeserializerBase.deserializeFromString(BeanDeserializerBase.java:1373) ~[jackson-databind-2.9.7.jar:2.9.7]
    at com.fasterxml.jackson.databind.deser.BeanDeserializer._deserializeOther(BeanDeserializer.java:171) ~[jackson-databind-2.9.7.jar:2.9.7]
    at com.fasterxml.jackson.databind.deser.BeanDeserializer.deserialize(BeanDeserializer.java:161) ~[jackson-databind-2.9.7.jar:2.9.7]
    at com.fasterxml.jackson.databind.deser.impl.MethodProperty.deserializeAndSet(MethodProperty.java:127) ~[jackson-databind-2.9.7.jar:2.9.7]
    at com.fasterxml.jackson.databind.deser.BeanDeserializer.deserializeFromObject(BeanDeserializer.java:369) ~[jackson-databind-2.9.7.jar:2.9.7]
    at com.fasterxml.jackson.databind.deser.BeanDeserializer.deserialize(BeanDeserializer.java:159) ~[jackson-databind-2.9.7.jar:2.9.7]
    at com.fasterxml.jackson.databind.ObjectMapper._readMapAndClose(ObjectMapper.java:4013) ~[jackson-databind-2.9.7.jar:2.9.7]
    at com.fasterxml.jackson.databind.ObjectMapper.readValue(ObjectMapper.java:3084) ~[jackson-databind-2.9.7.jar:2.9.7]
    at org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter.readJavaType(AbstractJackson2HttpMessageConverter.java:239) ~[spring-web-5.1.3.RELEASE.jar:5.1.3.RELEASE]
    at org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter.read(AbstractJackson2HttpMessageConverter.java:227) ~[spring-web-5.1.3.RELEASE.jar:5.1.3.RELEASE]
    at org.springframework.web.servlet.mvc.method.annotation.AbstractMessageConverterMethodArgumentResolver.readWithMessageConverters(AbstractMessageConverterMethodArgumentResolver.java:204) ~[spring-webmvc-5.1.3.RELEASE.jar:5.1.3.RELEASE]
    at org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor.readWithMessageConverters(RequestResponseBodyMethodProcessor.java:157) ~[spring-webmvc-5.1.3.RELEASE.jar:5.1.3.RELEASE]
    at org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor.resolveArgument(RequestResponseBodyMethodProcessor.java:130) ~[spring-webmvc-5.1.3.RELEASE.jar:5.1.3.RELEASE]
    at org.springframework.web.method.support.HandlerMethodArgumentResolverComposite.resolveArgument(HandlerMethodArgumentResolverComposite.java:126) ~[spring-web-5.1.3.RELEASE.jar:5.1.3.RELEASE]

同样的事情发生在Integer或任何其他类型上。如果请求只包含non-nullable字段，它会起作用。

知道这里出了什么问题吗？

Answer 1

从 openapi-generator v5.1.1 开始，您可以在 config.json 中使用：

{
  "openApiNullable": false
}

删除该依赖关系。大多数时候不需要它（如果您检查生成的代码），因此能够不在类路径中添加不需要的依赖项是很酷的。

或者直接在你的 gradle 插件中build.gradle你可以这样做：

openApiGenerate {
    generatorName = "spring"
    inputSpec = "$rootDir/specs/petstore-v3.0.yaml"
    outputDir = "$buildDir/generated"
    apiPackage = "org.openapi.example.api"
    modelPackage = "org.openapi.example.model"
    configOptions = [
        openApiNullable: "false"
    ]
}

Answer 2

OpenAPI 生成器团队实现了jackson-databind-nullable模块，您应该将其包含到您的项目中。最新版本是 0.2.1。

<dependency>
    <groupId>org.openapitools</groupId>
    <artifactId>jackson-databind-nullable</artifactId>
    <version>0.2.1</version>
</dependency>

如果模块不会被自动检测到，您需要通过以下方式手动检测：

ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new JsonNullableModule());

或者，如果您在Spring项目中使用 Jackson ，那么您可以通过以下方式注册它：

@Bean
@Primary
public Jackson2ObjectMapperBuilder customObjectMapper() {
    return new Jackson2ObjectMapperBuilder()
            // other configs are possible
            .modules(new JsonNullableModule());
}

Answer 3

正如 @Micha\xc5\x82 Ziober 所说，您必须将 jackson-databind-nullable 添加到您的 Maven 依赖项中，并且需要注册 jackson 模块。最简单的方法是将以下内容添加到您的应用程序中：

\n

@Configuration\npublic class JacksonConfig {\n  @Bean\n  public Module jsonNullableModule() {\n    return new JsonNullableModule();\n  }\n}\n

\n

Spring 自动将 Jackson 模块添加到 ObjectMapper，如文档所述：

\n

\n

com.fasterxml.jackson.databind.Module 类型的任何 bean 都会自动注册到自动配置的Jackson2ObjectMapperBuilder，并应用于它创建的任何 ObjectMapper 实例。这提供了一种全局机制，用于在您向应用程序添加新功能时\n贡献自定义模块。\n

\n

\n