Spring Boot 实现万能文件在线预览-开源学习一
Spring Boot 实现万能文件在线预览-开源学习一
1. 项目特性
- 支持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镜像发行包,方便在容器环境部署
- 抽象预览服务接口,方便二次开发,非常方便添加其他类型文件预览支持
- 最最重要Apache协议开源,代码pull下来想干嘛就干嘛
2. 官网及文档
地址:https://kkfileview.keking.cn
3. 在线体验
地址:https://file.keking.cn/index
4. 项目文档(Project documentation)
- 详细wiki文档:https://gitee.com/kekingcn/file-online-preview/wikis/pages
- 中文文档:https://gitee.com/kekingcn/file-online-preview/blob/master/README.md
- English document:https://gitee.com/kekingcn/file-online-preview/blob/master/README.en.md
5. 部署指南
5.1 环境要求
- Java: 1.8+
- OpenOffice或LiberOffice(Windows下已内置,CentOS或Ubuntu下会自动下载安装,MacOS下需要自行安装)
5.2 部署运行
5.2.1物理机或虚拟机上运行
- 从 码云发行版本 下载最新版发行包
- 解压kkFileView-x.x.x文件(Windows用.zip包,Linux/MacOS用.tar.gz包)
- 打开解压后文件夹的bin目录,运行startup脚本(Windows下以管理员身份运行
startup.bat
,Linux以root用户运行startup.sh
) - 浏览器访问本机8012端口 http://127.0.0.1:8012 即可看到项目演示用首页
5.2.2 Docker容器环境环境运行
- 拉取镜像
docker pull keking/kkfileview
- 运行
docker run -it -p 8012:8012 keking/kkfileview
- 浏览器访问容器8012端口
http://xxx.xxx.xxx.xxx:8012
即可看到项目演示用首页
5.3 项目接入使用
当您的项目内需要预览文件时,只需要调用浏览器打开本项目的预览接口,并传入须要预览文件的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));
6. 使用指南
当您的项目内需要预览文件时,只需要调用浏览器打开本项目的预览接口,并传入须要预览文件的url。
注意,如果要预览的url里包含需要转义的特殊字符,如下表格,请使用encodeURIComponent(url)转义
符号 | url中转义结果 | 转义码 |
---|---|---|
+ | URL 中+号表示空格 | %2B |
空格 | URL中的空格可以用+号或者编码 | %20 |
/ | 分隔目录和子目录 | %2F |
? | 分隔实际的URL和参数 | %3F |
% | 指定特殊字符 | %25 |
# | 表示书签 | %23 |
& | URL 中指定的参数间的分隔符 | %26 |
= | URL 中指定参数的值 | %3D |
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(url)));
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(url));
2. http/https下载流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 = '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. FTP下载url预览 #
1). FTP匿名访问 #.-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服务器,只需要在配置文件中 配置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服务器)
如果预览服务要访问多台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));
7 配置说明
打开conf目录,下面有一个application.properties配置文件,有部分配置是可以在程序运行中变更的,其他的变更需要重新启动程序
不可动态配置,需要重启生效部分 #
server.context-path #
说明:kkFileView运行时tomcat的ServletContext 默认值:/
示例:server.context-path = /preview
file.dir #
说明:预览文件存储路径,当有大量文件要预览时需要保证该目录所在磁盘有足够的容量
默认值:程序根目录下的file目录下
示例:file.dir = D:\\kkFileview\\
office.home #
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 #
可在运行时动态改变部分 #
base.url #
location /preview {proxy_pass 192.168.1.233:8012;
}
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 #
simText #
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 #
watermark.txt #
默认水印内容,如需取消水印,内容设置为空即可,例如:watermark.txt = ${WATERMARK_TXT:}
默认值:‘’
watermark.x.space #
watermark.y.space #
watermark.font #
watermark.fontsize #
watermark.color #
watermark.alpha #
水印透明度,要求设置在大于等于0.005,小于1
默认值:0.2
watermark.width #
watermark.height #
watermark.angle #
8. 文档预览效果
1. 文本预览
支持所有类型的文本文档预览, 由于文本文档类型过多,无法全部枚举,默认开启的类型如下 txt,html,xml,properties,md,java,py,c,cpp,sql
如有没有未覆盖全面,可通过配置文件 指定文本类型
文本预览效果如下
2. 图片预览
支持jpg,jpeg,png,gif等图片预览(翻转,缩放,镜像),预览效果如下
3. word文档预览
支持doc,docx文档预览,word预览有两种模式:一种是每页word转为图片预览,另一种是整个word文档转成pdf,再预览pdf。两种模式的适用场景如下
- 图片预览:word文件大,前台加载整个pdf过慢
- pdf预览:内网访问,加载pdf快
默认为每页word转为图片预览,可通过点击右边的pdf图标转,也可通过配置文件 设置默认预览模式
图片预览模式预览效果如下
pdf预览模式预览效果如下
4. ppt文档预览
支持ppt,pptx文档预览,和word文档一样,有两种预览模式
图片预览模式预览效果如下
pdf预览模式预览效果如下
5. pdf文档预览
支持pdf文档预览,和word文档一样,有两种预览模式
图片预览模式预览效果如下
pdf预览模式预览效果如下
6. excel文档预览
支持xls,xlsx文档预览,预览效果如下
ps,如碰到excel预览乱码问题,可参考 预览乱码
7. 压缩文件预览
支持zip,rar,jar,tar,gzip等压缩包,预览效果如下
可点击压缩包中的文件名,直接预览文件,预览效果如下
8. 多媒体文件预览
理论上支持所有的视频、音频文件,由于无法枚举所有文件格式,默认开启的类型如下
mp3,wav,mp4,flv
如有没有未覆盖全面,可通过配置文件指定多媒体类型
视频预览效果如下
音频预览效果如下
9 .局部代码实现细节
Spring Boot 实现万能文件在线预览-开源学习一相关推荐
- 上班第一天公司要你用Spring Boot 实现万能文件在线预览
欢迎关注方志朋的博客,回复"666"获面试宝典 推荐一个用 Spring Boot 搭建的文档在线预览解决方案:kkFileView,一款成熟且开源的文件文档在线预览项目解决方案, ...
- Spring Boot 实现万能文件在线预览
推荐一个用 Spring Boot 搭建的文档在线预览解决方案:kkFileView,一款成熟且开源的文件文档在线预览项目解决方案,对标业内付费产品有永中office.office365.idocv等 ...
- Spring Boot 实现万能文件在线预览,已开源,真香!!
点击上方"Java基基",选择"设为星标" 做积极的人,而不是积极废人! 每天 14:00 更新文章,每天掉亿点点头发... 源码精品专栏 原创 | Java ...
- SpringBoot实现万能文件在线预览,已开源,真香!!!
欢迎关注方志朋的博客,回复"666"获面试宝典 推荐一个用Spring Boot搭建的文档在线预览解决方案: kkFileView,一款成熟且开源的文件文档在线预览项目解决方案,对 ...
- SpringBoot 实现万能文件在线预览,已开源,支持offcie、office365等,真香!!
大家好,我是东哥. 推荐一个用 Spring Boot 搭建的文档在线预览解决方案:kkFileView,一款成熟且开源的文件文档在线预览项目解决方案,对标业内付费产品有永中office.office ...
- 从零开始用SpringBoot 搭了一套万能文件在线预览系统,我觉的挺好用!
来源:https://www.cnblogs.com/itfly8/p/4967966.html 推荐一个用 Spring Boot 搭建的文档在线预览解决方案:kkFileView,一款成熟且开源的 ...
- 万能文件在线预览项目,开源!
支持 20 多种主流格式的文件在线浏览,这个项目值得学习. 编程导航开源仓库:https://github.com/liyupi/code-nav 大家好,我是鱼皮,今天分享一个优秀的.100% 开源 ...
- SpringBoot 实现万能文件在线预览,已开源!!!
以下内容来自公众号逆锋起笔,关注每日干货及时送达
- kkfileview v2.0 发布,文件在线预览项目方案
kkfileview文件在线预览 此项目为文件文档在线预览项目解决方案,项目使用流行的spring boot搭建,易上手和部署,部署好后可以独立提供预览服务,使用http接口访问,不需要和应用集成,具 ...
最新文章
- Oracle 常用语句
- SparkStreaming “Could not read data from write ahead log record” 报错分析解决
- Windows 7 任务栏开发 之 进度条(Progress Bar)
- 多线程的那点儿事(之多核编程)
- ubuntu下rar文件解压后文件名乱码的解决方案
- 【渝粤教育】10763k2_客户服务管理_21秋考试
- 欠的债,这一次都还给你们
- 如何自学生物信息学:从菜鸟到专家
- 计算机文献检索语言,计算机文献检索论文参考文献集 计算机文献检索论文参考文献数量是多少...
- 智慧水务ZWS云平台方案,共促水务行业数字化建设
- c语言实验总结200字,数控毕业生自我鉴定200字(精选3篇)
- 如何设置QQ和微信截图快捷键
- weedfs php,Weed-FS之Volume数据迁移
- 毕设 数据库ER图绘制过程中的参考资料
- CVPR 2022 论文列表(持续更新)
- A Survey: Visual Place Recognition 视觉场景识别的一篇调研
- 去别人家做客脚臭尴尬,但是现在用了爱锝就好了 !
- 电视盒子显示服务器未连接,你家的电视盒子直播总是卡,解决方法全都在这里...
- 2019年12月PAT甲级 第一题 Good in C(1164)题解
- Android插件中使用EventBus出现java.lang.IllegalArgumentException: Expected receiver of type xxx, but got xx
热门文章
- 坦克大战--Java类型 ---- (3)实现socket通信
- Centos7 编译安装Nginx
- Zipline推出基于Lua跨平台游戏中间件Moai
- 看这家大型国有企业的如何寻找与突破数字化?实现利益新的增长点
- VMware10 安装黑苹果步骤以及遇到的问题
- 淘宝案例、防抖和节流
- No qualifying bean of type ‘com.alibaba.dubbo.config.ApplicationConfig‘ available: expected at least
- [转载]面试官你也伤不起啊!
- 应用服务器巡检,服务器巡检-常规检查项
- 太极博弈原理学生读后感之先归宗再演化