引入MarkDown文档的好处

相信很多朋友在开发和工作过程中都会使用MarkDown格式来编写文档,Markdown文档的好处多多:

而在众多的MarkDown文档的编辑器中,我们比较常用的一款工具是Typora,前几年是免费的,最近1.0正式版以后开始要收费了。

markdown 编辑痕迹(自己动手编写清理工具)(1)

Typora的优势

Typora容许随时随地开展无缝拼接浏览,从而可以在编辑的同时及时的看到效果。笔者现在写这个文档就是使用的这个工具。它有以下好处:

  1. 在Win,Mac和Linux上能用
  2. 它具备审校作用,能够检查拼读和英语的语法
  3. 全自动匹配Markdown标记,比如括弧
  4. 支持大概100种語言并支持英语的语法突显
  5. 丰富多彩的作用和键盘快捷键
  6. 与内联公式和显示信息公式适配
Typora的不足

工具可以做到图文并茂的编写文档,所有插入的图片默认放在当前文档的assets目录下,也可以通过设置指定图片保存的位置,使用起来很方便。

markdown 编辑痕迹(自己动手编写清理工具)(2)

但不足的是,如果文档进行了修改,图片从文档中删除了,残留在当前目录下的assets目录下的图片并不会一同删除。随着文档不断的更新和修改,这个目录下的图片文件会越留越多,有时多达几十M。不但占用空间,而且毫无用处。

markdown 编辑痕迹(自己动手编写清理工具)(3)

虽然我们可以手动点击每张图片查看具体是哪张图片,再一张张手工去删除,但图片如果多的话,也是很繁琐的事情,而且考验人的耐心。

markdown 编辑痕迹(自己动手编写清理工具)(4)

我们能不能自己写个程序,分析整个Markdown文档中的图片地址,然后批量删除呢?有了这个想法以后,我就自己花了一些时间做了一个,目前已经使用了一年多了,没有发现什么问题,特意写出来分享给大家。

实现思路思路

首先我们需要分析Markdown文档的格式,它本质上就是一个文本文件。大致实现思路如下:

  1. 使用java中的IO流API对文档进行解析
  2. 找到文档中图片的地址,使用正则表达式进行分析,将所有文档中出现的图片文件名保存成一个集合。
  3. 再到assets文件夹下去查找所有的图片文件名,也保存成一个集合。
  4. 对比两个文件名的集合,将在assets目录下存在的文件,文档中不存在的图片文件全部找出来
  5. 删除所有不存在的图片文件
源代码

