手把手教你用 Spring Boot搭建一個在線文件預覽系統！支持ppt、doc等多種類型文件預覽

昨晚搭建環境都花了好一會時間，主要在浪費在了安裝 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/

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

OpenOffice 是 Apache 旗下的一款開源免費的文字處理軟件，支持 Windows、Liunx、OS X 等主流操作系統。

OpenOffice 和 Windows 下 office 辦公軟件有點類似，不過其實開源免費的。

啟動項目

運行FilePreviewApplication的 main 方法，服務啟動后，訪問http://localhost:8012/ 會看到如下界面，代表服務啟動成功。

使用

我們首先上傳了 3 個不同的類型的文件來分別演示一下圖片、PDF、Word 文檔的預覽。

圖片的預覽

kkFileView 支持 jpg，jpeg，png，gif 等多種格式圖片的預覽，還包括了翻轉，縮放圖片等操作。

圖片的預覽效果如下。

Word 文檔的預覽

kkFileView 支持 doc，docx 文檔預覽。

另外，根據 Word 大小以及網速問題， Word 預覽提供了兩種模式：

• 每頁 Word 轉為圖片預覽
• 整個 Word 文檔轉成 PDF，再預覽 PDF。

兩種模式的適用場景如下

• 圖片預覽 ：Word 文件大（加載 PDF 速度比較慢）的情況。
• PDF 預覽 ：內網訪問（加載 PDF 速度比較快）的情況。

圖片預覽模式預覽效果如下：

PDF 預覽模式預覽效果如下：

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 接口，如下圖所示。

不同文件類型的預覽都會實現 FilePreview 接口，然后重寫filePreviewHandle()方法。比如： OfficeFilePreviewImpl 這個主要負責處理 office 文件的預覽、PdfFilePreviewImpl 主要負責處理 pdf 文件的預覽。

文件預覽具體實現分析

下面我們以 office 文件的預覽為入口來分析。

首先要明確的是 excel 類型的預覽是通過將 excel 文件轉換為 HTML 實現的，其他類型 office 文件的預覽是通過將文件轉換為 PDF 或者是 圖片的方式來預覽的。

舉個例子。我們上傳了一份名為 武漢市文化市場管理辦法.docx 的 Word 文件並預覽的話，jodconverter-web/src/main/file 路徑下會生成兩個相關文件，這兩個文件分別對應了我們提到的 PDF 預覽 和 圖片預覽這兩種方式。

• 武漢市文化市場管理辦法.pdf
• 由 Word 文件所轉化得到的一系列圖片

我們以一個名為 武漢市文化市場管理辦法.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

我整理了一份優質原創PDF資源免費分享給大家，大部分內容都是我的原創，少部分來自朋友。

下載地址：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