用 Java 实现生成 Markdown 文本的工具
#Markdown [字体 小·中·大]公司的 IM 每天有许多机器人推送的消息，我也在使用，这个功能是好的，但是当我们想去发送一些格式优美的消息时，却要费许多功夫，主要来源于字符串拼接，如果要拼接出 Markdown 格式的那就更费力了，另外由拼接带来的是混乱的代码，为了解决这个痛点，我写了一个 Java 代码生成 Markdown 文本的工具，还给它起了一个酷酷的名字 MdKiller。
MdKiller —— Markdown 杀手。
MdKiller 可以格式化生成 Markdown 文本的工具，支持常用 Markdown 格式生成，例如引用块、代码块、有无序列表、表格等，内容上支持字体样式（style）和内容的嵌套，适用于 IM 消息 Markdown 排版。
以下为 Github 仓库 介绍页内容。
一、使用
1、引入依赖，由于是单文件，直接把文件拷贝到项目即可使用。
2、使用，示例如下：
1@Test
2public void test(){
3 String md=MdKiller.of()
4 .title("一个标题")
5 .text("文本")
6 .ref()
7 .text("文本1")
8 .text("文本2")
9 .ul()
10 .text("文本3")
11 .text("文本4")
12 .endUl()
13 .endRef()
14 .link("链接","https://elltor.com")
15 .build();
16 System.out.println(md);
17}
输出 Markdown 文本：
1### 一个标题
2文本
3> 文本1
4> 文本2
5> - 文本3
6> - 文本4
7
8[链接▸](https://elltor.com)
P.S. 更多演示可以参考单元测试。
二、特性介绍
- 易用性：易于排版文案、支持主流 Markdown 语法内容，就像用代码写 Markdown。
- 通用性：生成内容通用，工具生成标准 Markdown 格式并保障最大兼容性。
- 扩展性：具备一定扩展性，扩展 API 简单；内容多样，理论上所有输入的文本均支持样式。
- 集成：除 JDK 外无依赖；小巧，单文件约 700+ 行代码；
- 鲁棒性：具备一定容错性，所有接口均经过单元测试，见目录
test/java/com/elltor/md。
三、最佳实践
在 IM 中排版消息是痛苦的，这个工具就是要解决这个问题，通常在 IM 排版消息会遇到下列问题：
- 在程序中直接拼接很难对 Markdown 进行排版，拼接使人头大，维护更加麻烦。（P.S. 不反对使用模版，但当增加/删除模版中的参数时也是麻烦的）
- 差的 Markdown 消息特点：文案没有结构、重点不突出、交互差，不能突出主题。
因此，我们改善 IM 消息实际上就是解决上面两个问题。
3.1 链式调用 vs 普通调用
用不同的风格生成 Markdown 文本。
1/**
2 * 链式调用 vs 普通调用
3 */
4@Test
5public void callByChainShow() {
6 String md = MdKiller.of()
7 .title("标题")
8 .text("文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落")
9 .ref()
10 .text("引用中的普通文本")
11 .text("引用中的普通文本-设置颜色", MdKiller.Style.RED)
12 .text("引用中的普通文本-加粗", MdKiller.Style.BOLD)
13 .text("名字", Arrays.asList("值1", "值2", "值3","值4", "值5"))
14 .endRef()
15 .link("有问题点链接", "https://elltor.com")
16 .build();
17 System.out.println(md);
18}
19
20@Test
21public void callByNormalShow() {
22 MdKiller.SectionBuilder bd = MdKiller.of();
23 bd.title("标题");
24 bd.text("文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落");
25 // 进入块级元素返回新 builder 对象，需要对象接收
26 bd = bd.ref();
27 bd.text("引用中的普通文本");
28 bd.text("引用中的普通文本-设置颜色", MdKiller.Style.RED);
29 bd.text("引用中的普通文本-加粗", MdKiller.Style.BOLD);
30 bd.text("名字", Arrays.asList("值1", "值2", "值3","值4", "值5"));
31 // 出块级元素返回父 builder 对象，需要对象接收
32 bd = bd.endRef();
33 bd.link("有问题点链接", "https://elltor.com");
34 String md = bd.build();
35 System.out.println(md);
36}
输出：
1### 标题
2文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落
3> 引用中的普通文本
4> <font color='red'>引用中的普通文本-设置颜色</font>
5> **引用中的普通文本-加粗**
6> 名字：值1 | 值2 | 值3 | 值4 | 值5
7
8[有问题点链接▸](https://elltor.com)
3.2 一个简洁消息模版
1/**
2 * 通过标题、引用中的文本和超链接形成了一个较为有格式的排版
3 */
4@Test
5public void aBeautifulMsgTemplate() {
6 String md = MdKiller.of()
7 .title("标题")
8 .text("文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落")
9 .ref()
10 .text("引用中的普通文本")
11 .text("引用中的普通文本-设置颜色", MdKiller.Style.RED)
12 .text("引用中的普通文本-加粗", MdKiller.Style.BOLD)
13 .text("") // 一个空行
14 .text("名字", Arrays.asList("值1", "值2", "值3","值4", "值5"))
15 .endRef()
16 .link("有问题点链接", "https://elltor.com")
17 .build();
18 System.out.println(md);
19}
输出：
1### 标题
2文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落
3> 引用中的普通文本
4> <font color='red'>引用中的普通文本-设置颜色</font>
5> **引用中的普通文本-加粗**
6>
7> 名字：值1 | 值2 | 值3 | 值4 | 值5
8
9[有问题点链接▸](https://elltor.com)
3.3 用列表使内容更清晰
1/**
2 * 通过标题、列表、超链接形成排版
3 */
4@Test
5public void aBeautifulMsgTemplate2() {
6 String md = MdKiller.of()
7 .title("标题")
8 .text("文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落")
9 .ul()
10 .text("引用中的普通文本")
11 .text("引用中的普通文本-设置颜色", MdKiller.Style.RED)
12 .text("引用中的普通文本-加粗", MdKiller.Style.BOLD)
13 .text("名字", Arrays.asList("值1", "值2", "值3","值4", "值5"))
14 .endUl()
15 .link("有问题点链接", "https://elltor.com")
16 .build();
17 System.out.println(md);
18}
输出：
1### 标题
2文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落 文本段落
3- 引用中的普通文本
4- <font color='red'>引用中的普通文本-设置颜色</font>
5- **引用中的普通文本-加粗**
6- 名字：值1 | 值2 | 值3 | 值4 | 值5
7
8[有问题点链接▸](https://elltor.com)
3.4 使用表格
1/**
2 * 可以直接放置表格，或者在引用块中嵌套表格
3 */
4@Test
5public void tableShow() {
6 String[][] data = {
7 {"姓名", "姓别", "芳龄", "身高"},
8 {"不知火舞",null, "18", "173"},
9 {"孙策", "男", "23", "181"},
10 {"李白", "男", null, "179"},
11 };
12
13 String md = MdKiller.of()
14 .title("使用表格")
15 .text("月老的记事本：", MdKiller.Style.RED)
16 .table()
17 .data(data)
18 .endTable()
19 .subTitle("嵌套表格")
20 .ref()
21 .text("月老的记事本：", MdKiller.Style.YELLOW)
22 .table()
23 .data(data)
24 .endTable()
25 .endRef()
26 .build();
27 System.out.println(md);
28}
输出：
1### 使用表格
2<font color='red'>月老的记事本：</font>
3
4姓名 | 姓别 | 芳龄 | 身高
5- | - | - | -
6不知火舞 | | 18 | 173
7孙策 | 男 | 23 | 181
8李白 | 男 | | 179
9
10#### 嵌套表格
11> <font color='gold'>月老的记事本：</font>
12>
13> 姓名 | 姓别 | 芳龄 | 身高
14> - | - | - | -
15> 不知火舞 | | 18 | 173
16> 孙策 | 男 | 23 | 181
17> 李白 | 男 | | 179
3.5 生成模版以提高性能
1/**
2 * 通过工具生成一个消息模版，你可以通过缓存消息模版进一步提高性能
3 */
4@Test
5public void genTemplateAndCacheShow() {
6 String mdTemplate = MdKiller.of()
7 .title("%s")
8 .text("%s")
9 .ref()
10 .text("%s")
11 .endRef()
12 .link("%s", "%s")
13 .build();
14 String realMd = String.format(mdTemplate,
15 "消息模版标题",
16 "这是一个消息模版，你可以通过缓存消息模版以提高性能。",
17 "在引用中的消息 —— 这是一个消息模版，你可以通过缓存消息模版以提高性能。",
18 "详情链接🔗", "https://elltor.com");
19 System.out.println(realMd);
20}
输出：
1### 消息模版标题
2这是一个消息模版，你可以通过缓存消息模版以提高性能。
3> 在引用中的消息 —— 这是一个消息模版，你可以通过缓存消息模版以提高性能。
4
5[详情链接🔗▸](https://elltor.com)
3.6 灵活在文本中拼接 Markdown 样式
1@Test
2public void joinMarkdownShow() {
3 String md = MdKiller.of()
4 .text("### 标题")
5 .ref()
6 .text("**文本**")
7 .text("名字", "*值(斜体)*")
8 .text("加粗文本", MdKiller.Style.BOLD)
9 .link("链接", "https://elltor.com")
10 .endRef()
11 .text("[详情链接🔗](https://elltor.com)")
12 .build();
13 System.out.println(md);
14}
输出：
1### 标题
2> **文本**
3> 名字：*值(斜体)*
4> **加粗文本**
5> [链接▸](https://elltor.com)
6
7[详情链接🔗](https://elltor.com)
四、最后
欢迎体验，如果有 Bug 可以直接在 GitHub 提 Issue，使用建议、交流 elltor(at)163.com，如果对你有帮助，可以点个 Star。