Java xml数据格式返回实现操作

2023-07-18 02:33:03 229

前言：对于服务器后端开发，接口返回的数据格式一般要求都是json，但是也有使用xml格式

RequestBody注解

对于SpringMVC，很多人会认为接口方法使用@Controller搭配@ResponseBody和@RequestMapping注解后，java对象会转换成json格式返回。

但实际上配合@ResponseBody注解后，接口返回的数据类型是根据HTTPRequestHeader中的Accept属性来确定的，可以是XML或者JSON数据

通过适当的HttpMessageConverter对java对象进行格式转换，常用的有:

ByteArrayHttpMessageConverter

负责读取二进制格式的数据和写出二进制格式的数据；

StringHttpMessageConverter

负责读取字符串格式的数据和写出二进制格式的数据；

ResourceHttpMessageConverter

负责读取资源文件和写出资源文件数据；

FormHttpMessageConverter

负责读取form提交的数据；

MappingJacksonHttpMessageConverter

负责读取和写入json格式的数据；

SouceHttpMessageConverter

负责读取和写入xml中javax.xml.transform.Source定义的数据；

Jaxb2RootElementHttpMessageConverter

负责读取和写入xml标签格式的数据；

AtomFeedHttpMessageConverter

负责读取和写入Atom格式的数据；

RssChannelHttpMessageConverter

负责读取和写入RSS格式的数据

具体使用哪个怎么判断这里就不细讲了，我们关心的是Jaxb2RootElementHttpMessageConverter这个方法，后面会讲为啥会提

java对象与xml之间互相转换

使用Java自带注解的方式实现（@XmlRootElement，@XmlAccessorType，@XmlElement，@XmlAttribute），具体使用方法网上有很多

这里直接代码举例

importjavax.xml.bind.annotation.XmlElement;
importjavax.xml.bind.annotation.XmlRootElement;
importjavax.xml.bind.annotation.XmlType;

@XmlRootElement(name="city")
@XmlType(propOrder={"name","province"})
publicclassCity{
privateStringname;
privateStringprovince;

publicCity(){
}

publicCity(Stringname,Stringprovince){
this.name=name;
this.province=province;
}

publicStringgetName(){
returnname;
}

@XmlElement
publicvoidsetName(Stringname){
this.name=name;
}

publicStringgetProvince(){
returnprovince;
}

@XmlElement
publicvoidsetProvince(Stringprovince){
this.province=province;
}
}

controller

importorg.springframework.stereotype.Controller;
importorg.springframework.web.bind.annotation.RequestMapping;
importorg.springframework.web.bind.annotation.ResponseBody;

@Controller
publicclassIndexController{

@RequestMapping(path="/get")
@ResponseBody
publicCitygetXml(){
Citycity=newCity("太原","山西");
returncity;
}
}

请求http://localhost:8080/get返回结果如下

是不很容易就实现接口返回xml格式

使用

对象属性中有可能存在计算逻辑'<‘或'>',而在xml文件中这两个符号是不合法的,会转换为<和>,这样数据就'坏'了,所以的加入是非常有必要的!

一般实现：使用XmlAdapter定义一个CDataAdapter类，网上也有很多代码

大概的实现如下

publicclassCDataAdapterextendsXmlAdapter{

@Override
publicStringunmarshal(Stringv)throwsException{
//我们这里没有xml转java对象，这里就不具体实现了
returnv;
}

@Override
publicStringmarshal(Stringv)throwsException{
returnnewStringBuilder("").toString();
}

}

然后使用注解XmlJavaTypeAdapter作用于属性变量上

@XmlJavaTypeAdapter(value=CDataAdapter.class)
@XmlElement
publicvoidsetProvince(Stringprovince){
this.province=province;
}

结果

但是实际上看源码

这个不是我们希望的，产生原因是Jaxb默认会把字符'<','>'进行转义,下面解决这个问题

我们使用org.eclipse.persistence.oxm.annotations.XmlCDATA注解来解决

使用EclipseLinkJAXB(MOXy)

pom文件增加


org.eclipse.persistence
org.eclipse.persistence.moxy
xx版本

上一节中的属性使用注解

...
importorg.eclipse.persistence.oxm.annotations.XmlCDATA;

