Spring OXM-XStream使用别名

最新推荐文章于 2022-06-07 16:11:31 发布
最新推荐文章于 2022-06-07 16:11:31 发布
阅读量1.3w 收藏
点赞数 2
分类专栏： 【Spring-OXM】 文章标签： spring oxm xstream alias
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yangshangwei/article/details/78715607
版权

导读

在Spring OXM-XStream快速入门 的案例中，我们看到生成的xml报文如下：

<com.xgj.oxm.xstream.quickDemo.domain.User>
  <id>1</id>
  <userName>Artisan</userName>
  <password>artisan</password>
  <credits>1000</credits>
  <lastVisit>2017-12-05 07:30:46.772 UTC</lastVisit>
  <logs>
    <com.xgj.oxm.xstream.quickDemo.domain.LoginLog>
      <loginLogId>99</loginLogId>
      <userId>1</userId>
      <ip>127.0.0.1</ip>
      <loginDate>2017-12-05 07:30:46.772 UTC</loginDate>
    </com.xgj.oxm.xstream.quickDemo.domain.LoginLog>
  </logs>
</com.xgj.oxm.xstream.quickDemo.domain.User>

在默认情况下，Java对象到XML的映射是Java对象属性名对应XML的元素名，Java类的全名对应XML根元素的名字。

事实上，在实际应用中,如果XML和Java类都已经存在相应的名称，那么在进行转换时，需要设置别名进行映射。

别名配置的三种情况

  • 类别名： 使用alias(String name,Class type)

  • 类成员别名：使用aliasField（String alias, Class definedIn, String fieldName）

  • 类成员作为xml属性别名：使用aliasAttribute(Class definedIn, String attributeName, String alias)方法。 并且需要通过 useAttributeFor(Class definedIn, String fieldName) 应用到某个类上。

从上面的实例中我们看到XML元素结构不是很友好，接下来我们通过XStream提供的别名机制来修饰生成的XML元素的结构。

package com.xgj.oxm.xstream.quickDemo.aliasDemo;

import java.text.ParseException;
import java.util.Date;

import com.thoughtworks.xstream.XStream;
import com.xgj.oxm.xstream.quickDemo.domain.LoginLog;
import com.xgj.oxm.xstream.quickDemo.domain.User;

public class XStreamAliasDemo {

    private static XStream xstream;

    static {
        // 创建一个Xstream实例，使用默认的XPP解析器
        xstream = new XStream();

        // (1)设置类别名，修改默认的全限定名的名称
        xstream.alias("user", User.class);
        xstream.alias("loginLog", LoginLog.class);

        // (2)设置类成员别名 <id>1</id> 改为<userId>1</userId>
        xstream.aliasField("userId", User.class, "id");

        // (3)把LoginLog的userId属性视为xml属性，默认为xml的元素
        xstream.aliasAttribute(LoginLog.class, "userId", "id");
        xstream.useAttributeFor(LoginLog.class, "userId");

        // (4)去掉集合类型生成XML的父节点，即忽略xml中的<logs></logs>标记
        xstream.addImplicitCollection(User.class, "logs");
    }

    /**
     * 
     * 
     * @Title: getUser
     * 
     * @Description: 初始化转换对象
     * 
     * @return
     * 
     * @return: User
     * @throws ParseException
     */
    public static User getUser() throws ParseException {
        LoginLog log = new LoginLog();
        log.setIp("127.0.0.1");
        log.setLoginLogId(99);
        log.setUserId(1);
        log.setLoginDate(new Date());

        LoginLog log2 = new LoginLog();
        log2.setIp("192.168.1.1");
        log2.setLoginLogId(22);
        log2.setUserId(2);
        log2.setLoginDate(new Date());


        User user = new User();
        user.setId(1);
        user.setUserName("Artisan");
        user.setPassword("artisan");
        user.setCredits(1000);
        user.setLastVisit(new Date());

        user.addLoginLog(log);
        user.addLoginLog(log2);
        return user;
    }

    /**
     * 
     * 
     * @Title: objectToXml
     * 
     * @Description: Java对象转换成XML
     * 
     * @throws Exception
     * 
     * @return: void
     */
    public static void objectToXml() throws Exception {

        // 获取转换的User对象实例
        User user = getUser();
        // 输出内容到控制台,查看一下
        System.out.println(xstream.toXML(user));

        System.out.println("objectToXml successfully");
    }


    public static void main(String[] args) throws Exception {
        objectToXml();
    }

}

输出

