Java 操作 Markdown(1)--commonmark-java 使用

commonmark-java 是一个用于解析和渲染 Markdown 文本的 Java 库；本文主要介绍其基本使用，文中所使用到的软件版本：Java 17.0.5、commonmark-java 0.25.1。
1、简介

commonmark-java 可以用来解析抽象语法树（AST），访问和操作其节点，以及生成 HTML 或 Markdown。它最初是 commonmark.js 的移植版，但后来发展成为一个可扩展的库，具备以下特点：

• 小巧（核心没有依赖，扩展以独立的组件形式提供）
  
• 快速（比曾经流行的 Markdown 库 pegdown 快 10 到 20 倍）
  
• 灵活（解析后可操作 AST，定制 HTML 渲染）
  
• 可扩展（支持表格、删除线、自动链接等）
  

commonmark-java 需要使用 Java 11 及以上版本。
2、commonmark-java 使用

2.1、样例文件

解析 Markdown 时使用该样例文件。

1. ## 1 Markdown语法教程
3. ### 1.1 标题
5. 不同数量的`#`可以完成不同的标题，如下：
7. # 一级标题
9. ## 二级标题
11. ### 三级标题
13. ### 1.2 字体
15. 粗体、斜体、粗体和斜体，删除线，需要在文字前后加不同的标记符号。如下：
17. **这个是粗体**
19. *这个是斜体*
21. ***这个是粗体加斜体***
23. ~~这里是删除线~~
25. 注：如果想给字体换颜色、字体或者居中显示，需要使用内嵌HTML来实现。
27. ### 1.3 无序列表
29. 无序列表的使用，在符号`-`后加空格使用。如下：
31. - 无序列表 1
32. - 无序列表 2
33. - 无序列表 3
35. 如果要控制列表的层级，则需要在符号`-`前使用空格。如下：
37. - 无序列表 1
38. - 无序列表 2
39.   - 无序列表 2.1
40.   - 无序列表 2.2
42. ### 1.4 有序列表
44. 有序列表的使用，在数字及符号`.`后加空格后输入内容，如下：
46. 1. 有序列表 1
47. 2. 有序列表 2
48. 3. 有序列表 3
50. ### 1.5 引用
52. 引用的格式是在符号`>`后面书写文字。如下：
54. > 读一本好书，就是在和高尚的人谈话。 ——歌德
56. > 雇用制度对工人不利，但工人根本无力摆脱这个制度。 ——阮一峰
58. ### 1.7 链接
60. 微信公众号仅支持公众号文章链接，即域名为`https://mp.weixin.qq.com/`的合法链接。使用方法如下所示：
62. 对于该论述，欢迎读者查阅之前发过的文章，[你是《未来世界的幸存者》么？](https://mp.weixin.qq.com/s/s5IhxV2ooX3JN_X416nidA)
64. ### 1.8 图片
66. 插入图片，格式如下：
68. 
70. 支持 jpg、png、gif、svg 等图片格式，**其中 svg 文件仅可在微信公众平台中使用**，svg 文件示例如下：
72. 
74. 支持图片**拖拽和截图粘贴**到编辑器中。
76. 注：支持图片 ***拖拽和截图粘贴*** 到编辑器中，仅支持 https 的图片，图片粘贴到微信时会自动上传微信服务器。
78. ### 1.9 分割线
80. 可以在一行中用三个以上的减号来建立一个分隔线，同时需要在分隔线的上面空一行。如下：
82. ---
84. ### 1.10 表格
86. 可以使用冒号来定义表格的对齐方式，如下：
88. | 姓名   | 年龄 |     工作 |
89. | :----- | :--: | -------: |
90. | 小可爱 |  18  | 吃可爱多 |
91. | 小小勇敢 |  20  | 爬棵勇敢树 |
92. | 小小小机智 |  22  | 看一本机智书 |

复制代码

test.md2.2、引入依赖

1. <dependency>
2.     <groupId>org.commonmark</groupId>
3.     commonmark</artifactId>
4.     <version>0.26.0</version>
5. </dependency>
7. <dependency>
8.     <groupId>org.commonmark</groupId>
9.     commonmark-ext-gfm-tables</artifactId>
10.     <version>0.26.0</version>
11. </dependency>

复制代码

2.3、API 方式生成 HTML 或 Markdown 文档

1. @Test
2. public void serialize() {
3.     Document document = new Document();
4.     Heading heading = new Heading();
5.     heading.setLevel(2);
6.     heading.appendChild(new Text("1 Markdown语法教程"));
7.     document.appendChild(heading);
9.     heading = new Heading();
10.     heading.setLevel(3);
11.     heading.appendChild(new Text("1.1 标题"));
12.     document.appendChild(heading);
14.     Paragraph paragraph = new Paragraph();
15.     paragraph.appendChild(new Text("不同数量的"));
16.     paragraph.appendChild(new Code("#"));
17.     paragraph.appendChild(new Text("可以完成不同的标题，如下："));
18.     document.appendChild(paragraph);
20.     heading = new Heading();
21.     heading.setLevel(1);
22.     heading.appendChild(new Text("一级标题"));
23.     document.appendChild(heading);
25.     heading = new Heading();
26.     heading.setLevel(2);
27.     heading.appendChild(new Text("二级标题"));
28.     document.appendChild(heading);
30.     heading = new Heading();
31.     heading.setLevel(3);
32.     heading.appendChild(new Text("三级标题"));
33.     document.appendChild(heading);
35.     heading = new Heading();
36.     heading.setLevel(3);
37.     heading.appendChild(new Text("1.2 字体"));
38.     document.appendChild(heading);
40.     paragraph = new Paragraph();
41.     paragraph.appendChild(new Text("粗体、斜体、粗体和斜体，删除线，需要在文字前后加不同的标记符号。如下："));
42.     document.appendChild(paragraph);
44.     paragraph = new Paragraph();
45.     StrongEmphasis strongEmphasis = new StrongEmphasis();
46.     strongEmphasis.appendChild(new Text("这个是粗体"));
47.     paragraph.appendChild(strongEmphasis);
48.     document.appendChild(paragraph);
50.     paragraph = new Paragraph();
51.     Emphasis emphasis = new Emphasis("*");
52.     emphasis.appendChild(new Text("这个是斜体"));
53.     paragraph.appendChild(emphasis);
54.     document.appendChild(paragraph);
56.     paragraph = new Paragraph();
57.     strongEmphasis = new StrongEmphasis();
58.     emphasis = new Emphasis("*");
59.     emphasis.appendChild(new Text("这个是粗体加斜体"));
60.     strongEmphasis.appendChild(emphasis);
61.     paragraph.appendChild(strongEmphasis);
62.     document.appendChild(paragraph);
64.     paragraph = new Paragraph();
65.     paragraph.appendChild(new Text("~~这里是删除线~~"));
66.     document.appendChild(paragraph);
68.     paragraph = new Paragraph();
69.     paragraph.appendChild(new Text("注：如果想给字体换颜色、字体或者居中显示，需要使用内嵌HTML来实现。"));
70.     document.appendChild(paragraph);
72.     heading = new Heading();
73.     heading.setLevel(3);
74.     heading.appendChild(new Text("1.3 无序列表"));
75.     document.appendChild(heading);
77.     paragraph = new Paragraph();
78.     paragraph.appendChild(new Text("无序列表的使用，在符号"));
79.     paragraph.appendChild(new Code("-"));
80.     paragraph.appendChild(new Text("后加空格使用。如下："));
81.     document.appendChild(paragraph);
83.     BulletList bulletList = new BulletList();
84.     ListItem listItem = new ListItem();
85.     listItem.appendChild(new Text("无序列表 1"));
86.     bulletList.appendChild(listItem);
87.     bulletList.appendChild(new SoftLineBreak());
88.     listItem = new ListItem();
89.     listItem.appendChild(new Text("无序列表 2"));
90.     bulletList.appendChild(listItem);
91.     bulletList.appendChild(new SoftLineBreak());
92.     listItem = new ListItem();
93.     listItem.appendChild(new Text("无序列表 3"));
94.     bulletList.appendChild(listItem);
95.     document.appendChild(bulletList);
97.     paragraph = new Paragraph();
98.     paragraph.appendChild(new Text("如果要控制列表的层级，则需要在符号"));
99.     paragraph.appendChild(new Code("-"));
100.     paragraph.appendChild(new Text("前使用空格。如下："));
101.     document.appendChild(paragraph);
103.     bulletList = new BulletList();
104.     listItem = new ListItem();
105.     listItem.appendChild(new Text("无序列表 1"));
106.     bulletList.appendChild(listItem);
107.     bulletList.appendChild(new SoftLineBreak());
108.     listItem = new ListItem();
109.     listItem.appendChild(new Text("无序列表 2"));
110.     bulletList.appendChild(listItem);
111.     bulletList.appendChild(new SoftLineBreak());
112.     BulletList bulletList2 = new BulletList();
113.     listItem = new ListItem();
114.     listItem.setMarkerIndent(2);
115.     listItem.appendChild(new Text("无序列表 2.1"));
116.     bulletList2.appendChild(listItem);
117.     bulletList2.appendChild(new SoftLineBreak());
118.     listItem = new ListItem();
119.     listItem.setMarkerIndent(2);
120.     listItem.appendChild(new Text("无序列表 2.2"));
121.     bulletList2.appendChild(listItem);
122.     bulletList.appendChild(bulletList2);
123.     document.appendChild(bulletList);
125.     heading = new Heading();
126.     heading.setLevel(3);
127.     heading.appendChild(new Text("1.4 有序列表"));
128.     document.appendChild(heading);
130.     paragraph = new Paragraph();
131.     paragraph.appendChild(new Text("有序列表的使用，在数字及符号"));
132.     paragraph.appendChild(new Code("."));
133.     paragraph.appendChild(new Text("后加空格后输入内容，如下："));
134.     document.appendChild(paragraph);
136.     OrderedList orderedList = new OrderedList();
137.     listItem = new ListItem();
138.     listItem.appendChild(new Text("有序列表 1"));
139.     orderedList.appendChild(listItem);
140.     orderedList.appendChild(new SoftLineBreak());
141.     listItem = new ListItem();
142.     listItem.appendChild(new Text("有序列表 2"));
143.     orderedList.appendChild(listItem);
144.     orderedList.appendChild(new SoftLineBreak());
145.     listItem = new ListItem();
146.     listItem.appendChild(new Text("有序列表 3"));
147.     orderedList.appendChild(listItem);
148.     document.appendChild(orderedList);
150.     heading = new Heading();
151.     heading.setLevel(3);
152.     heading.appendChild(new Text("1.5 引用"));
153.     document.appendChild(heading);
155.     paragraph = new Paragraph();
156.     paragraph.appendChild(new Text("引用的格式是在符号"));
157.     paragraph.appendChild(new Code(">"));
158.     paragraph.appendChild(new Text("后面书写文字。如下："));
159.     document.appendChild(paragraph);
161.     BlockQuote blockQuote = new BlockQuote();
162.     blockQuote.appendChild(new Text("读一本好书，就是在和高尚的人谈话。 ——歌德"));
163.     document.appendChild(blockQuote);
165.     blockQuote = new BlockQuote();
166.     blockQuote.appendChild(new Text("雇用制度对工人不利，但工人根本无力摆脱这个制度。 ——阮一峰"));
167.     document.appendChild(blockQuote);
169.     heading = new Heading();
170.     heading.setLevel(3);
171.     heading.appendChild(new Text("1.7 链接"));
172.     document.appendChild(heading);
174.     paragraph = new Paragraph();
175.     paragraph.appendChild(new Text("微信公众号仅支持公众号文章链接，即域名为"));
176.     paragraph.appendChild(new Code("https://mp.weixin.qq.com/"));
177.     paragraph.appendChild(new Text("的合法链接。使用方法如下所示："));
178.     document.appendChild(paragraph);
180.     paragraph = new Paragraph();
181.     Link link = new Link("https://mp.weixin.qq.com/s/s5IhxV2ooX3JN_X416nidA", null);
182.     link.appendChild(new Text("你是《未来世界的幸存者》么？"));
183.     paragraph.appendChild(new Text("对于该论述，欢迎读者查阅之前发过的文章，"));
184.     paragraph.appendChild(link);
185.     document.appendChild(paragraph);
187.     heading = new Heading();
188.     heading.setLevel(3);
189.     heading.appendChild(new Text("1.8 图片"));
190.     document.appendChild(heading);
192.     paragraph = new Paragraph();
193.     paragraph.appendChild(new Text("插入图片，格式如下："));
194.     document.appendChild(paragraph);
196.     paragraph = new Paragraph();
197.     Image image = new Image("https://markdown.com.cn/images/qrcode_for_gh_82cf87d482f0_258.jpg", null);
198.     image.appendChild(new Text("这里写图片描述"));
199.     paragraph.appendChild(image);
200.     document.appendChild(paragraph);
202.     paragraph = new Paragraph();
203.     paragraph.appendChild(new Text("支持 jpg、png、gif、svg 等图片格式，"));
204.     emphasis = new Emphasis("**");
205.     emphasis.appendChild(new Text("其中 svg 文件仅可在微信公众平台中使用"));
206.     paragraph.appendChild(emphasis);
207.     paragraph.appendChild(new Text("，svg 文件示例如下："));
208.     document.appendChild(paragraph);
210.     paragraph = new Paragraph();
211.     image = new Image("https://markdown.com.cn/images/i-am-svg.svg", null);
212.     paragraph.appendChild(image);
213.     document.appendChild(paragraph);
215.     paragraph = new Paragraph();
216.     paragraph.appendChild(new Text("支持图片"));
217.     strongEmphasis = new StrongEmphasis();
218.     strongEmphasis.appendChild(new Text("拖拽和截图粘贴"));
219.     paragraph.appendChild(strongEmphasis);
220.     paragraph.appendChild(new Text("到编辑器中。"));
221.     document.appendChild(paragraph);
223.     paragraph = new Paragraph();
224.     paragraph.appendChild(new Text("注：支持图片 "));
225.     strongEmphasis = new StrongEmphasis();
226.     emphasis = new Emphasis("*");
227.     emphasis.appendChild(new Text("拖拽和截图粘贴"));
228.     strongEmphasis.appendChild(emphasis);
229.     paragraph.appendChild(strongEmphasis);
230.     paragraph.appendChild(new Text(" 到编辑器中，仅支持 https 的图片，图片粘贴到微信时会自动上传微信服务器。"));
231.     document.appendChild(paragraph);
233.     heading = new Heading();
234.     heading.setLevel(3);
235.     heading.appendChild(new Text("1.9 分割线"));
236.     document.appendChild(heading);
238.     paragraph = new Paragraph();
239.     paragraph.appendChild(new Text("可以在一行中用三个以上的减号来建立一个分隔线，同时需要在分隔线的上面空一行。如下："));
240.     document.appendChild(paragraph);
242.     ThematicBreak thematicBreak = new ThematicBreak();
243.     thematicBreak.setLiteral("---");
244.     document.appendChild(thematicBreak);
246.     heading = new Heading();
247.     heading.setLevel(3);
248.     heading.appendChild(new Text("1.10 表格"));
249.     document.appendChild(heading);
251.     paragraph = new Paragraph();
252.     paragraph.appendChild(new Text("可以使用冒号来定义表格的对齐方式，如下："));
253.     document.appendChild(paragraph);
255.     TableBlock tableBlock = new TableBlock();
256.     TableHead tableHead = new TableHead();
257.     TableRow tableRow = new TableRow();
258.     TableCell tableCell = new TableCell();
259.     tableCell.appendChild(new Text("姓名"));
260.     tableCell.setAlignment(TableCell.Alignment.LEFT);
261.     tableRow.appendChild(tableCell);
262.     tableCell = new TableCell();
263.     tableCell.appendChild(new Text("年龄"));
264.     tableCell.setAlignment(TableCell.Alignment.CENTER);
265.     tableRow.appendChild(tableCell);
266.     tableCell = new TableCell();
267.     tableCell.appendChild(new Text("工作"));
268.     tableCell.setAlignment(TableCell.Alignment.RIGHT);
269.     tableRow.appendChild(tableCell);
270.     tableHead.appendChild(tableRow);
272.     TableBody tableBody = new TableBody();
273.     tableRow = new TableRow();
274.     tableCell = new TableCell();
275.     tableCell.appendChild(new Text("小可爱"));
276.     tableRow.appendChild(tableCell);
277.     tableCell = new TableCell();
278.     tableCell.appendChild(new Text("18"));
279.     tableRow.appendChild(tableCell);
280.     tableCell = new TableCell();
281.     tableCell.appendChild(new Text("吃可爱多"));
282.     tableRow.appendChild(tableCell);
283.     tableBody.appendChild(tableRow);
285.     tableRow = new TableRow();
286.     tableCell = new TableCell();
287.     tableCell.appendChild(new Text("小小勇敢"));
288.     tableRow.appendChild(tableCell);
289.     tableCell = new TableCell();
290.     tableCell.appendChild(new Text("20"));
291.     tableRow.appendChild(tableCell);
292.     tableCell = new TableCell();
293.     tableCell.appendChild(new Text("爬棵勇敢树"));
294.     tableRow.appendChild(tableCell);
295.     tableBody.appendChild(tableRow);
297.     tableRow = new TableRow();
298.     tableCell = new TableCell();
299.     tableCell.appendChild(new Text("小小小机智"));
300.     tableRow.appendChild(tableCell);
301.     tableCell = new TableCell();
302.     tableCell.appendChild(new Text("22"));
303.     tableRow.appendChild(tableCell);
304.     tableCell = new TableCell();
305.     tableCell.appendChild(new Text("看一本机智书"));
306.     tableRow.appendChild(tableCell);
307.     tableBody.appendChild(tableRow);
309.     tableBlock.appendChild(tableHead);
310.     tableBlock.appendChild(tableBody);
311.     document.appendChild(tableBlock);
313.     List<Extension> extensions = List.of(TablesExtension.create());
314.     MarkdownRenderer markdownRenderer = MarkdownRenderer.builder().extensions(extensions).build();
315.     //转成markdown格式
316.     String md = markdownRenderer.render(document);
317.     System.out.println(md);
319.     HtmlRenderer htmlRenderer = HtmlRenderer.builder().extensions(extensions).build();
320.     //转成html
321.     String html = htmlRenderer.render(document);
322.     System.out.println(html);
323. }

复制代码

2.4、解析 Markdown 文档

1. @Test
2. public void deserialize() throws IOException {
3.     List<Extension> extensions = List.of(TablesExtension.create());
4.     Parser parser = Parser.builder().extensions(extensions).build();
5.     InputStreamReader reader = new InputStreamReader(CommonmarkCase.class.getClassLoader().getResourceAsStream("test.md"));
6.     Node document = parser.parseReader(reader);
8.     Node node = document.getFirstChild();
9.     while (node != null) {
10.         System.out.println(node.getClass());
11.         if (node.getClass().equals(Heading.class)) {//处理标题
12.             Heading heading = (Heading) node;
13.             Text text = (Text)heading.getFirstChild();
14.             System.out.println(text.getLiteral());
15.         } else if (node.getClass().equals(BulletList.class)) {//处理无序列表
16.             BulletList bulletList = (BulletList) node;
17.             Node node2 = bulletList.getFirstChild();
18.             while (node2 != null) {
19.                 if (node2.getClass().equals(ListItem.class)) {
20.                     Node node3 = node2.getFirstChild();
21.                     if (node3.getClass().equals(Paragraph.class)) {
22.                         Text text = (Text)node3.getFirstChild();
23.                         System.out.println(text.getLiteral());
24.                     }
26.                     if (node3.getNext() != null && node3.getNext().getClass().equals(BulletList.class)) {
27.                         System.out.println("二级无序列表");
28.                         //TODO: 继续解析
29.                     }
30.                 }
31.                 node2 = node2.getNext();
32.             }
33.         }
34.         //else if  ...
35.         node = node.getNext();
36.     }
37. }

复制代码

2.5、完整代码

1. package com.abc.md;
3. import lombok.extern.slf4j.Slf4j;
4. import org.commonmark.Extension;
5. import org.commonmark.ext.gfm.tables.*;
6. import org.commonmark.node.*;
7. import org.commonmark.parser.Parser;
8. import org.commonmark.renderer.html.HtmlRenderer;
9. import org.commonmark.renderer.markdown.MarkdownRenderer;
10. import org.junit.Test;
12. import java.io.IOException;
13. import java.io.InputStreamReader;
14. import java.util.List;
17. @Slf4j
18. public class CommonmarkCase {
19.     @Test
20.     public void serialize() {
21.         Document document = new Document();
22.         Heading heading = new Heading();
23.         heading.setLevel(2);
24.         heading.appendChild(new Text("1 Markdown语法教程"));
25.         document.appendChild(heading);
27.         heading = new Heading();
28.         heading.setLevel(3);
29.         heading.appendChild(new Text("1.1 标题"));
30.         document.appendChild(heading);
32.         Paragraph paragraph = new Paragraph();
33.         paragraph.appendChild(new Text("不同数量的"));
34.         paragraph.appendChild(new Code("#"));
35.         paragraph.appendChild(new Text("可以完成不同的标题，如下："));
36.         document.appendChild(paragraph);
38.         heading = new Heading();
39.         heading.setLevel(1);
40.         heading.appendChild(new Text("一级标题"));
41.         document.appendChild(heading);
43.         heading = new Heading();
44.         heading.setLevel(2);
45.         heading.appendChild(new Text("二级标题"));
46.         document.appendChild(heading);
48.         heading = new Heading();
49.         heading.setLevel(3);
50.         heading.appendChild(new Text("三级标题"));
51.         document.appendChild(heading);
53.         heading = new Heading();
54.         heading.setLevel(3);
55.         heading.appendChild(new Text("1.2 字体"));
56.         document.appendChild(heading);
58.         paragraph = new Paragraph();
59.         paragraph.appendChild(new Text("粗体、斜体、粗体和斜体，删除线，需要在文字前后加不同的标记符号。如下："));
60.         document.appendChild(paragraph);
62.         paragraph = new Paragraph();
63.         StrongEmphasis strongEmphasis = new StrongEmphasis();
64.         strongEmphasis.appendChild(new Text("这个是粗体"));
65.         paragraph.appendChild(strongEmphasis);
66.         document.appendChild(paragraph);
68.         paragraph = new Paragraph();
69.         Emphasis emphasis = new Emphasis("*");
70.         emphasis.appendChild(new Text("这个是斜体"));
71.         paragraph.appendChild(emphasis);
72.         document.appendChild(paragraph);
74.         paragraph = new Paragraph();
75.         strongEmphasis = new StrongEmphasis();
76.         emphasis = new Emphasis("*");
77.         emphasis.appendChild(new Text("这个是粗体加斜体"));
78.         strongEmphasis.appendChild(emphasis);
79.         paragraph.appendChild(strongEmphasis);
80.         document.appendChild(paragraph);
82.         paragraph = new Paragraph();
83.         paragraph.appendChild(new Text("~~这里是删除线~~"));
84.         document.appendChild(paragraph);
86.         paragraph = new Paragraph();
87.         paragraph.appendChild(new Text("注：如果想给字体换颜色、字体或者居中显示，需要使用内嵌HTML来实现。"));
88.         document.appendChild(paragraph);
90.         heading = new Heading();
91.         heading.setLevel(3);
92.         heading.appendChild(new Text("1.3 无序列表"));
93.         document.appendChild(heading);
95.         paragraph = new Paragraph();
96.         paragraph.appendChild(new Text("无序列表的使用，在符号"));
97.         paragraph.appendChild(new Code("-"));
98.         paragraph.appendChild(new Text("后加空格使用。如下："));
99.         document.appendChild(paragraph);
101.         BulletList bulletList = new BulletList();
102.         ListItem listItem = new ListItem();
103.         listItem.appendChild(new Text("无序列表 1"));
104.         bulletList.appendChild(listItem);
105.         bulletList.appendChild(new SoftLineBreak());
106.         listItem = new ListItem();
107.         listItem.appendChild(new Text("无序列表 2"));
108.         bulletList.appendChild(listItem);
109.         bulletList.appendChild(new SoftLineBreak());
110.         listItem = new ListItem();
111.         listItem.appendChild(new Text("无序列表 3"));
112.         bulletList.appendChild(listItem);
113.         document.appendChild(bulletList);
115.         paragraph = new Paragraph();
116.         paragraph.appendChild(new Text("如果要控制列表的层级，则需要在符号"));
117.         paragraph.appendChild(new Code("-"));
118.         paragraph.appendChild(new Text("前使用空格。如下："));
119.         document.appendChild(paragraph);
121.         bulletList = new BulletList();
122.         listItem = new ListItem();
123.         listItem.appendChild(new Text("无序列表 1"));
124.         bulletList.appendChild(listItem);
125.         bulletList.appendChild(new SoftLineBreak());
126.         listItem = new ListItem();
127.         listItem.appendChild(new Text("无序列表 2"));
128.         bulletList.appendChild(listItem);
129.         bulletList.appendChild(new SoftLineBreak());
130.         BulletList bulletList2 = new BulletList();
131.         listItem = new ListItem();
132.         listItem.setMarkerIndent(2);
133.         listItem.appendChild(new Text("无序列表 2.1"));
134.         bulletList2.appendChild(listItem);
135.         bulletList2.appendChild(new SoftLineBreak());
136.         listItem = new ListItem();
137.         listItem.setMarkerIndent(2);
138.         listItem.appendChild(new Text("无序列表 2.2"));
139.         bulletList2.appendChild(listItem);
140.         bulletList.appendChild(bulletList2);
141.         document.appendChild(bulletList);
143.         heading = new Heading();
144.         heading.setLevel(3);
145.         heading.appendChild(new Text("1.4 有序列表"));
146.         document.appendChild(heading);
148.         paragraph = new Paragraph();
149.         paragraph.appendChild(new Text("有序列表的使用，在数字及符号"));
150.         paragraph.appendChild(new Code("."));
151.         paragraph.appendChild(new Text("后加空格后输入内容，如下："));
152.         document.appendChild(paragraph);
154.         OrderedList orderedList = new OrderedList();
155.         listItem = new ListItem();
156.         listItem.appendChild(new Text("有序列表 1"));
157.         orderedList.appendChild(listItem);
158.         orderedList.appendChild(new SoftLineBreak());
159.         listItem = new ListItem();
160.         listItem.appendChild(new Text("有序列表 2"));
161.         orderedList.appendChild(listItem);
162.         orderedList.appendChild(new SoftLineBreak());
163.         listItem = new ListItem();
164.         listItem.appendChild(new Text("有序列表 3"));
165.         orderedList.appendChild(listItem);
166.         document.appendChild(orderedList);
168.         heading = new Heading();
169.         heading.setLevel(3);
170.         heading.appendChild(new Text("1.5 引用"));
171.         document.appendChild(heading);
173.         paragraph = new Paragraph();
174.         paragraph.appendChild(new Text("引用的格式是在符号"));
175.         paragraph.appendChild(new Code(">"));
176.         paragraph.appendChild(new Text("后面书写文字。如下："));
177.         document.appendChild(paragraph);
179.         BlockQuote blockQuote = new BlockQuote();
180.         blockQuote.appendChild(new Text("读一本好书，就是在和高尚的人谈话。 ——歌德"));
181.         document.appendChild(blockQuote);
183.         blockQuote = new BlockQuote();
184.         blockQuote.appendChild(new Text("雇用制度对工人不利，但工人根本无力摆脱这个制度。 ——阮一峰"));
185.         document.appendChild(blockQuote);
187.         heading = new Heading();
188.         heading.setLevel(3);
189.         heading.appendChild(new Text("1.7 链接"));
190.         document.appendChild(heading);
192.         paragraph = new Paragraph();
193.         paragraph.appendChild(new Text("微信公众号仅支持公众号文章链接，即域名为"));
194.         paragraph.appendChild(new Code("https://mp.weixin.qq.com/"));
195.         paragraph.appendChild(new Text("的合法链接。使用方法如下所示："));
196.         document.appendChild(paragraph);
198.         paragraph = new Paragraph();
199.         Link link = new Link("https://mp.weixin.qq.com/s/s5IhxV2ooX3JN_X416nidA", null);
200.         link.appendChild(new Text("你是《未来世界的幸存者》么？"));
201.         paragraph.appendChild(new Text("对于该论述，欢迎读者查阅之前发过的文章，"));
202.         paragraph.appendChild(link);
203.         document.appendChild(paragraph);
205.         heading = new Heading();
206.         heading.setLevel(3);
207.         heading.appendChild(new Text("1.8 图片"));
208.         document.appendChild(heading);
210.         paragraph = new Paragraph();
211.         paragraph.appendChild(new Text("插入图片，格式如下："));
212.         document.appendChild(paragraph);
214.         paragraph = new Paragraph();
215.         Image image = new Image("https://markdown.com.cn/images/qrcode_for_gh_82cf87d482f0_258.jpg", null);
216.         image.appendChild(new Text("这里写图片描述"));
217.         paragraph.appendChild(image);
218.         document.appendChild(paragraph);
220.         paragraph = new Paragraph();
221.         paragraph.appendChild(new Text("支持 jpg、png、gif、svg 等图片格式，"));
222.         emphasis = new Emphasis("**");
223.         emphasis.appendChild(new Text("其中 svg 文件仅可在微信公众平台中使用"));
224.         paragraph.appendChild(emphasis);
225.         paragraph.appendChild(new Text("，svg 文件示例如下："));
226.         document.appendChild(paragraph);
228.         paragraph = new Paragraph();
229.         image = new Image("https://markdown.com.cn/images/i-am-svg.svg", null);
230.         paragraph.appendChild(image);
231.         document.appendChild(paragraph);
233.         paragraph = new Paragraph();
234.         paragraph.appendChild(new Text("支持图片"));
235.         strongEmphasis = new StrongEmphasis();
236.         strongEmphasis.appendChild(new Text("拖拽和截图粘贴"));
237.         paragraph.appendChild(strongEmphasis);
238.         paragraph.appendChild(new Text("到编辑器中。"));
239.         document.appendChild(paragraph);
241.         paragraph = new Paragraph();
242.         paragraph.appendChild(new Text("注：支持图片 "));
243.         strongEmphasis = new StrongEmphasis();
244.         emphasis = new Emphasis("*");
245.         emphasis.appendChild(new Text("拖拽和截图粘贴"));
246.         strongEmphasis.appendChild(emphasis);
247.         paragraph.appendChild(strongEmphasis);
248.         paragraph.appendChild(new Text(" 到编辑器中，仅支持 https 的图片，图片粘贴到微信时会自动上传微信服务器。"));
249.         document.appendChild(paragraph);
251.         heading = new Heading();
252.         heading.setLevel(3);
253.         heading.appendChild(new Text("1.9 分割线"));
254.         document.appendChild(heading);
256.         paragraph = new Paragraph();
257.         paragraph.appendChild(new Text("可以在一行中用三个以上的减号来建立一个分隔线，同时需要在分隔线的上面空一行。如下："));
258.         document.appendChild(paragraph);
260.         ThematicBreak thematicBreak = new ThematicBreak();
261.         thematicBreak.setLiteral("---");
262.         document.appendChild(thematicBreak);
264.         heading = new Heading();
265.         heading.setLevel(3);
266.         heading.appendChild(new Text("1.10 表格"));
267.         document.appendChild(heading);
269.         paragraph = new Paragraph();
270.         paragraph.appendChild(new Text("可以使用冒号来定义表格的对齐方式，如下："));
271.         document.appendChild(paragraph);
273.         TableBlock tableBlock = new TableBlock();
274.         TableHead tableHead = new TableHead();
275.         TableRow tableRow = new TableRow();
276.         TableCell tableCell = new TableCell();
277.         tableCell.appendChild(new Text("姓名"));
278.         tableCell.setAlignment(TableCell.Alignment.LEFT);
279.         tableRow.appendChild(tableCell);
280.         tableCell = new TableCell();
281.         tableCell.appendChild(new Text("年龄"));
282.         tableCell.setAlignment(TableCell.Alignment.CENTER);
283.         tableRow.appendChild(tableCell);
284.         tableCell = new TableCell();
285.         tableCell.appendChild(new Text("工作"));
286.         tableCell.setAlignment(TableCell.Alignment.RIGHT);
287.         tableRow.appendChild(tableCell);
288.         tableHead.appendChild(tableRow);
290.         TableBody tableBody = new TableBody();
291.         tableRow = new TableRow();
292.         tableCell = new TableCell();
293.         tableCell.appendChild(new Text("小可爱"));
294.         tableRow.appendChild(tableCell);
295.         tableCell = new TableCell();
296.         tableCell.appendChild(new Text("18"));
297.         tableRow.appendChild(tableCell);
298.         tableCell = new TableCell();
299.         tableCell.appendChild(new Text("吃可爱多"));
300.         tableRow.appendChild(tableCell);
301.         tableBody.appendChild(tableRow);
303.         tableRow = new TableRow();
304.         tableCell = new TableCell();
305.         tableCell.appendChild(new Text("小小勇敢"));
306.         tableRow.appendChild(tableCell);
307.         tableCell = new TableCell();
308.         tableCell.appendChild(new Text("20"));
309.         tableRow.appendChild(tableCell);
310.         tableCell = new TableCell();
311.         tableCell.appendChild(new Text("爬棵勇敢树"));
312.         tableRow.appendChild(tableCell);
313.         tableBody.appendChild(tableRow);
315.         tableRow = new TableRow();
316.         tableCell = new TableCell();
317.         tableCell.appendChild(new Text("小小小机智"));
318.         tableRow.appendChild(tableCell);
319.         tableCell = new TableCell();
320.         tableCell.appendChild(new Text("22"));
321.         tableRow.appendChild(tableCell);
322.         tableCell = new TableCell();
323.         tableCell.appendChild(new Text("看一本机智书"));
324.         tableRow.appendChild(tableCell);
325.         tableBody.appendChild(tableRow);
327.         tableBlock.appendChild(tableHead);
328.         tableBlock.appendChild(tableBody);
329.         document.appendChild(tableBlock);
331.         List<Extension> extensions = List.of(TablesExtension.create());
332.         MarkdownRenderer markdownRenderer = MarkdownRenderer.builder().extensions(extensions).build();
333.         //转成markdown格式
334.         String md = markdownRenderer.render(document);
335.         System.out.println(md);
337.         HtmlRenderer htmlRenderer = HtmlRenderer.builder().extensions(extensions).build();
338.         //转成html
339.         String html = htmlRenderer.render(document);
340.         System.out.println(html);
341.     }
343.     @Test
344.     public void deserialize() throws IOException {
345.         List<Extension> extensions = List.of(TablesExtension.create());
346.         Parser parser = Parser.builder().extensions(extensions).build();
347.         InputStreamReader reader = new InputStreamReader(CommonmarkCase.class.getClassLoader().getResourceAsStream("test.md"));
348.         Node document = parser.parseReader(reader);
350.         Node node = document.getFirstChild();
351.         while (node != null) {
352.             System.out.println(node.getClass());
353.             if (node.getClass().equals(Heading.class)) {//处理标题
354.                 Heading heading = (Heading) node;
355.                 Text text = (Text)heading.getFirstChild();
356.                 System.out.println(text.getLiteral());
357.             } else if (node.getClass().equals(BulletList.class)) {//处理无序列表
358.                 BulletList bulletList = (BulletList) node;
359.                 Node node2 = bulletList.getFirstChild();
360.                 while (node2 != null) {
361.                     if (node2.getClass().equals(ListItem.class)) {
362.                         Node node3 = node2.getFirstChild();
363.                         if (node3.getClass().equals(Paragraph.class)) {
364.                             Text text = (Text)node3.getFirstChild();
365.                             System.out.println(text.getLiteral());
366.                         }
368.                         if (node3.getNext() != null && node3.getNext().getClass().equals(BulletList.class)) {
369.                             System.out.println("二级无序列表");
370.                             //TODO: 继续解析
371.                         }
372.                     }
373.                     node2 = node2.getNext();
374.                 }
375.             }
376.             //else if  ...
377.             node = node.getNext();
378.         }
379.     }
380. }

复制代码

CommonmarkCase.java 
 
 
参考：https://github.com/commonmark/commonmark-java。
 

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！