一般来讲,每个系统都有上传图片或者文件的功能,多个项目的上传文件这个功能基本上也都是差不多的,无非是限制上传的文件类型不一样,所有我们有必要开发一个统一的服务来满足公司 不同项目的上传文件的需求。
要满足不同项目的上传功能,大概有两种方法。第一种,各自项目前端还是要上传到对应的后端,后端统一上传到文件服务,这样的好处是可以利用各个项目的验证功能,缺点是项目后端还是有少许逻辑,而且从项目前端到对应后端,再从项目后端到上传服务,数据的传输多了一步。第二种,从各个项目的前端直接上传的上传服务,这种方式效率高,对应的后端也没什么逻辑,但是需要解决权限验证的问题,不然别人知道了你的上传服务地址,偷偷上传就不好了。
刚开始的时候,我使用第一种方式,效果不怎么好,就着手第二中方式的实现,第二中方式首先要解决的是验证的问题,还好现在有 api 验证的方式可以直接借鉴,所以我决定使用 jwt 来做权限验证。具体流程是这样的:项目前端调用本项目 api 获取 jwt,项目前端携带 jwt 直接把文件上传到上传服务,上传服务返回上传成功的 url 地址。 上传服务和项目后端都属于项目后端部分,这样就确保了 jwt 的加密是外人不可见的,思路我们想清楚了,现在就要开始细节的设计了。
首先是上传服务这边的功能配置,结合 appsettings.json,我们逐个说一下:
{
"AllowedHosts": "*",
"urls": "http://localhost:6001",
"uploadServer": {
"rootUrl": "http://localhost:6001",
"entryPoint1": "/upload",
"entryPoint2": "/chunkUpload",
"virtualPath": "",
"physicalPath": "/Users/loogn/Desktop/uploader",
"appendMimes": ".htm3:text/html;",
"responseCache": 604800,
"jwtSecret": "1234561234",
"limitSize": "20mb",
"allowExts": ".txt;.jpg;.jpeg;.png;.doc;.docx;.xls;.xlsx;.ppt;.pptx;.pdf",
"apps": {
"default": {
"allowOrigins": "",
"enableThumbnail": true,
"limitExts": ".exe;",
"thumbnailExts": ".jpg;.jpeg;.png;"
},
"app1": {
"allowOrigins": "*"
}
}
}
}
- rootUrl 是上传成功后文件 url 的基地址,如果作为静态文件服务器来提供对上传成功的文件的访问,那么这这里的地址应该和 urls 一样;如果上传成功的文件的访问由其他服务器提供(如 nginx),那么这里就是对应 nginx 的域名;
- entryPoint1 是一般上传的服务地址,完整地址是 urls+entryPoint1;
- entryPoint2 是分块上传的服务地址,完整地址是 urls+entryPoint2,分块上传需要 html5 的支持,对应的客户端类库是开源项目 simple-uploader ;
- virtualPath:作为静态文件服务器的时候,对应的项目目录;
- physicalPath:文件上传的本地目录;
- appendMimes: 作为静态文件服务器时,添加的 mime 类型映射;
- responseCache:作为静态文件服务器时,静态文件的缓存时间(秒);
- jwtSecret:jwt 的秘钥,各个项目后端要使用相同的秘钥加密获得 jwt;
- limitSize:默认限制大小,只能以 mb 或 kb 为单位结尾;
- allowExts : 默认允许上传的文件类型后缀
- apps: 该节点中是一个字典结构,key 是各个项目名称,value 是特定项目的特殊配置,其中 key 为 default 的所有项目的默认配置。
我们稍后再说 value 中的配置项,现在我们说一下 jwt。jwt 需要通过 header 或者 form 传给上传服务。
对 jwt 不清楚的同学可以看这里 jwt.io ,我们约定 payload 中有以下四项配置:
- exp 表示过期时间,utc 时间戳,必填
- app 表示项目名称,必填
- size 表示项目上传大小限制 ,支持 mb 和 kb 为单位,选填,可以覆盖 uploadServer.limitSize
- exts 表示该项目额外支持的文件类型,选填
由于 jwt 是项目后端发布的,所以项目后端有权限和义务做好相应的配置,比如 exp 过期时间,由于 jwt 发布出去之后无法收回,exp 就显得额外重要了,如果上传小文件,估计 1 分钟的时间就够了(前提是项目后端的时间和上传服务的时间一致),比如 exts 配置,如果该项目需要上传 mp4 文件,那么并不需要再上传服务器上修改配置,只需要再返回 jwt 的时候加入 exts:".mp4"就行了。
现在再说说上传服务的配置中 apps 子节点的配置:
- allowOrigins 允许上传的前台域名
- enableThumbnail 作文静态文件服务器时,是否启用生成缩率图功能
- limitExts 禁止的文件后缀,比如".exe",如果默认配置或 jwt 配置允许,这里是最后防线,所以项目可上传的后缀为 uploadServer.allowExts+jwt 中 exts-apps 中 limitExts
- thumbnailExts 启用缩率图时,可以应用的文件后缀,缩率图地址使用返回的 url 加?w=100&h=200 这样的地址访问。
项目地址:uploadServer
欢迎来到这里!
我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。
注册 关于