<user>
  <userId>1</userId>
  <userName>Artisan</userName>
  <password>artisan</password>
  <credits>1000</credits>
  <lastVisit>2017-12-05 13:39:32.698 UTC</lastVisit>
  <loginLog id="1">
    <loginLogId>99</loginLogId>
    <ip>127.0.0.1</ip>
    <loginDate>2017-12-05 13:39:32.698 UTC</loginDate>
  </loginLog>
  <loginLog id="2">
    <loginLogId>22</loginLogId>
    <ip>192.168.1.1</ip>
    <loginDate>2017-12-05 13:39:32.698 UTC</loginDate>
  </loginLog>
</user>

说明：

在（1）处，通过XStream的alias方法来设置类别名。

在（2）处，通过XStream的aliasField方法将User类的id属性设置为userId

在（3）处，通过XStream的aliasAttribute和useAttributeFor方法将LoginLog类的userId属性设置为id，并设置为LoginLog元素的属性。 默认为LoginLog元素的子元素。

在（4）处，通过XStream的addImplicitCollection方法删除集合节点logs,即忽略XML中的<logs></logs>标记。

官方Demo

问题

假设我们有如下的XML，我们如何使用XStream去读写呢？ 

<blog author="Guilherme Silveira">
  <entry>
    <title>first</title>
    <description>My first blog entry.</description>
  </entry>
  <entry>
    <title>tutorial</title>
    <description>
        Today we have developed a nice alias tutorial. Tell your friends! NOW!
    </description>
  </entry>
</blog>

结合XStream中的方法，我们来分析一下

  • blog 节点有个 author 属性 ,可以使用aliasAttribute 和 useAttributeFor方法应用到Blog类上，也可以使用XStream的转换器，这里我们使用转换器的方式。 因为要使用转换器，所以需要一个Author类以及对应的一个name属性用于存储name的值

  • 子节点是多个entry，可以使用List来存储

  • entry节点有title 和 description 属性 ，所以需要一个Entry类以及2个属性

Model

接下来我们来看下我们创建的几个model类

package com.xgj.oxm.xstream.quickDemo.aliasDemo.officeDemo;

import java.util.ArrayList;
import java.util.List;

public class Blog {

    // Author
    private Author writer;

    // Entry集合
    private List<Entry> entries = new ArrayList<Entry>();

    /**
     * 
     * 
     * @Title:Blog
     * 
     * @Description:构造函数
     * 
     * @param writer
     */
    public Blog(Author writer) {
        this.writer = writer;
    }

    /**
     * 
     * 
     * @Title: add
     * 
     * @Description: 添加Entry
     * 
     * @param entry
     * 
     * @return: void
     */
    public void add(Entry entry) {
        entries.add(entry);
    }

    /**
     * 
     * 
     * @Title: getContent
     * 
     * @Description: 获取Entry List集合
     * 
     * @return
     * 
     * @return: List<Entry>
     */
    public List<Entry> getContent() {
        return entries;
    }
}

package com.xgj.oxm.xstream.quickDemo.aliasDemo.officeDemo;

public class Author {

    private String name;

    public Author(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }
}

package com.xgj.oxm.xstream.quickDemo.aliasDemo.officeDemo;

public class Entry {

    private String title, description;

    public Entry(String title, String description) {
        this.title = title;
        this.description = description;
    }
}

我们没有创建set/get方法，可根据需要创建。

A Simple Test

接下来，我们来测试一下

public static void main(String[] args) {

        Blog teamBlog = new Blog(new Author("Guilherme Silveira"));
        teamBlog.add(new Entry("first","My first blog entry."));
        teamBlog.add(new Entry("tutorial",
                "Today we have developed a nice alias tutorial. Tell your friends! NOW!"));

        XStream xstream = new XStream();
        System.out.println(xstream.toXML(teamBlog));

}

输出如下

<com.xgj.oxm.xstream.quickDemo.aliasDemo.officeDemo.Blog>
  <writer>
    <name>Guilherme Silveira</name>
  </writer>
  <entries>
    <com.xgj.oxm.xstream.quickDemo.aliasDemo.officeDemo.Entry>
      <title>first</title>
      <description>My first blog entry.</description>
    </com.xgj.oxm.xstream.quickDemo.aliasDemo.officeDemo.Entry>
    <com.xgj.oxm.xstream.quickDemo.aliasDemo.officeDemo.Entry>
      <title>tutorial</title>
      <description>Today we have developed a nice alias tutorial. Tell your friends! NOW!</description>
    </com.xgj.oxm.xstream.quickDemo.aliasDemo.officeDemo.Entry>
  </entries>
</com.xgj.oxm.xstream.quickDemo.aliasDemo.officeDemo.Blog>

Class aliasing