...
...
@XmlCDATA
@XmlElement
publicvoidsetProvince(Stringprovince){
this.province=province;
}

注意：一定要设置jaxb.properties文件，并且要放在要转换成xml的java对象所在目录，并且要编译到target中，不然XmlCDATA注解不生效

jaxb.properties文件内容，就是指定创建JAXBContext对象的工长

javax.xml.bind.context.factory=org.eclipse.persistence.jaxb.JAXBContextFactory

到这里配置完成！

补充知识：JavaDocument生成和解析XML

一）Document介绍

API来源：在JDK中javax.xml.*包下

使用场景：

1、需要知道XML文档所有结构

2、需要把文档一些元素排序

3、文档中的信息被多次使用的情况

优势：由于Document是java中自带的解析器，兼容性强

缺点：由于Document是一次性加载文档信息，如果文档太大，加载耗时长，不太适用

二）Document生成XML

实现步骤：

第一步：初始化一个XML解析工厂

DocumentBuilderFactoryfactory=DocumentBuilderFactory.newInstance();

第二步：创建一个DocumentBuilder实例

DocumentBuilderbuilder=factory.newDocumentBuilder();

第三步：构建一个Document实例

Documentdoc=builder.newDocument();

doc.setXmlStandalone(true);

standalone用来表示该文件是否呼叫其它外部的文件。若值是”yes”表示没有呼叫外部文件

第四步：创建一个根节点，名称为root，并设置一些基本属性

Elementelement=doc.createElement("root");

element.setAttribute("attr","root");//设置节点属性

childTwoTwo.setTextContent("rootattr");//设置标签之间的内容

第五步：把节点添加到Document中，再创建一些子节点加入

doc.appendChild(element);

第六步：把构造的XML结构，写入到具体的文件中

实现源码：

packagecom.oysept.xml;
importjava.io.File;
importjavax.xml.parsers.DocumentBuilder;
importjavax.xml.parsers.DocumentBuilderFactory;
importjavax.xml.parsers.ParserConfigurationException;
importjavax.xml.transform.OutputKeys;
importjavax.xml.transform.Transformer;
importjavax.xml.transform.TransformerConfigurationException;
importjavax.xml.transform.TransformerException;
importjavax.xml.transform.TransformerFactory;
importjavax.xml.transform.dom.DOMSource;
importjavax.xml.transform.stream.StreamResult;

importorg.w3c.dom.Document;
importorg.w3c.dom.Element;

/**
*Document生成XML
*@authorouyangjun
*/
publicclassCreateDocument{

publicstaticvoidmain(String[]args){
//执行Document生成XML方法
createDocument(newFile("E:\\person.xml"));
}

publicstaticvoidcreateDocument(Filefile){
try{
//初始化一个XML解析工厂
DocumentBuilderFactoryfactory=DocumentBuilderFactory.newInstance();

//创建一个DocumentBuilder实例
DocumentBuilderbuilder=factory.newDocumentBuilder();

//构建一个Document实例
Documentdoc=builder.newDocument();
doc.setXmlStandalone(true);
//standalone用来表示该文件是否呼叫其它外部的文件。若值是”yes”表示没有呼叫外部文件

//创建一个根节点
//说明:doc.createElement("元素名")、element.setAttribute("属性名","属性值")、element.setTextContent("标签间内容")
Elementelement=doc.createElement("root");
element.setAttribute("attr","root");

//创建根节点第一个子节点
ElementelementChildOne=doc.createElement("person");
elementChildOne.setAttribute("attr","personOne");
element.appendChild(elementChildOne);

//第一个子节点的第一个子节点
ElementchildOneOne=doc.createElement("people");
childOneOne.setAttribute("attr","peopleOne");
childOneOne.setTextContent("attrpeopleOne");
elementChildOne.appendChild(childOneOne);

//第一个子节点的第二个子节点
ElementchildOneTwo=doc.createElement("people");
childOneTwo.setAttribute("attr","peopleTwo");
childOneTwo.setTextContent("attrpeopleTwo");
elementChildOne.appendChild(childOneTwo);

//创建根节点第二个子节点
ElementelementChildTwo=doc.createElement("person");
elementChildTwo.setAttribute("attr","personTwo");
element.appendChild(elementChildTwo);

//第二个子节点的第一个子节点
ElementchildTwoOne=doc.createElement("people");
childTwoOne.setAttribute("attr","peopleOne");
childTwoOne.setTextContent("attrpeopleOne");
elementChildTwo.appendChild(childTwoOne);

//第二个子节点的第二个子节点
ElementchildTwoTwo=doc.createElement("people");
childTwoTwo.setAttribute("attr","peopleTwo");
childTwoTwo.setTextContent("attrpeopleTwo");
elementChildTwo.appendChild(childTwoTwo);

//添加根节点
doc.appendChild(element);

//把构造的XML结构，写入到具体的文件中
TransformerFactoryformerFactory=TransformerFactory.newInstance();
Transformertransformer=formerFactory.newTransformer();
//换行
transformer.setOutputProperty(OutputKeys.INDENT,"YES");
//文档字符编码
transformer.setOutputProperty(OutputKeys.ENCODING,"utf-8");

//可随意指定文件的后缀,效果一样,但xml比较好解析,比如:E:\\person.txt等
transformer.transform(newDOMSource(doc),newStreamResult(file));

System.out.println("XMLCreateDocumentsuccess!");
}catch(ParserConfigurationExceptione){
e.printStackTrace();
}catch(TransformerConfigurationExceptione){
e.printStackTrace();
}catch(TransformerExceptione){
e.printStackTrace();
}
}
}

