XML和JSON是两种经常在网络使用的数据表示格式。

1.XML

XML是可扩展标记语言(eXtensible Markup Language)的缩写,它是是一种数据表示格式,可以描述非常复杂的数据结构,常用于传输和存储数据。
例如,一个描述书籍的XML文档可能如下:

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE note SYSTEM "book.dtd">
  3. <book id="1">
  4. <name>Java核心技术</name>
  5. <author>Cay S. Horstmann</author>
  6. <isbn lang="CN">1234567</isbn>
  7. <tags>
  8. <tag>Java</tag>
  9. <tag>Network</tag>
  10. </tags>
  11. <pubDate/>
  12. </book>

XML有几个特点:一是纯文本,默认使用UTF-8编码,二是可嵌套,适合表示结构化数据。如果把XML内容存为文件,那么它就是一个XML文件,例如book.xml。此外,XML内容经常通过网络作为消息传输。

XML的结构

XML有固定的结构,首行必定是<?xml version=”1.0”?>,可以加上可选的编码。紧接着,如果以类似<!DOCTYPE note SYSTEM “book.dtd”>声明的是文档定义类型(DTD:Document Type Definition),DTD是可选的。接下来是XML的文档内容,一个XML文档有且仅有一个根元素,根元素可以包含任意个子元素,元素可以包含属性,例如,1234567包含一个属性lang=”CN”,且元素必须正确嵌套。如果是空元素,可以用表示。
由于使用了<、>以及引号等标识符,如果内容出现了特殊符号,需要使用&???;表示转义。例如,Java必须写成:

  1. <name>Java&lt;tm&gt;</name>

常见的特殊字符如下:

字符 表示
< <
> >
& &
"
'

格式正确的XML(Well Formed)是指XML的格式是正确的,可以被解析器正常读取。而合法的XML是指,不但XML格式正确,而且它的数据结构可以被DTD或者XSD验证。
DTD文档可以指定一系列规则,例如:

  • 根元素必须是book
  • book元素必须包含name,author等指定元素
  • isbn元素必须包含属性lang

如何验证XML文件的正确性呢?最简单的方式是通过浏览器验证。可以直接把XML文件拖拽到浏览器窗口,如果格式错误,浏览器会报错。
和结构类似的HTML不同,浏览器对HTML有一定的“容错性”,缺少关闭标签也可以被解析,但XML要求严格的格式,任何没有正确嵌套的标签都会导致错误。
XML是一个技术体系,除了我们经常用到的XML文档本身外,XML还支持:

  • DTD和XSD:验证XML结构和数据是否有效;
  • Namespace:XML节点和属性的名字空间;
  • XSLT:把XML转化为另一种文本;
  • XPath:一种XML节点查询语言;

XML使用嵌套结构的数据表示方式,支持格式验证;
XML常用于配置文件、网络消息传输等。

2.DOM

因为XML是一种树形结构的文档,它有两种标准的解析API:

  • DOM:一次性读取XML,并在内存中表示为树形结构;
  • SAX:以流的形式读取XML,使用事件回调。

我们先来看如何使用DOM来读取XML。
DOM是Document Object Model的缩写,DOM模型就是把XML结构作为一个树形结构处理,从根节点开始,每个节点都可以包含任意个子节点。
我们以下面的XML为例:

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <book id="1">
  3. <name>Java核心技术</name>
  4. <author>Cay S. Horstmann</author>
  5. <isbn lang="CN">1234567</isbn>
  6. <tags>
  7. <tag>Java</tag>
  8. <tag>Network</tag>
  9. </tags>
  10. <pubDate/>
  11. </book>

如果解析为DOM结构,它大概长这样:
image.png
注意到最顶层的document代表XML文档,它是真正的“根”,而虽然是根元素,但它是document的一个子节点。
Java提供了DOM API来解析XML,它使用下面的对象来表示XML的内容:

  • Document:代表整个XML文档;
  • Element:代表一个XML元素;
  • Attribute:代表一个元素的某个属性。

使用DOM API解析一个XML文档的代码如下:

  1. InputStream input = Main.class.getResourceAsStream("/book.xml");
  2. DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
  3. DocumentBuilder db = dbf.newDocumentBuilder();
  4. Document doc = db.parse(input);

