MOXy:DynamicJAXBContext错误地处理XSD枚举文字(@XmlEnumValue)

时间:2019-11-11 10:07:55

标签: java enums jaxb moxy

问题::在使用DynamicJAXBContext时,由MOXy生成的枚举的映射(经2.7.4、2.7.5测试)显示出不希望的(错误的)行为:

  1. XML源中期望的值对应于the java.lang.Enum.name(),而不是XSD中定义的文字。 例如:给定XSD枚举文字fooValue,MOXy期望FOO_VALUE
  2. 即使在XML源中使用了java.lang.Enum.name()(已经很骇人了!),动态生成的java.lang.Enum常量也没有@XmlEnumValue批注。这将导致在编组时生成无效的XML:考虑上一个示例,Marshaller会写FOO_VALUE而不是fooValue

问题:有什么办法可以改善这种行为?我可以忍受问题1,但是问题2使MOXy对我来说完全无法使用。

复制:

JUnit-Test(为简便起见,省略了导入)(失败):

  @Test
  public void test_xmlEnumValue() throws Exception {
    String resourcesBasePath = "src/test/resources/enums/";
    FileInputStream xsdInputStream = new FileInputStream(resourcesBasePath + "EnumSchema.xsd");
    DynamicJAXBContext jaxbContext = DynamicJAXBContextFactory.createContextFromXSD(xsdInputStream, null, null, null);
    JAXBUnmarshaller unmarshaller = jaxbContext.createUnmarshaller();

    File inputFile = new File(resourcesBasePath + "EnumSchemaInstance.xml");
    StreamSource xmlInputStreamSource = new StreamSource(inputFile);
    JAXBElement<DynamicEntity> dynamicEntity = (JAXBElement<DynamicEntity>) unmarshaller.unmarshal(xmlInputStreamSource);
    Enum testEnumValue = (Enum) dynamicEntity.getValue().get("testEnumValue");
    assertThat(testEnumValue.name(), IsEqual.equalTo("FOO_VALUE"));
  }

EnumSchema.xsd:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://acme.com/test" targetNamespace="http://acme.com/test"
    elementFormDefault="qualified" attributeFormDefault="unqualified" version="1.0">
    <xs:element name="test" type="tns:TestType" />
    <xs:complexType name="TestType">
        <xs:sequence>
            <xs:element name="testEnumValue" type="tns:TestEnum" />
        </xs:sequence>
    </xs:complexType>
    <xs:simpleType name="TestEnum">
        <xs:restriction base="xs:string">
            <xs:enumeration value="fooValue" />
            <xs:enumeration value="Bar_Value" />
        </xs:restriction>
    </xs:simpleType>
</xs:schema>

EnumSchemaInstance.xml:

<test xmlns="http://acme.com/test">
    <testEnumValue>fooValue</testEnumValue>
</test>

进一步的研究:

@XmlEnumValue上仍可以找到EnumTypeInfo注释的最新时间是org.eclipse.persistence.jaxb.compiler.MappingsGenerator.buildJAXBEnumTypeConverter(Mapping, EnumTypeInfo)

private JAXBEnumTypeConverter buildJAXBEnumTypeConverter(Mapping mapping, EnumTypeInfo enumInfo){
    JAXBEnumTypeConverter converter = new JAXBEnumTypeConverter(mapping, enumInfo.getClassName(), false);
    List<String> fieldNames = enumInfo.getFieldNames();
    List<Object> xmlEnumValues = enumInfo.getXmlEnumValues();
    for (int i=0; i< fieldNames.size(); i++) {
        converter.addConversionValue(xmlEnumValues.get(i), fieldNames.get(i));
    }
    return converter;
}

此时的问题似乎是fieldNamesxmlEnumValues都只包含一个值:value。考虑到此时可以通过在JEnumConstant中使用正确注释的com.sun.codemodel.JDefinedClass.enumConstantsByName来获得正确的值,这几乎没有用。由于此方法创建的映射现在仅将"value"映射到"value",因此缺少的值将在稍后的时间点映射,在此处org.eclipse.persistence.jaxb.JAXBEnumTypeConverter.initialize(DatabaseMapping, Session)

