Определите пространства имен Spring JAXB без использования NamespacePrefixMapper - PullRequest
Новая
       14

Определите пространства имен Spring JAXB без использования NamespacePrefixMapper

25 голосов
/ 20 июля 2010

[Сильно отредактировано по мере понимания]

Можно ли заставить Spring Jaxb2Marshaller использовать пользовательский набор префиксов пространства имен (или, по крайней мере, уважать те, которые указаны в файле схемы / аннотациях) без необходимости использовать расширение NamespacePrefixMapper?

Идея состоит в том, чтобы иметь класс с отношением «имеет» к другому классу, который, в свою очередь, содержит свойство с другим пространством имен. Чтобы лучше проиллюстрировать это, рассмотрим следующую схему проекта, в которой используется JDK1.6.0_12 (последнее, что я могу получить на работе). У меня есть следующее в пакете org.example.domain:

Main.java: 

package org.example.domain;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;

public class Main {
  public static void main(String[] args) throws JAXBException {
    JAXBContext jc = JAXBContext.newInstance(RootElement.class);

    RootElement re = new RootElement();
    re.childElementWithXlink = new ChildElementWithXlink();

    Marshaller marshaller = jc.createMarshaller();
    marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
    marshaller.marshal(re, System.out);
  }

}

RootElement.java: 

package org.example.domain;

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement(namespace = "www.example.org/abc", name="Root_Element")
public class RootElement {
  @XmlElement(namespace = "www.example.org/abc")
  public ChildElementWithXlink childElementWithXlink;

}

ChildElementWithXLink.java: 

package org.example.domain;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlSchemaType;

@XmlRootElement(namespace="www.example.org/abc", name="Child_Element_With_XLink")
public class ChildElementWithXlink {
  @XmlAttribute(namespace = "http://www.w3.org/1999/xlink")
  @XmlSchemaType(namespace = "http://www.w3.org/1999/xlink", name = "anyURI")
  private String href="http://www.example.org";

}

package-info.java: 

@javax.xml.bind.annotation.XmlSchema(
    namespace = "http://www.example.org/abc",
    xmlns = {
          @javax.xml.bind.annotation.XmlNs(prefix = "abc", namespaceURI ="http://www.example.org/abc"),
          @javax.xml.bind.annotation.XmlNs(prefix = "xlink", namespaceURI = "http://www.w3.org/1999/xlink")
            }, 
    elementFormDefault = javax.xml.bind.annotation.XmlNsForm.QUALIFIED)
    package org.example.domain;

Запуск Main.main () дает следующий вывод: 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:Root_Element xmlns:ns1="http://www.w3.org/1999/xlink" xmlns:ns2="www.example.org/abc">
<ns2:childElementWithXlink ns1:href="http://www.example.org"/>
</ns2:Root_Element>

тогда как я бы хотел: 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<abc:Root_Element xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:abc="www.example.org/abc">
<abc:childElementWithXlink xlink:href="http://www.example.org"/>
</abc:Root_Element>

Как только эта часть заработает, проблема переходит к настройке Jaxb2Marshaller в Spring (Spring 2.5.6, где spring-oxm-tiger-1.5.6 предоставляет Jaxb2Marshaller), так что он обеспечивает то же самое с помощью простого настройка контекста и вызов маршала ().

Спасибо за постоянный интерес к этой проблеме!

Ответы [ 4 ]

12 голосов
/ 22 июля 2010

[Некоторые правки, предлагающие альтернативу JAXB-RI, находятся в конце этого поста]

Ну, после долгих царапин мне, наконец, пришлось принять это для моей среды (JDK1.6.0_12 в WindowsXP и JDK1.6.0_20 на Mac Leopard) Я просто не могу заставить это работать, не прибегая к злу, которое является NamespacePrefixMapper.Почему это зло?Потому что это заставляет полагаться на внутренний класс JVM в вашем производственном коде.Эти классы не являются частью надежного интерфейса между JVM и вашим кодом (т.е. они меняются между обновлениями JVM).

