Spring Boot項目中實現(xiàn)文件上傳功能的示例

更新時間：2020年12月08日 11:41:54 作者：風起青萍末

這篇文章主要介紹了Spring Boot項目中實現(xiàn)文件上傳功能,本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下

在實際項目中，文件上傳是很多項目必不可少的一個功能。那么在 Spring Boot 項目中又是如何來實現(xiàn)文件上傳功能的呢？一般來說，上傳的文件可以保存到項目根目錄下的某一文件夾中，但這樣做顯然是不太合適的。因此我們選擇將文件上傳到專門的文件服務器中。很多云計算廠商都提供文件存儲服務。這里我選擇的是阿里云的對象存儲(OSS)。

一、配置OSS

1. 導入SDK

首先，你需要注冊阿里云的賬號并開通對象存儲服務。在準備工作完成之后，需要導入 JAVA 版本的 SDK，這里使用 maven 進行導入

<!-- 阿里云OSS對象存儲 -->
<dependency>
	<groupId>com.aliyun.oss</groupId>
	<artifactId>aliyun-sdk-oss</artifactId>
	<version>3.8.0</version>
</dependency>

2. 修改配置文件

導入完成后在 application.properties 配置文件中添加以下內(nèi)容

# 節(jié)點域名
aliyun.oss.endpoint=oss-cn-xxxxxxx.aliyuncs.com
# 賬戶id
aliyun.oss.accessKeyId=xxxxxxxxxxxxx
# 賬戶密碼
aliyun.oss.accessKeySecret=xxxxxxxxxxxxx
# bucket名稱
aliyun.oss.bucketName=xxxxxxxxxxx
# 簽名過期時間
aliyun.oss.policy.expire=300
# 上傳文件的最大尺寸
aliyun.oss.maxSize=10
# 上傳地址的前綴
aliyun.oss.dir.prefix=xxx
# 回調(diào)參數(shù)的請求地址
aliyun.oss.callback=http://www.xxxxxx.com/api/aliyun/oss/callback

以上內(nèi)容在開通服務后均可獲取到，請根據(jù)實際情況進行修改

3. 初始化

OSSClient是OSS的Java客戶端，用于管理存儲空間和文件等OSS資源。使用Java SDK發(fā)起OSS請求，您需要初始化一個OSSClient實例，并根據(jù)需要修改ClientConfiguration的默認配置項。

根據(jù)官方文檔的描述，需要初始化一個ossClient實例并將其注入到Spring容器中，因此可以編寫一個配置類OssConfig

@Configuration
@PropertySource(value = {"classpath:application.properties"}, encoding = "utf-8")
public class OssConfig {

 @Value("${aliyun.oss.endpoint}")
 private String endpoint;

 @Value("${aliyun.oss.accessKeyId}")
 private String accessKeyId;

 @Value("${aliyun.oss.accessKeySecret}")
 private String secretAccessKey;

 @Bean
 public OSS ossClient(){
 return new OSSClientBuilder().build(endpoint, accessKeyId, secretAccessKey);
 }
}

更多詳細的配置，請參考官方文檔：初始化

二、文件上傳

1. 流程分析

我們以典型的表單上傳為例，在使用對象存儲OSS后，表單上傳分為以下幾個流程：

注：Policy表單域用于驗證請求的合法性。例如可以指定上傳的大小，可以指定上傳的Object名稱等，上傳成功后客戶端跳轉(zhuǎn)到的URL，上傳成功后客戶端收到的狀態(tài)碼。

PolicyConditions policyConds = new PolicyConditions();
policyConds.addConditionItem(PolicyConditions.COND_CONTENT_LENGTH_RANGE, 0, maxSize);
policyConds.addConditionItem(MatchMode.StartWith, PolicyConditions.COND_KEY, DIR_PREFIX);
String postPolicy = ossClient.generatePostPolicy(expiration, policyConds);
byte[] binaryData = postPolicy.getBytes(StandardCharsets.UTF_8);
// 將Policy字符串進行base64編碼
String policy = BinaryUtil.toBase64String(binaryData);
// 用OSS的AccessKeySecret對base64編碼后的Policy進行簽名
String signature = ossClient.calculatePostSignature(postPolicy);

