手把手教你用 Spring Boot搭建一个在线文件预览系统！支持ppt、doc等多种类型文件预览

本是古典何须时尚 2022-12-15 06:28 237阅读 0赞

> 昨晚搭建环境都花了好一会时间，主要在浪费在了安装 openoffice 这个依赖环境上(*Mac 需要手动安装*)。
> 
> 然后，又一步一步功能演示，记录，调试项目，并且简单研究了一下核心代码之后才把这篇文章写完。
> 
> 另外，这篇文章我还会简单分析一下项目核心代码。
> 
> *如果有帮助，欢迎点赞/再看鼓励，我会开心很久 ღ( ´･ᴗ･\` )比心*

## 项目介绍 ##

官方是这样介绍 kkFileView 的：

> kkFileView 是使用 spring boot 打造文件文档在线预览项目解决方案，支持 doc、docx、ppt、pptx、xls、xlsx、zip、rar、mp4、mp3 以及众多类文本如 txt、html、xml、java、properties、sql、js、md、json、conf、ini、vue、php、py、bat、gitignore 等文件在线预览

**简单来说 kkFileView 就是常见的文件类型的在线预览解决方案。**

总的来说我觉得 kkFileView 是一个非常棒的开源项目，在线文件预览这个需求非常常见。感谢开源！

下面， 我站在一个“上帝”的角度从多个维度来评价一下 kkFileView：

1.  代码质量一般，有很多可以优化的地方比如：
    
     *  `Controller` 层代码嵌套太多逻辑
     *  没有进行全局异常处理(*代码中是直接返回错误信息的 json 数据给前端，我并不推荐这样做*)
     *  返回值不需要通过`ObjectMapper`转换为 JSON 格式（`ResponseEntity`\+`@RestController` 就行了）
     *  …
2.  使用的公司比较多，说明项目整体功能还是比较稳定和成熟的！
3.  代码整体逻辑还是比较清晰的，比较容易看懂，给作者们点个赞！

## 环境搭建 ##

### 克隆项目 ###

通过以下命令即可将项目克隆到本地：

git clone https://gitee.com/kekingcn/file-online-preview.git

### 安装 OpenOffice ###

office 类型的文件的预览依赖了 OpenOffice ，所以我们首先要安装 OpenOffice(Windows 下已内置，Linux 会自动安装，Mac OS 下需要手动安装)。

下面演示一下如何在 Mac 上安装 OpenOffice。

你可以通过以下命令安装最新版的 OpenOffice：

brew cask install openoffice

不过，这种方式下载可能会比较慢，你可以直接去官网下载 dmg 安装包。

官方下载地址：[https://www.openoffice.org/download/][https_www.openoffice.org_download]

![OpenOffice下载][OpenOffice]

很多小伙伴就要问了：**OpenOffice 是什么呢？**

[OpenOffice][OpenOffice 1] 是 Apache 旗下的一款开源免费的文字处理软件，支持 Windows、Liunx、OS X 等主流操作系统。

OpenOffice 和 Windows 下 office 办公软件有点类似，不过其实开源免费的。

![why openoffice][]

### 启动项目 ###

运行`FilePreviewApplication`的 main 方法，服务启动后，访问[http://localhost:8012/][http_localhost_8012] 会看到如下界面，代表服务启动成功。

![项目启动成功][20201015194328801.png]

## 使用 ##

我们首先上传了 3 个不同的类型的文件来分别演示一下图片、PDF、Word 文档的预览。

![20201015194328978.png][]

### 图片的预览 ###

**kkFileView 支持 jpg，jpeg，png，gif 等多种格式图片的预览，还包括了翻转，缩放图片等操作。**

图片的预览效果如下。

![图片的预览效果][20201015194329517.png]

### Word 文档的预览 ###

**kkFileView 支持 doc，docx 文档预览。**

另外，根据 Word 大小以及网速问题， Word 预览提供了两种模式：

*  每页 Word 转为图片预览
 *  整个 Word 文档转成 PDF，再预览 PDF。

两种模式的适用场景如下

*  **图片预览** ：Word 文件大（加载 PDF 速度比较慢）的情况。
 *  **PDF 预览** ：内网访问（加载 PDF 速度比较快）的情况。

图片预览模式预览效果如下：

![20201015194329908.png][]

PDF 预览模式预览效果如下：

![20201015194330591.png][]

### PDF 文档的预览 ###

kkFileView 支持 PDF 文档预览。类似 Word 文档预览， PDF 预览提供了两种模式：

*  每页 Word 转为图片预览
 *  整个 Word 文档转成 PDF，再预览 PDF。

由于和 Word 文档的预览展示效果一致，这里就不放图片了。

## 文件预览核心代码分析 ##

### API 层 ###

文件预览调用的接口是 `/onlinePreview` 。

通过分析 `/onlinePreview` 接口我们发现， 后端接收到预览请求之后，会从 URL 和请求中筛选出自己需要的信息比如文件后缀、文件名。

之后会调用`FilePreview`类 的 `filePreviewHandle()` 方法。`filePreviewHandle()` 方法是实现文件预览的核心方法。

@RequestMapping(value = "/onlinePreview")
    public String onlinePreview(String url, Model model, HttpServletRequest req) { 
        FileAttribute fileAttribute = fileUtils.getFileAttribute(url);
        req.setAttribute("fileKey", req.getParameter("fileKey"));
        model.addAttribute("pdfDownloadDisable", ConfigConstants.getPdfDownloadDisable());
        model.addAttribute("officePreviewType", req.getParameter("officePreviewType"));
        FilePreview filePreview = previewFactory.get(fileAttribute);
        logger.info("预览文件url：{}，previewType：{}", url, fileAttribute.getType());
        return filePreview.filePreviewHandle(url, model, fileAttribute);
    }

`FilePreview` 是文件预览接口，不同的文件类型的预览都实现了 `FilePreview` 接口，并实现了 `filePreviewHandle()` 方法。

### 文件预览接口 ###

public interface FilePreview { 
        String filePreviewHandle(String url, Model model, FileAttribute fileAttribute);
    }

不同的文件类型的预览都实现了 `FilePreview` 接口，如下图所示。

![20201015194330836.png][]

不同文件类型的预览都会实现 `FilePreview` 接口，然后重写`filePreviewHandle()`方法。比如： `OfficeFilePreviewImpl` 这个主要负责处理 office 文件的预览、`PdfFilePreviewImpl` 主要负责处理 pdf 文件的预览。

### 文件预览具体实现分析 ###

下面我们以 office 文件的预览为入口来分析。

首先要明确的是 excel 类型的预览是通过将 excel 文件转换为 HTML 实现的，其他类型 office 文件的预览是通过将文件转换为 PDF 或者是 图片的方式来预览的。

举个例子。我们上传了一份名为 `武汉市文化市场管理办法.docx` 的 Word 文件并预览的话，`jodconverter-web/src/main/file` 路径下会生成两个相关文件，这两个文件分别对应了我们提到的 PDF 预览 和 图片预览这两种方式。

*  `武汉市文化市场管理办法.pdf`
 *  由 Word 文件所转化得到的一系列图片

![2020101519433136.png][]

我们以一个名为 `武汉市文化市场管理办法.docx` 的文件来举例说明一下代码中是如何做的。

通过分析代码， 我们定位到了 `OfficeFilePreviewImpl` 这个主要负责处理 office 文件预览的类。

/** * 处理office文件 */
    @Service
    public class OfficeFilePreviewImpl implements FilePreview { 
    
    }

我们来简单分析一下 `OfficeFilePreviewImpl` 类中实现预览的核心方法是 `filePreviewHandle` 。

> 说明：这部分代码的逻辑不够清晰，还可以抽方法优化以让人更容易读懂，感兴趣的小伙伴可以自己动手重构一下，然后去给作者提个 PR。

@Override
        public String filePreviewHandle(String url, Model model, FileAttribute fileAttribute) { 
            // 1.获取预览类型(image/pdf/html)，用户请求中传了officePreviewType参数就取参数的，没传取系统默认（image）
            String officePreviewType = model.asMap().get("officePreviewType") == null ? ConfigConstants.getOfficePreviewType() : model.asMap().get("officePreviewType").toString();
            // 2.获取 URL 地址
            String baseUrl = BaseUrlFilter.getBaseUrl();// http://localhost:8012/
            // 3.获取图片相关信息
            String suffix=fileAttribute.getSuffix();//文件后缀如docx
            String fileName=fileAttribute.getName();//文件名如：武汉市文化市场管理办法.docx
            // 4. 判断是否为 html 格式预览也就是判断文件否为 excel
            boolean isHtml = suffix.equalsIgnoreCase("xls") || suffix.equalsIgnoreCase("xlsx");
            // 5. 将文件的后缀名更换为 .pdf 或者 .html（excel文件的情况）
            String pdfName = fileName.substring(0, fileName.lastIndexOf(".") + 1) + (isHtml ? "html" : "pdf");
            // 6. 转换后的文件输出的文件夹如 file-online-preview/jodconverter-web/src/main/file/武汉市文化市场管理办法.pdf）
            String outFilePath = FILE_DIR + pdfName;
            // 7 .判断之前是否已转换过，如果转换过，直接返回，否则执行转换
            // 文件第一次被预览的时候会首先对文件进行缓存处理
            if (!fileUtils.listConvertedFiles().containsKey(pdfName) || !ConfigConstants.isCacheEnabled()) { 
                String filePath;
                // 下载文件
                ReturnResponse<String> response = downloadUtils.downLoad(fileAttribute, null);
                if (0 != response.getCode()) { 
                    model.addAttribute("fileType", suffix);
                    model.addAttribute("msg", response.getMsg());
                    return "fileNotSupported";
                }
                filePath = response.getContent();
                if (StringUtils.hasText(outFilePath)) { 
                    officeToPdf.openOfficeToPDF(filePath, outFilePath);
                    if (isHtml) { 
                        // 对转换后的文件进行操作(改变编码方式)
                        fileUtils.doActionConvertedFile(outFilePath);
                    }
                    if (ConfigConstants.isCacheEnabled()) { 
                        // 加入缓存
                        fileUtils.addConvertedFile(pdfName, fileUtils.getRelativePath(outFilePath));
                    }
                }
            }
            // 8.根据预览类型officePreviewType，选择不同的预览方式
            // 比如,如果预览类型officePreviewType为pdf则进行pdf方式预览
            if (!isHtml && baseUrl != null && (OFFICE_PREVIEW_TYPE_IMAGE.equals(officePreviewType) || OFFICE_PREVIEW_TYPE_ALL_IMAGES.equals(officePreviewType))) { 
                return getPreviewType(model, fileAttribute, officePreviewType, baseUrl, pdfName, outFilePath, pdfUtils, OFFICE_PREVIEW_TYPE_IMAGE);
            }
            model.addAttribute("pdfUrl", pdfName);
            return isHtml ? "html" : "pdf";
        }

项目地址： [https://github.com/kekingcn/kkFileView][https_github.com_kekingcn_kkFileView]

我整理了一份优质原创PDF资源免费分享给大家，大部分内容都是我的原创，少部分来自朋友。

![image-20201012105544846.png][] ![image-20201012105608336][]

下载地址：[https://cowtransfer.com/s/fbed14f0c22a4d][https_cowtransfer.com_s_fbed14f0c22a4d] 。

## 我的开源项目推荐 ##

1.  [JavaGuide][] ：「Java学习+面试指南」一份涵盖大部分Java程序员所需要掌握的核心知识。准备 Java 面试，首选 JavaGuide！
2.  [guide-rpc-framework][] ：A custom RPC framework implemented by Netty+Kyro+Zookeeper.（一款基于 Netty+Kyro+Zookeeper 实现的自定义 RPC 框架-附详细实现过程和相关教程）
3.  [jsoncat][] ：仿 Spring Boot 但不同于 Spring Boot 的一个轻量级的 HTTP 框架
4.  [programmer-advancement][] ：程序员应该有的一些好习惯+面试必知事项！
5.  [springboot-guide][] ：Not only Spring Boot but also important knowledge of Spring（不只是SpringBoot还有Spring重要知识点）
6.  [awesome-java][] ：Collection of awesome Java project on Github(Github 上非常棒的 Java 开源项目集合).

[我是 Guide 哥，一 Java 后端开发，会一点前端，自由的少年。我们下期再见！微信搜“**JavaGuide**”回复“**面试突击**”领取我整理的 4 本原创PDF][Guide _ Java _JavaGuide_ 4 _PDF]

## 优质原创PDF资源 ##

一些计算机基础+Java的原创PDF下载地址: [https://pan.baidu.com/s/1H-tR39b9UYHPWRGm1V0-1Q][https_pan.baidu.com_s_1H-tR39b9UYHPWRGm1V0-1Q] 密码: 8djk

![453fe80ef8fb263ac9716942f65fe4d7.png][]

[https_www.openoffice.org_download]: https://www.openoffice.org/download/
[OpenOffice]: /images/20221123/119d3ba280ba46bbaaf8a71dbab5b5d4.png
[OpenOffice 1]: https://www.openoffice.org/
[why openoffice]: /images/20221123/2dee7aa3486347989bac6d3144267f8c.png
[http_localhost_8012]: http://localhost:8012/
[20201015194328801.png]: /images/20221123/e3caf22ac4314ac796b00f213d1fec0d.png
[20201015194328978.png]: /images/20221123/b391aa66ccae4d3bbf7d5e89064906ec.png
[20201015194329517.png]: /images/20221123/92832051caf043ae90762c69b0092dc7.png
[20201015194329908.png]: /images/20221123/74efccc360c240bbb16889c2e61496e0.png
[20201015194330591.png]: /images/20221123/cec7d0749b944d29bd565216fb0bc622.png
[20201015194330836.png]: /images/20221123/715099590b1846488c847d3628d59703.png
[2020101519433136.png]: /images/20221123/771085b1768e46cf993c6e6d623111dc.png
[https_github.com_kekingcn_kkFileView]: https://github.com/kekingcn/kkFileView
[image-20201012105544846.png]: https://cdn.jsdelivr.net/gh/javaguide-tech/blog-images/2020-10/image-20201012105544846.png
[image-20201012105608336]: /images/20221123/5f288470386048f7bb9c4e248d8c2b47.png
[https_cowtransfer.com_s_fbed14f0c22a4d]: https://cowtransfer.com/s/fbed14f0c22a4d
[JavaGuide]: https://github.com/Snailclimb/JavaGuide
[guide-rpc-framework]: https://github.com/Snailclimb/guide-rpc-framework
[jsoncat]: https://github.com/Snailclimb/jsoncat
[programmer-advancement]: https://github.com/Snailclimb/programmer-advancement
[springboot-guide]: https://github.com/Snailclimb/springboot-guide
[awesome-java]: https://github.com/Snailclimb/awesome-java
[Guide _ Java _JavaGuide_ 4 _PDF]: https://www.yuque.com/docs/share/71251673-1fef-416e-93d7-489a25a9eda5?#%20%E3%80%8A%E8%B5%B0%E8%BF%91JavaGuide%E3%80%8B
[https_pan.baidu.com_s_1H-tR39b9UYHPWRGm1V0-1Q]: https://pan.baidu.com/s/1H-tR39b9UYHPWRGm1V0-1Q
[453fe80ef8fb263ac9716942f65fe4d7.png]: /images/20221123/f3d9534b95ff49ca91cb9fcc39b9a521.png