По моему мнению, Sun должна решить эту проблему, или кто-то с более глубокими знаниями мог бы добавить к этому ответу - пожалуйста!

Двигаемся дальше.Поскольку NamespacePrefixMapper не предполагается использовать вне JVM, он не включен в стандартный путь компиляции javac (подраздел rt.jar, контролируемый ct.sym).Это означает, что любой код, который зависит от него, вероятно, будет хорошо компилироваться в IDE, но не будет работать в командной строке (например, Maven или Ant).Чтобы преодолеть это, файл rt.jar должен быть явно включен в сборку, и даже тогда Windows, похоже, испытывает проблемы, если в пути есть пробелы.

Если вы оказались в этой позиции, вот Mavenфрагмент, который избавит вас от неприятностей: 

<dependency>
  <groupId>com.sun.xml.bind</groupId>
  <artifactId>jaxb-impl</artifactId>
  <version>2.1.9</version>
  <scope>system</scope>
  <!-- Windows will not find rt.jar if it is in a path with spaces -->
  <systemPath>C:/temp/rt.jar</systemPath>
</dependency>

Обратите внимание на жестко закодированный путь для мусора в странное место для rt.jar.Вы можете обойти это с помощью комбинации {java.home} /lib/rt.jar, которая будет работать на большинстве ОС, но из-за проблемы с пространством Windows не гарантируется.Да, вы можете использовать профили и соответственно активировать ...

В качестве альтернативы, в Ant вы можете сделать следующее: 

<path id="jre.classpath">
  <pathelement location="${java.home}\lib" />
</path>
// Add paths for build.classpath and define {src},{target} as usual
<target name="compile" depends="copy-resources">
  <mkdir dir="${target}/classes"/>
  <javac bootclasspathref="jre.classpath" includejavaruntime="yes" debug="on" srcdir="${src}" destdir="${target}/classes" includes="**/*">
    <classpath refid="build.classpath"/>
  </javac>
</target>

А как насчет конфигурации Jaxb2Marshaller Spring?Что ж, вот оно, в комплекте с моим собственным NamespacePrefixMapper:

Spring: 

<!-- JAXB2 marshalling (domain objects annotated with JAXB2 meta data) -->
<bean id="jaxb2Marshaller" class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
<property name="contextPaths">
  <list>
    <value>org.example.domain</value>
  </list>
</property>
<property name="marshallerProperties">
  <map>
    <!-- Good for JDK1.6.0_6+, lose 'internal' for earlier releases - see why it's evil? -->
    <entry key="com.sun.xml.internal.bind.namespacePrefixMapper" value-ref="myCapabilitiesNamespacePrefixMapper"/>
    <entry key="jaxb.formatted.output"><value type="boolean">true</value></entry>
  </map>
</property>
</bean>

<!-- Namespace mapping prefix (ns1->abc, ns2->xlink etc) -->
<bean id="myNamespacePrefixMapper" class="org.example.MyNamespacePrefixMapper"/>

Тогда мой код NamespacePrefixMapper: 

public class MyNamespacePrefixMapper extends NamespacePrefixMapper {

  public String getPreferredPrefix(String namespaceUri,
                               String suggestion,
                               boolean requirePrefix) {
    if (requirePrefix) {
      if ("http://www.example.org/abc".equals(namespaceUri)) {
        return "abc";
      }
      if ("http://www.w3.org/1999/xlink".equals(namespaceUri)) {
        return "xlink";
      }
      return suggestion;
    } else {
      return "";
    }
  }
}

Ну, вот оно.Надеюсь, это поможет кому-то избежать боли, через которую я прошел.О, кстати, вы можете столкнуться со следующим исключением, если вы используете вышеуказанный злой подход в Jetty:

java.lang.IllegalAccessError: классу sun.reflect.GeneratedConstructorAccessor23 не удается получить доступ к его суперклассу sun.reflect.ConstructorAccessorImpl