XML文件效果图：

三）Document解析XML

实现步骤：

第一步：先获取需要解析的文件，判断文件是否已经存在或有效

第二步：初始化一个XML解析工厂

DocumentBuilderFactoryfactory=DocumentBuilderFactory.newInstance();

第三步：创建一个DocumentBuilder实例

DocumentBuilderbuilder=factory.newDocumentBuilder();

第四步：创建一个解析XML的Document实例

Documentdoc=builder.parse(file);

第五步：先获取根节点的信息，然后根据根节点递归一层层解析XML

实现源码：

packagecom.oysept.xml;

importjava.io.File;
importjava.io.IOException;
importjavax.xml.parsers.DocumentBuilder;
importjavax.xml.parsers.DocumentBuilderFactory;
importjavax.xml.parsers.ParserConfigurationException;

importorg.w3c.dom.Attr;
importorg.w3c.dom.Document;
importorg.w3c.dom.Element;
importorg.w3c.dom.NamedNodeMap;
importorg.w3c.dom.Node;
importorg.w3c.dom.NodeList;
importorg.xml.sax.SAXException;

/**
*Document解析XML
*@authorouyangjun
*/
publicclassParseDocument{

publicstaticvoidmain(String[]args){
Filefile=newFile("E:\\person.xml");
if(!file.exists()){
System.out.println("xml文件不存在,请确认!");
}else{
parseDocument(file);
}
}

publicstaticvoidparseDocument(Filefile){
try{
//初始化一个XML解析工厂
DocumentBuilderFactoryfactory=DocumentBuilderFactory.newInstance();

//创建一个DocumentBuilder实例
DocumentBuilderbuilder=factory.newDocumentBuilder();

//创建一个解析XML的Document实例
Documentdoc=builder.parse(file);

//获取根节点名称
StringrootName=doc.getDocumentElement().getTagName();
System.out.println("根节点:"+rootName);

System.out.println("递归解析--------------begin------------------");
//递归解析Element
Elementelement=doc.getDocumentElement();
parseElement(element);
System.out.println("递归解析--------------end------------------");
}catch(ParserConfigurationExceptione){
e.printStackTrace();
}catch(SAXExceptione){
e.printStackTrace();
}catch(IOExceptione){
e.printStackTrace();
}
}

//递归方法
publicstaticvoidparseElement(Elementelement){
System.out.print("<"+element.getTagName());
NamedNodeMapattris=element.getAttributes();
for(inti=0;i");

NodeListnodeList=element.getChildNodes();
NodechildNode;
for(inttemp=0;temp");
}
}

XML解析效果图：

以上这篇Javaxml数据格式返回实现操作就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持毛票票。

声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。

Java xml数据格式返回实现操作

热门推荐

随机推荐