在Rest服务调用中应用JAXB来实现XML与对象之间的转换

最新推荐文章于 2023-01-08 11:15:42 发布
最新推荐文章于 2023-01-08 11:15:42 发布
阅读量2k 收藏 1
点赞数
分类专栏： 软件解决方案 文章标签： jaxb xml rest string import class

最近在用HttpClien来调用Rest服务，在其中要用到XML与java对象之间的转换，发现用JAXB非常方便。现整理如下。具体应用例子转帖自http://terrencexu.javaeye.com/blog/702089

 

在java开发中使用XML几乎是每个程序员都会碰到的，目前可供我们选择的库也有很多，包括，dom4j， jaxen,  SAX等等，本文将介绍如何使用JAXB进行Object-XML mapping.

 

JAXB目前已经集成到了JDK6中，但还是推荐下载使用最新版的jaxb库， https://jaxb.dev.java.net/，本文下载的是2.2.3，下载安装后将安装后的lib目录中的jaxb-impl.jar拷贝到项目的lib目录中，引用即可，即可使用该下载的JAXB包。

 

从JAXB2.0开始，可以通过使用annotation进行Object-XMl mapping。

 

本文将通过以下步骤演示如何使用JAXB annotation绑定使用了namespace的XML文件

1. 创建Employees.java和Employee.java

2. 创建package-info.java和jaxb.index文件

3. 创建XMLParser.java封装marshal/unmarshal操作

4. 创建employees.xml文件

5. 创建Test.java运行测试

6. 运行结果：

 

1. 创建Employees.java和Employee.java

Java代码

package com.javaeye.terrencexu.jaxb;  

import java.util.ArrayList;  

import java.util.List;  

import javax.xml.bind.annotation.XmlElement;  

import javax.xml.bind.annotation.XmlRootElement;  

 

@XmlRootElement(name = "employees")  

public class Employees {    

 

    private List<Employee> employees;  

 

    public Employees() {  

        employees = new ArrayList<Employee>();  

    }  

 

    @XmlElement(name = "employee" , namespace=NameSpace.ADMIN_URI)  

    public List<Employee> getEmployees() {

        return employees;

    }

 

    public void setEmployees(List<Employee> employees) {

        this.employees = employees;

    }

 

    public void addEmployee(Employee employee) {  

        employees.add(employee);  

    }    

 

} 

 

 

Java代码

package com.javaeye.terrencexu.jaxb;  

import javax.xml.bind.annotation.XmlElement;  

 

public class Employee {  

 

    private String userId;  

    private String password;  

    private String name;  

    private int age;  

    private String gender;  

 

    public Employee() {  

    }  

 

    public Employee(String userId, String psw, String name, int age, Gender gender) {  

        this.userId = userId;  

        this.password = psw;  

        this.name = name;  

        this.age = age;  

        this.gender = gender.getValue();  

    }  

 

     @XmlElement(name = "userId", namespace=NameSpace.ADMIN_URI)  

     public String getUserId() {

         return userId;

      }

 

      public void setUserId(String userId) {

         this.userId = userId;

}

 

@XmlElement(name = "password", namespace=NameSpace.ADMIN_URI) 

public String getPassword() {

return password;

}

 

public void setPassword(String password) {

this.password = password;

}

 

@XmlElement(name = "name", namespace=NameSpace.ADMIN_URI)  

public String getName() {

return name;

}

 

public void setName(String name) {

this.name = name;

}

 

@XmlElement(name = "age", namespace=NameSpace.ADMIN_URI)

public int getAge() {

return age;

}

 

public void setAge(int age) {

this.age = age;

}

 

@XmlElement(name = "gender", namespace=NameSpace.ADMIN_URI)  

public String getGender() {

return gender;

}

 

public void setGender(String gender) {

this.gender = gender;

}

 

}  

Java代码
package com.javaeye.terrencexu.jaxb;
public class NameSpace {
public static final String ADMIN_PREFIX = "admin";  
    public static final String ADMIN_URI = "http://www.company.com/management/employees/admin";  
}
Java代码
package com.javaeye.terrencexu.jaxb;  
  
public enum Gender {  
  
    MALE("Male"),  
    FEMALE("Female");  
      
    private String value;  
      
    private Gender(String value) {  
        this.value = value;  
    }  
      
    public String getValue() {  
        return this.value;  
    }  
      
} 

2. 创建package-info.java和jaxb.index文件

创建package-info.java文件是为了注册xmlns, 将该文件放在当前source code的package下面，如果不使用namespace可以不创建该文件

 

