2. 程式人生 > >JAXB實現JAVA BEAN與XML之間的轉換

JAXB實現JAVA BEAN與XML之間的轉換

阿新 • • 發佈：2018-12-26

JAXB主要用來實現物件和XML之間的序列化和反序列化，關於JAXB的介紹就不多說了，網上一搜一大把，這裡主要總結下基本使用方法和一些注意事項

首先定義兩個示例類ClassA,ClassB，用於後續的示例演示

public class ClassA {
    private int classAId;
    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;
    }
}
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;
    }
}
用於序列化的XmlUtil
import java.io.StringReader;
import java.io.StringWriter;
import javax.xml.bind.*;

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 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());
        }
    }
}
呼叫如下：
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));
    }
}
輸出結果如下：
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<classA>
    <classAId>11</classAId>
    <classAName>A1</classAName>
    <classB>
        <classBId>22</classBId>
        <classBName>B2</classBName>
    </classB>
</classA>

這裡要注意以下幾點

  1. 要序列化的類加上 @XmlRootElement註解，否則會報錯(錯誤提示很清晰，這裡就不貼出來了)
  2. JAXB序列化XML時  預設序列化getter和setter，且getter和setter必須成對出現才會被序列化
  3. 屬性名稱，預設序列化出來的類和屬性名稱預設是首字母轉換為小寫，若需要控制屬性名稱需要在getter或setter上使用 @XmlElement(name="ClassAId") 指定名稱，這裡要注意的是@XmlElement放置在getter或setter上都行，但只能放一個，也就是說不能同時在getter和setter上使用@XmlElement註解
  4. 如何控制根節點名稱？
    使用@XmlRootElement指定name屬性即可，如@XmlRootElement(name="ClassA")
  5. 怎麼新增名稱空間
    使用@XmlRootElement(namespace="cn.lzrabbit") 指定namespace屬性
  6. 怎麼精確控制每個屬性名稱
    JAXB自動轉化為首字母小寫會導致不可預料的屬性名稱出現， 不嫌麻煩的話為每個屬性設定@XmlElement(name="")，想省事的話使用Field
  7. 怎麼樣實現序列化時使用Field欄位而不是使用setter和getter
    在要使用的類上面加上@XmlAccessorType(XmlAccessType.FIELD)註解，並指定為XmlAccessType.FIELD，這裡強烈推薦使用@XmlAccessorType(XmlAccessType.FIELD)註解，因為這樣你可以精確的控制每個元素的名稱，而不需要為每個屬性去設定@XmlElement(name="")註解，當然也可以在Field上使用@XmlElement註解

下面給出使用了使用如上註解後的程式碼示例

@XmlRootElement(namespace="cn.lzrabbit")
@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
@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;
    }
}
輸出xml為
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:classA xmlns:ns2="cn.lzrabbit">
    <classAId>11</classAId>
    <ClassAName>A1</ClassAName>
    <classB>
        <ClassBId>22</ClassBId>
        <ClassBName>B2</ClassBName>
    </classB>
</ns2:classA>
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>
複製程式碼

相關推薦

JAXB實現JAVA BEAN與XML之間的轉換

