一个文件在线预览解决方案，丰富、灵活，可支持第三方快速集成接入

随着无纸化办公进入到各行各业中，很多的信息化系统，比如OA、ERP、财务营销等系统，都需要各种文档附件的上传和下载。在设计或者使用这些系统往往都会遇到以下两个问题：

- **不支持在线文件预览功能：**需要使用者进行下载本地使用本地编辑器打开查看才行；
- **不同系统间的文件独立管理：**导致即使带了预览功能，一样的文件还是需要再在不同的系统中重新上传

所以，在文件预览管理方案中：一方面我们需要的是一个文件预览的能力，它既能统一上传、预览、管理文档；另一方面还能支持企业其他的应用系统进行无缝的集成文件预览的能力。

#  kkFileView 介绍

**一句话介绍kkFileView：**一个文件文档在线预览解决方案，易上手和部署，基本支持主流办公文档的在线预览如doc,docx,xls,xlsx,ppt,pptx,pdf,txt,zip,rar,图片,视频,音频等等。

![图片](http://banmag.cn:8089/i/2024/07/12/6690897007a10.png)

**🏠 项目信息**

```bash
#github地址
https://github.com/kekingcn/kkFileView
#项目地址
https://kkview.cn/zh-cn/index.html
#在线demo环境
https://file.kkview.cn/
```

![图片](http://banmag.cn:8089/i/2024/07/12/669089701727d.png)

## 🚀**功能特性**

- ####

- #### **一键部署，快速接入：**支持Windows、Linux平台一键部署，两行js代码就可以接入预览；

- #### **支持常见文件格式，兼容新版Office文档：**支持文本、图片、Office文档、WPS文档、PDF、视频、音频、压缩包等常见文件类型预览；

- #### **支持多种预览模式灵活切换：**支持pdf、加载分页图、轮播图片等预览模式动态配置、灵活切换

- #### **独立部署，提供restful接口，适用于第三方应用快速集成：**独立于业务系统外，提供restful http接口，开发语言无关，微服务场景下直接提供在线预览服务

## **🛠 支持的文件类型**

目前支持的文件类型如下：

- 支持 doc, docx, xls, xlsx, xlsm, ppt, pptx, csv, tsv, dotm, xlt, xltm, dot, dotx,xlam, xla 等 Office 办公文档
- 支持 wps, dps, et, ett, wpt 等国产 WPS Office 办公文档
- 支持 odt, ods, ots, odp, otp, six, ott, fodt, fods 等OpenOffice、LibreOffice 办公文档
- 支持 vsd, vsdx 等 Visio 流程图文件
- 支持 wmf, emf 等 Windows 系统图像文件
- 支持 psd 等 Photoshop 软件模型文件
- 支持 pdf ,ofd, rtf 等文档
- 支持 xmind 软件模型文件
- 支持 bpmn 工作流文件
- 支持 eml 邮件文件
- 支持 epub 图书文档
- 支持 obj, 3ds, stl, ply, gltf, glb, off, 3dm, fbx, dae, wrl, 3mf, ifc, brep, step, iges, fcstd, bim 等 3D 模型文件
- 支持 dwg, dxf 等 CAD 模型文件
- 支持 txt, xml(渲染), md(渲染), java, php, py, js, css 等所有纯文本
- 支持 zip, rar, jar, tar, gzip, 7z 等压缩包
- 支持 jpg, jpeg, png, gif, bmp, ico, jfif, webp 等图片预览（翻转，缩放，镜像）
- 支持 tif, tiff 图信息模型文件
- 支持 tga 图像格式文件
- 支持 svg 矢量图像格式文件
- 支持 mp3,wav,mp4,flv 等音视频格式文件
- 支持 avi,mov,rm,webm,ts,rm,mkv,mpeg,ogg,mpg,rmvb,wmv,3gp,ts,swf 等视频格式转码预览
- 支持 dcm 等医疗数位影像预览
- 支持 drawio 绘图预览

**一、拉取镜像**

```

# 可访问docker中央仓库的环境中
docker pull keking/kkfileview:4.1.0

# 不可访问docker中央仓库的环境中
wget https://kkview.cn/resource/kkFileView-4.1.0-docker.tar
docker load -i kkFileView-4.1.0-docker.tar
```

**二、运行应用**

```
docker run -it -p 8012:8012 keking/kkfileview:4.1.0
```

*备注：目前官网最新版本为4.3.0，但是Docker发行包镜像无法直接拉取，有兴趣的同学可以采用源码部署。或者为了社区稳定发展，可以加入kk 开源社区，为社区贡献一份爱心*

![图片](http://banmag.cn:8089/i/2024/07/12/6690899e1055a.png)

**二、访问应用**

浏览器访问 http://hostip:8012 即可看到项目界面。

![图片](http://banmag.cn:8089/i/2024/07/12/6690899e0ca74.png)

#  kkFileView 文件预览效果

#

### 1. 文本预览

支持所有类型的文本文档预览， 由于文本文档类型过多，无法全部枚举，默认开启的类型如下 txt,html,htm,asp,jsp,xml,json,properties,md,gitignore,log,java,py,c,cpp,sql,sh,bat,m,bas,prg,cmd
文本预览效果如下
![图片](http://banmag.cn:8089/i/2024/07/12/669089ea90661.png)

### 2. 图片预览

支持jpg，jpeg，png，gif等图片预览（翻转，缩放，镜像），预览效果如下
![图片](http://banmag.cn:8089/i/2024/07/12/669089e8c4a8f.png)

### 3. word文档预览

支持doc，docx文档预览，word预览有两种模式：一种是每页word转为图片预览，另一种是整个word文档转成pdf，再预览pdf。两种模式的适用场景如下

- 图片预览：word文件大，前台加载整个pdf过慢
- pdf预览：内网访问，加载pdf快
  图片预览模式预览效果如下
  ![图片](http://banmag.cn:8089/i/2024/07/12/669089ea4dba8.png)
  pdf预览模式预览效果如下
  ![图片](http://banmag.cn:8089/i/2024/07/12/669089ea8459e.png)

### 4. ppt文档预览

支持ppt，pptx文档预览，和word文档一样，有两种预览模式
图片预览模式预览效果如下

![图片](http://banmag.cn:8089/i/2024/07/12/669089ea87018.png)

pdf预览模式预览效果如下
![图片](http://banmag.cn:8089/i/2024/07/12/669089ea4f4d7.png)

### 5. pdf文档预览

支持pdf文档预览，和word文档一样，有两种预览模式
图片预览模式预览效果如下
![图片](http://banmag.cn:8089/i/2024/07/12/669089ebc9afe.png)
pdf预览模式预览效果如下
![图片](http://banmag.cn:8089/i/2024/07/12/669089ec5fb9a.png)

### 6. excel文档预览

支持xls，xlsx文档预览，预览效果如下
![图片](http://banmag.cn:8089/i/2024/07/12/669089ee1201a.png)
ps，如碰到excel预览乱码问题，可参考 预览乱码

另xlsx还支持web预览模式(4.3.0版本起默认启用)，预览效果如下
![图片](http://banmag.cn:8089/i/2024/07/12/669089ee424c3.png)

### 7. 压缩文件预览

支持zip,rar,jar,tar,gzip等压缩包，预览效果如下
![图片](http://banmag.cn:8089/i/2024/07/12/669089ee15160.png)
可点击压缩包中的文件名，直接预览文件，预览效果如下
![图片](http://banmag.cn:8089/i/2024/07/12/669089ee61a4e.png)

### 8. 多媒体文件预览

理论上支持所有的视频、音频文件，由于无法枚举所有文件格式，默认开启mp3,wav,mp4,flv 类型
如有没有未覆盖全面，可通过配置文件指定多媒体类型
视频预览效果如下
![图片](http://banmag.cn:8089/i/2024/07/12/669089eeb8613.png)
音频预览效果如下
![图片](http://banmag.cn:8089/i/2024/07/12/669089eecdd80.png)

### 9. CAD文档预览

支持CAD dwg文档预览，和word文档一样，有两种预览模式
图片预览模式预览效果如下

![图片](http://banmag.cn:8089/i/2024/07/12/669089ea87018.png)
pdf预览模式预览效果如下
![图片](http://banmag.cn:8089/i/2024/07/12/669089f05d51d.png)

### 10. 流程图bpmn文件预览

支持bpmn流程图文件预览，预览效果如下

![图片](http://banmag.cn:8089/i/2024/07/12/669089f05d331.png)

### 11. 3D模型文件文件预览

支持 obj, 3ds, stl, ply, gltf, glb, off, 3dm, fbx, dae, wrl, 3mf, ifc, brep, step, iges, fcstd, bim 等3D模型文件预览，预览效果如下

![图片](http://banmag.cn:8089/i/2024/07/12/669089f062520.png)

### 12. dcm医疗数位影像预览

支持dcm医疗数位影像预览，预览效果如下

![图片](http://banmag.cn:8089/i/2024/07/12/669089f166d5b.png)

### 13. drawio流程图预览

支持drawio流程图预览，预览效果如下

![图片](http://banmag.cn:8089/i/2024/07/12/669089f10b17f.png)

#  第三方快速集成

如果你的项目需要接入文件预览项目，达到对docx、excel、ppt、jpg等文件的预览效果，那么通过在你的项目中加入下面的代码就可以成功实现。

```js
var url = 'http://127.0.0.1:8080/file/test.txt'; //要预览文件的访问地址
window.open('http://127.0.0.1:8012/onlinePreview?url='+encodeURIComponent(base64Encode(url)));
```

新增多图片同时预览功能，接口如下：

```js
var fileUrl =url1+'|'+url2;//多url使用'|'字符隔开
window.open('http://127.0.0.1:8012/picturesPreview?urls='+encodeURIComponent(base64Encode(fileUrl)));
```

#  最后

kkFileView是一个优先的文件文档在线预览开源解决方案，项目使用流行的 Spring Boot 搭建，易上手和部署，部署好后可以独立提供预览服务，使用 http 接口访问，不需要和应用集成，具有跨系统跨语言使用的特性。也希望有兴趣的小伙伴在使用的同时，多多支持本项目的开源社区，开源不易，需要用爱发电。