Java通过JAXB以xml的形式保存实体类数据到本地

[TOC]

最近公司做了个桌面应用，登陆页面要求做个类似于QQ登陆时的账号下拉列表，需要将账号信息保存在本地，考虑了下，打算以xml的形式保存，在此做个记录。

简单实现

首先来看一下需要保存的数据类，其实就是一个很普通的java实体类。

public class Student {
    private int id;
    private String name;

    public Student(int id, String name) {
        this.id = id;
        this.name = name;
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

因为可能要保存多个账号信息，将上述实体类做一个简单封装，作为要存储的实体类对象：

@XmlRootElement
public class SaveData {
    private List students;

    @XmlElement(name = "student")
    public List getStudents() {
        return students;
    }

    public void setStudents(List students) {
        this.students = students;
    }
}

最后是数据的读取：

public class BeanToXml {
    public static void main(String[] args) {
        SaveData data = new SaveData();
        List list = new ArrayList<>();
        list.add(new Student(1,"Allen"));
        list.add(new Student(2,"Tom"));
        list.add(new Student(3,"Lili"));
        data.setStudents(list);

        BeanToXml beanToXml = new BeanToXml<>();
        beanToXml.saveUserData(data,SaveData.class);
    }
    //获取本地的保存文件  System.getProperty("user.home") 得到的是用户主目录，其他相关值见附录
    private File getSavePath() {
        File file = new File(System.getProperty("user.home") + File.separator + "test");
        if (!file.exists())
            file.mkdir();
        file = new File(file.getPath() + File.separator + "test.xml");
        return file;
    }

    /**
     * 保存数据
     *
     * @param data 需要保存的数据
     * @param cls 数据bean的class对象
     */
    private void saveUserData(T data, Class cls) {
        try {
            JAXBContext context = JAXBContext.newInstance(cls);
            Marshaller m = context.createMarshaller();
            m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);

            // Marshalling and saving XML to the file.
            m.marshal(data, getSavePath());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    private T loadUserData(Class cls) {
        try {
            JAXBContext context = JAXBContext.newInstance(cls);
            Unmarshaller um = context.createUnmarshaller();

            // Reading XML from the file and unmarshalling.
            return (T) um.unmarshal(getSavePath());

        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }
    }
}

保存的本地xml数据：

    
        1
        Allen
    
    
        2
        Tom
    
    
        3
        Lili
    

扩展

注解说明

首先是三种用于标注顶级类或枚举的注解，他们可以配合使用，会被保留到运行时。

• @XmlAccessOrder：用于标注顶级类或包，会被保留到运行时。对java对象映射成的xml元素进行排序。有两个值：

  1. XmlAccessOrder.UNDEFINED：不排序。此为默认值。

  2. XmlAccessOrder.ALPHABETICAL：按字母顺序排序。

• @XmlAccessorType：用于标注顶级类或包，会被保留到运行时。控制实体类的哪些属性会被映射到xml。有4种值，默认值为PUBLIC_MEMBER：
  1. XmlAccessType.PROPERTY：所有有getter/setter的属性。
  2. XmlAccessType.FIELD：所有非静态的、非临时变量，也可以理解为所有非静态成员变量。
  3. XmlAccessType.PUBLIC_MEMBER：所有public的或者有getter/setter的属性。
  4. XmlAccessType.NONE：所有属性都不映射。
• @XmlRootElement：用于标注顶级类或枚举，会被保留到运行时。表示xml的根元素，有name和namespace两个方法，可以自定义xml的根元素名称和命名空间，name默认会使用类名，namespace默认为空。
• @XmlType：用于标注顶级类或枚举，会被保留到运行时。包括name，propOrder等属性，propOrder用于排序，不指定时按@XmlAccessOrder排序。

再来看看其他常用注解：

• @XmlElement：用于标注属性、方法或者参数，会被保留到运行时。用于将java属性映射为xml节点，可以通过name来修改节点的名称。
• @XmlAttribute：用于标注属性、方法，会被保留到运行时。用于将java属性映射为xml属性。
• @XmlTransient：用于标注属性、方法或类，会被保留到运行时。用于在java映射到xml时忽略此属性，不映射到xml。

踩坑

• 上面这段代码在java 6/7/8版本都是运行正常的，但是在java 9版本会报java.lang.NoClassDefFoundError: javax/xml/bind/JAXBException 异常，解决办法请参考这里

附录

java系统属性.png