前端向OSS服務器上傳文件時要上傳Policy表單域，OSS服務器將對Policy表單域的內(nèi)容進行驗證。關(guān)于 Post Policy 的詳細內(nèi)容，請參考官方文檔：Post Policy

當文件上傳成功后，OSS服務器會向應用服務器發(fā)起回調(diào)請求，具體流程如下：

用戶只需要在發(fā)送給 OSS 的請求中攜帶相應的 Callback 參數(shù)，即能實現(xiàn)回調(diào)。

Callback 參數(shù)是由一段經(jīng)過 base64 編碼的 JSON 字符串（字段）。構(gòu)建 callback 參數(shù)的關(guān)鍵是指定請求回調(diào)的服務器 URL（callbackUrl）以及回調(diào)的內(nèi)容（callbackBody）。

// 上傳回調(diào)參數(shù)
Callback callback = new Callback();
// 指定請求回調(diào)的服務器URL
callback.setCallbackUrl(CALLBACK);
//（可選）設(shè)置回調(diào)請求消息頭中Host的值，即您的服務器配置Host的值。
// callback.setCallbackHost("yourCallbackHost");
// 設(shè)置發(fā)起回調(diào)時請求body的值。
callback.setCallbackBody("{\\\"filename\\\":${object},\\\"mineType\\\":${mimeType}}");
// 設(shè)置發(fā)起回調(diào)請求的Content-Type。
callback.setCalbackBodyType(Callback.CalbackBodyType.JSON);
// 設(shè)置發(fā)起回調(diào)請求的自定義參數(shù)，由Key和Value組成，Key必須以x:開始。
// callback.addCallbackVar("x:dir", "value");

更詳細的內(nèi)容請閱讀官方文檔：Callback

2. 功能實現(xiàn)

首先編寫 Post Policy 封裝對象OssPolicyResult

@Data
public class OssPolicyResult {

	@ApiModelProperty("用戶id")
	private String accessKeyId;
	
	@ApiModelProperty("Post Policy經(jīng)過base64編碼過的字符串")
 private String policy;
	
	@ApiModelProperty("對policy簽名后的字符串")
 private String signature;

	// @ApiModelProperty("對象的鍵值")
	// private String key;
	
	@ApiModelProperty("上傳文件夾路徑前綴")
 private String dir;
	
	@ApiModelProperty("oss對外服務的訪問域名")
 private String host;

	@ApiModelProperty("上傳成功后的回調(diào)設(shè)置")
	private String callback;
}

然后需自定義一個回調(diào)結(jié)果對象OssCallBackResult

@Data
public class OssCallBackResult {

 @ApiModelProperty("文件的鏈接")
 private String url;
 @ApiModelProperty("文件名稱")
 private String filename;
 @ApiModelProperty("文件大小")
 private String size;
 @ApiModelProperty("文件的mimeType")
 private String mimeType;
 @ApiModelProperty("圖片文件的寬")
 private String width;
 @ApiModelProperty("圖片文件的高")
 private String height;
}

注：以上內(nèi)容可根據(jù)實際需要進行修改

之后編寫 Service 接口及實現(xiàn)類

Service 接口：

public interface OssService {
	
 // 生成Post Policy
	OssPolicyResult policy();
	
 // 上傳成功后的回調(diào)
	OssCallBackResult callback(Map<String, Object> requestBody);
}

Service 實現(xiàn)類：

@Slf4j
@Service
@PropertySource(value = {"classpath:application.properties"}, encoding = "utf-8")
public class OssServiceImpl implements OssService {

	@Value("${aliyun.oss.endpoint}")
	private String ENDPOINT;

	@Value("${aliyun.oss.accessKeyId}")
	private String ACCESS_KEY_ID;

	@Value("${aliyun.oss.accessKeySecret}")
	private String SECRET_ACCESS_KEY;

	@Value("${aliyun.oss.bucketName}")
	private String BUCKET_NAME;

	@Value("${aliyun.oss.policy.expire}")
	private int EXPIRE;

	@Value("${aliyun.oss.maxSize}")
	private int MAX_SIZE;

