介绍

一个介于华为云OBS跟普通开发人员之间的一个文件上传框架，将常用能力进行了封装。
目的是让未曾接触过OBS的开发人员，无脑拖来就用，五分钟对接好，开发者无踩坑、也不会给团队里其他同事造坑。
从此无论本地存储、分布式存储、对象存储……都是完全一样的代码调用！它赋予你各种存储随便切换随便用的能力，而无需动项目代码。

场景

• 任何需要图片、附件上传的系统，需要做文件上传功能，需要拿来即用，不想自己踩坑的。
• 对系统要做分布式部署，要将图片、附件等自行上传产生的文件进行独立存放的。
• 传统方式存放在服务器上，使服务器带宽、磁盘产生不小的费用，需要大幅降低上云成本，将附件独立出来存储及提供高速访问的。
• 初创时业务量小，第一年选择将上传附件放在服务器本身，但考虑到后面可能会做大，做大时要将附件分离出去独立存储，但又不想去改系统代码的，可通过配置两个参数无缝切换。

架构

优势

• 无门槛 开发者无需花精力去查阅详细的文档及SDK，拿来即用，5分钟跑起来。给开发者继续深入探索的机会。
• bug修复 如果使用它时出现了bug，开发人员也无需去理会、跟踪，你只需要反馈上来，我们来统一修复。
• 高安全 数据持久性高达99.9999999999%、千万级并发、高可靠、不怕上传漏洞导致上传可执行文件、多区域自动备份保障数据安全。
• 低成本 大幅降低带宽、磁盘的费用。比如原本10M带宽，可能降到2M就够用了。原本200G数据盘，你都可以去掉数据盘，只用系统盘运行项目就能使用。

使用

1. 在普通Java项目中使用

1.1 pom.xml 中加入：

<!-- 文件上传相关的核心支持，是必须有的  -->
<dependency> 
    <groupId>cn.zvo.fileupload</groupId>
    <artifactId>fileupload-core</artifactId>
    <version>1.1</version>
</dependency>
<!-- 加入华为云OBS存储相关实现 -->
<dependency> 
	<groupId>cn.zvo.fileupload</groupId>
	<artifactId>fileupload-storage-huaweicloudOBS</artifactId>
	<version>1.0</version>
</dependency>

1.2 代码中使用

/**** 定义存储位置，存储到华为云OBS中 ****/
String key = "H0TPUBC6YDZWRxxxxxxx";	//华为云的 Access Key Id
String secret = "je56lHbJ62VOhoSXcsfI9InmPAtVY9xxxxxxxxxx";	//华为云的 Access Key Secret
String endpoint = "obs.cn-north-4.myhuaweicloud.com";	//华为云连接的地址节点,传入格式如 "obs.cn-north-4.myhuaweicloud.com" ,详细可参考 https://developer.huaweicloud.com/endpoint?OBS
String obsname = "cha-template";	//obs桶的名称
HuaweicloudOBSStorage obsStorage = new HuaweicloudOBSStorage(key, secret, endpoint, obsname);

/**** 创建文件上传工具对象 ****/
FileUpload fileUpload = new FileUpload();
fileUpload.setStorage(obsStorage);	//设置使用obs存储
//fileUpload.setMaxFileSize("10MB");	//设置最大上传大小为10MB，不设置默认是3MB
//fileUpload.setAllowUploadSuffix("jpg|zip|txt");	//设置允许上传的后缀名，不设置默认是一堆图片、压缩包、文档、音视频等常见后缀
//fileUpload.setDomain("http://cdn.yourdomain.com/");  //还可设置OBS绑定的域名或CDN加速域名，不设置默认返回的是obs桶自带域名的文件url

/**** 上传，这里上传一个文本文件，内容是 123456 ，将他保存到 桶 abc 目录下的 1.txt 文件 ****/
UploadFileVO vo = fileUpload.uploadString("abc/1.txt", "123456");
System.out.println(vo);	//打印结果

点此查看 cn.zvo.fileupload.storage.huaweicloudOBS.Demo.java 文件

2. 在SpringBoot项目中使用

2.1 pom.xml 中加入：

<!-- 文件上传相关的核心支持，是必须有的  -->
<dependency> 
    <groupId>cn.zvo.fileupload</groupId>
    <<artifactId>fileupload-core</artifactId>
    <version>1.1</version>
</dependency>
<!-- 加入华为云OBS存储相关实现 -->
<dependency> 
	<groupId>cn.zvo.fileupload</groupId>
	<artifactId>fileupload-storage-huaweicloudOBS</artifactId>
	<version>1.0</version>
