JAXB命名空间及命名空间前缀处理

本篇介绍下JAXB进阶使用，命名空间处理

• 使用package-info.java添加默认命名空间
  在需要添加命名空间的包下面添加package-info.java文件，然后添加@XmlSchema注解，这样整个包序列化时就都会自动加上命名空间了

  @XmlSchema(namespace = "http://www.lzrabbit.cn")
  package cn.lzrabbit;
  
  import javax.xml.bind.annotation.XmlSchema;

   

• 命名空间前缀处理
  相信大名鼎鼎的ns2，nsXX让很多人非常头疼类似下面这样的

  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <ns2:classA xmlns:ns2="http://www.lzrabbit.cn">
      <classAId>11</classAId>
      <ClassAName>A1</ClassAName>
      <classB>
          <ClassBId>22</ClassBId>
          <ClassBName>B2</ClassBName>
      </classB>
  </ns2:classA>

  解决方法一(不推荐)：
  添加package-info.java添加@XmlSchema注解并设置属性xmlns

  @XmlSchema( xmlns = { @XmlNs(namespaceURI = "http://www.lzrabbit.cn", prefix = "rabbit"), @XmlNs(namespaceURI = "http://www.cnblogs.com", prefix = "blog")})
  
  package cn.lzrabbit;
  import javax.xml.bind.annotation.XmlSchema;
  import javax.xml.bind.annotation.XmlNs;

  ClassA如下

  package cn.lzrabbit;
  
  import javax.xml.bind.annotation.*;
  
  @XmlRootElement(namespace="http://www.lzrabbit.cn")
  @XmlAccessorType(XmlAccessType.FIELD)
  public class ClassA {
      private int classAId;
      
      @XmlElement(name="ClassAName")
      private String classAName;
  
      private ClassB classB;
  
      public int getClassAId() {
          return classAId;
      }
      public void setClassAId(int classAId) {
          this.classAId = classAId;
      }
  
      public String getClassAName() {
          return classAName;
      }
  
      public void setClassAName(String classAName) {
          this.classAName = classAName;
      }
  
      public ClassB getClassB() {
          return classB;
      }
  
      public void setClassB(ClassB classB) {
          this.classB = classB;
      }
  }

   

  序列化结果如下，可以看到已经按照我们所预期的修改了命名空间前缀，这里要注意下需要自定义前缀的实体类添加的@XmlRootElement(namespace="http://www.lzrabbit.cn")注解时指定的namespace必须和package-info.java定义的前缀一致，否则还是会生成nsXX这样的前缀

  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <rabbit:classA xmlns:rabbit="http://www.lzrabbit.cn" xmlns:blog="http://www.cnblogs.com">
      <classAId>11</classAId>
      <ClassAName>A1</ClassAName>
      <classB>
          <ClassBId>22</ClassBId>
          <ClassBName>B2</ClassBName>
      </classB>
  </rabbit:classA>

  注意事项
  1.若jdk版本为1.6的需要需要添加jaxb-core-2.2.7.jar和jaxb-impl-2.2.7.jar两个包的引用，否则即便设置了package-info的XmlSchema注解的xmlns注释也不能生效，若为jdk 1.7的无需添加
  2.使用XmlSchema定义的前缀会对整个包生效，无法实现对每个实体类的单独前缀定义，很不灵活，故此不推荐使用此方式
  
  解决方法二(推荐)：
  同方法一若jdk版本为1.6需要添加jaxb-core-2.2.7.jar和jaxb-impl-2.2.7.jar两个包的引用，不过方法二不需要添加package-info当然也就不需要定义XmlSchema
  思路就是实现NamespacePrefixMapper抽象类，并重写getPreferredPrefix方法，看到方法名应该都明白了，对就是在序列化的时候重写获取命名空间前缀方法，为了简洁这里使用类匿名内部类实现的

  marshaller.setProperty("com.sun.xml.bind.namespacePrefixMapper", new NamespacePrefixMapper() {
                  @Override
                  public String getPreferredPrefix(String namespaceUri, String suggestion, boolean requirePrefix) {
                      if (namespaceUri.equals("http://www.lzrabbit.cn")) return "abc";
                     return suggestion;
                  }
              });

  如上所示，在序列化时判断namespaceUri也就是我们定义的命名空间，然后返回我们自定义的前缀，其中的suggestion参数就是默认的前缀，有兴趣的话打印下就会发现suggestion就是ns2之类的前缀，把要自定义前缀的命名空间都在这里判断下就可以完全控制自定义前缀了，相对方法一来说可以实现对每个实体类的命名空间前缀控制，采用方法二后的序列化结果：

  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <abc:classA xmlns:abc="http://www.lzrabbit.cn">
      <classAId>11</classAId>
      <ClassAName>A1</ClassAName>
      <classB>
          <ClassBId>22</ClassBId>
          <ClassBName>B2</ClassBName>
      </classB>
  </abc:classA>

  采用方法二后的序列化方法

  package cn.lzrabbit;
  
  import java.io.StringReader;
  import java.io.StringWriter;
  
  import javax.xml.bind.*;
  
  import com.sun.xml.bind.marshaller.NamespacePrefixMapper;
  import com.sun.xml.bind.v2.WellKnownNamespace;
  
  public class XmlUtil {
  
      public static String toXML(Object obj) {
          try {
              JAXBContext context = JAXBContext.newInstance(obj.getClass());
  
              Marshaller marshaller = context.createMarshaller();
              marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");// //编码格式
              marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);// 是否格式化生成的xml串
              marshaller.setProperty(Marshaller.JAXB_FRAGMENT, false);// 是否省略xm头声明信息
  
              marshaller.setProperty("com.sun.xml.bind.namespacePrefixMapper", new NamespacePrefixMapper() {
                  @Override
                  public String getPreferredPrefix(String namespaceUri, String suggestion, boolean requirePrefix) {
                      if (namespaceUri.equals("http://www.lzrabbit.cn")) return "abc";
                      if (namespaceUri.contains("http://www.cnblogs.com")) return "blog";
                      return suggestion;
                  }
              });
  
              StringWriter writer = new StringWriter();
              marshaller.marshal(obj, writer);
              return writer.toString();
          } catch (Exception e) {
              throw new RuntimeException(e);
          }
      }
  
      @SuppressWarnings("unchecked")
      public static <T> T fromXML(String xml, Class<T> valueType) {
          try {
              JAXBContext context = JAXBContext.newInstance(valueType);
              Unmarshaller unmarshaller = context.createUnmarshaller();
              return (T) unmarshaller.unmarshal(new StringReader(xml));
          } catch (Exception e) {
              throw new RuntimeException(e.getMessage());
          }
      }
  }

   

现在我们基本解决了jaxb序列化xml的命名空间及前缀问题，但还是有很多问题，比如序列化和反序列化时如何忽略命名空间，如何使用@XmlRootElement控制每个实体类的默认命名空间也就是消除命名空间前缀

下一篇继续深入，Java XML操作之JAXB玩转命名空间 

最后给下jaxb-core-2.2.7.jar和jaxb-impl-2.2.7.jar两个包的maven引用

<dependency>
    <groupId>com.sun.xml.bind</groupId>
    <artifactId>jaxb-core</artifactId>
    <version>2.2.7</version>
</dependency>

<dependency>
    <groupId>com.sun.xml.bind</groupId>
    <artifactId>jaxb-impl</artifactId>
    <version>2.2.7</version>
</dependency>

也可以自行去官网下载 https://jaxb.java.net/