我们需要把com.xgj.oxm.xstream.quickDemo.aliasDemo.officeDemo.Blog 和 com.xgj.oxm.xstream.quickDemo.aliasDemo.officeDemo.Entry 转换成 blog 和 entry.

通过

    xstream.alias("blog", Blog.class);
    xstream.alias("entry", Entry.class);
Blog teamBlog = new Blog(new Author("Guilherme Silveira"));

        teamBlog.add(new Entry("first", "My first blog entry."));
        teamBlog.add(new Entry("tutorial",
                "Today we have developed a nice alias tutorial. Tell your friends! NOW!"));

        XStream xstream = new XStream();

        // alias Class
        xstream.alias("blog", Blog.class);
        xstream.alias("entry", Entry.class);

        System.out.println(xstream.toXML(teamBlog));

输出结果如下

<blog>
  <writer>
    <name>Guilherme Silveira</name>
  </writer>
  <entries>
    <entry>
      <title>first</title>
      <description>My first blog entry.</description>
    </entry>
    <entry>
      <title>tutorial</title>
      <description>Today we have developed a nice alias tutorial. Tell your friends! NOW!</description>
    </entry>
  </entries>
</blog>

Field aliasing

下面把wirter转换为 author .通过

xstream.aliasField("author", Blog.class, "writer");

输出如下

<blog>
  <author>
    <name>Guilherme Silveira</name>
  </author>
  <entries>
    <entry>
      <title>first</title>
      <description>My first blog entry.</description>
    </entry>
    <entry>
      <title>tutorial</title>
      <description>Today we have developed a nice alias tutorial. Tell your friends! NOW!</description>
    </entry>
  </entries>
</blog>

Implicit Collections

去掉entries节点，通过

xstream.addImplicitCollection(Blog.class, "entries");

输出如下

<blog>
  <author>
    <name>Guilherme Silveira</name>
  </author>
  <entry>
    <title>first</title>
    <description>My first blog entry.</description>
  </entry>
  <entry>
    <title>tutorial</title>
    <description>Today we have developed a nice alias tutorial. Tell your friends! NOW!</description>
  </entry>
</blog>

Attribute aliasing

下一步是将writer成员变量转换为xml的属性 ， 为了做到这一点，我们需要告诉XStream将Blog#writer字段同义为author

问题 ： how does XStream converts an Author in a String so it can be written as a XML tag attribute?

Attributes cannot be written for types that are handled by Converter implementations, we have to use a SingleValueConverter and implement our own converter for the Author:

package com.xgj.oxm.xstream.quickDemo.aliasDemo.officeDemo;

import com.thoughtworks.xstream.converters.SingleValueConverter;

public class AuthorConverter implements SingleValueConverter {

    /**
     * tells XStream which types it can deal with
     */
    public boolean canConvert(Class type) {
        return type.equals(Author.class);
    }

    /**
     * extract a String from an Author
     */
    public String toString(Object obj) {
        return ((Author) obj).getName();
    }

    /**
     * takes a String and returns an Author
     */
    public Object fromString(String name) {
        return new Author(name);
    }
}

然后注册转换器

xstream.useAttributeFor(Blog.class, "writer");
xstream.registerConverter(new AuthorConverter());

完整的代码如下

package com.xgj.oxm.xstream.quickDemo.aliasDemo.officeDemo;

import com.thoughtworks.xstream.XStream;

public class AliasTest {
    public static void main(String[] args) {
        Blog teamBlog = new Blog(new Author("Guilherme Silveira"));
        teamBlog.add(new Entry("first", "My first blog entry."));
        teamBlog.add(new Entry("tutorial",
                "Today we have developed a nice alias tutorial. Tell your friends! NOW!"));

        XStream xstream = new XStream();
        xstream.alias("blog", Blog.class);
        xstream.alias("entry", Entry.class);

        xstream.aliasField("author", Blog.class, "writer");

        xstream.addImplicitCollection(Blog.class, "entries");

        xstream.useAttributeFor(Blog.class, "writer");
        xstream.registerConverter(new AuthorConverter());

        System.out.println(xstream.toXML(teamBlog));
    }
}

输出

<blog author="Guilherme Silveira">
  <entry>
    <title>first</title>
    <description>My first blog entry.</description>
  </entry>
  <entry>
    <title>tutorial</title>
    <description>Today we have developed a nice alias tutorial. Tell your friends! NOW!</description>
  </entry>
</blog>

Package aliasing

 xstream.aliasPackage("my.company", "org.thoughtworks");

比如 

package com.xgj.oxm.xstream.quickDemo.aliasDemo.officeDemo;

import com.thoughtworks.xstream.XStream;

public class AliasPackage {

