fastDFS文件服务客户端gomyck-fastdfs-spring-boot-starter

完美集成fastDFS文件服务客户端, 支持断点续传, 分块上传, 文件秒传, 稳定的前后端组件(前端H5), 支持多用户并发上传文件校验(文件锁), 可以快速集成fastDFS文件服务, 免去繁琐的配置, 拿来即用, 目前暂时仅支持springboot开发环境

开始使用

一.环境配置

1.在pom文件中加入仓库地址: (后续会有maven中央仓库版本发布)

<repositories>
 <repository>
 <id>gomyck-repo</id>
 <name>Gomyck proxy Ali</name>
 <url>http://nexus.gomyck.com/nexus/content/repositories/gomyck-repo/</url>
 </repository>
 
 <!-- 快照版本更新频繁, 如不想和作者保持同步, 请删除下面仓库地址并使用release版本: 1.0.1-release -->
 <repository>
 <id>gomyck-repo-snapshot</id>
 <name>Gomyck proxy Ali Snapshot</name>
 <url>http://nexus.gomyck.com/nexus/content/repositories/gomyck-repo-snapshot/</url>
 <snapshots>
 <enabled>true</enabled>
 <updatePolicy>always</updatePolicy>
 </snapshots>
 </repository>
</repositories>

2.在pom文件中加入依赖:

<dependency>
 <groupId>com.gomyck</groupId>
 <artifactId>gomyck-fastdfs-spring-boot-starter</artifactId>
 <version>1.0.2-SNAPSHOT</version>
</dependency>

3.编辑yml文件(以下为全量配置):

#单个文件上传大小限制
spring:
 servlet:
 multipart:
 max-file-size: 5000MB
#fastdfs客户端配置
fdfs:
 connect-timeout: 1601
 thumb-image:
 width: 150
 height: 150
 pool:
 jmx-name-prefix: 1
 jmx-name-base: 1
 max-wait-millis: 102
 tracker-list: 
 - 192.168.1.1:22122 #fastdfs服务地址
 so-timeout: 1501
pool:
 max-total: 153
gomyck:
 config:
 redis: true #是否使用redis存储文件上传信息以及上传锁
 redis:
 host: 127.0.0.1 
 password: xxxxx
 port: 6379
 fastdfs: #fastdfs上传配置
 chunk-size: 5 #分块大小, 上传文件分块的大小 单位: MB
 download-chunk-size: 100 #分块下载大小 单位: byte
 group-id: group1 #fastdfs的组, 文件会被存到这个组下
 file-server-protocol: http #远程文件服务连接协议
 file-server-url: 192.168.1.196 #远程文件服务连接地址

4.在静态资源映射表中加入以下配置

@Configuration
public class config extends WebMvcConfigurationSupport {
 @Override
 protected void addResourceHandlers(ResourceHandlerRegistry registry) {
 registry.addResourceHandler("ck-fastdfs/**").addResourceLocations("classpath:/META-INF/resources/ck-fastdfs/");
 registry.addResourceHandler("ck-util/**").addResourceLocations("classpath:/META-INF/resources/ck-util/");
 registry.addResourceHandler("ck-3pty/**").addResourceLocations("classpath:/META-INF/resources/ck-3pty/");
 super.addResourceHandlers(registry);
 }
}

5.启动服务, 访问示例页面: host{:port}/{contextPath/}ck-fastdfs/view/ckFastDFS.html (可以渲染表示环境配置成功)

二.开发文档

本项目后端服务不在文档说明范围内, 高玩可以自行阅读修改, 只针对前端JS的使用做说明注释

1.在需要开发文件上传的页面(你的业务页面), 引入js:

host{:port}/{contextPath/}/ck-3pty/jquery/jquery-core.min.js

host{:port}/{contextPath/}/ck-fastdfs/js/webuploader.nolog.js

host{:port}/{contextPath/}/ck-fastdfs/js/ckFastDFS.js

2.开发文档

1.实例化前端上传实例:

const option = {
 //config something.....
};
const cfd = new CkFastDFS(option);

每个实例可以绑定多个上传按钮, 支持id选择器, 类选择器等jq插件支持的选择器类型

多实例存在的场景: 多个文件服务分组, 当不同的按钮上传文件到不同分组时, 可能需要页面多实例来处理

2.option参数说明:

{ 
 baseURI: "../../", //后端服务URI(包括上下文) (非必填)
 fastDFSGroup: "group1", //文件上传至fastdfs的组名 (非必填)
 uploaderConfig: {}, //webUploader配置 (非必填)
 uploadButton: { //按钮配置 (必填)
 buttonId: "#btn1", //选择器 (必填), 支持jq插件所支持的所有selector类型
 multiple: true //是否允许多文件选择 (非必填, 默认false)
 },
 uploadProgressBar: { //进度条 (非必填)
 changeBar: function (refer, file, progressVal) { //文件上传中, 进度改变时会触发该方法 
 console.log("进度条改变: " + refer + "|||" + file.id + "|||" + progressVal);
 }
 },
 uploadListener: { //上传监听(非必填) 
 
 // 参数说明: 
 // refer:点击上传的按钮jq对象 
 // file:上传的文件 
 // result:后端服务返回的结果
 // reason:错误类型, 通常为字符串: server
 
 //添加文件信息
 appendFileInfo: function (refer, file) {
 console.log("选择文件: " + refer + "|||" + file.id);
 },
 //添加到上传队列之前
 beforeAppendFileInQueued: function (refer, file) {
 console.log("添加到队列之前: " + refer + "|||" + file.id);
 return true;
 },
 //开始上传
 beginUpload: function (refer, file) {
 console.log("开始上传: " + refer + "|||" + file.id);
 },
 //分块上传成功
 chunkUploadSuccess: function (refer, file, result) {
 console.log("分块上传成功:" + refer + "|||" + file.id + "|||" + JSON.stringify(result))
 },
 //上传出错
 uploadError: function (refer, file, reason) {
 console.log("上传失败: " + refer + "|||" + file.id + "|||" + reason);
 },
 //上传成功
 uploadSuccess: function (refer, file, result) {
 console.log("上传成功: " + refer + "|||" + file.id + "|||" + JSON.stringify(result));
 },
 //上传完成(不管上传成功失败, 都会触发该方法)
 uploadComplete: function (refer, file) {
 console.log("上传完成: " + refer + "|||" + file.id);
 },
 //全局错误
 error: function (type, tips) {
 console.log("全局错误: " + type + "|||" + tips)
 }
 }
}

3.实例函数说明:

cfd.addButton(selector); //向实例中添加按钮
cfd.pauseUpload(param); //暂停上传 param 为布尔值时, 为暂停正在上传的文件, file类型时, 暂停指定file的上传, null|undefined时为全部暂停
cfd.cancleUpload(file); //取消指定文件的上传

4.其他说明

1. 如何在自己的项目中添加fastdfs客户端实例:
2. 使用@Autowired即可注入以下接口实例
3. TrackerClient - TrackerServer接口
4. GenerateStorageClient - 一般文件存储接口 (StorageServer接口)
5. FastFileStorageClient - 为方便项目开发集成的简单接口(StorageServer接口)
6. AppendFileStorageClient - 支持文件续传操作的接口 (StorageServer接口)
7. 如何扩展前端js:
8. 请参考类:CkFastDFS.js
9. 请参考webUploader官网API
10. 当然, 你也可以fork master分支代码, 打包后供他人使用(修改后的分支代码, pom文件中的parent请删掉, 并手动指定依赖版本, 否则可能会出现版本不一致问题)