Java xml數(shù)據(jù)格式返回實(shí)現(xiàn)操作
前言:對(duì)于服務(wù)器后端開(kāi)發(fā),接口返回的數(shù)據(jù)格式一般要求都是json,但是也有使用xml格式
RequestBody注解
對(duì)于SpringMVC,很多人會(huì)認(rèn)為接口方法使用@Controller搭配@ResponseBody和@RequestMapping注解后,java對(duì)象會(huì)轉(zhuǎn)換成json格式返回。
但實(shí)際上配合@ResponseBody注解后,接口返回的數(shù)據(jù)類型是根據(jù)HTTP Request Header中的Accept屬性來(lái)確定的,可以是XML或者JSON數(shù)據(jù)
通過(guò)適當(dāng)?shù)腍ttpMessageConverter對(duì)java對(duì)象進(jìn)行格式轉(zhuǎn)換,常用的有:
ByteArrayHttpMessageConverter
負(fù)責(zé)讀取二進(jìn)制格式的數(shù)據(jù)和寫(xiě)出二進(jìn)制格式的數(shù)據(jù);
StringHttpMessageConverter
負(fù)責(zé)讀取字符串格式的數(shù)據(jù)和寫(xiě)出二進(jìn)制格式的數(shù)據(jù);
ResourceHttpMessageConverter
負(fù)責(zé)讀取資源文件和寫(xiě)出資源文件數(shù)據(jù);
FormHttpMessageConverter
負(fù)責(zé)讀取form提交的數(shù)據(jù);
MappingJacksonHttpMessageConverter
負(fù)責(zé)讀取和寫(xiě)入json格式的數(shù)據(jù);
SouceHttpMessageConverter
負(fù)責(zé)讀取和寫(xiě)入 xml 中javax.xml.transform.Source定義的數(shù)據(jù);
Jaxb2RootElementHttpMessageConverter
負(fù)責(zé)讀取和寫(xiě)入xml 標(biāo)簽格式的數(shù)據(jù);
AtomFeedHttpMessageConverter
負(fù)責(zé)讀取和寫(xiě)入Atom格式的數(shù)據(jù);
RssChannelHttpMessageConverter
負(fù)責(zé)讀取和寫(xiě)入RSS格式的數(shù)據(jù)
具體使用哪個(gè)怎么判斷這里就不細(xì)講了,我們關(guān)心的是Jaxb2RootElementHttpMessageConverter這個(gè)方法,后面會(huì)講為啥會(huì)提
java對(duì)象與xml之間互相轉(zhuǎn)換
使用Java自帶注解的方式實(shí)現(xiàn)(@XmlRootElement,@XmlAccessorType,@XmlElement,@XmlAttribute),具體使用方法網(wǎng)上有很多
這里直接代碼舉例
import javax.xml.bind.annotation.XmlElement; import javax.xml.bind.annotation.XmlRootElement; import javax.xml.bind.annotation.XmlType; @XmlRootElement(name = "city") @XmlType(propOrder = { "name","province"}) public class City { private String name; private String province; public City() { } public City(String name, String province) { this.name = name; this.province = province; } public String getName() { return name; } @XmlElement public void setName(String name) { this.name = name; } public String getProvince() { return province; } @XmlElement public void setProvince(String province) { this.province = province; } }
controller
import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.ResponseBody; @Controller public class IndexController { @RequestMapping(path = "/get") @ResponseBody public City getXml(){ City city= new City("太原","山西"); return city; } }
請(qǐng)求http://localhost:8080/get 返回結(jié)果如下
是不很容易就實(shí)現(xiàn)接口返回xml格式
使用<![CDATA[]]>
對(duì)象屬性中有可能存在計(jì)算邏輯'<‘或'>',而在xml文件中這兩個(gè)符號(hào)是不合法的,會(huì)轉(zhuǎn)換為<和>,這樣數(shù)據(jù)就'壞'了,所以<![CDATA[]]>的加入是非常有必要的!
一般實(shí)現(xiàn):使用XmlAdapter定義一個(gè)CDataAdapter類,網(wǎng)上也有很多代碼
大概的實(shí)現(xiàn)如下
public class CDataAdapter extends XmlAdapter<String, String> { @Override public String unmarshal(String v) throws Exception { // 我們這里沒(méi)有xml轉(zhuǎn)java對(duì)象,這里就不具體實(shí)現(xiàn)了 return v; } @Override public String marshal(String v) throws Exception { return new StringBuilder("<![CDATA[").append(v).append("]]>").toString(); } }
然后使用注解XmlJavaTypeAdapter作用于屬性變量上
@XmlJavaTypeAdapter(value=CDataAdapter.class) @XmlElement public void setProvince(String province) { this.province = province; }
結(jié)果
但是實(shí)際上看源碼
這個(gè)不是我們希望的,產(chǎn)生原因是Jaxb默認(rèn)會(huì)把字符'<', '>'進(jìn)行轉(zhuǎn)義, 下面解決這個(gè)問(wèn)題
我們使用org.eclipse.persistence.oxm.annotations.XmlCDATA注解來(lái)解決
使用EclipseLink JAXB (MOXy)
pom文件增加
<dependency> <groupId>org.eclipse.persistence</groupId> <artifactId>org.eclipse.persistence.moxy</artifactId> <version>xx版本</version> </dependency>
上一節(jié)中的屬性使用注解
... import org.eclipse.persistence.oxm.annotations.XmlCDATA; ... ... @XmlCDATA @XmlElement public void setProvince(String province) { this.province = province; }
注意:一定要設(shè)置jaxb.properties文件,并且要放在要轉(zhuǎn)換成xml的java對(duì)象所在目錄,并且要編譯到target中,不然XmlCDATA注解不生效
jaxb.properties文件內(nèi)容,就是指定創(chuàng)建JAXBContext對(duì)象的工長(zhǎng)
javax.xml.bind.context.factory=org.eclipse.persistence.jaxb.JAXBContextFactory
到這里配置完成!
補(bǔ)充知識(shí):Java Document生成和解析XML
一)Document介紹
API來(lái)源:在JDK中javax.xml.*包下
使用場(chǎng)景:
1、需要知道XML文檔所有結(jié)構(gòu)
2、需要把文檔一些元素排序
3、文檔中的信息被多次使用的情況
優(yōu)勢(shì):由于Document是java中自帶的解析器,兼容性強(qiáng)
缺點(diǎn):由于Document是一次性加載文檔信息,如果文檔太大,加載耗時(shí)長(zhǎng),不太適用
二)Document生成XML
實(shí)現(xiàn)步驟:
第一步:初始化一個(gè)XML解析工廠
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
第二步:創(chuàng)建一個(gè)DocumentBuilder實(shí)例
DocumentBuilder builder = factory.newDocumentBuilder();
第三步:構(gòu)建一個(gè)Document實(shí)例
Document doc = builder.newDocument();
doc.setXmlStandalone(true);
standalone用來(lái)表示該文件是否呼叫其它外部的文件。若值是 ”yes” 表示沒(méi)有呼叫外部文件
第四步:創(chuàng)建一個(gè)根節(jié)點(diǎn),名稱為root,并設(shè)置一些基本屬性
Element element = doc.createElement("root");
element.setAttribute("attr", "root");//設(shè)置節(jié)點(diǎn)屬性
childTwoTwo.setTextContent("root attr");//設(shè)置標(biāo)簽之間的內(nèi)容
第五步:把節(jié)點(diǎn)添加到Document中,再創(chuàng)建一些子節(jié)點(diǎn)加入
doc.appendChild(element);
第六步:把構(gòu)造的XML結(jié)構(gòu),寫(xiě)入到具體的文件中
實(shí)現(xiàn)源碼:
package com.oysept.xml; import java.io.File; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.parsers.ParserConfigurationException; import javax.xml.transform.OutputKeys; import javax.xml.transform.Transformer; import javax.xml.transform.TransformerConfigurationException; import javax.xml.transform.TransformerException; import javax.xml.transform.TransformerFactory; import javax.xml.transform.dom.DOMSource; import javax.xml.transform.stream.StreamResult; import org.w3c.dom.Document; import org.w3c.dom.Element; /** * Document生成XML * @author ouyangjun */ public class CreateDocument { public static void main(String[] args) { // 執(zhí)行Document生成XML方法 createDocument(new File("E:\\person.xml")); } public static void createDocument(File file) { try { // 初始化一個(gè)XML解析工廠 DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); // 創(chuàng)建一個(gè)DocumentBuilder實(shí)例 DocumentBuilder builder = factory.newDocumentBuilder(); // 構(gòu)建一個(gè)Document實(shí)例 Document doc = builder.newDocument(); doc.setXmlStandalone(true); // standalone用來(lái)表示該文件是否呼叫其它外部的文件。若值是 ”yes” 表示沒(méi)有呼叫外部文件 // 創(chuàng)建一個(gè)根節(jié)點(diǎn) // 說(shuō)明: doc.createElement("元素名")、element.setAttribute("屬性名","屬性值")、element.setTextContent("標(biāo)簽間內(nèi)容") Element element = doc.createElement("root"); element.setAttribute("attr", "root"); // 創(chuàng)建根節(jié)點(diǎn)第一個(gè)子節(jié)點(diǎn) Element elementChildOne = doc.createElement("person"); elementChildOne.setAttribute("attr", "personOne"); element.appendChild(elementChildOne); // 第一個(gè)子節(jié)點(diǎn)的第一個(gè)子節(jié)點(diǎn) Element childOneOne = doc.createElement("people"); childOneOne.setAttribute("attr", "peopleOne"); childOneOne.setTextContent("attr peopleOne"); elementChildOne.appendChild(childOneOne); // 第一個(gè)子節(jié)點(diǎn)的第二個(gè)子節(jié)點(diǎn) Element childOneTwo = doc.createElement("people"); childOneTwo.setAttribute("attr", "peopleTwo"); childOneTwo.setTextContent("attr peopleTwo"); elementChildOne.appendChild(childOneTwo); // 創(chuàng)建根節(jié)點(diǎn)第二個(gè)子節(jié)點(diǎn) Element elementChildTwo = doc.createElement("person"); elementChildTwo.setAttribute("attr", "personTwo"); element.appendChild(elementChildTwo); // 第二個(gè)子節(jié)點(diǎn)的第一個(gè)子節(jié)點(diǎn) Element childTwoOne = doc.createElement("people"); childTwoOne.setAttribute("attr", "peopleOne"); childTwoOne.setTextContent("attr peopleOne"); elementChildTwo.appendChild(childTwoOne); // 第二個(gè)子節(jié)點(diǎn)的第二個(gè)子節(jié)點(diǎn) Element childTwoTwo = doc.createElement("people"); childTwoTwo.setAttribute("attr", "peopleTwo"); childTwoTwo.setTextContent("attr peopleTwo"); elementChildTwo.appendChild(childTwoTwo); // 添加根節(jié)點(diǎn) doc.appendChild(element); // 把構(gòu)造的XML結(jié)構(gòu),寫(xiě)入到具體的文件中 TransformerFactory formerFactory=TransformerFactory.newInstance(); Transformer transformer=formerFactory.newTransformer(); // 換行 transformer.setOutputProperty(OutputKeys.INDENT, "YES"); // 文檔字符編碼 transformer.setOutputProperty(OutputKeys.ENCODING, "utf-8"); // 可隨意指定文件的后綴,效果一樣,但xml比較好解析,比如: E:\\person.txt等 transformer.transform(new DOMSource(doc),new StreamResult(file)); System.out.println("XML CreateDocument success!"); } catch (ParserConfigurationException e) { e.printStackTrace(); } catch (TransformerConfigurationException e) { e.printStackTrace(); } catch (TransformerException e) { e.printStackTrace(); } } }
XML文件效果圖:
三)Document解析XML
實(shí)現(xiàn)步驟:
第一步:先獲取需要解析的文件,判斷文件是否已經(jīng)存在或有效
第二步:初始化一個(gè)XML解析工廠
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
第三步:創(chuàng)建一個(gè)DocumentBuilder實(shí)例
DocumentBuilder builder = factory.newDocumentBuilder();
第四步:創(chuàng)建一個(gè)解析XML的Document實(shí)例
Document doc = builder.parse(file);
第五步:先獲取根節(jié)點(diǎn)的信息,然后根據(jù)根節(jié)點(diǎn)遞歸一層層解析XML
實(shí)現(xiàn)源碼:
package com.oysept.xml; import java.io.File; import java.io.IOException; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.parsers.ParserConfigurationException; import org.w3c.dom.Attr; import org.w3c.dom.Document; import org.w3c.dom.Element; import org.w3c.dom.NamedNodeMap; import org.w3c.dom.Node; import org.w3c.dom.NodeList; import org.xml.sax.SAXException; /** * Document解析XML * @author ouyangjun */ public class ParseDocument { public static void main(String[] args){ File file = new File("E:\\person.xml"); if (!file.exists()) { System.out.println("xml文件不存在,請(qǐng)確認(rèn)!"); } else { parseDocument(file); } } public static void parseDocument(File file) { try{ // 初始化一個(gè)XML解析工廠 DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); // 創(chuàng)建一個(gè)DocumentBuilder實(shí)例 DocumentBuilder builder = factory.newDocumentBuilder(); // 創(chuàng)建一個(gè)解析XML的Document實(shí)例 Document doc = builder.parse(file); // 獲取根節(jié)點(diǎn)名稱 String rootName = doc.getDocumentElement().getTagName(); System.out.println("根節(jié)點(diǎn): " + rootName); System.out.println("遞歸解析--------------begin------------------"); // 遞歸解析Element Element element = doc.getDocumentElement(); parseElement(element); System.out.println("遞歸解析--------------end------------------"); } catch (ParserConfigurationException e) { e.printStackTrace(); } catch (SAXException e) { e.printStackTrace(); } catch (IOException e) { e.printStackTrace(); } } // 遞歸方法 public static void parseElement(Element element) { System.out.print("<" + element.getTagName()); NamedNodeMap attris = element.getAttributes(); for (int i = 0; i < attris.getLength(); i++) { Attr attr = (Attr) attris.item(i); System.out.print(" " + attr.getName() + "=\"" + attr.getValue() + "\""); } System.out.println(">"); NodeList nodeList = element.getChildNodes(); Node childNode; for (int temp = 0; temp < nodeList.getLength(); temp++) { childNode = nodeList.item(temp); // 判斷是否屬于節(jié)點(diǎn) if (childNode.getNodeType() == Node.ELEMENT_NODE) { // 判斷是否還有子節(jié)點(diǎn) if(childNode.hasChildNodes()){ parseElement((Element) childNode); } else if (childNode.getNodeType() != Node.COMMENT_NODE) { System.out.print(childNode.getTextContent()); } } } System.out.println("</" + element.getTagName() + ">"); } }
XML解析效果圖:
以上這篇Java xml數(shù)據(jù)格式返回實(shí)現(xiàn)操作就是小編分享給大家的全部?jī)?nèi)容了,希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
MybatisPlus如何自定義TypeHandler映射JSON類型為L(zhǎng)ist
這篇文章主要介紹了MybatisPlus如何自定義TypeHandler映射JSON類型為L(zhǎng)ist,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-01-01JAVA使用POI(XSSFWORKBOOK)讀取EXCEL文件過(guò)程解析
這篇文章主要介紹了JAVA使用POI(XSSFWORKBOOK)讀取EXCEL文件過(guò)程解析,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-08-08Spring事務(wù)傳播屬性和隔離級(jí)別詳細(xì)介紹
這篇文章主要介紹了Spring事務(wù)傳播屬性和隔離級(jí)別詳細(xì)介紹,同時(shí)涉及傳播行為介紹,超時(shí)設(shè)置等相關(guān)內(nèi)容,需要的朋友可以參考下。2017-09-09解決idea中maven項(xiàng)目無(wú)端顯示404錯(cuò)誤的方法
這篇文章主要介紹了解決idea中maven項(xiàng)目無(wú)端顯示404錯(cuò)誤的方法,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-12-12MybatisPlus中QueryWrapper常用方法總結(jié)
MyBatis-Plus是一個(gè)Mybatis增強(qiáng)版工具,在MyBatis上擴(kuò)充了其他功能沒(méi)有改變其基本功能,為了簡(jiǎn)化開(kāi)發(fā)提交效率而存在,queryWrapper是mybatis plus中實(shí)現(xiàn)查詢的對(duì)象封裝操作類,本文就給大家總結(jié)了MybatisPlus中QueryWrapper的常用方法,需要的朋友可以參考下2023-07-07Java使用Iterator迭代器遍歷集合數(shù)據(jù)的方法小結(jié)
這篇文章主要介紹了Java使用Iterator迭代器遍歷集合數(shù)據(jù)的方法,結(jié)合實(shí)例形式分析了java迭代器進(jìn)行集合數(shù)據(jù)遍歷的常見(jiàn)操作技巧,需要的朋友可以參考下2019-11-11