    public static void main(String[] args) {
        Blog teamBlog = new Blog(new Author("Guilherme Silveira"));

        teamBlog.add(new Entry("first", "My first blog entry."));
        teamBlog.add(new Entry("tutorial",
                "Today we have developed a nice alias tutorial. Tell your friends! NOW!"));

        XStream xstream = new XStream();

        xstream.aliasPackage(
"com.artisan",
                "com.xgj.oxm.xstream.quickDemo.aliasDemo.officeDemo");

        System.out.println(xstream.toXML(teamBlog));

    }

}

输出

<com.artisan.Blog>
  <writer>
    <name>Guilherme Silveira</name>
  </writer>
  <entries>
    <com.artisan.Entry>
      <title>first</title>
      <description>My first blog entry.</description>
    </com.artisan.Entry>
    <com.artisan.Entry>
      <title>tutorial</title>
      <description>Today we have developed a nice alias tutorial. Tell your friends! NOW!</description>
    </com.artisan.Entry>
  </entries>
</com.artisan.Blog>

示例源码

代码已托管到Github—> https://github.com/yangshangwei/SpringMaster

小小工匠
关注
专栏目录
【spring大总结】希望所有看完这篇文章的C友，都能快速入门spring
大仙
09-03 6739
Spring快速入门1.spring1.1.优点1.2.缺点1.3.Spring框架的组成结构图1.3.1.核心容器1.3.2.AOP 和设备支持1.3.3.数据访问与集成1.3.4.Web1.3.5.消息(Messaging)1.3.6.Test2.Spring核心ioc2.1.ioc容器2.1.BeanFactory 容器2.1.2\. ApplicationContext 容器2.1.2.1.ClassPathXmlApplicationContext2.1.2.2.FileSystemXmlAppl
Spring-Spring的介绍和SpringFrameWork使用
yz_blanks的博客
11-18 315
一、什么是Spring框架 Spring框架是一种轻量级框架 Spring中提供了多种功能模块，可以根据自己功能需求定制模块，只需要引入对应需求的模块使用就可以了；并不需要像重量级框架，需要使用一个功能模块就必须要把整个框架拿过来。 Spring基本模块 Spring基本模块：Spring架构是一个分层架构，由基本7个定义良好的模块组成。Spring模块构建在Core Container核...
spring-oxm-3.2.8.jar
09-26
Spring oxm：Spring对于object/xml映射的支持，可以让JAVA与XML之间来回切换； spring-oxm是操作XML文件：生成，修改节点的完美第三方库
Spring OXM-XStream快速入门
热门推荐
小工匠
11-25 1万+
XStream概述 XStream的特点XStream概述官网: http://x-stream.github.io/index.htmlXStream开源类库,用于将java对象序列化为XML或者将XML反序列化为Java对象，是Java对象和XML之间的一个双向转换器. 目前最新的版本是1.4.10 . XStream的特点
Spring 之 @XStreamAlias
Hunter的专栏
04-12 946
参考：https://blog.csdn.net/tz_gx/article/details/11910777 一、 特点: 简化的API; 无映射文件; 高性能,低内存占用; 整洁的XML; 不需要修改对象;支持内部私有字段,不需要setter/getter方法 提供序列化接口; 自定义转换类型策略; 二、 使用场景 Transport转换 Persiste...
java oxm_spring oxm入门（包含demo）
weixin_34005394的博客
02-12 282
O/X Mapper 是什么？Spring 3.0 的一个新特性是 O/X Mapper。O/X 映射器这个概念并不新鲜，O 代表 Object，X 代表 XML。它的目的是在 Java 对象(几乎总是一个 plain old Java object，或简写为 POJO)和 XML 文档之间来回转换。例 如，您可能有一个带有几个属性的简单 bean，且您的业务需要将那个 Java 对象转换为一个 ...
Spring OXM
Manjusaka
11-15 664
Spring OXM简介O/X Mapping 是什么？　　Spring 3.0 的一个新特性是 O/X Mapper。然而O/X Mapping并不是新鲜的事物，Spring也是调用了第三方的O/X Mapping框架来完成他本身的工作。O=Object，X=XML，也就是对象与XML的映射器（转换器）。编组和解组　　进行 O/X 映射时，您经常会看到编组（marshalling）和解组（unma
spring使用OXM进行对象XML映射解析
08-28
3.2 使用XStream别名 * 在上面的示例中，Java对象的全类名对应XML文件的根元素，属性名对应XML文件的节点元素，但在实际情况中，Java对象和XML对象可能都已经定义好了名字，这时就需要使用别名映射。 * XStream有3...
Spring(一)
weixin_43164309的博客
09-02 196
Spring 简介 分层的Java SE/EE应用 full - stack轻量级开源框架。 核心:IOC(Inverse Of Control 控制反转)和AOP(Aspect Oriented Programming 面向切面编程) 优势 方便解耦，简化开发 AOP编程的支持 声明式事务的支持 方便程序的测试 方便集成各种优秀框架 降低JAVAEE API的使用难度 Java源码经典学习范例 体系结构 1. Data Access/Integration（数据访问／集成） 数据访问/集成层包括
Spring框架概述及其工厂模式
rincoo_的博客
06-07 764
Spring 框架是一个轻量级的解决方案，并且是构建企业就绪应用程序的一站式潜在 Store。但是Spring 是模块化的，允许您仅使用所需的那些 Component，而不必引入其他 Component。您可以将 IoC 容器与顶部的任何 Web 框架一起使用，但也可以仅使用Hibernate 集成代码或JDBC 抽象层。 Spring 框架支持声明式事务 Management，通过 RMI 或 Web 服务对逻辑的远程访问以及用于持久化数据的各种选项。它提供了功能齐全的MVC framework，并使您能
spring-oxm
ziruominglin的专栏
07-18 784
org.springframework           spring-oxm           ${spring.version}            是将简单的javabean转化成xml
Spring OXM-XStream转换器
小工匠
12-05 1万+
概述概述我们在开发的过程中，有的时候需要转换一些自定义类型，此时默认的映射方式可能无法满足需要。 XStream为我们提供了丰富的扩展，用户可以实现自己的转换器，然后调用registerConverter方法注册自定义的转换器。 实现自定义的转换器很简单，只需要实现XStream提供的Converter接口并实现其方法即可。
java oxm_spring使用OXM进行对象XML映射解析
weixin_31313629的博客
02-16 327
1、认识XML解析技术1.1、XML相关概念(1)DTD：XML语法规则，是XML文件的验证机制，可以通过比较XML文档和DTD文件看文档是否符合规范，元素和标签是否使用正确。(2)XML是SOA的基础。1.2、XML处理技术(1)为了使用XML，我们需要通过XML处理器或XMLAPI来访问数据，目前JAXP提供了2种处理XML的方法：DOM和SAX。①DOM：DOM通过编程方式对XML文档中数据...
Spring oxm入门实例
xiang__liu的博客
07-24 4064
O/XMapper是什么？ Spring3.0的一个新特性是O/XMapper。O/X映射器这个概念并不新鲜，O代表Object，X代表XML。它的目的是在Java对象（几乎总是一个plainoldJavaobject，或简写为POJO）和XML文档之间来回转换。 例如，您可能有一个带有几个属性的简单bean，且您的业务需要将那个Java对象转换为一个XML文档。Spring的O/XMappe...
Spring OXM-XStream流化对象
小工匠
12-07 1万+
概述 示例 示例源码概述XStream为java.io.ObjectInputStream和ObjectOutputStream提供了替代的实现，允许以对象流方式进行XML序列化或者反序列化操作。 这对于处理集合对象非常有用（List<User> users）,在内存中只保留一个User对象流。很显然，我们应该使用基于流而非DOM的XML解析器读取XML，以提高性能。 创建一个输出流，我们不得不
Spring OXM-Castor入门
linminx的博客
01-01 739
spring-oxm基本使用方法介绍
java oxm_Spring oxm入门实例
weixin_34922053的博客
02-12 226
o/xmapper是什么？spring3.0的一个新特性是o/xmapper。o/x映射器这个概念并不新鲜，o代表object，x代表xml。它的目的是在java对象(几乎总是一个plainoldjavaobject，或简写为pojo)和xml文档之间来回转换。例如，您可能有一个带有几个属性的简单bean，且您的业务需要将那个java对象转换为一个xml文档。spring的o/xmapper能够为...
Spring oxm 入门
qq_37151646的博客
09-12 6977
oxm : 是spring 3.0的一个新特性 o/xMapping 什么是o/xMapping？             o/x mapping 入门：                     功能：实践类与xml之间的相互转换。                     编组：marshalling 将javabean转化为xml                     解组：unmarshal...
体验 Spring 的 Object/XML 映射支持
兵临城下
03-28 162
Spring 是由 Rod Johnson 开发的一个健壮的 Java 应用程序框架，已在 Java 开发社区中得到广泛使用。Spring 以其流行的科技词汇而著名，比如 “dependency injection（依赖项注入）”、“inversion of control（控制反转）” 和 “aspect-oriented programming（面向方面编程）” 等。它还支持 Model-Vi...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

小小工匠

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值