JAXB主要用來實現物件和XML之間的序列化和反序列化，關於JAXB的介紹就不多說了，網上一搜一大把，這裡主要總結下基本使用方法和一些注意事項 首先定義兩個示例類ClassA,ClassB，用於後續的示例演示 public class ClassA { pri

Jaxb實現 複雜POJO 與 xml 的轉換

Person： package com.test; import java.util.Date; import java.util.List; import javax.xml.bind.annotation.XmlElement; import javax.xml

JAXB 實現bean與xml之間的轉換

之前一直用dom解析xml,在生成和解析的過程中都有點麻煩，最近又學習了JAXB解析xml ,並且很方便的實現javaBean 與xml 的互轉，很不錯，直接看效果： 實體類如下： package xmlTest; import javax.xml.bind.

使用JAXB實現Bean與Xml相互轉換

最近幾天，我自己負責的應用這邊引入了一個新的合作方，主要是我這邊呼叫他們的介面，但是有個很坑的地方，他們傳參居然不支援json格式，並且只支援xml格式進行互動，於是自己寫了一個工具類去支援bean與xml互相轉換，json與xml之間互相轉換。 JAXBContext 介面 我在這裡使用了rt.jar

Java Bean與Map之間相互轉化的實現

涵蓋 ffffff ger 動態性 ring eth 名稱 分享圖片 tro 目錄樹概述Apache BeanUtils將Bean轉MapApache BeanUtils將Map轉Bean理解BeanUtils將Bean轉Map的實現之手寫Bean轉Map 概述　　Apac

java bean 與map之間的轉換

import java.lang.reflect.Field; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; import java.util.ArrayList; impor

使用JAXB實現JAVA物件和XML字串的互相轉換

測試類： package com.solin.test; import java.util.ArrayList; import java.util.List; public class Tes

JAVA bean與XML互轉的利器---XStream

pub 普通 ati mat his cit true 是我 package 最近在項目中遇到了JAVA bean 和XML互轉的需求， 本來準備循規蹈矩使用dom4j忽然想起來之前曾接觸過的XStream, 一番研究豁然開朗，利器啊利器， 下來就XStream的一些用法與

使用jaxb 實現物件與xml之間的轉換,並且是 soap報文與物件轉換

使用jaxb 實現物件與xml之間的轉換,並且是 soap報文與物件轉換 1.測試用例 public class TestJaxb { @Test public void testToObject(){ JaxbBinder jaxbBinder = new Jax

JAXB 實現Java和xml的互相轉換

下面是 轉於 ： https://blog.csdn.net/qq383264679/article/details/52231128           感謝博主 首先介紹下什麼是JAXB？

java關於物件(javabean)與xml之間的相互轉換

今天我們要探討的一個問題是，如何將xml格式的字串轉換成物件，以及物件轉換成xml字串。 簡介 現如今，雖然資料的傳輸大部分都是用json格式來進行傳輸，但是xml畢竟也會有一些老的專案在進行使用，身為一個萬能的程式設計師。我們又怎能不會使

使用JAXB來完成Javabean與XML檔案(字串)之間的相互轉換

1. 什麼是JAXB？ JAXB（Java Architecture for XML Binding) 是一個業界的標準，是一項可以根據XML Schema產生Java類的技術。該過程中，JAXB也提供了將XML例項文件反向生成Java物件樹的方法，

XStream實現javabean與xml之間相互轉換

XStream是thoughtworks公司釋出的一個簡單的Java類庫，用於將JavaBean序列化為XML，並且能夠將XML檔案反向轉換為JavaBean. 例項: user.java impor

Java日期和字串之間轉換,自己封裝日期與字串轉換類

一:日期與字串轉換 public class DateFormatDemo { public static void main(String[] args) throws ParseException { //日期轉換成字串 Date d = new Date(); Simple

SpringMVC中使用@RequestBody,@ResponseBody註解實現Java物件和XML/JSON資料自動轉換（上）

Spring3.1開始使用新的HandlerMapping 和 HandlerAdapter 來支援@Contoller 和@RequestMapping註解處理:處理器對映RequestMappingHandlerMapping和處理器介面卡RequestMappingH

利用反射機制完成java物件與物件之間的轉換

在微服務架構的專案中，我們經常會遇到外觀模式設計，把核心的資料結構隱藏起來，暴露對外的request和response資料結構。如果巢狀的層級多了，層層的資料轉換將會增加大量程式碼，讓整個專案看起來臃腫不堪。例如： public void saveVisitStatInfo(VisitS

Java 字串與byte之間的相互轉換

寫在前面 你是否跟我一樣，在一些需要加密的程式碼裡看見需要把字串轉換為位元組的場景，例如MD5加密。而你每次看到像我以前一樣，自動地略過（反正別人都寫好了，我用就是了）。如果是的話，不要再逃避了，下面跟我一起來了解一下字串與byte之間轉換的原理 正文

Java程式設計基礎：在Mybatis註解中使用typeHandler實現Java列舉與資料庫int值的自動轉換

概述 在專案開發過程中經常會遇到資料庫儲存的是數值，在Java程式碼列舉表示的欄位。這些欄位在儲存和查詢時需要做一個轉換：寫資料庫的時候將列舉轉換為數字，讀資料庫時將數字轉換為列舉。 下面介紹一種通過mybatis註解實現資料型別自動轉換的方式。該方式能處理

[java] 圖片與base64之間的互相轉換

這篇文章實現的功能是，本地或者線上的圖片轉換成base64和base64轉換成圖片。好了不多說了，直接上程式碼！import java.io.ByteArrayOutputStream; import java.io.FileInputStream; import java.

C# 實現DataTable、DataSet與XML互相轉換

2008-11-12 19:00     /**//// <summary>    /// 把DataSet、DataTable、DataView格式轉換成XML字串、XML檔案    /// </summary>    public class DataToXml    {