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<Student> students;

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

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

最后是数据的读取:

public class BeanToXml<T> {
    public static void main(String[] args) {
        SaveData data = new SaveData();
        List<Student> 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<SaveData> 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<T> 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<T> 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数据:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<saveData>
    <student>
        <id>1</id>
        <name>Allen</name>
    </student>
    <student>
        <id>2</id>
        <name>Tom</name>
    </student>
    <student>
        <id>3</id>
        <name>Lili</name>
    </student>
</saveData>

扩展

注解说明

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

  • @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
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,386评论 6 479
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,939评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,851评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,953评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,971评论 5 369
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,784评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,126评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,765评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,148评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,744评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,858评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,479评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,080评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,053评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,278评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,245评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,590评论 2 343

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,598评论 18 139
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,577评论 18 399
  • “#本文参加青春大赛,本人保证本文为本人原创,如有问题则与主办方无关,自愿放弃评优评奖资格” 佘珊 南昌大学 15...
    吧啦吧啦_e041阅读 557评论 1 7
  • 我们终归还是逃不过两个人相处的七年之痒,自从上次的裂痕出现之后,也就一直有一个疙瘩在中间横着,无法跨越… 我们竟然...
    Amily2016阅读 172评论 0 0
  • 6/5日 爬楼听小影老师留言,记下比较触动自己的几点: 1,幸福和烦恼皆来自人际关系。 2,在关系中,谁感受到痛苦...
    妈妈熊阅读 177评论 1 2