@XmlSchema(  

xmlns={  

        @XmlNs(prefix=NameSpace.ADMIN_PREFIX, namespaceURI=NameSpace.ADMIN_URI)  

}  

)  

package com.javaeye.terrencexu.jaxb;  

 

import javax.xml.bind.annotation.XmlNs;

import javax.xml.bind.annotation.XmlSchema;

 创建jaxb.index注册Employees, Employee，如果不使用包级context，可以不创建该文件

 

Employees  

Employee

 

 

 

3. 创建XMLParser.java封装marshal/unmarshal操作

 

package com.javaeye.terrencexu.jaxb;

import java.io.InputStream;

import java.io.StringWriter;

import javax.xml.bind.JAXBContext;

import javax.xml.bind.JAXBException;

import javax.xml.bind.Marshaller;

import javax.xml.bind.Unmarshaller;

 

public final class XMLParser {

private static final String PACKAGE_NAME = "com.javaeye.terrencexu.jaxb";

private JAXBContext jc;

 

public XMLParser() {

try {

jc = JAXBContext.newInstance(PACKAGE_NAME, getClass().getClassLoader());

} catch (JAXBException e) {

e.printStackTrace();

}

}

 

public Object unmarshal(InputStream xml,Class objclass) {

Object obj = null;

try {

Unmarshaller u = jc.createUnmarshaller();

Reader reader = new InputStreamReader(xml,"utf-8");

StreamSource source = new StreamSource(reader);

obj = u.unmarshal(source,objclass).getValue();

} catch (JAXBException e) {

 e.printStackTrace();

throw new RuntimeException(

"Can't unmarshal the XML file, error message: " + e.getMessage());

}catch(UnSupportedEncodingException e){

 e.printStackTrace();
} 

return obj;

}

 

public String marshal(Object obj) {

String result = null;

try {

Marshaller m = jc.createMarshaller();

StringWriter writer = new StringWriter();

m.marshal(obj, writer);

result = writer.toString();

} catch (JAXBException e) {

throw new RuntimeException(

"Can't marshal the XML file, error message: " + e.getMessage());

}

return result;

}

 

}

 

4. 创建employees.xml文件

 

<?xml version="1.0" encoding="utf-8" ?>  

<employees xmlns:admin="http://www.company.com/management/employees/admin">  

    <admin:employee>  

        <admin:userId>johnsmith@company.com</admin:userId>  

        <admin:password>abc123_</admin:password>  

        <admin:name>John Smith</admin:name>  

        <admin:age>24</admin:age>  

        <admin:gender>Male</admin:gender>  

    </admin:employee>  

    <admin:employee>  

        <admin:userId>christinechen@company.com</admin:userId>  

        <admin:password>123456</admin:password>  

        <admin:name>Christine Chen</admin:name>  

        <admin:age>27</admin:age>  

        <admin:gender>Female</admin:gender>  

    </admin:employee>  

</employees> 

这是一个很普通的xml文件，主要是为了后面的测试，用于展示组织内部的成员（employee）状况，这里有一点需要注意的是使用了namespace，这也是本文将要演示的重点。

 

5.创建Test.java运行测试

package com.javaeye.terrencexu.jaxb;  

 

import java.io.File;

import java.io.FileInputStream;

import java.io.FileNotFoundException;

import java.util.List;

 

public class Test {  

    public static void main(String[] args) throws FileNotFoundException {  

        testUnmarshal();  

        testMarshal();  

    }  

 

    public static void testUnmarshal() throws FileNotFoundException {  

     XMLParser xMLParser = new XMLParser();

        Employees employees = (Employees) xMLParser.unmarshal(  

          new FileInputStream(new File("D:/eclipse 3.6/workspace/JAXB-test/src/xml/employees.xml"),Employees.class));  

 

        List<Employee> employeeList = employees.getEmployees();  

 

        if (employeeList != null && employeeList.size() > 0) {  

            for (Employee employee : employeeList) {  

                StringBuilder builder = new StringBuilder();  

                builder.append("[UserID: ").append(employee.getUserId()).append(", ")  

                       .append("Password: ").append(employee.getPassword()).append(", ")  

                       .append("Name: ").append(employee.getName()).append(", ")  

                       .append("Age: ").append(employee.getAge()).append(", ")  

                       .append("Gender").append(employee.getGender()).append("]");  

 

                System.out.println(builder.toString());  

            }  

        }  

 

    }  

 

