百度360必应搜狗淘宝本站头条
python类型转换python串口编程python计时python异常python进度条
当前位置：网站首页 > 技术资源 > 正文

在线文档预览kkFileView部署及使用指南

off999 2025-03-14 19:46 22 浏览 0 评论

项目简介

此项目为文件文档在线预览项目解决方案，对标业内付费产品有【永中office】【office365】【idocv】等。该项目使用流行的spring boot搭建，易上手和部署，基本支持主流办公文档的在线预览，如doc,docx,Excel,pdf,txt,zip,rar,图片等等。

项目特性

  • 支持word excel ppt，pdf等办公文档
  • 支持txt,java,php,py,md,js,css等所有纯文本
  • 支持zip,rar,jar,tar,gzip等压缩包
  • 支持jpg，jpeg，png，gif等图片预览（翻转，缩放，镜像）
  • 支持mp3，mp4，flv等多媒体文件预览
  • 使用spring boot开发，预览服务搭建部署非常简便
  • rest接口提供服务，跨平台特性(java,php,python,go,php，....)都支持，应用接入简单方便
  • 支持普通http/https文件下载url、http/https文件下载流url、ftp下载url等多种预览源
  • 提供zip，tar.gz发行包，提供一键启动脚本和丰富的配置项，方便部署使用
  • 提供Docker镜像发行包，方便在容器环境部署
  • 抽象预览服务接口，方便二次开发，非常方便添加其他类型文件预览支持

部署指南

1. 环境要求

  1. Java: 1.8+
  2. Maven：3.4+

2. 下载代码&编译打包

2.1. 从码云仓库拉取代码

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

2.2. 使用maven编译打包

cd file-online-preview
mvn clean package -DskipTests

2.3. 使用docker构建镜像

docker build -t keking/kkfileview:v4.0.0 .

Docker容器环境环境运行

  • 拉取镜像
docker pull keking/kkfileview
  • 运行
docker run -it -p 8012:8012 keking/kkfileview
  • 浏览器访问容器8012端口 http://xxx.xxx.xxx.xxx:8012 即可看到项目演示用首页

3. 项目接入使用

3.1.普通文件下载url预览

3.x.x 及以上版本

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/js-base64@3.6.0/base64.min.js"></script>

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

2.x.x 及以下版本

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

3.2. http/https下载流url预览

很多系统内不是直接暴露文件下载地址，而是请求通过id、code等参数到通过统一的接口，后端通过id或code等参数定位文件，再通过OutputStream输出下载，此时下载url是不带文件后缀名的，预览时需要拿到文件名，传一个参数fullfilename=xxx.xxx来指定文件名，示例如下

3.x.x 版本

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/js-base64@3.6.0/base64.min.js"></script>

var originUrl = 'http://127.0.0.1:8080/filedownload?fileId=1'; //要预览文件的访问地址
var previewUrl = originUrl + '&fullfilename=test.txt'
window.open('http://127.0.0.1:8012/onlinePreview?url='+encodeURIComponent(Base64.encode(previewUrl)));

2.x.x 及以下版本

var originUrl = 'http://127.0.0.1:8080/filedownload?fileId=1'; //要预览文件的访问地址
var previewUrl = originUrl + '&fullfilename=test.txt'
window.open('http://127.0.0.1:8012/onlinePreview?url='+encodeURIComponent(previewUrl));

3.3. FTP下载url预览

1). FTP匿名访问

如果要预览的FTP url是可以匿名访问的（不需要用户名密码），则可以直接通过下载url预览，示例如下

3.x.x 版本

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/js-base64@3.6.0/base64.min.js"></script>

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

2.x.x 及以下版本

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

2). 非匿名访问，确定只有访问一台FTP服务器

如果预览服务只访问一台FTP服务器，只需要在配置文件中 配置FTP链接信息 ，则可以直接通过下载url预览，示例如下

3.x.x 版本

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/js-base64@3.6.0/base64.min.js"></script>

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

2.x.x 及以下版本

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

3). 非匿名访问，不只访问一台FTP服务器

如果预览服务要访问多台FTP服务器，且用户名密码不一致，可以通过在url中加入用户名密码等参数预览(url参数中的优化于配置文件中的)，示例如下

3.x.x 版本

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/js-base64@3.6.0/base64.min.js"></script>

var originUrl = 'ftp://127.0.0.1/file/test.txt'; //要预览文件的访问地址
var previewUrl = originUrl + '?ftp.username=xx&ftp.password=xx&ftp.control.encoding=xx';
window.open('http://127.0.0.1:8012/onlinePreview?url='+encodeURIComponent(Base64.encode(previewUrl)));

2.x.x 及以下版本

var originUrl = 'ftp://127.0.0.1/file/test.txt'; //要预览文件的访问地址
var previewUrl = originUrl + '?ftp.username=xx&ftp.password=xx&ftp.control.encoding=xx';
window.open('http://127.0.0.1:8012/onlinePreview?url='+encodeURIComponent(previewUrl));

配置说明

打开conf目录，下面有一个application.properties配置文件，有部分配置是可以在程序运行中变更的，其他的变更需要重新启动程序

不可动态配置，需要重启生效部分

server.context-path

说明：kkFileView运行时tomcat的ServletContext 默认值：/ 示例：server.context-path = /preview

file.dir

说明：预览文件存储路径，当有大量文件要预览时需要保证该目录所在磁盘有足够的容量
默认值：程序根目录下的file目录下
示例：file.dir = D:\\kkFileview\\

office.home

说明：openoffice或libreoffice安装目录，一般情况下不用配置，如果需要使用自己安装openoffice或libreoffice，可以自行指定
默认值：不同操作系统各自对应的默认安装目录
示例：office.home = C:\\Program Files (x86)\\OpenOffice 4

cache.type

说明：缓存实现方式，默认为内嵌RocksDB实现，可选项：'default', 'jdk', 'redis'

  • default：默认实现，使用RocksDB存储引擎，使用磁盘存储，会占用少量磁盘空间；Windows下需要使用管理员身份启动程序
  • jdk：java对象实现，使用纯内存对象存储，速度极快，外部依赖最少，调试部署方便，会占用内存，推荐调试时和预览文件量不是很大时（<50万）使用，预览文件量极大或有大量压缩包时不推荐使用
  • redis: redis作为缓存实现，速度快，不占用内存和磁盘空间，但是需要有外部redis服务

当配置为redis实现时，需要同时配置redis连接相关配置，如下：

spring.redisson.address = 127.0.0.1:6379
spring.redisson.password = xxxxxx

cache.clean

说明：是否需要自动定时清理缓存及预览过的文件，默认开启（如果不清理缓存，同一个url下如果文件发生变更是不会重新拉取新的文件再去预览的），开启的情况下会在每天凌晨3点清理所有缓存及预览文件，推荐预览量不大，对预览速度要求不高，且同一url下文件经常更新的用户开启，预览量大、预览速度要求高的用户不推荐开启

  • true: 默认值，开启
  • false: 不开启
  • 空：注释掉，不开启

可在运行时动态改变部分

base.url

说明：提供预览服务的地址，默认从接收请求url读，如果使用nginx等反向代理，需要手动设置为通过nginx访问预览服务的地址
默认值：未设置
示例：base.url =
https://file.keking.cn/preview
例如nginx的访问地址为 https://file.keking.cn 想要使用
https://file.keking.cn/preview/来做预览，kkFileView部署在内网192.168.1.233服务器上，需要在nginx中添加反向代理如下

location /preview {
    proxy_pass 192.168.1.233:8012;
}

修改kkFileView的配置文件如下两项

server.context-path = /preview
base.url = https://file.keking.cn/preview

使用如下地址来访问预览页面

var url = 'https://file.keking.cn/file/test.txt'; //要预览文件的访问地址
window.open('https://file.keking.cn/preview/onlinePreview?url='+encodeURIComponent(url));

trust.host

说明：信任站点，设置了之后，会限制只能预览来自信任站点列表的文件，默认不限制，多个用','隔开， 默认值：未设置 示例：trust.host = file.keking.cn,kkfileview.keking.cn

simText

说明：用来配置预览方式为纯文本的文件类型
默认值：txt,html,htm,asp,jsp,xml,json,properties,md,gitignore,log,java,py,c,cpp,sql,sh,bat,m,bas,prg,cmd

media

说明：用来配置预览方式为多媒体（视频、音频）的文件类型
默认值：mp3,wav,mp4,flv

office.preview.type

说明：office文件（doc、docx、ppt、pptx）、pdf 文件预览方式，默认为图片方式，预览时也有按钮相互切换，可选项：'image', 'pdf'

  • image: 默认预览方式，将office文件每一页后台转成图片，前台懒加载（只加载当前页面内容），推荐预览文件大且前台加载慢的时候使用
  • pdf: 统一转成pdf加一次加载，推荐内网访问，网速快时使用

office.preview.switch.disabled

说明：是否关闭office预览页面上的切换开关，默认不关闭
默认值：false

pdf.download.disable

说明：是否禁止下载转换生成的pdf文件，默认禁止
默认值：true

file.upload.disable

说明：是否禁用演示首页文件上传，默认不禁止
默认值：false

ftp.username

说明：预览url为FTP地址时，默认的ftp用户名，可过url参数中的ftp.username=xxx覆盖，即优先使用url参数中的，如果url参数中没有，则取本配置的
默认值：null

ftp.password

说明：预览url为FTP地址时，默认的ftp密码，可过url参数中的ftp.password=xxx覆盖，即优先使用url参数中的，如果url参数中没有，则取本配置的
默认值：null

ftp.control.encoding

说明：预览源为FTP时, FTP连接默认的ControlEncoding，根据FTP服务器的操作系统选择，Linux一般为设置UTF-8，Windows一般为设置GBK。可过url参数中的ftp.control.encoding=xxx覆盖，即优先使用url参数中的，如果url参数中没有，则取本配置的
默认值：UTF-8

watermark.txt

默认水印内容，如需取消水印，内容设置为空即可，例如：watermark.txt = ${WATERMARK_TXT:}
默认值：''

watermark.x.space

水印x轴间隔
默认值：10

watermark.y.space

水印y轴间隔
默认值：10

watermark.font

水印字体
默认值：微软雅黑

watermark.fontsize

水印字体大小
默认值：18px

watermark.color

水印字体颜色
默认值：black

watermark.alpha

水印透明度，要求设置在大于等于0.005，小于1
默认值：0.2

watermark.width

水印宽度
默认值：180

watermark.height

水印高度 默认值：80

watermark.angle

水印倾斜度数，要求设置在大于等于0，小于90
默认值：10

常见问题

Q：怎么把这个项目集成到我的项目里

A：不需要集成，本项目只需要独立部署，向外提供http预览服务（外部系统只需要访问本项目预览接口并传入需要预览文件的url，就可以打开预览页面）

Q：怎么把这个项目放Tomcat里运行

A：不需要放进Tomcat里，编译好的发行包为zip包，直接解压运行一键启动脚本就可以完成部署（需要有java环境）具体部署步骤详见：部署指南

Q：预览并发问题&预览首次打开慢

A：可使用预览转码队列，将需要预览的文件url放入队列中，提前进行转码，本地访问接口为：
http://127.0.0.1:8012/addTask?url=http://xxx/test.txt (url参数为需要需要的文件访问地址)

Q：预览乱码

A：乱码问题可能有如下两个原因

  • 字体问题
    大部分Linux系统上并没有预装中文字体或字体不全，需要把常用字体拷贝到Linux服务器上，具体操作如下： 下载如下字体包 http://kkfileview.keking.cn/fonts.zip 文件解压完整拷贝到Linux下的 /usr/share/fonts目录。然后依次执行mkfontscale 、mkfontdir 、fc-cache使字体生效
  • 编码问题

编码问题分为如下两方面

  1. Excel文件编码格式 Excel软件是可以选择用什么编码去保存文件的
    目前我们读取Eecel文件是用的服务器操作系统默认编码，可以通过在启动脚本里加入如-Dfile.encoding=UTF-8指定，详见 码云项目首页评论区讨论
  2. 生成html网页编码格式
    生成html网页也是用的服务器操作系统默认编码(java系统属性：sun.jnu.encoding)，比如用浏览器用手动更改编码格式为utf-8或gbk打开没有问题，但是用浏览器默认编码就有问题，此时可调整系统配置文件中的配置项converted.file.charset可解决此类乱码问题, 详见 编码配置

Q：Linux下运行startup.sh脚本报错：/bin/bash^M: bad interpreter: No such file or directory

A：一般为在Windows下用IDEA导入项目编译时，默认使用Windows(\r\n)下的文件换行符导致的，导入项目时设置默认换行符为Unix类操作系统换行符再编译即可（File->Settings->Editor->Code Style->Line separator 选择Unix and MacOs(\n)）

Q：Linux下启动项目后日志报错：org.artofsolving.jodconverter.office.OfficeException: office process died with exit code 127

A：操作系统缺少libXext.so.6包，请自行下载安装：
http://kkfileview.keking.cn/fonts.zip

Q：启动项目后日志报错：java.lang.IllegalStateException: a process with acceptString 'socket,host=127.0.0.1,port=8100' is already running; pid 26468

A：有正在运行的openoffice进程，kill掉相关进程再重新启动

Q：Windows系统下启动报错：Error creating bean with name 'cacheServiceRocksDBImpl'

A：本项目默认使用内嵌RocksDB存储引擎作缓存，需要以管理员身份运行，或配置使用其他缓存实现，详见：缓存配置

Q：如何水印文本内容动态传值

A：在预览url后面加上参数&watermarkTxt即可
例如：

var url = 'http://127.0.0.1:8080/file/test.txt'; //要预览文件的访问地址
window.open('http://127.0.0.1:8012/onlinePreview?url=' + encodeURIComponent(url) + '&watermarkTxt=' + encodeURIComponent('动态水印'));

Q：使用nginx代理时预览出现异常

A：一般是nginx和kkFileView配置有问题
例如nginx的访问地址为 https://file.keking.cn 想要使用
https://file.keking.cn/preview/来做预览，kkFileView部署在内网192.168.1.233服务器上，需要在nginx中添加反向代理如下：

location /preview {
    proxy_pass 192.168.1.233:8012;
}

修改kkFileView的配置文件如下两项

server.context-path = /preview
base.url = https://file.keking.cn/preview

使用如下地址来访问预览页面

var url = 'https://file.keking.cn/file/test.txt'; //要预览文件的访问地址
window.open('https://file.keking.cn/preview/onlinePreview?url='+encodeURIComponent(url));

Q：使用docker部署时如何指定配置文件中的配置项

A：针对docker运行的用户，所有配置项可以使用设置相应的环境变量来配置
环境变量的KEY为配置文件中每个配置项后${}中的KEY
例如，使用docker运行要指定base.url为http://file.keking.cn，docker运行命令如下

docker run -it -d -p 8012:8012 -e BASE_URL="http://file.keking.cn" keking/kkfileview:v2.2.1

Q：使用内网预览时没有问题，但是使用外网预览有问题

A：一般是公司网络使用的路由器不支持或没开启域内NAT，kkFileView无法通过外网地址下载要预览的文件
例如kkFileView部署在公司192.168.1.233服务器上，本地访问http://192.168.1.233:8012可以正常预览
公司运维把192.168.1.233的8012端口暴露到公网ip或域名(http://xxx.xxx.xxx:8012)，公网打首页也正常，但是预览就出错
这种一般是因为公司主路由器不支持或没开启域内NAT

预览展示

  • 文本预览


  • word文档预览

  • ppt文档预览

  • excel文档预览

  • 压缩文件预览

  • 多媒体文件预览

  • CAD文档预览

相关推荐

电脑bios有什么用（电脑bios能干什么）

电脑BIOS（基本输入输出系统）是计算机启动时运行的固件，它负责初始化计算机硬件，并提供操作系统加载所需的基本功能。BIOS主要功能包括：检测和配置硬件设备、加载操作系统、管理电源和温度、提供系统启动...

华硕电脑蓝屏怎么修复（华硕蓝屏怎么办）

华硕电脑蓝屏恢复的方法如下：安全模式进入系统。重启电脑后，连续按下F8键直至出现启动选项界面，选择安全模式进入系统，若此时能够正常运行，说明问题可能是由于软件冲突引起的。检查驱动程序兼容性。过于陈旧或...

win10教育版怎么改成专业版（win10最稳定三个版本）

一、首先，点击Windows10“开始”菜单，找到电脑应用列表，二、然后，在应用列表中找到“Windows系统”文件夹中找到“命令提示符”，点击打开。三、然后，系统跳转到“命令提示符”窗口。四、然后，...

ps下载官网（ps官网免费下载）

要从Adobe官网下载AdobePhotoshop（PS），可以按照以下步骤进行：1.打开网页浏览器，进入Adobe官网的主页。网址是：https://www.adobe.com。2.在网页的顶...

hiwifi极路由登录（hiwifi极路由设置）
  • hiwifi极路由登录（hiwifi极路由设置）
  • hiwifi极路由登录（hiwifi极路由设置）
  • hiwifi极路由登录（hiwifi极路由设置）
  • hiwifi极路由登录（hiwifi极路由设置）
连wifi就能打电话的软件（无卡用wifi打电话）

我的手机是安卓2.2系统所有这里只针对Android2.2系统其他系统版本的朋友可以试一试需要一款拨号软件：PPPOE拨号软件；而拨号软件必须要获得root权限（管理权限）才能拨号；下载安装这...

wifi优化大师下载（wifi优化软件）

1.设定-应用程序管理器-已下载-单击需要卸载的软件-卸载。2.点击最近应用程序键-进入任务管理器-已下载-点击""""卸载""""。3...

无网络单机游戏（好玩的无网络单机游戏）

一款能够让我们自由畅快的进行游戏的合集软件。在这个合集之中有着各种各样的单机小游戏。这些小游戏不需要联网就可以玩了，没有防沉迷系统，我们想玩多久就玩多久，合集之中小游戏的类型有很多种，有赛车类、射击类...

笔记本电脑推荐理由（推荐笔记本子）

配置落后散热出现问题是笔记本报废的主要原因因为旧电脑问题很多。一是现在新电脑价格不算贵，没必要用旧的，电脑可不兴新不如旧的说法；二是二手电脑是否大修过，是否有什么瑕疵，是否运行速度有问题，是否被人监控...

tplink设置向导（tp link路由器的设置向导）

tplink路由器首次设置时才会自动弹出向导，如果希望自动弹出，可先还原出厂设置，然后再登录即可自动弹出，还原出厂设置步骤如下：　　1、路由器开启电源；　　2、按下路由器表面的reset复位按钮，个别...

破解苹果激活锁的万能id（破解iphone id激活锁软件）

提前打开我的AppleID界面，点击管理您的账户。点击忘记AppleID，填写与AppleID相关的各项基本信息。通过电子邮件内的链接或回答安全问题，或者进行人工破解。1、登陆苹果官网，点击下面...

手机上不了wifi是什么原因（手机上不了网连不了wifi）

1.手机wifi已连接不可上网问题出现后首先检测一下是否为手机本身突发性的问题，可以进行关机重启一下再连接看是否还会出现这样的情况。或者使用其他手机或设备连接WiFi试试能否上网。2.如果不是手机的问...

桌面图标大小设置（怎么修改桌面图标大小设置）
  • 桌面图标大小设置（怎么修改桌面图标大小设置）
  • 桌面图标大小设置（怎么修改桌面图标大小设置）
  • 桌面图标大小设置（怎么修改桌面图标大小设置）
  • 桌面图标大小设置（怎么修改桌面图标大小设置）
win10有产品id没有密钥（win10 我没有产品密钥）

WIN10，在左下角输入WINDOWSPOWERSHELL,然后点击系统查询结果第一项，在弹出的窗口中输入：(Get-WmiObject-query‘select*fromSoftware...

win10截屏后找不到了（win10截屏后找不到了怎么办）

Win10系统截屏后没有更新通知并不是一个常见的问题。可能是由于系统设置或者安装的软件造成的。如果系统设置为静音或者禁用通知，那么截屏后不会有通知。另外，一些截屏软件可能会阻止系统通知，需要手动设置...

取消回复欢迎 你 发表评论:

一周热门
最近发表
标签列表
Copyright Your WebSite.Some Rights Reserved.