Detailed example of JAXB namespace and prefix in Java-javaTutorial-php.cn

This article mainly introduces you to the relevant information about the JAXB namespace and prefixes. The article introduces it in detail through the example code. It has certain reference learning value for everyone's study or work. Friends who need it follow the below Let’s learn together.

This article explains how to use jaxb combined with dom4j's XMLFilterImpl filter to achieve complete control of serialization and deserialization

Mainly implement the following functions

 Ignore namespace when serializing and deserializing
 Use when serializing @XmlRootElement(namespace="http:/ /www.lzrabbit.cn") annotation is used as the default namespace of the class, completely eliminating the namespace prefix
 It will not work when the referenced class has a different namespace during serialization Generate a namespace prefix, but add the corresponding xmlns declaration to the specific xml node
 Other xml node naming and namespace requirements
 There are multiple namespaces under the same package
 Custom namespace prefix

Dependent jar dom4j

 <dependency>
   <groupId>dom4j</groupId>
   <artifactId>dom4j</artifactId>
   <version>1.6.1</version>
 </dependency>

Copy after login

The main principle is to control the namespace and xml node name through the anonymous implementation class of XMLFilterImpl during serialization and deserialization, to achieve diverse Personalized needs, don’t talk nonsense and go directly to the code. If you have more personalized needs, please expand by yourself

package com.bjpowernode.util;

import java.io.StringReader;
import java.io.StringWriter;

import javax.xml.bind.*;
import javax.xml.transform.sax.SAXSource;

import org.dom4j.io.OutputFormat;
import org.dom4j.io.XMLWriter;
import org.xml.sax.Attributes;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.XMLReader;
import org.xml.sax.helpers.XMLFilterImpl;
import org.xml.sax.helpers.XMLReaderFactory;

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头声明信息

   StringWriter out = new StringWriter();
   OutputFormat format = new OutputFormat();
   format.setIndent(true);
   format.setNewlines(true);
   format.setNewLineAfterDeclaration(false);
   XMLWriter writer = new XMLWriter(out, format);

   XMLFilterImpl nsfFilter = new XMLFilterImpl() {
    private boolean ignoreNamespace = false;
    private String rootNamespace = null;
    private boolean isRootElement = true;

    @Override
    public void startDocument() throws SAXException {
     super.startDocument();
    }

    @Override
    public void startElement(String uri, String localName, String qName, Attributes atts) throws SAXException {
     if (this.ignoreNamespace) uri = "";
     if (this.isRootElement) this.isRootElement = false;
     else if (!uri.equals("") && !localName.contains("xmlns")) localName = localName + " xmlns=\"" + uri + "\"";

     super.startElement(uri, localName, localName, atts);
    }

    @Override
    public void endElement(String uri, String localName, String qName) throws SAXException {
     if (this.ignoreNamespace) uri = "";
     super.endElement(uri, localName, localName);
    }

    @Override
    public void startPrefixMapping(String prefix, String url) throws SAXException {
     if (this.rootNamespace != null) url = this.rootNamespace;
     if (!this.ignoreNamespace) super.startPrefixMapping("", url);

    }
   };
   nsfFilter.setContentHandler(writer);
   marshaller.marshal(obj, nsfFilter);
   return out.toString();

  } catch (Exception e) {
   throw new RuntimeException(e);
  }
 }

 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));
   SerializeUtil obj = new SerializeUtil();
   XMLReader reader = XMLReaderFactory.createXMLReader();
   XMLFilterImpl nsfFilter = new XMLFilterImpl() {
    private boolean ignoreNamespace = false;

    @Override
    public void startDocument() throws SAXException {
     super.startDocument();
    }

    @Override
    public void startElement(String uri, String localName, String qName, Attributes atts) throws SAXException {
     if (this.ignoreNamespace) uri = "";
     super.startElement(uri, localName, qName, atts);
    }

    @Override
    public void endElement(String uri, String localName, String qName) throws SAXException {
     if (this.ignoreNamespace) uri = "";
     super.endElement(uri, localName, localName);
    }

    @Override
    public void startPrefixMapping(String prefix, String url) throws SAXException {
     if (!this.ignoreNamespace) super.startPrefixMapping("", url);
    }
   };
   nsfFilter.setParent(reader);
   InputSource input = new InputSource(new StringReader(xml));
   SAXSource source = new SAXSource(nsfFilter, input);
   return (T) unmarshaller.unmarshal(source);
  } catch (Exception e) {
   throw new RuntimeException(e.getMessage());
  }
 }
}

Copy after login

Example entity class

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;

 @XmlElement(namespace="http://www.cnblogs.com/")
 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;
 }
}

import javax.xml.bind.annotation.*;

@XmlAccessorType(XmlAccessType.FIELD)
public class ClassB {
 private int ClassBId;
 private String ClassBName;

 public int getClassBId() {
  return ClassBId;
 }

 public void setClassBId(int classBId) {
  this.ClassBId = classBId;
 }

 public String getClassBName() {
  return ClassBName;
 }

 public void setClassBName(String classBName) {
  this.ClassBName = classBName;
 }
}

Copy after login

Call

import com.bjpowernode.util.XmlUtil;

public class MainRun {

 /**
  * @param args
  */
 public static void main(String[] args) {

  ClassB classB = new ClassB();
  classB.setClassBId(22);
  classB.setClassBName("B2");

  ClassA classA = new ClassA();
  classA.setClassAId(11);
  classA.setClassAName("A1");
  classA.setClassB(classB);

  System.out.println(XmlUtil.toXML(classA));
 }

}

Copy after login

Output result:

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

Copy after login

You can see that the output xml fully meets our expectations

The implementation details are all in the code. It is very simple. When you encounter xml namespace problems with special needs, you no longer have to worry

Summarize

The above is the detailed content of Detailed example of JAXB namespace and prefix in Java. For more information, please follow other related articles on the PHP Chinese website!