JAXB 深入显出 - JAXB 教程 List转化为XML

﹏ヽ暗。殇╰゛Y 2022-05-14 16:24 375阅读 0赞

**摘要：** JAXB 作为JDK的一部分，能便捷地将Java对象与XML进行相互转换，本教程从实际案例出发来讲解JAXB 2 的那些事儿。[完整版目录][Link 1]

## 前情回顾 ##

之前介绍的都是关于某一种转换方式，这一节开始，将基于某种数据类型做转换。

## Java 对象中含有 List ##

商品信息中的有很多小项，所以使用List类型。

@XmlAccessorType(XmlAccessType.FIELD)
    public class Product { 
    
    	@XmlAttribute
    	private String id;
    	
    	private List<String> item;
    // setters,getters
    }

测试一下。

@Test 
    	public void test1() throws JAXBException { 
    		Product product = new Product();
    		product.setId("1301");
    		product.setItem(Arrays.asList("ItemA","ItemB","ItemC"));
    		
    		JAXB.marshal(product, System.out);
    	}

XML结果。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <product id="1301">
        <item>ItemA</item>
        <item>ItemB</item>
        <item>ItemC</item>
    </product>

这是最普通的一种转化方式。如果需要改变XML的Element的名称，可以设置`@XmlElement(name = "Item")`。

## Java 对象中含有 List 、XML被包裹 ##

如果想让生成的XML外围被包裹起来，可以加上注解`@XmlElementWrapper`。

@XmlRootElement
    @XmlAccessorType(XmlAccessType.FIELD)
    public class Product2 { 
    
    	@XmlAttribute
    	private String id;
    	
    	@XmlElementWrapper(name = "Items")
    	private List<String> item;
    // setters,getters
    }

测试一下。

@Test
    	public void test2() throws JAXBException { 
    		Product2 product = new Product2();
    		product.setId("1302");
    		product.setItem(Arrays.asList("ItemA","ItemB","ItemC"));
    		
    		JAXB.marshal(product, System.out);
    	}

XML结果。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <product2 id="1302">
        <Items>
            <item>ItemA</item>
            <item>ItemB</item>
            <item>ItemC</item>
        </Items>
    </product2>

可以看到，item 有了父标签`Items`

## Java对象含有非简单类型的List ##

商品信息中的小项还含有属性。

@XmlRootElement
    @XmlAccessorType(XmlAccessType.FIELD)
    public class Product3 { 
    
    	@XmlAttribute
    	private String id;
    	
    	private List<Item> item;
    // setters,getters
    }

每一个小项都更加复杂，注意这里的 `name` 使用的注解`@XmlValue`。

@XmlAccessorType(XmlAccessType.FIELD)
    public class Item { 
    
    	@XmlAttribute
    	private String id;
    	@XmlValue
    	private String name;
    // setters,getters
    }

测试一下。

@Test
    	public void test3() throws JAXBException { 
    		Product3 product = new Product3();
    		product.setId("1303");
    		product.setItem(Arrays.asList(new Item("13031","ItemA"),new Item("13032","ItemB"),new Item("13033","ItemC")));
    		
    		JAXB.marshal(product, System.out);
    	}

生成的XML。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <product3 id="1303">
        <item id="13031">ItemA</item>
        <item id="13032">ItemB</item>
        <item id="13033">ItemC</item>
    </product3>

## 使用注解 @XmlList ##

在JAXB 中，有一个注解 `@XmlList`主要是为了在一个XML的Element中添加多个值。

@XmlAccessorType(XmlAccessType.FIELD)
    public class Product4 { 
    
    	@XmlAttribute
    	private String id;
    	
    	@XmlList
    	private List<String> item;
    // setters,getters
    }

测试一下。

@Test
    	public void test4() throws JAXBException { 
    		Product4 product = new Product4();
    		product.setId("1304");
    		product.setItem(Arrays.asList("ItemA","ItemB","ItemC"));
    		
    		JAXB.marshal(product, System.out);
    	}

生成的XMl 如下：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <product4 id="1304">
        <item>ItemA ItemB ItemC</item>
    </product4>

可以看到，`item`包含了List中的所有数据。

## 完整代码 ##

可以在[GitHub][]找到完整代码。  
本节代码均在该包下：`package com.example.demo.lesson13;`

## 下节预览 ##

本节介绍了 JAXB 中List的相关转化，下一节将介绍Map转换的相关操作。

[Link 1]: https://blog.csdn.net/jiangchao858/article/details/81842774
[GitHub]: https://github.com/cj96248/jaxb-example.git