DocumentBuilder.parse()用于解析一个XML,它可以接收InputStream,File或者URL,如果解析无误,我们将获得一个Document对象,这个对象代表了整个XML文档的树形结构,需要遍历以便读取指定元素的值:

  1. void printNode(Node n, int indent) {
  2. for (int i = 0; i < indent; i++) {
  3. System.out.print(' ');
  4. }
  5. switch (n.getNodeType()) {
  6. case Node.DOCUMENT_NODE: // Document节点
  7. System.out.println("Document: " + n.getNodeName());
  8. break;
  9. case Node.ELEMENT_NODE: // 元素节点
  10. System.out.println("Element: " + n.getNodeName());
  11. break;
  12. case Node.TEXT_NODE: // 文本
  13. System.out.println("Text: " + n.getNodeName() + " = " + n.getNodeValue());
  14. break;
  15. case Node.ATTRIBUTE_NODE: // 属性
  16. System.out.println("Attr: " + n.getNodeName() + " = " + n.getNodeValue());
  17. break;
  18. default: // 其他
  19. System.out.println("NodeType: " + n.getNodeType() + ", NodeName: " + n.getNodeName());
  20. }
  21. for (Node child = n.getFirstChild(); child != null; child = child.getNextSibling()) {
  22. printNode(child, indent + 1);
  23. }
  24. }

解析结构如下:

  1. Document: #document
  2. Element: book
  3. Text: #text =
  4. Element: name
  5. Text: #text = Java核心技术
  6. Text: #text =
  7. Element: author
  8. Text: #text = Cay S. Horstmann
  9. Text: #text =
  10. ...

对于DOM API解析出来的结构,我们从根节点Document出发,可以遍历所有子节点,获取所有元素、属性、文本数据,还可以包括注释,这些节点被统称为Node,每个Node都有自己的Type,根据Type来区分一个Node到底是元素,还是属性,还是文本,等等。
使用DOM API时,如果要读取某个元素的文本,需要访问它的Text类型的子节点,所以使用起来还是比较繁琐的。
Java提供的DOM API可以将XML解析为DOM结构,以Document对象表示;
DOM可在内存中完整表示XML数据结构;
DOM解析速度慢,内存占用大。

3.SAX

另一种解析XML的方式是SAX。SAX是Simple API for XML的缩写,它是一种基于流的解析方式,边读取XML边解析,并以事件回调的方式让调用者获取数据。因为是一边读一边解析,所以无论XML有多大,占用的内存都很小。
SAX解析会触发一系列事件:

  • startDocument:开始读取XML文档;
  • startElement:读取到了一个元素,例如
  • characters:读取到了字符;
  • endElement:读取到了一个结束的元素,例如;
  • endDocument:读取XML文档结束。

如果我们用SAX API解析XML,Java代码如下:

  1. InputStream input = Main.class.getResourceAsStream("/book.xml");
  2. SAXParserFactory spf = SAXParserFactory.newInstance();
  3. SAXParser saxParser = spf.newSAXParser();
  4. saxParser.parse(input, new MyHandler());

关键代码SAXParser.parse()除了需要传入一个InputStream外,还需要传入一个回调对象,这个对象要继承自DefaultHandler:

  1. class MyHandler extends DefaultHandler {
  2. public void startDocument() throws SAXException {
  3. print("start document");
  4. }
  5. public void endDocument() throws SAXException {
  6. print("end document");
  7. }
  8. public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
  9. print("start element:", localName, qName);
  10. }
  11. public void endElement(String uri, String localName, String qName) throws SAXException {
  12. print("end element:", localName, qName);
  13. }
  14. public void characters(char[] ch, int start, int length) throws SAXException {
  15. print("characters:", new String(ch, start, length));
  16. }
  17. public void error(SAXParseException e) throws SAXException {
  18. print("error:", e);
  19. }
  20. void print(Object... objs) {
  21. for (Object obj : objs) {
  22. System.out.print(obj);
  23. System.out.print(" ");
  24. }
  25. System.out.println();
  26. }
  27. }

运行SAX解析代码,可以打印出下面的结果:

  1. start document
  2. start element: book
  3. characters:
  4. start element: name
  5. characters: Java核心技术
  6. end element: name
  7. characters:
  8. start element: author
  9. ...

如果要读取节点的文本,我们就必须在解析过程中根据startElement()和endElement()定位当前正在读取的节点,可以使用栈结构保存,每遇到一个startElement()入栈,每遇到一个endElement()出栈,这样,读到characters()时我们才知道当前读取的文本是哪个节点的。可见,使用SAX API仍然比较麻烦。
SAX是一种流式解析XML的API;
SAX通过事件触发,读取速度快,消耗内存少;
调用方必须通过回调方法获得解析过程中的数据。

4.Jackson

观察XML文档的结构:

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <book id="1">
  3. <name>Java核心技术</name>
  4. <author>Cay S. Horstmann</author>
  5. <isbn lang="CN">1234567</isbn>
  6. <tags>
  7. <tag>Java</tag>
  8. <tag>Network</tag>
  9. </tags>
  10. <pubDate/>
  11. </book>

它完全可以对应到一个定义好的JavaBean中:

  1. public class Book {
  2. public long id;
  3. public String name;
  4. public String author;
  5. public String isbn;
  6. public List<String> tags;
  7. public String pubDate;
  8. }

