18

我是在 xml 中使用命名空间的新手,所以我有点困惑,想澄清一下。我有一个 java 服务,我在其中接收具有许多不同名称空间的 xml 文档,当我让它工作时,我觉得我一定做错了什么,所以我想检查一下。在我的 package-info.java 我有我的模式注释,例如:

@javax.xml.bind.annotation.XmlSchema(
    xmlns={
        @javax.xml.bind.annotation.XmHS(prefix="train", namespaceURI="http://mycompany/train"), 
        @javax.xml.bind.annotation.XmHS(prefix="passenger", namespaceURI="http://mycompany/passenger")
    }, 
    elementFormDefault = javax.xml.bind.annotation.XmlNsForm=QUALIFIED
)

我有一个在类级别注释的 Train.java:

@XmlRootElement(name="Train", namespace="http://mycompany/train")

并且类中的每个字段都用以下注释:

@XmlElement(name="Color") for example

火车包含一个乘客列表,所以有一个属性

private Set<Passenger> passengers;

并且此集合注释为:

@XmlElementWrapper(name="Passengers")
@XmlElements(@XmlElement(name="Passenger", namespace="http://mycompany/passenger"))

然后在Passenger.java中,类本身被注释:

@XmlElement(name="Passenger", namespace="http://mycompany/passenger")

最后,对于Passenger.java 中的各个字段,它们的注释如下:

@XmlElement(name="TicketNumber", namespace="http://mycompany/passenger")

所以当我有一个看起来像这样的xml时:

<train:Train>
   <train:Color>Red</train:Color>
   <train:Passengers>
       <train:Passenger>
           <passenger:TicketNumber>T101</passenger:TicketNumber>
       </train:Passenger>
   </train:Passengers>
</train:Train>

现在我解组收到的这个 xml,并设置了 Train 的 Color 属性和Passenger 的 TicketNumber 属性。但我不知道为什么我需要在 TicketNumber 上的 XmlElement 注释上添加命名空间 url 才能工作,但我不需要为 Train 上的 Color 属性这样做。如果我从 TicketNumber 上的 XmlElement 注释中删除命名空间属性,则 xml 中的值不会映射到对象,除非我也从 xml 请求中删除命名空间前缀。我觉得因为我已经在 XmlRootElement 上为乘客定义了命名空间属性,所以我不需要为类中的每个字段都这样做,就像我不需要为火车一样,所以我假设我一定是设置有问题。有人可以指出我正确的方向吗?谢谢!

4

1 回答 1

30

以下是基于您的模型在JAXB (JSR-222)中命名空间如何工作的解释。

JAVA模型

包信息

以下是您的@XmlSchema注释的修改版本。它包含一些关键信息:

  • namespace- 默认命名空间将用于限定未指定另一个命名空间的全局元素(对应于@XmlRootElement@XmlElementDecl注释的那些(以及基于值的本地元素)。elementFormDefault
  • elementFormDefault默认情况下,只有全局元素是命名空间限定的,但通过将值设置为XmlNsForm.QUALIFIED所有未指定显式命名空间的元素将使用该namespace值限定。
  • xmlns是 JAXB impl 应该为这些命名空间使用的首选前缀集(尽管它们可能使用其他前缀)。
@XmlSchema(
    namespace="http://mycompany/train",
    elementFormDefault = XmlNsForm.QUALIFIED,
    xmlns={
       @XmlNs(prefix="train", namespaceURI="http://mycompany/train"), 
       @XmlNs(prefix="passenger", namespaceURI="http://mycompany/passenger")
   }
)
package forum15772478;

import javax.xml.bind.annotation.*;

火车

由于Train类对应的所有元素都对应注解namespace上的指定,所以@XmlSchema我们不需要指定任何命名空间信息。

  • 全局元素 -@XmlRootElement注释对应于全局元素。
  • 本地元素 -@XmlElementWrapper@XmlElement注释对应于本地元素。
package forum15772478;

import java.util.List;
import javax.xml.bind.annotation.*;

@XmlRootElement(name="Train")
public class Train {

    private List<Passenger> passengers;

    @XmlElementWrapper(name="Passengers")
    @XmlElement(name="Passenger")
    public List<Passenger> getPassengers() {
        return passengers;
    }

    public void setPassengers(List<Passenger> passengers) {
        this.passengers = passengers;
    }

}

乘客

如果类上的属性对应的所有元素Passenger都将在http://mycompany/passenger命名空间中,那么您可以使用该@XmlType注解来覆盖namespace@XmlSchema注解。

package forum15772478;

import javax.xml.bind.annotation.*;

@XmlType(namespace="http://mycompany/passenger")
public class Passenger {

    private String ticketNumber;

    @XmlElement(name="TicketNumber")
    public String getTicketNumber() {
        return ticketNumber;
    }

    public void setTicketNumber(String ticketNumber) {
        this.ticketNumber = ticketNumber;
    }

}

或者,您可以在属性级别覆盖命名空间。

package forum15772478;

import javax.xml.bind.annotation.*;

public class Passenger {

    private String ticketNumber;

    @XmlElement(
        namespace="http://mycompany/passenger",
        name="TicketNumber")
    public String getTicketNumber() {
        return ticketNumber;
    }

    public void setTicketNumber(String ticketNumber) {
        this.ticketNumber = ticketNumber;
    }

}

演示代码

可以运行以下演示代码来证明一切正常:

演示

package forum15772478;

import java.io.File;
import javax.xml.bind.*;

public class Demo {

    public static void main(String[] args) throws Exception {
        JAXBContext jc = JAXBContext.newInstance(Train.class);

        Unmarshaller unmarshaller = jc.createUnmarshaller();
        File xml = new File("src/forum15772478/input.xml");
        Train train = (Train) unmarshaller.unmarshal(xml);

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

}

输入.xml/输出

在下面的 XML 中,我添加了您问题中的 XML 文档中缺少的必要名称空间声明。

<train:Train 
   xmlns:train="http://mycompany/train" 
   xmlns:passenger="http://mycompany/passenger">
   <train:Color>Red</train:Color>
   <train:Passengers>
       <train:Passenger>
           <passenger:TicketNumber>T101</passenger:TicketNumber>
       </train:Passenger>
   </train:Passengers>
</train:Train>

了解更多信息

于 2013-04-02T19:45:51.067 回答