Skip to content

[Java][restclient] Build XmlMapper via builder when useJackson3=true #23872

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
seonwooj0810 wants to merge 1 commit into
base: master
Choose a base branch
from
+86 −5
Open

[Java][restclient] Build XmlMapper via builder when useJackson3=true #23872

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions modules/openapi-generator/src/main/resources/Java/libraries/restclient/ApiClient.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,12 @@ package {{invokerPackage}};

{{#withXml}}
import {{jacksonPackage}}.dataformat.xml.XmlMapper;
{{^useJackson3}}
import {{jacksonPackage}}.dataformat.xml.ser.ToXmlGenerator;
{{/useJackson3}}
{{#useJackson3}}
import {{jacksonPackage}}.dataformat.xml.XmlWriteFeature;
{{/useJackson3}}
{{/withXml}}

import {{jacksonPackage}}.databind.DeserializationFeature;
Expand Down Expand Up @@ -238,16 +243,21 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
*/
public static RestClient.Builder buildRestClientBuilder({{#useJackson3}}JsonMapper{{/useJackson3}}{{^useJackson3}}ObjectMapper{{/useJackson3}} mapper) {
{{#withXml}}
{{#useJackson3}}
XmlMapper xmlMapper = XmlMapper.builder()
.enable(XmlWriteFeature.WRITE_XML_DECLARATION)
{{#openApiNullable}}
.addModule(new JsonNullableJackson3Module())
{{/openApiNullable}}
.build();
{{/useJackson3}}
{{^useJackson3}}
XmlMapper xmlMapper = new XmlMapper();
xmlMapper.configure(ToXmlGenerator.Feature.WRITE_XML_DECLARATION, true);
{{#openApiNullable}}
{{^useJackson3}}
xmlMapper.registerModule(new JsonNullableModule());
{{/useJackson3}}
{{#useJackson3}}
xmlMapper.registerModule(new JsonNullableJackson3Module());
{{/useJackson3}}
{{/openApiNullable}}
{{/useJackson3}}
{{/withXml}}

{{#useJackson3}}
Expand Down
71 changes: 71 additions & 0 deletions .../openapi-generator/src/test/java/org/openapitools/codegen/java/JavaClientCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3453,6 +3453,77 @@ public void testRestClientWithXML_issue_19137() {
);
}

@Test(description = "Regression test for issue #23860: with useJackson3=true the generated"
+ " restclient ApiClient must build XmlMapper via the immutable Builder API,"
+ " because XmlMapper.configure(...) and registerModule(...) were removed in Jackson 3.")
public void testRestClientWithXMLAndJackson3_issue_23860() {
final Path output = newTempFolder();
final CodegenConfigurator configurator = new CodegenConfigurator()
.setGeneratorName(JAVA_GENERATOR)
.setLibrary(JavaClientCodegen.RESTCLIENT)
.setAdditionalProperties(Map.of(
CodegenConstants.API_PACKAGE, "xyz.abcdef.api",
CodegenConstants.WITH_XML, true,
JavaClientCodegen.USE_JACKSON_3, true,
JavaClientCodegen.USE_SPRING_BOOT4, true,
JavaClientCodegen.OPENAPI_NULLABLE, false
))
.setInputSpec("src/test/resources/3_1/java/petstore.yaml")
.setOutputDir(output.toString().replace("\\", "/"));

List<File> files = new DefaultGenerator().opts(configurator.toClientOptInput()).generate();

validateJavaSourceFiles(files);
assertFileContains(
output.resolve("src/main/java/xyz/abcdef/ApiClient.java"),
"import tools.jackson.dataformat.xml.XmlMapper;",
"import tools.jackson.dataformat.xml.XmlWriteFeature;",
"XmlMapper xmlMapper = XmlMapper.builder()",
".enable(XmlWriteFeature.WRITE_XML_DECLARATION)",
".build();"
);
TestUtils.assertFileNotContains(
output.resolve("src/main/java/xyz/abcdef/ApiClient.java"),
"xmlMapper.configure(",
"xmlMapper.registerModule(",
"import tools.jackson.dataformat.xml.ser.ToXmlGenerator;"
);
}

@Test(description = "Regression test for issue #23860: with useJackson3=true and"
+ " openApiNullable=true, the JsonNullableJackson3Module must be wired via the"
+ " XmlMapper.Builder#addModule API.")
public void testRestClientWithXMLAndJackson3AndOpenApiNullable_issue_23860() {
final Path output = newTempFolder();
final CodegenConfigurator configurator = new CodegenConfigurator()
.setGeneratorName(JAVA_GENERATOR)
.setLibrary(JavaClientCodegen.RESTCLIENT)
.setAdditionalProperties(Map.of(
CodegenConstants.API_PACKAGE, "xyz.abcdef.api",
CodegenConstants.WITH_XML, true,
JavaClientCodegen.USE_JACKSON_3, true,
JavaClientCodegen.USE_SPRING_BOOT4, true,
JavaClientCodegen.OPENAPI_NULLABLE, true
))
.setInputSpec("src/test/resources/3_1/java/petstore.yaml")
.setOutputDir(output.toString().replace("\\", "/"));

List<File> files = new DefaultGenerator().opts(configurator.toClientOptInput()).generate();

validateJavaSourceFiles(files);
assertFileContains(
output.resolve("src/main/java/xyz/abcdef/ApiClient.java"),
"import org.openapitools.jackson.nullable.JsonNullableJackson3Module;",
"XmlMapper xmlMapper = XmlMapper.builder()",
".addModule(new JsonNullableJackson3Module())",
".build();"
);
TestUtils.assertFileNotContains(
output.resolve("src/main/java/xyz/abcdef/ApiClient.java"),
"xmlMapper.registerModule("
);
}


@Test
public void testRestClientWithUseSingleRequestParameter_issue_19406() {
Expand Down