public void initialize(DatabaseMapping mapping, Session session) {
    Iterator<Enum> i = EnumSet.allOf(m_enumClass).iterator();
    while (i.hasNext()) {
        Enum theEnum = i.next();
        if (this.getAttributeToFieldValues().get(theEnum) == null) {
            Object existingVal = this.getAttributeToFieldValues().get(theEnum.name());
            if (existingVal != null) {
                this.getAttributeToFieldValues().remove(theEnum.name());
                addConversionValue(existingVal, theEnum);
            } else {
                // if there's no user defined value, create a default
                if (m_usesOrdinalValues) {
                    addConversionValue(theEnum.ordinal(), theEnum);
                } else {
                    addConversionValue(theEnum.name(), theEnum);
                }
            }
        }
    }

    super.initialize(mapping, session);
}

不考虑使用序数值,现在映射将在一侧使用java.lang.Enum.name()->问题1 ),而在另一侧使用java.lang.Enum s侧。但是,由于java.lang.Class.getFields()的字段(即java.lang.Enum)缺少@XmlEnumValue批注,因此编组者创建的XML也将包含java.lang.Enum.name()->问题2

EnumSchemaInstance.xml中的XML链以包含java.lang.Enum.name(),即e。:

<?xml version="1.0" encoding="UTF-8"?> <test xmlns="http://acme.com/test"> <testEnumValue>FOO_VALUE</testEnumValue> </test>

导致映射找到java.lang.Enum,进一步验证问题1。现在,如果JAXBElement<DynamicEntity> dynamicEntity再次像这样编组:

JAXBMarshaller marshaller = jaxbContext.createMarshaller();
marshaller.setProperty(JAXBMarshaller.JAXB_FORMATTED_OUTPUT, true);
marshaller.marshal(dynamicEntity, System.out);

XML输出显示java.lang.Enum.name(),进一步验证问题2:

<?xml version="1.0" encoding="UTF-8"?>
<test xmlns="http://acme.com/test">
   <testEnumValue>FOO_VALUE</testEnumValue>
</test>

编辑:链接到EclipseLink Bugzilla:https://bugs.eclipse.org/bugs/show_bug.cgi?id=552902

1 个答案:

答案 0 :(得分:0)

TL; DR::如果不调整/重写SchemaMetadataDynamicClassLoaderDynamicClassWriter是不可能的,这是很多工作。

完整版本: 最终由org.eclipse.persistence.dynamic.DynamicClassWriter.createEnum(EnumInfo)调用的DynamicClassLoader仅知道一个EnumInfo对象,该对象在前者中定义。 EnumInfo对注解一无所知,只知道类名和枚举文字

public static class EnumInfo {
    String className;
    List<String> literalLabels = new ArrayList<String>();

    ...

}

MOXy的(间接)调用部分是org.eclipse.persistence.jaxb.dynamic.metadata.SchemaMetadata.createClassModelFromXJC(ArrayList<JDefinedClass>, JCodeModel, DynamicClassLoader),在JEnumConstant s中存储的注释信息丢失了:

        if (definedClass.getClassType().equals(ClassType.ENUM)) {
            Map<String, JEnumConstant> enumConstants = (Map<String, JEnumConstant>) PrivilegedAccessHelper.getValueFromField(JDEFINEDCLASS_ENUMCONSTANTS, definedClass);
            Object[] enumValues = enumConstants.keySet().toArray();
            dynamicClassLoader.addEnum(definedClass.fullName(), enumValues);
        }

为了保留注释,存储在JEnumConstant的注释信息将需要在DynamicClassWriter中可用(例如,通过扩展EnumInfo)和{的实现{1}}将需要进行调整以编写表示注释的字节码。