Так что удачи в сортировке.Подсказка: rt.jar в пути загрузки вашего веб-сервера.

[Дополнительные правки, чтобы показать подход JAXB-RI (эталонная реализация)]

Если вы можете ввести Библиотеки JAXB-RI в своем коде вы можете внести следующие изменения, чтобы получить тот же эффект:

Main: 

// Add a new property that implies external access
marshaller.setProperty("com.sun.xml.bind.namespacePrefixMapper", new MyNamespacePrefixMapper());

MyNamespacePrefixMapper: 

// Change the import to this
import com.sun.xml.bind.marshaller.NamespacePrefixMapper;

Добавьте следующий JAR-файл из загрузки JAXB-RI (после перехода через лицензионные циклы) из папки / lib: 

jaxb-impl.jar

Запуск Main.main () приведет к желаемому выводу.

9 голосов
/ 20 июля 2010

(Сильно отредактированный ответ)

Я считаю, что проблема в вашем коде связана с некоторыми несоответствиями URI в пространстве имен. Иногда вы используете "http://www.example.org/abc", а иногда " www.example.org/abc ". Следующие действия должны помочь:

Main.java 

package org.example.domain;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;

public class Main {

    public static void main(String[] args) throws JAXBException { 
        JAXBContext jc = JAXBContext.newInstance(RootElement.class); 
        System.out.println(jc);

        RootElement re = new RootElement(); 
        re.childElementWithXlink = new ChildElementWithXlink(); 

        Marshaller marshaller = jc.createMarshaller(); 
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true); 
        marshaller.marshal(re, System.out); 
      } 
}

RootElement.java 

package org.example.domain; 

import javax.xml.bind.annotation.XmlElement; 
import javax.xml.bind.annotation.XmlRootElement; 

@XmlRootElement(namespace="http://www.example.org/abc", name="Root_Element") 
public class RootElement { 
  @XmlElement(namespace = "http://www.example.org/abc") 
  public ChildElementWithXlink childElementWithXlink; 

}

ChildElementWithXLink.java 

package org.example.domain;

import javax.xml.bind.annotation.XmlAttribute; 
import javax.xml.bind.annotation.XmlRootElement; 
import javax.xml.bind.annotation.XmlSchemaType; 

@XmlRootElement(namespace="http://www.example.org/abc", name="Child_Element_With_XLink") 
public class ChildElementWithXlink { 
  @XmlAttribute(namespace = "http://www.w3.org/1999/xlink") 
  @XmlSchemaType(namespace = "http://www.w3.org/1999/xlink", name = "anyURI") 
  private String href="http://www.example.org"; 

}

package-info.java 

@javax.xml.bind.annotation.XmlSchema( 
    namespace = "http://www.example.org/abc", 
    xmlns = { 
          @javax.xml.bind.annotation.XmlNs(prefix = "abc", namespaceURI ="http://www.example.org/abc"), 
          @javax.xml.bind.annotation.XmlNs(prefix = "xlink", namespaceURI = "http://www.w3.org/1999/xlink") 
            },  
    elementFormDefault = javax.xml.bind.annotation.XmlNsForm.QUALIFIED) 
    package org.example.domain;

Теперь запущенный Main.main () дает следующий вывод: 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<abc:Root_Element xmlns:abc="http://www.example.org/abc" xmlns:xlink="http://www.w3.org/1999/xlink">
    <abc:childElementWithXlink xlink:href="http://www.example.org"/>
</abc:Root_Element>
1 голос
/ 12 января 2011

@ Blaise: Можете ли вы обновить документацию MOXy с помощью этой информации:

Определить пространства имен Spring JAXB без использования NamespacePrefixMapper

Я думаю, что там не описано, какВы можете настроить префиксы пространства имен.Спасибо!

0 голосов
/ 05 августа 2011

Реализация JAXB в JDK 7 поддерживает префикс пространства имен. Я попытался с JDK 1.6.0_21 без удачи.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.

Нет похожих вопросов

...