JAXB入门教程
JAXB,全称为 Java Architecture for XML Binding,使用JAXB 注解可以实现java对象和xml相互转换,本文带你轻松入门,主要使用下面两个方法:
- Marshalling – 转换java对象至xml。
- Unmarshalling – 转换xml至java对象。
必要的软件环境:
- JDK 1.6
- JAXB 2.0
JAXB非常容易,首先在java对象上使用注解,然后使用axbMarshaller.marshal() 或 jaxbMarshaller.unmarshal()方法实现java对象/xml之间转换。
1. JAXB 依赖
如果你使用JDK1.6或以上版本,无需额外的jar包,因为其已经是JDK的内置功能。可以参考:JAXB is bundled in JDK 1.6 。
注:
低于1.6版本JDK,下载JAXB 从这里,把 “jaxb-api.jar”和“jaxb-impl.jar”放置项目类路径。
2. JAXB 注解
需要转换的java对象,必须使用JAXB注解。注解是很容易理解,可以参考JAXB指导详细说明。
- package com.mkyong.core;
- import javax.xml.bind.annotation.XmlAttribute;
- import javax.xml.bind.annotation.XmlElement;
- import javax.xml.bind.annotation.XmlRootElement;
- @XmlRootElement
- public class Customer {
- String name;
- int age;
- int id;
- public String getName() {
- return name;
- }
- @XmlElement
- public void setName(String name) {
- this.name = name;
- }
- public int getAge() {
- return age;
- }
- @XmlElement
- public void setAge(int age) {
- this.age = age;
- }
- public int getId() {
- return id;
- }
- @XmlAttribute
- public void setId(int id) {
- this.id = id;
- }
- }
3. 转换java对象至XML
JAXB marshalling 示例,转换customer 对象至xml文件。jaxbMarshaller.marshal()
有许多重载方法,找到你需要的方法实现正确输出。
- package com.mkyong.core;
- import java.io.File;
- import javax.xml.bind.JAXBContext;
- import javax.xml.bind.JAXBException;
- import javax.xml.bind.Marshaller;
- public class JAXBExample {
- public static void main(String[] args) {
- Customer customer = new Customer();
- customer.setId(100);
- customer.setName("mkyong");
- customer.setAge(29);
- try {
- File file = new File("C:\\file.xml");
- JAXBContext jaxbContext = JAXBContext.newInstance(Customer.class);
- Marshaller jaxbMarshaller = jaxbContext.createMarshaller();
- // output pretty printed
- jaxbMarshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT,true);
- jaxbMarshaller.marshal(customer,file);
- jaxbMarshaller.marshal(customer,System.out);
- } catch (JAXBException e) {
- e.printStackTrace();
- }
- }
- }
输出结果:
- <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
- <customer id="100">
- <age>29</age>
- <name>mkyong</name>
- </customer>
4. 转换XML 至java对象
JAXB unmarshalling 示例,转换 XML 文件内容至customer 对象. jaxbMarshaller.unmarshal()
有许多重载方法,找到你需要的方法实现正确输出。
- package com.mkyong.core;
- import java.io.File;
- import javax.xml.bind.JAXBContext;
- import javax.xml.bind.JAXBException;
- import javax.xml.bind.Unmarshaller;
- public class JAXBExample {
- public static void main(String[] args) {
- try {
- File file = new File("C:\\file.xml");
- JAXBContext jaxbContext = JAXBContext.newInstance(Customer.class);
- Unmarshaller jaxbUnmarshaller = jaxbContext.createUnmarshaller();
- Customer customer = (Customer) jaxbUnmarshaller.unmarshal(file);
- System.out.println(customer);
- } catch (JAXBException e) {
- e.printStackTrace();
- }
- }
- }
输出结果:
- [===]Customernamemkyong,age29,id100