如果能直接从XML文档解析成一个JavaBean,那比DOM或者SAX不知道容易到哪里去了。
幸运的是,一个名叫Jackson的开源的第三方库可以轻松做到XML到JavaBean的转换。我们要使用Jackson,先添加两个Maven的依赖:

  • com.fasterxml.jackson.dataformat:jackson-dataformat-xml:2.10.1
  • org.codehaus.woodstox:woodstox-core-asl:4.4.1

然后,定义好JavaBean,就可以用下面几行代码解析:

  1. InputStream input = Main.class.getResourceAsStream("/book.xml");
  2. JacksonXmlModule module = new JacksonXmlModule();
  3. XmlMapper mapper = new XmlMapper(module);
  4. Book book = mapper.readValue(input, Book.class);
  5. System.out.println(book.id);
  6. System.out.println(book.name);
  7. System.out.println(book.author);
  8. System.out.println(book.isbn);
  9. System.out.println(book.tags);
  10. System.out.println(book.pubDate);

注意到XmlMapper就是我们需要创建的核心对象,可以用readValue(InputStream, Class)直接读取XML并返回一个JavaBean。运行上述代码,就可以直接从Book对象中拿到数据:

  1. 1
  2. Java核心技术
  3. Cay S. Horstmann
  4. 1234567
  5. [Java, Network]
  6. null

如果要解析的数据格式不是Jackson内置的标准格式,那么需要编写一点额外的扩展来告诉Jackson如何自定义解析。这里我们不做深入讨论,可以参考Jackson的官方文档
使用Jackson解析XML,可以直接把XML解析为JavaBean,十分方便。

5.JSON

JSON是JavaScript Object Notation的缩写,它去除了所有JavaScript执行代码,只保留JavaScript的对象格式。一个典型的JSON如下:

  1. {
  2. "id": 1,
  3. "name": "Java核心技术",
  4. "author": {
  5. "firstName": "Abc",
  6. "lastName": "Xyz"
  7. },
  8. "isbn": "1234567",
  9. "tags": ["Java", "Network"]
  10. }

JSON作为数据传输的格式,有几个显著的优点:

  • JSON只允许使用UTF-8编码,不存在编码问题;
  • JSON只允许使用双引号作为key,特殊字符用\转义,格式简单;
  • 浏览器内置JSON支持,如果把数据用JSON发送给浏览器,可以用JavaScript直接处理。

因此,JSON适合表示层次结构,因为它格式简单,仅支持以下几种数据类型:

  • 键值对:{“key”: value}
  • 数组:[1, 2, 3]
  • 字符串:”abc”
  • 数值(整数和浮点数):12.34
  • 布尔值:true或false
  • 空值:null

浏览器直接支持使用JavaScript对JSON进行读写:

  1. // JSON string to JavaScript object:
  2. jsObj = JSON.parse(jsonStr);
  3. // JavaScript object to JSON string:
  4. jsonStr = JSON.stringify(jsObj);

所以,开发Web应用的时候,使用JSON作为数据传输,在浏览器端非常方便。因为JSON天生适合JavaScript处理,所以,绝大多数REST API都选择JSON作为数据传输格式。
常用的用于解析JSON的第三方库有:

  • Jackson
  • Gson
  • Fastjson

使用下面的代码解析一个JSON文件:

  1. InputStream input = Main.class.getResourceAsStream("/book.json");
  2. ObjectMapper mapper = new ObjectMapper();
  3. // 反序列化时忽略不存在的JavaBean属性:
  4. mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
  5. Book book = mapper.readValue(input, Book.class);

核心代码是创建一个ObjectMapper对象。关闭DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES功能使得解析时如果JavaBean不存在该属性时解析不会报错。
把JSON解析为JavaBean的过程称为反序列化。如果把JavaBean变为JSON,那就是序列化。要实现JavaBean到JSON的序列化,只需要一行代码:

  1. String json = mapper.writeValueAsString(book);

1.反序列化

在反序列化时,Jackson要求Java类需要一个默认的无参数构造方法,否则,无法直接实例化此类。存在带参数构造方法的类,如果要反序列化,注意再提供一个无参数构造方法。
对于enum字段,Jackson按String类型处理,即:

  1. class Book {
  2. public DayOfWeek start = MONDAY;
  3. }

序列化为:

  1. {
  2. "start": "MONDAY"
  3. }

对于record类型,Jackson会自动找出它的带参数构造方法,并根据JSON的key进行匹配,可直接反序列化。对record类型的支持需要版本2.12.0以上。
JSON是轻量级的数据表示方式,常用于Web应用;
Jackson可以实现JavaBean和JSON之间的转换;
可以通过Module扩展Jackson能处理的数据类型;
可以自定义JsonSerializer和JsonDeserializer来定制序列化和反序列化。