    public static void testMarshal() {  

        Employees employees = new Employees();  

        employees.addEmployee(new Employee("johnsmith@company.com", "abc123_", "John Smith", 24, Gender.MALE));  

        employees.addEmployee(new Employee("christinechen@company.com", "123456", "Christine Chen", 27, Gender.FEMALE));  

        XMLParser xMLParser = new XMLParser();  

        String result = xMLParser.marshal(employees);  

        System.out.println(result);  

    }  

}  

 

6. 运行结果：

 

 

[UserID: johnsmith@company.com, Password: abc123_, Name: John Smith, Age: 24, GenderMale]

[UserID: christinechen@company.com, Password: 123456, Name: Christine Chen, Age: 27, GenderFemale]

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<employees xmlns:admin="http://www.company.com/management/employees/admin">

<admin:employee>

<admin:userId>johnsmith@company.com</admin:userId>

<admin:password>abc123_</admin:password>

<admin:name>John Smith</admin:name>

<admin:age>24</admin:age>

<admin:gender>Male</admin:gender>

</admin:employee>

<admin:employee>

<admin:userId>christinechen@company.com</admin:userId>

<admin:password>123456</admin:password>

<admin:name>Christine Chen</admin:name>

<admin:age>27</admin:age>

<admin:gender>Female</admin:gender>

</admin:employee></employees>

 

 

 

x_yp
关注
专栏目录
使用RestTemplate接收XML数据转对象与发送XML请求数据
月哥说了算的博客
04-08 8376
背景 公司项目和别家公司合作开发，涉及到了接口对接，对方提供的接口文档中数据交互全部都是XMl格式，第一次遇到xml数据的接口，这里记录下对XMl数据的处理。 开始 1.认识下XMl ❤ XML 指可扩展标记语言（EXtensible Markup Language） ❤ XML 是一种标记语言，很类似 HTML ❤ XML 的设计宗旨是传输数据，而非显示数据 ❤ XML 标签没有被预定义。您需要自行定义标签。 ❤ XML 被设计为具有自我描述性。 ❤ XML 是 W3C 的推荐标准 <?xml ve
java 调用rest服务_从Java调用Restful Service
weixin_42494160的博客
02-12 381
小编典典更新跟进此：我可以这样吗？如果xml返回为4......如果我正在构造一个Person对象，我相信这会阻塞。我可以只绑定我想要的xml元素吗？如果是，我该怎么做。您可以按以下方式映射此XML：input.xml2Jane40John50Personspackage forum7177628;import java.util.List;import javax.xml.bind.annota...
使用JAXB处理XML文档——先睹为快
AYellow的专栏
05-20 2342
 JAXB以其方便的XML数据处理能力可能会引起你的兴趣。你可能还不了解JAXB是什么，想要知道它到底有什么好处，如果这是你需要的，你才会再花时间去细细的研究它，或者你只需要使用最基本的功能。然而Sun关于JAXB的文档有80页之多。我想大部分人都没有耐心看完这样的长篇大论。本文以简短的篇幅介绍了JAXB的基本使用，算是先睹为快吧。本文附带的代码包括了JAXB1.0 early access版