	@Value("${aliyun.oss.dir.prefix}")
	private String DIR_PREFIX;

	@Value("${aliyun.oss.callback}")
	private String CALLBACK;

	@Autowired
	private OSS ossClient;

	@Override
	public OssPolicyResult policy() {
		OssPolicyResult result = new OssPolicyResult();
		// 簽名有效期
		long expireEndTime = System.currentTimeMillis() + EXPIRE * 1000;
		Date expiration = new Date(expireEndTime);
		// 文件名稱
		// String filename = UUID.randomUUID().toString();
		// 文件大小
		long maxSize = MAX_SIZE * 1024 * 1024;
		// 提交節(jié)點
		String action = "http://" + BUCKET_NAME + "." + ENDPOINT;
		// 上傳回調(diào)參數(shù)
		Callback callback = new Callback();
		// 指定請求回調(diào)的服務器URL
		callback.setCallbackUrl(CALLBACK);
		//（可選）設(shè)置回調(diào)請求消息頭中Host的值，即您的服務器配置Host的值。
		// callback.setCallbackHost("yourCallbackHost");
		// 設(shè)置發(fā)起回調(diào)時請求body的值。
		callback.setCallbackBody("{\\\"filename\\\":${object}}");
		// 設(shè)置發(fā)起回調(diào)請求的Content-Type。
		callback.setCalbackBodyType(Callback.CalbackBodyType.JSON);
		// 設(shè)置發(fā)起回調(diào)請求的自定義參數(shù)，由Key和Value組成，Key必須以x:開始。
		// callback.addCallbackVar("x:dir", "value");
		try {
			PolicyConditions policyConds = new PolicyConditions();
			policyConds.addConditionItem(PolicyConditions.COND_CONTENT_LENGTH_RANGE, 0, maxSize);
			policyConds.addConditionItem(MatchMode.StartWith, PolicyConditions.COND_KEY, DIR_PREFIX);
			String postPolicy = ossClient.generatePostPolicy(expiration, policyConds);
			byte[] binaryData = postPolicy.getBytes(StandardCharsets.UTF_8);
 // 將Policy字符串進行base64編碼
			String policy = BinaryUtil.toBase64String(binaryData);
 // 用OSS的AccessKeySecret對base64編碼后的Policy進行簽名
			String signature = ossClient.calculatePostSignature(postPolicy);
 // 將callback配置進行base64編碼
			String callbackData = BinaryUtil.toBase64String(OSSUtils.jsonizeCallback(callback).getBytes());
			// 返回結(jié)果
			result.setAccessKeyId(ACCESS_KEY_ID);
			result.setPolicy(policy);
			result.setSignature(signature);
			// result.setKey(filename);
			result.setDir(dir);
			result.setHost(action);
			result.setCallback(callbackData);
		} catch (Exception e) {
			log.error("簽名生成失敗", e);
		}
		return result;
	}

	@Override
	public OssCallBackResult callback(Map<String, Object> requestBody) {
		OssCallBackResult ossCallbackResult = new OssCallBackResult();
		// 文件名
		String filename = requestBody.get("filename").toString();
		// 文件鏈接
		String url = "https://" + BUCKET_NAME + "." + ENDPOINT + "/" + DIR_PREFIX + "/" + filename;
		ossCallbackResult.setUrl(url);
		return ossCallbackResult;
	}
}

添加 Controller 層：

@Api(tags = "阿里云對象存儲接口")
@RequestMapping("/api")
@RestController
public class OssController {
	
	@Autowired
	private OssService ossService;
	
	@ApiOperation(value = "OSS上傳簽名生成")
	@GetMapping("/aliyun/oss/policy")
	public Object policy() {
		return ossService.policy();
	}

	@ApiOperation(value = "OSS上傳成功回調(diào)")
	@PostMapping("/aliyun/oss/callback")
	public Object callback(@RequestBody Map<String, Object> requestBody) {
		return ossService.callback(requestBody);
	}
}

到此這篇關(guān)于Spring Boot項目中實現(xiàn)文件上傳功能的示例的文章就介紹到這了,更多相關(guān)Spring Boot實現(xiàn)文件上傳內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: