jaxb的介绍，以及对jaxb的入门

最新推荐文章于 2024-04-10 13:53:25 发布
最新推荐文章于 2024-04-10 13:53:25 发布
阅读量2.6k 收藏 7
点赞数 1
分类专栏： java编程篇
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq383264679/article/details/52231128
版权
介绍顺序按照：

1. JAXB的介绍

2. JAXB中的核心类以及相关类介绍   

3. JAXB中的常用注解介绍

4. 使用演示展示


首先介绍下什么是JAXB？

JAXB（Java Architecture for XML Binding) 是一项可以根据XML Schema产生Java类的技术。 该过程中，JAXB也提供了将XML实例文档反向生成Java对象树的方法，并能将Java对象树的内容重新写到 XML实例文档。Jaxb 2.0是JDK 1.6的组成部分。我们不需要下载第三方jar包 即可做到轻松转换。


JAXB的核心类有如下三个：

       JAXBContext类，是应用的入口，用于管理XML/Java绑定信息。

                   该类不能直接创建，只能使用如下方式进行实例化JAXBContext对象：

static JAXBContext

 newInstance(Class... classesToBeBound)
           Obtain a new instance of a JAXBContext class.
static JAXBContextnewInstance(Class[] classesToBeBound, Map<String,?> properties)
           Obtain a new instance of a JAXBContext class.
static JAXBContextnewInstance(String contextPath)
           Obtain a new instance of a JAXBContext class.
static JAXBContextnewInstance(String contextPath, ClassLoader classLoader)
           Obtain a new instance of a JAXBContext class.
static JAXBContextnewInstance(String contextPath, ClassLoader classLoader, Map<String,?> properties)
           Obtain a new instance of a JAXBContext class.

       Marshaller接口，将Java对象序列化为XML数据。

                  该类是设置转换为XML数据的熟悉如格式化输出xml，设备xml的编码格式等：

                  Marshaller marshaller = context.createMarshaller();  
                  marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);  
                  marshaller.setProperty(Marshaller.JAXB_ENCODING, encoding);  
                  marshaller.setProperty(Marshaller.JAXB_FRAGMENT, false);


       Unmarshaller接口，将XML数据反序列化为Java对象。

                  反序列化java对象需要用到的实例：

                  Unmarshaller unmarshaller = context.createUnmarshaller();  
                   t = (T) unmarshaller.unmarshal(new StringReader(xml));


使用JAXB常用的注解如下：

  • @XmlType，将Java类或枚举类型映射到XML模式类型
  • @XmlAccessorType(XmlAccessType.FIELD) ，控制字段或属性的序列化。FIELD表示JAXB将自动绑定Java类中的每个非静态的（static）、非瞬态的（由@XmlTransient标 注）字段到XML。其他值还有XmlAccessType.PROPERTY和XmlAccessType.NONE。
  • @XmlAccessorOrder，控制JAXB 绑定类中属性和字段的排序。
  • @XmlJavaTypeAdapter，使用定制的适配器（即扩展抽象类XmlAdapter并覆盖marshal()和unmarshal()方法），以序列化Java类为XML。
  • @XmlElementWrapper ，对于数组或集合（即包含多个元素的成员变量），生成一个包装该数组或集合的XML元素（称为包装器）。
  • @XmlRootElement，将Java类或枚举类型映射到XML元素。
  • @XmlElement，将Java类的一个属性映射到与属性同名的一个XML元素。
  • @XmlAttribute，将Java类的一个属性映射到与属性同名的一个XML属性。

 1.@XmlType

　　@XmlType用在class类的注解，常与@XmlRootElement，@XmlAccessorType一起使用。它有三个属性：name、propOrder、namespace，经常使用的只有前两个属性。如：

@XmlType(name = "basicStruct", propOrder = {
    "intValue",
    "stringArray",
    "stringValue"
)
在使用@XmlType的propOrder 属性时，必须列出JavaBean对象中的所有属性，否则会报错。

　2.@XmlElement

　　@XmlElement将java对象的属性映射为xml的节点，在使用@XmlElement时，可通过name属性改变java对象属性在xml中显示的名称。如：

　　@XmlElement(name="Address") 　　
　　private String yourAddress;

　3.@XmlRootElement

　　@XmlRootElement用于类级别的注解，对应xml的跟元素，常与 @XmlType 和 @XmlAccessorType一起使用。如：

　　@XmlType
　　@XmlAccessorType(XmlAccessType.FIELD)
　　@XmlRootElement
　　public class Address {}

　4.@XmlAttribute

　　@XmlAttribute用于把java对象的属性映射为xml的属性,并可通过name属性为生成的xml属性指定别名。如：
　　@XmlAttribute(name="Country")
　　private String state;

　5.@XmlAccessorType

　　@XmlAccessorType用于指定由java对象生成xml文件时对java对象属性的访问方式。常与@XmlRootElement、@XmlType一起使用。它的属性值是XmlAccessType的4个枚举值，分　　　别为：

　　XmlAccessType.FIELD:java对象中的所有成员变量

　　XmlAccessType.PROPERTY：java对象中所有通过getter/setter方式访问的成员变量

　　XmlAccessType.PUBLIC_MEMBER：java对象中所有的public访问权限的成员变量和通过getter/setter方式访问的成员变量

　　XmlAccessType.NONE:java对象的所有属性都不映射为xml的元素

　　注意：@XmlAccessorType的默认访问级别是XmlAccessType.PUBLIC_MEMBER，因此，如果java对象中的private成员变量设置了public权限的getter/setter方法，就不要在　　　private变量上使用@XmlElement和@XmlAttribute注解，否则在由java对象生成xml时会报同一个属性在java类里存在两次的错误。同理，如果@XmlAccessorType的访问权限　　　为XmlAccessType.NONE，如果在java的成员变量上使用了@XmlElement或@XmlAttribute注解，这些成员变量依然可以映射到xml文件。

　6.@XmlAccessorOrder

　　@XmlAccessorOrder用于对java对象生成的xml元素进行排序。它有两个属性值：

　　AccessorOrder.ALPHABETICAL：对生成的xml元素按字母书序排序

　　XmlAccessOrder.UNDEFINED:不排序

　7.@XmlTransient

　　@XmlTransient用于标示在由java对象映射xml时，忽略此属性。即，在生成的xml文件中不出现此元素。

　8.@XmlJavaTypeAdapter

　　@XmlJavaTypeAdapter常用在转换比较复杂的对象时，如map类型或者格式化日期等。使用此注解时，需要自己写一个adapter类继承XmlAdapter抽象类，并实现里面的方法。

　　@XmlJavaTypeAdapter(value=xxx.class),value为自己定义的adapter类

　　XmlAdapter如下：

public abstract class XmlAdapter<ValueType,BoundType> {
    // Do-nothing constructor for the derived classes.
    protected XmlAdapter() {}
    // Convert a value type to a bound type.
    public abstract BoundType unmarshal(ValueType v);
    // Convert a bound type to a value type.
    public abstract ValueType marshal(BoundType v);
 }

演示DEMO


工具类：

package com.lgy.xml;

import java.io.StringReader;
import java.io.StringWriter;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.Marshaller;
import javax.xml.bind.Unmarshaller;

public class JaxbUtil {
	/** 
     * JavaBean转换成xml 
     * 默认编码UTF-8 
     * @param obj 
     * @param writer 
     * @return  
     */  
    public static String convertToXml(Object obj) {  
        return convertToXml(obj, "UTF-8");  
    }  
  
    /** 
     * JavaBean转换成xml 
     * @param obj 
     * @param encoding  
     * @return  
     */  
    public static String convertToXml(Object obj, String encoding) {  
        String result = null;  
        try {  
            JAXBContext context = JAXBContext.newInstance(obj.getClass());  
            Marshaller marshaller = context.createMarshaller();  
            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);  
            marshaller.setProperty(Marshaller.JAXB_ENCODING, encoding);  
            marshaller.setProperty(Marshaller.JAXB_FRAGMENT, false);
            StringWriter writer = new StringWriter();  
            marshaller.marshal(obj, writer);  
            result = writer.toString();  
        } catch (Exception e) {  
            e.printStackTrace();  
        }  
  
        return result;  
    }  
  
    /** 
     * xml转换成JavaBean 
     * @param xml 
     * @param c 
     * @return 
     */  
    @SuppressWarnings("unchecked")  
    public static <T> T converyToJavaBean(String xml, Class<T> c) {  
        T t = null;  
        try {  
            JAXBContext context = JAXBContext.newInstance(c);  
            Unmarshaller unmarshaller = context.createUnmarshaller();  
            t = (T) unmarshaller.unmarshal(new StringReader(xml));  
        } catch (Exception e) {  
            e.printStackTrace();  
        }  
  
        return t;  
    }  
}

简单类型： 

package com.lgy.xml;

import java.util.Date;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;

@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name="xmlDemo")
@XmlType(propOrder = { "author", "calendar", "price"})
public class XmlDemo {
	@XmlElement(required = true)
	private String author;

	@XmlElement(name = "price_1", required = true)
	private float price;

	@XmlElement
	private Date calendar;

	@XmlAttribute
	private Integer id;

	public String getAuthor() {
		return author;
	}

	public void setAuthor(String author) {
		this.author = author;
	}

	public float getPrice() {
		return price;
	}

	public void setPrice(float price) {
		this.price = price;
	}

	public Date getCalendar() {
		return calendar;
	}

	public void setCalendar(Date calendar) {
		this.calendar = calendar;
	}

	public Integer getId() {
		return id;
	}

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

	@Override
	public String toString() {
		return "XmlDemo [author=" + author + ", price=" + price + ", calendar=" + calendar + ", id=" + id + "]";
	}
}

复杂类型： 

package com.lgy.xml;

import java.util.List;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name="Generators")
@XmlType(propOrder = {"generatorsGroups"})
public class Generators {
	@XmlAttribute
	private Integer id;
	
	@XmlElement(required = true)
	private List<GeneratorsGroup> generatorsGroups;

	public Integer getId() {
		return id;
	}

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

	public List<GeneratorsGroup> getGeneratorsGroups() {
		return generatorsGroups;
	}

	public void setGeneratorsGroups(List<GeneratorsGroup> generatorsGroups) {
		this.generatorsGroups = generatorsGroups;
	}

	@Override
	public String toString() {
		return "Generators [id=" + id + ", generatorsGroups=" + generatorsGroups + "]";
	}
	
}


package com.lgy.xml;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;

@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(propOrder = {"test"})
public class GeneratorsGroup {
	@XmlElement(required = true)
	private String test;

	public String getTest() {
		return test;
	}

	public void setTest(String test) {
		this.test = test;
	}

	@Override
	public String toString() {
		return "GeneratorsGroup [test=" + test + "]";
	}
	
	
}


小勇Oo
关注
  • 1
    点赞
  • 踩
  • 7
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
JAXB实例入门
04-27
在本文中，我们将探讨JAXB的基本概念、使用场景以及如何通过一个简单的实例来入门。 ### JAXB的核心功能 1. **对象到XML的序列化**：JAXB能够将Java对象转换为XML文档，使得Java应用程序能够方便地生成XML输出。 2...
XML JAXB入门示例
12-15
JAXB还支持复杂的XML结构，如嵌套元素、数组和集合，以及处理XML命名空间。对于复杂的数据结构，可以使用`@XmlElementRef`和`@XmlElementRefs`注解来处理多态性，或者使用`@XmlJavaTypeAdapter`来定制类型转换。 在...
JAXB — 使用说明文档
nokiazhangjj的专栏
03-29 791
一、前言。     最近正在做一个项目，根据需求计划需要一种 Object XML的工具，而JAXB就非常符合需求，于是以下是近天来的研究心得。 二、JAXB技术介绍 1.         什么是JAXB？     Java  Architecture for XML Binding (JAXB) 是一个业界的标准，是一项可以根据XML Schema产生Java类的技术。该过程中
JAXB基础API，注解（整理）
weixin_45036188的博客
11-07 4749
JAXB基础API，注解整理1.API2.注解3.常用API 1.API 2.注解 3.常用API
使用JAXB实现JavaBean与XML互相转换
最新发布
m0_37845840的博客
04-10 656
javaBean和xml转换工具类。xml文件根元素的定义。
jaxb解析xml
雨里de风的专栏
05-26 423
import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.UnsupportedEncodingException; import javax.xml.bind.JAXBContext; import javax.xml.bind.JAXBException; imp
JAXBContext 处理 CDATA
david_lee0407的博客
10-08 416
在这里我遇到一个问题就是我把这个properties文件一起直接放到了代码的model类所在的包里了，譬如com.abc.model的包里，但是编译打包的时候，该文件不会打到包里，不会进target里。后来我把该文件放到了，resources下面的相应目录里，com\abc\model,问题解决。不是用 maven 管理的话，自己手动加一下。就这三步，可以搞定。
Java之JAXB的介绍与使用
m0_47743175的博客
12-10 2282
Java之JAXB的介绍与使用
jaxb注解使用_使用JAXB的简介
最佳 Java 编程
06-26 985
jaxb注解使用 我正在将一些依赖于Apache XMLBeans的模块迁移到JAXB。 这是令人兴奋和充满挑战的几天。 我想记下我遇到的一些重要事情，以供将来可能会发现有用的任何人使用。 首先，让我们来看一下设置用于JAXB代码生成的maven插件。 在撰写本文时，我遇到了两个Maven插件。 http://www.mojohaus.org/jaxb2-maven-plugin/D...
JAXB入门学习（五）
07-27
NULL 博文链接：https://popomonkey.iteye.com/blog/688580
jaxb入门学习
11-23
这是一个不错的文档哦，希望能下下来参考看看
jaxb jar包
01-23
jaxb jar(jaxb-api-2.2.7.jar) 针对xml和bean转化工具
jaxb-core-2.3.0.jar
07-22
有关Maven项目中缺少jaxb-api的异常报错解决，jaxb-core-2.3.0.jar
JAXB简易教程
06-09
这个简易教程将引导我们了解如何使用JAXB进行XML到Java对象以及Java对象到XML的转换，这对于处理XML数据在Java应用中的序列化和反序列化非常有用。 **1. 前言** JAXB的主要目的是简化XML数据处理，让开发者能够...
JAXB介绍二
weixin_30295091的博客
09-18 76
链接上一遍 JAXB介绍一, 本节主要介绍解析xml的步骤, 下面的例子是在实际项目中运用的, 把它拿出来单独写一个java运行程序. 5. 测试实例 先给出我的代码结构图: 再给出要解析的Script.xml文件的内容: <?xml version='1.0' encoding='UTF-8' ?> <Script> <SchemaVer...
Jaxb多层 java 与 xml 转换
AndyLizh的专栏
09-02 4243
/**   *    */   package com.wonders.quartz.cocc.model.xml;      import java.util.List;      import javax.xml.bind.annotation.XmlAttribute;   import javax.xml.bind.annotation.XmlElement;   imp
Spring Boot项目打jar包遇到的坑
sinnnnnner的博客
12-18 2748
Spring Boot项目打jar包遇到的坑 No Class Def Found Error javax JAXB 参考博客：https://blog.csdn.net/hadues/article/details/79188793 https://segmentfault.com/q/1010000012480240 问题原因： JAXB API是java EE 的API，因此在java...
JAXB注解的使用详解
热门推荐
小马哥的专栏
07-17 1万+
在开始介绍jaxb注解的使用方法之前，我们先来看看具体是什么？有什么用？ 一、     JAXB是什么？ JAXB（即Java Architecturefor XML Binding）是一个业界的标准，即是一项可以根据XML Schema产生Java类的技术。该过程中，JAXB也提供了将XML实例文档反向生成Java对象树的方法，并能将Java对象树的内容重新写到XML实例文档。 二、
springboot整合jaxb
08-11
要在Spring Boot中整合JAXB，您可以按照以下步骤进行操作： 1. 添加依赖：在您的项目的pom.xml文件中，添加JAXB依赖项。 ```xml <dependency> <groupId>javax.xml.bind</groupId> <artifactId>jaxb-api</artifactId> <version>2.3.1</version> </dependency> ``` 2. 创建Java类：创建要映射到XML的Java类。使用JAXB注解配置类和字段。 ```java @XmlRootElement public class Person { private String name; private int age; // 省略构造函数、getter和setter方法 } ``` 3. 创建XML转换工具类：创建一个工具类，用于执行XML转换操作。 ```java import javax.xml.bind.JAXBContext; import javax.xml.bind.JAXBException; import javax.xml.bind.Marshaller; import javax.xml.bind.Unmarshaller; import java.io.File; public class JAXBUtils { public static void marshal(Object object, File file) throws JAXBException { JAXBContext jaxbContext = JAXBContext.newInstance(object.getClass()); Marshaller marshaller = jaxbContext.createMarshaller(); marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true); marshaller.marshal(object, file); } public static <T> T unmarshal(Class<T> clazz, File file) throws JAXBException { JAXBContext jaxbContext = JAXBContext.newInstance(clazz); Unmarshaller unmarshaller = jaxbContext.createUnmarshaller(); return clazz.cast(unmarshaller.unmarshal(file)); } } ``` 4. 配置Spring Boot：在您的Spring Boot应用程序的配置类上添加JAXB相关的配置。 ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.http.converter.HttpMessageConverter; import org.springframework.http.converter.xml.MarshallingHttpMessageConverter; import org.springframework.oxm.jaxb.Jaxb2Marshaller; @Configuration public class JAXBConfig { @Bean public Jaxb2Marshaller jaxb2Marshaller() { Jaxb2Marshaller marshaller = new Jaxb2Marshaller(); marshaller.setPackagesToScan("com.example.demo"); // 设置要扫描的包路径 return marshaller; } @Bean public HttpMessageConverter<Object> marshallingHttpMessageConverter(Jaxb2Marshaller jaxb2Marshaller) { return new MarshallingHttpMessageConverter(jaxb2Marshaller); } } ``` 5. 使用JAXB：在您的控制器或服务类中使用JAXB进行XML转换操作。 ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class PersonController { @Autowired private Jaxb2Marshaller jaxb2Marshaller; @GetMapping("/person") public Person getPerson() { Person person = new Person(); person.setName("John"); person.setAge(25); return person; } @GetMapping("/xml") public String getXml() { Person person = getPerson(); StringWriter writer = new StringWriter(); jaxb2Marshaller.marshal(person, new StreamResult(writer)); return writer.toString(); } } ``` 这样，当访问`/person`接口时，将返回一个Person对象的JSON表示。当访问`/xml`接口时，将返回Person对象的XML表示。 这就是在Spring Boot中整合JAXB的基本步骤。您可以根据需要进行扩展和自定义。希望对您有所帮助！

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值