调用REST服务，处理JSON格式, XML格式, RSS/ATOM格式的数据(转)
weixin_34044273的博客
10-09 101
作者：webabcd介绍Silverlight 2.0 调用REST服务，处理JSON格式, XML格式, RSS/ATOM格式的数据 通过 System.Net.WebClient 类调用 REST 服务 通过 System.Json 命名控件下的类处理 JSON 数据 通过 System.Xml.Linq 命名空间下的类（LINQ to XML）处理 XML 数据 通过...
使用 JAXB 框架定制 Web 服务行为
it_man的专栏
05-21 1714
WSDL、SOAP 和 UDDI 是 Web 服务中最基础也是最重要的组成部分，这三个协议定义了 Web 服务的描述，发现以及访问。 JAXB（Java Architecture for XML Binding）是由 J2EE 体系中标准的 XML schema 和 Java 数据绑定框架，开发者可以使用 JAXB 方便地在 Java 应用程序中进行 XML 数据和 Java 对象的转换。
rest_framework_xml 解析xml成Python 字典格式数据对象
Ch3nnn的博客
03-10 305
XML <UploadResult> <OriginalInfo> <Key>test.jpeg</Key> <Location>qr-code-1305143506.cos.ap-shanghai.myqcloud.com/test.jpeg</Location> <ETag>&quot;930b8ceb82c9e7ed3dc61bdc0f8577065f7484a7&quot;<.
《Jaxb2 转换XML文档》学习笔记
08-11
在Spring框架中，JAXB2可以方便地与其他组件（如REST服务）集成，通过配置自动处理XML的序列化和反序列化。 总结，JAXB2是Java开发中处理XML的强大工具，通过注解简化了对象与XML之间的转换，使得数据交换变得更加...
webservice远程调用与cxf框架共26页.pdf
10-30
4. **数据绑定**：CXF支持多种数据绑定技术，如JAXB（Java Architecture for XML Binding）和XMLBeans，方便地将XML数据与Java对象相互转换。 5. **安全机制**：CXF提供了一系列的安全特性，包括基本认证、OAuth、...
jersery client调用REST框架web services服务的一个示例
04-04
在实际项目中，开发者可以利用Jersey客户端与其他RESTful服务进行交互，实现数据交换和功能调用。 总之，"jersery client调用REST框架web services服务的一个示例"是一个关于如何使用Java的Jersey库作为客户端工具...
rest+spring+webservice交互xml文件
06-08
REST（Representational ...总的来说，这个简单的文档展示了如何在Spring环境中构建REST服务，使用XML作为数据交换格式，并从客户端进行交互。理解REST原理、Spring的依赖注入以及XML处理机制是实现这一目标的关键。
Jaxb webservice java调用
06-13
Jaxb webservice java调用客户端代码示例
使用RESTEasy + JAXB的XML示例
一名可爱的技术搬运工
05-24 277
RESTEasy，是JAXB支持XML文件所必需的。 在本教程中，我们向您展示如何创建“用户”对象，将其转换为XML文件，然后将其返回给客户端。 1. RESTEasy + JAXB 要在RESTEasy中使用JAXB，您需要包括“ resteasy-jaxb-provider.jar ”依赖项。 档案：pom.xml <repositories> <re...
Resteasy转换JAXB和json
jackyrongvip的专栏
09-21 244
resteasy其实是个很好用的类库,下面介绍下如何使用Resteay去 在JAXB和JSON中进行转换。注意resteasy使用的是Jettison JSON library (地址：http://jettison.codehaus.org/） 1） pom.xml文件的设置 JBoss repository https://repository.jbos...
JAXB：使用annotation绑定XML(xmlns)
iteye_9325的博客
06-29 422
在java开发中使用XML几乎是每个程序员都会碰到的，目前可供我们选择的库也有很多，包括，dom4j， jaxen,  SAX等等，本文将介绍如何使用JAXB进行Object-XML mapping.   JAXB目前已经集成到了JDK6中，但是还是推荐下载使用最新版的jaxb库， https://jaxb.dev.java.net/   从JAXB2.0开始，可以通过使用annotati...
JAXB: 通过schema验证XML文件
iteye_9325的博客
07-01 301
接上文 JAXB：使用annotation绑定XML(xmlns)   在使用JAXB解析XML文件的时候我们有时候可能会需要通过schema文件验证XML的格式，接上文的XMLParser.java   示例代码如下： public static Object unmarshal(InputStream xml, Class&lt;?&gt; clazz) throws SAXExce...
换了jdk版本之后出现的问题：出现 javax.xml.bind.JAXBContext 错误
最新发布
世上哪有什么岁月静好,不过是有人替你负重前行
01-08 2074
在使用 JDK11 进行 SpringBoot 的微服务部署时出现 javax.xml.bind.JAXBContext 错误导致程序无法启动。可以通过 maven 依赖手动进行引入。
castor Unmarshaller 读取XMl文件 运行没报错，但是读取值为null 问题解决
zling工作室
04-17 1965
jar包： castor-0.9.5.2.jar xerces-J_1.4.0.jar
处理 XML 解析中的错误,使用 SAX 处理 XML 解析中的错误
01-14 679
在更新的 Java 语言 API（JAXP、JAXB 和 JAX-WS 等）中解析 XML 变得如此容易，以至于 XML 解析已成为 Java 编程的重要方面。但是，更高级的 API 中的抽象使得无法细粒度控制解析器和数据之间的交互，因此存在潜在的问题。在本文中，我将展示 SAX 如何提供一种易于使用的方法来处理这些错误，即使您没有直接使用 SAX，仍然可以使用这种方法。 错误处理避免程序
CXF移动服务详解与应用
在处理请求和响应的过程中，CXF会使用Java消息服务（JMS）、数据绑定（如JAXB）和协议栈来序列化和反序列化数据。此外，代码中可能涉及到异常处理，例如`Exception`类，这通常用于捕获和处理服务执行过程中可能出现...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值