</dependency>
<!-- 在 SpringBoot 框架中的快速使用。 （在不同的框架中使用，这里引入的framework.xxx也不同） -->
<dependency> 
    <groupId>cn.zvo.fileupload</groupId>
    <artifactId>fileupload-framework-springboot</artifactId>
    <version>1.1</version>
</dependency> 

2.2 参数配置

配置 application.properties (或yml)，加入：

# 文件上传 https://github.com/xnx3/FileUpload
#
# 设置允许上传的文件最大是多大，比如10MB 单位为 KB、MB ， 如果此项不设置，这里默认是3MB
fileupload.maxSize=10MB
# 设置允许上传的后缀名,传入格式如 png|jpg|gif|zip 多个用英文|分割。如果不设置，默认允许像是pdf、word、图片、音频、视频、zip等常用的且安全的文件后缀都可上传
fileupload.allowUploadSuffix=jpg|png|txt|zip
# 设置上传后文件所访问URL的域名，传入如： http://xxxx.com/  注意格式，后面以 / 结尾。这里结合CDN加速一起使用效果更佳
fileupload.domain=http://res.zvo.cn/
#
# 设置当前使用的是哪种存储方式
# 如果此不设置，默认使用的是本地存储的方式。如果设置了，pom.xml 文件中，记得将此存储方式引入进来，不然会报错找不到这个class文件
# 下面便是具体针对华为云obs这种存储方式的配置了
# 华为云的 Access Key Id
fileupload.storage.huaweicloudOBS.accessKeyId=H0TPUBC6YDZxxxxxxxx
# 华为云的 Access Key Secret
fileupload.storage.huaweicloudOBS.accessKeySecret=je56lHuJ62VOhoSXxsfI9InmPAtVY9xxxxxxx
# 区域，传入格式如 "obs.cn-north-4.myhuaweicloud.com" ,详细可参考 https://developer.huaweicloud.com/endpoint?OBS
fileupload.storage.huaweicloudOBS.endpoint=obs.cn-north-4.myhuaweicloud.com
# 桶的名称
fileupload.storage.huaweicloudOBS.obsname=cha-template

2.3 Java代码

建立一个Controller，其中加入：

/**
 * 文件上传
 */
@RequestMapping(value="upload.json", method= {RequestMethod.POST})
@ResponseBody
public UploadFileVO uploadImage(@RequestParam("file") MultipartFile multipartFile){
	//将文件上传到 upload/file/ 文件夹中
	return fileUpload.uploadImage("upload/file/", multipartFile);
}

/**
 * 文件下载
 * @param path 要下载的文件，传入如 upload/file/123.zip
 */
@RequestMapping(value="download")
public void download(String path, HttpServletResponse response){
	FileUploadUtil.download(path, response);
}

2.4 前端html代码

src/main/resources/static/ 下增加一个 upload.html 的文件，目的是能使用 localhost:8080/upload.html 就能访问到。 其内容为：

选择要上传的文件（可以传个图片试试）：<br/>
<input type="file" name="file"/><button onclick="upload();">上传</button>

<script src="http://res.zvo.cn/request/request.js"></script><!-- 文件上传，开源地址 https://github.com/xnx3/request -->
<script>
function upload(){
	var file = document.getElementsByName('file')[0].files[0];	 //要上传的文件
	request.upload('/upload.json', {}, file, function(data){  //执行上传操作
		console.log(data);
		if(data.result == '1'){
			// 上传成功
		}else{
			// 上传出错，可弹出失败提示 ： data.info
		}
	});
}
</script>

2.5 运行起来，测试一下

访问 http://localhost:8080/upload.html 即可进行测试体验了。
另外也可参见 demo_springboot/README.md 直接将这个demo_springboot项目拉下来，无需任何修改直接运行即可访问使用

案例

有哪些线上项目在使用它？

• wangmarket CMS
• 网页全自动翻译js组件服务端文件缓存层
• 家乡味道小程序
• 东营凯通汽车售后系统
• 鸿音翻译销售线索管理系统
• 朵妍秀供销商在线订货系统
• 租号侠游戏账号租赁app
• 神武传感器在线订货系统
• 天聚充电桩物联网系统
• ......

交流

如果您在使用过程中遇到任何异常情况，可在此提 Issues， 请详细说一下您遇到的问题。如果可以，请尽可能描述的详细一些，以便我们可以更全面地测试，以便快速找到问题所在