Removes use of JAXB API via jackson-dataformat-xml #29384

linghengqian · 2023-12-12T17:37:43Z

Changes proposed in this pull request:

Removes use of JAXB API via jackson-dataformat-xml. Reference Transition from Java EE to Jakarta EE #26041 (comment) .
Getting rid of the JAXB API will make ShardingSphere JDBC Core work out of the box under Spring Boot OSS 3/Quarkus 3/Micronaut Framework 4/Helidon 3 with Jakarta EE 9+. The only limitation is XA distributed transactions. This will completely resolve javax.xml.bind.JAXBException: Implementation of JAXB-API has not been found on module path or classpath. #26896.
I know there are quite a few breaking changes on Jackson 3.0. But the problems caused by https://github.com/FasterXML/jackson/wiki/Jackson-Release-3.0 appear to be much smaller than those caused by Jakarta EE 9. And Jackson 3.0 hasn't been released yet.
Revisiting Revise JAXB and javax dependencies in ShardingSphere #16863. I verified on OpenJDK 17.0.9 that shardingsphere-transaction-xa-narayana does not require JAXB at all.
Removes GraalVM Reachability Metadata for org.glassfish.jaxb:jaxb-runtime:2.3.1 which is no longer needed. Passed the test of ./mvnw -PnativeTestInShardingSphere -T1C -e clean test. For Improve GraalVM Reachability Metadata and corresponding nativeTest related unit tests #29052 .
The reason I don't use xstream is because it requires a lot of json entries for the GraalVM Reachability Metadata. Reference How to reduce the amount of metadata when there are a lot of reflections in the code. oracle/graalvm-reachability-metadata#232.
Explicitly introduce com.fasterxml.jackson.datatype:jackson-datatype-jdk8 to adapt to Jackson 2.16.0. Otherwise an error is thrown.

[ERROR] Tests run: 1, Failures: 0, Errors: 1, Skipped: 0, Time elapsed: 0.954 s <<< FAILURE! -- in org.apache.shardingsphere.data.pipeline.core.job.PipelineJobIdUtilsTest
[ERROR] org.apache.shardingsphere.data.pipeline.core.job.PipelineJobIdUtilsTest.assertParse -- Time elapsed: 0.869 s <<< ERROR!
com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Java 8 optional type `java.util.Optional<java.lang.String>` not supported by default: add Module "com.fasterxml.jackson.datatype:jackson-datatype-jdk8" to enable handling (through reference chain: org.apache.shardingsphere.data.pipeline.scenario.migration.MigrationJobId["jobType"]->org.apache.shardingsphere.data.pipeline.scenario.migration.MigrationJobType["toBeStartDisabledNextJobType"])
        at com.fasterxml.jackson.databind.exc.InvalidDefinitionException.from(InvalidDefinitionException.java:77)
        at com.fasterxml.jackson.databind.SerializerProvider.reportBadDefinition(SerializerProvider.java:1330)
        at com.fasterxml.jackson.databind.ser.impl.UnsupportedTypeSerializer.serialize(UnsupportedTypeSerializer.java:35)
        at com.fasterxml.jackson.databind.ser.BeanPropertyWriter.serializeAsField(BeanPropertyWriter.java:732)
        at com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serializeFields(BeanSerializerBase.java:770)
        at com.fasterxml.jackson.databind.ser.BeanSerializer.serialize(BeanSerializer.java:183)
        at com.fasterxml.jackson.databind.ser.BeanPropertyWriter.serializeAsField(BeanPropertyWriter.java:732)
        at com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serializeFields(BeanSerializerBase.java:770)
        at com.fasterxml.jackson.databind.ser.BeanSerializer.serialize(BeanSerializer.java:183)
        at com.fasterxml.jackson.databind.ser.DefaultSerializerProvider._serialize(DefaultSerializerProvider.java:502)
        at com.fasterxml.jackson.databind.ser.DefaultSerializerProvider.serializeValue(DefaultSerializerProvider.java:341)
        at com.fasterxml.jackson.databind.ObjectMapper._writeValueAndClose(ObjectMapper.java:4793)
        at com.fasterxml.jackson.databind.ObjectMapper.writeValueAsString(ObjectMapper.java:4038)
        at org.apache.shardingsphere.infra.util.json.JsonUtils.toJsonString(JsonUtils.java:61)
        at org.apache.shardingsphere.data.pipeline.core.job.id.PipelineJobId.marshalSuffix(PipelineJobId.java:54)
        at org.apache.shardingsphere.data.pipeline.core.job.id.PipelineJobIdUtils.marshal(PipelineJobIdUtils.java:52)
        at org.apache.shardingsphere.data.pipeline.core.job.PipelineJobIdUtilsTest.assertParse0(PipelineJobIdUtilsTest.java:44)
        at org.apache.shardingsphere.data.pipeline.core.job.PipelineJobIdUtilsTest.assertParse(PipelineJobIdUtilsTest.java:38)
        at java.base/java.lang.reflect.Method.invoke(Method.java:568)
        at java.base/java.util.ArrayList.forEach(ArrayList.java:1511)
        at java.base/java.util.ArrayList.forEach(ArrayList.java:1511)

Before committing this PR, I'm sure that I have checked the following options:

My code follows the code of conduct of this project.
I have self-reviewed the commit code.
I have (or in comment I request) added corresponding labels for the pull request.
I have passed maven check locally : ./mvnw clean install -B -T1C -Dmaven.javadoc.skip -Dmaven.jacoco.skip -e.
I have made corresponding changes to the documentation.
I have added corresponding unit tests for my changes.

zhfeng · 2023-12-13T02:36:03Z

...in/java/org/apache/shardingsphere/mode/repository/standalone/jdbc/sql/JDBCRepositorySQL.java

 @Getter
 public final class JDBCRepositorySQL {

-    @XmlAttribute(required = true)
+    @JacksonXmlProperty(isAttribute = true)


We lost required here? Is there no such property with JacksonXmlProperty?

There is no direct equivalent.

Unfortunately XML is special: due to structure being what it is, empty Element looks either as "Object with no properties" or "empty String".

In Required attribute of @JsonProperty is ignored when deserializing from XML FasterXML/jackson-dataformat-xml#538, the Jackson maintainer has a different opinion on required than the JAXB API. Should I use @JsonProperty to mark required and then set it as follows?

final XmlMapper xmlMapper = new XmlMapper(); xmlMapper.configure(DeserializationFeature.FAIL_ON_MISSING_CREATOR_PROPERTIES, true);

I'm not sure how the JAXB API handles the required attribute.

In my local unit test, jaxb-runtime does not throw an exception for empty elements, but gets null values normally like jackson-dataformat-xml. required seems to be just for IDE censorship.

OK, I see. It could be better to open an issue since we need more investigation.

OK, I see. It could be better to open an issue since we need more investigation.

I opened Without setting @JsonCreator for the POJO, the required attribute in @JsonProperty is not checked FasterXML/jackson-dataformat-xml#625 .

A PR for testing is at Check specific properties when deserializing XML file #29577 .

linghengqian added feature: transaction type: refactor mode: standalone labels Dec 12, 2023

This was referenced Dec 12, 2023

Transition from Java EE to Jakarta EE #26041

Open

Improve GraalVM Reachability Metadata and corresponding nativeTest related unit tests #29052

Open

linghengqian force-pushed the remove-jaxb branch from a9c5fdd to b81d060 Compare December 12, 2023 18:08

linghengqian marked this pull request as ready for review December 12, 2023 18:09

Removes use of JAXB API via jackson-dataformat-xml

112635d

linghengqian force-pushed the remove-jaxb branch from b81d060 to 5b63b51 Compare December 12, 2023 20:46

Removes JAXB API in sql-federation-optimizer test

97edd1c

linghengqian force-pushed the remove-jaxb branch from 5b63b51 to 97edd1c Compare December 12, 2023 20:49

zhfeng reviewed Dec 13, 2023

View reviewed changes

terrymanu added this to the 5.4.2 milestone Dec 13, 2023

terrymanu approved these changes Dec 13, 2023

View reviewed changes

terrymanu merged commit f895ac9 into apache:master Dec 13, 2023
133 checks passed

linghengqian deleted the remove-jaxb branch December 13, 2023 05:02

This was referenced Dec 13, 2023

Create Maven module shardingsphere-jdbc-core-jakarta using Jakarta EE 9 API #29209

Closed

Remove sql-federation’s transitive dependency on JAXB #29393

Merged

This was referenced Dec 28, 2023

Check specific properties when deserializing XML file #29577

Merged

Without setting @JsonCreator for the POJO, the required attribute in @JsonProperty is not checked FasterXML/jackson-dataformat-xml#625

Closed

linghengqian mentioned this pull request Jan 21, 2024

Migrate from Jakarta EE 8 to Jakarta EE 9 #27976

Open

6 tasks

linghengqian mentioned this pull request Feb 12, 2024

Remove invalid Jakarta EE 8 dependency LICENSE #30098

Merged

6 tasks

linghengqian mentioned this pull request Apr 3, 2024

springboot3.1.2+shardingsphere5.4.1 Caused by: java.lang.ClassNotFoundException: com.sun.xml.internal.bind.v2.ContextFactory #30756

Closed

linghengqian mentioned this pull request Apr 30, 2024

SpringBoot project return format is not json #31067

Closed

linghengqian mentioned this pull request May 11, 2024

shardingsphere-jdbc-5.5.0 causes spring boot to return JSON data as XML #31203

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Removes use of JAXB API via jackson-dataformat-xml #29384

Removes use of JAXB API via jackson-dataformat-xml #29384

linghengqian commented Dec 12, 2023 •

edited

zhfeng Dec 13, 2023

linghengqian Dec 13, 2023 •

edited

linghengqian Dec 13, 2023

zhfeng Dec 13, 2023

linghengqian Dec 28, 2023

Removes use of JAXB API via jackson-dataformat-xml #29384

Removes use of JAXB API via jackson-dataformat-xml #29384

Conversation

linghengqian commented Dec 12, 2023 • edited

zhfeng Dec 13, 2023

Choose a reason for hiding this comment

linghengqian Dec 13, 2023 • edited

Choose a reason for hiding this comment

linghengqian Dec 13, 2023

Choose a reason for hiding this comment

zhfeng Dec 13, 2023

Choose a reason for hiding this comment

linghengqian Dec 28, 2023

Choose a reason for hiding this comment

linghengqian commented Dec 12, 2023 •

edited

linghengqian Dec 13, 2023 •

edited