昨晚搭建環境都花了好一會時間，主要在浪費在了安裝 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：
- 代碼質量一般，有很多可以優化的地方比如：
Controller層代碼嵌套太多邏輯- 沒有進行全域例外處理(代碼中是直接回傳錯誤資訊的 json 資料給前端，我并不推薦這樣做)
- 回傳值不需要通過
ObjectMapper轉換為 JSON 格式（ResponseEntity+@RestController就行了） - ......
- 使用的公司比較多，說明專案整體功能還是比較穩定和成熟的！
- 代碼整體邏輯還是比較清晰的，比較容易看懂，給作者們點個贊！
環境搭建
克隆專案
通過以下命令即可將專案克隆到本地：
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 = "https://www.cnblogs.com/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 ，
我的開源專案推薦
- JavaGuide ：「Java學習+面試指南」一份涵蓋大部分Java程式員所需要掌握的核心知識，準備 Java 面試，首選 JavaGuide！
- guide-rpc-framework ：A custom RPC framework implemented by Netty+Kyro+Zookeeper.（一款基于 Netty+Kyro+Zookeeper 實作的自定義 RPC 框架-附詳細實作程序和相關教程）
- jsoncat ：仿 Spring Boot 但不同于 Spring Boot 的一個輕量級的 HTTP 框架
- programmer-advancement ：程式員應該有的一些好習慣+面試必知事項！
- springboot-guide ：Not only Spring Boot but also important knowledge of Spring（不只是SpringBoot還有Spring重要知識點）
- awesome-java ：Collection of awesome Java project on Github(Github 上非常棒的 Java 開源專案集合).
我是 Guide 哥，一 Java 后端開發，會一點前端，自由的少年，我們下期再見！微信搜“JavaGuide”回復“面試突擊”領取我整理的 4 本原創PDF
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/173118.html
標籤：Java