package org.newboy.utils; import org.apache.commons.io.FileUtils; import org.apache.commons.lang3.StringUtils; import java.io.File; import java.io.IOException; import java.util.Collection; import java.util.HashSet; import java.util.Scanner; import java.util.regex.Matcher; import java.util.regex.Pattern; /** * @author NewBoy * @version 1.0 * @since 2020-12-04 * 删除MarkDown目录下多余的图片文件 */ public class MarkDownPictureCleaner { public static void main(String[] args) { System.out.println("=== MarkDown下冗余图片清理工具(开发者:NewBoy 版本:1.0) ==="); Scanner scanner = new Scanner(System.in); //MarkDown的文件名 String path = null; try { System.out.println("请输入Markdown文件的路径和文件名(可直接将md文件拖到命令窗口):"); path = scanner.nextLine(); } catch (Exception e) { // 用户可能按下 Ctrl C 终止程序 System.out.println("程序结束!"); scanner.close(); System.exit(0); } // 预检查,判断用户输入的文件是否存在 File file = null; //图片所在目录 String picDir = null; if (StringUtils.isNotBlank(path)) { //如果用户在DOS命令窗口拖入,前后有双引号,去掉双引号 path = path.trim().replace("\"", ""); //创建文件对象 file = new File(path); if (!file.exists()) { System.out.println("Markdown文件不存在!"); file = null; } else { System.out.println("请输入图片目录(默认为assets):"); //图片所在目录 picDir = scanner.nextLine(); //如果为空,空串,或者空格 if (StringUtils.isBlank(picDir)) { picDir = "assets"; } } } // 读取 Markdown 文件的内容 String content = null; if (file != null) { // 如果用户输入的文件不存在,跳过此次操作 System.out.println("您输入的路径:" file.getAbsolutePath()); try { content = FileUtils.readFileToString(file, "UTF-8"); } catch (IOException e) { System.out.println("文件读取异常:" e.getMessage()); content = null; } } if (content != null) { // 找出 Markdown 文件中所有图片的引用 String regex = "(!\\[.*\\])(\\(.*\\))|(<img\\b.*?(?:\\>|\\/>))"; // 捕获组,匹配类似于 "![*](*)" 的字符串 Pattern pattern = Pattern.compile(regex); Matcher matcher = pattern.matcher(content); HashSet<String> picturesInMarkdown = new HashSet<>(); while (matcher.find()) { String ref = matcher.group(0); String picture = null; int beginIndex = 0; int endIndex = 0; //如果是!开头 if (ref.startsWith("!")) { // 获取图片名称 beginIndex = ref.lastIndexOf("/") 1; endIndex = ref.length() - 1; } else if (ref.startsWith("<")) { //或者以<开头的 beginIndex = ref.indexOf("/") 1; endIndex = ref.indexOf('"', beginIndex); } picture = ref.substring(beginIndex, endIndex); //logger.info(picture); // 保存图片名称 picturesInMarkdown.add(picture); } System.out.println("MarkDown中一共有:" picturesInMarkdown.size() "个图片文件"); // 列出 Markdown 文件所在目录中的图片名称 File directory = file.getParentFile(); String[] extensions = {"png", "jpg", "jpeg", "bmp"}; // 图片扩展名 boolean recursive = true; // 不扫描子目录 HashSet<String> picturesInDirectory = new HashSet<String>(); //获取所有文件的集合 Collection<File> files = FileUtils.listFiles(directory, extensions, recursive); System.out.println("图片目录下一共有:" files.size() "个图片文件"); for (File picture : files) { String name = picture.getName(); picturesInDirectory.add(name); } // 列出冗余图片,并将其删除 picturesInDirectory.removeAll(picturesInMarkdown); int count = 0; for (String picture : picturesInDirectory) { String pic = directory.getAbsolutePath() File.separator picDir File.separator picture; System.out.println("删除图片:" pic); FileUtils.deleteQuietly(new File(pic)); count ; } System.out.println("操作完成,共删除了" count "个图片文件!"); } scanner.close(); System.exit(0); } }

使用说明

因为使用Java编写,使用需要安装Java虚拟机,为了方便用户的使用,特意编写了一个DOS下的命令行

@echo off java -jar markdown-picture-cleaner-1.0.jar pause

1.运行的时候会出现一个窗口,需要输入Markdown文件的路径和文件名,这个比较麻烦,但可以将需要清理的文件直接拖到窗口中,则会自动填充文件路径和文件名

markdown 编辑痕迹(自己动手编写清理工具)(5)

2.拖到窗口中会自动输入路径和文件名

markdown 编辑痕迹(自己动手编写清理工具)(6)

3.按下回车会让你输入图片的目录,默认是当前目录下的assets,如果图片是在这个目录下,直接按回车即可。

markdown 编辑痕迹(自己动手编写清理工具)(7)

4.最后显示清理的结果

markdown 编辑痕迹(自己动手编写清理工具)(8)

最后

以上是给各位读者提供了一种思路,大家也可以使用其它语言进行编写,比如可以直接运行在Windows下的VC或是VB,还有图形界面,用户体验会更好一些。同时软件本身只提供了基础功能,作者提供了源代码,懂Java的朋友可以在这个基础上去进一步完善。

,