蒼穹外賣-阿里云OSS文件上傳
- 一、阿里云OSS簡介
- **獲取AccessKey
- **獲取enpoint
- 二、代碼實現
- 1 引入依賴
- 2 定義OSS相關配置
- 2.1 application-dev.yml
- 2.2 application.yml
- 3 讀取OSS配置
- 3.1 AliOssProperties
- 4 生成OSS工具類對象
- 4.1 AliOssUtil
- 4.2 OssConfiguration
- 2.5 CommonController
- 三、測試文件上傳功能
- 1 直接在阿里云OSS上上傳文件
- 2 前后端聯調測試
參考:蒼穹外賣–圖片存儲第三方的存儲服務(阿里云OSS)開通+代碼實現
一、阿里云OSS簡介
? 阿里云對象存儲服務(Object Storage Service,簡稱OSS)提供基于網絡的數據存取服務。使用OSS,您可以通過網絡隨時存儲和調用包括文本、圖片、音頻和視頻等在內的各種非結構化數據文件。
阿里云OSS將數據文件以對象(object)的形式上傳到存儲空間(bucket)中。
創建的Bucked讀寫權限設置為”公共讀“
**獲取AccessKey
鼠標放到右上角頭像處
在創建AccessKey時會提示保存,保存為csv形式生成文件內容如下:
**獲取enpoint
二、代碼實現
1 引入依賴
<dependency><groupId>com.aliyun.oss</groupId><artifactId>aliyun-sdk-oss</artifactId><version>3.15.1</version>
</dependency>
2 定義OSS相關配置
2.1 application-dev.yml
sky:alioss:endpoint: oss-cn-beijing.aliyuncs.comaccess-key-id: LTAI5tSpSBjz8VCWKLG18eNVaccess-key-secret: dnORZm3ofD63gsS8xnQvqgCES2Z58Abucket-name: sky-jyx
創建和datasource同級的alioss。
2.2 application.yml
spring:profiles:active: dev #設置環境
sky:alioss:endpoint: ${sky.alioss.endpoint}access-key-id: ${sky.alioss.access-key-id}access-key-secret: ${sky.alioss.access-key-secret}bucket-name: ${sky.alioss.bucket-name}
3 讀取OSS配置
3.1 AliOssProperties
在sky-common模塊中,已定義。
package com.sky.properties;import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;/*** 阿里云配置實體類*/
@Component
/*請注意,為了使用@ConfigurationProperties注解,你需要在Spring Boot應用程序中啟用配置綁定功能。
你可以通過在主應用程序類上添加@EnableConfigurationProperties注解來實現。*/
@ConfigurationProperties(prefix = "sky.alioss")
@Data
public class AliOssProperties {private String endpoint; //表示OSS服務的訪問域名。private String accessKeyId; //表示訪問OSS服務所需的Access Key ID。private String accessKeySecret; //表示訪問OSS服務所需的Access Key Secret。private String bucketName; //表示要操作的存儲桶名稱。}
4 生成OSS工具類對象
4.1 AliOssUtil
在common中已經定義了這個util。
package com.sky.utils;import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import java.io.ByteArrayInputStream;/*** AliOssUtil類是一個包含文件上傳功能的工具類。*/
@Data
@AllArgsConstructor
@Slf4j
public class AliOssUtil {private String endpoint;private String accessKeyId;private String accessKeySecret;private String bucketName;/*** 文件上傳** @param bytes* @param objectName* @return*/public String upload(byte[] bytes, String objectName) {// 創建OSSClient實例。/*在upload方法中,首先創建了一個OSSClient實例,用于與OSS服務進行交互。*/OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);try {// 創建PutObject請求。/*然后,通過調用ossClient.putObject方法將文件上傳到指定的存儲桶中。*/ossClient.putObject(bucketName, objectName, new ByteArrayInputStream(bytes));/*在上傳過程中,通過捕獲OSSException和ClientException來處理可能出現的異常情況,并輸出相應的錯誤信息。*/} catch (OSSException oe) {System.out.println("Caught an OSSException, which means your request made it to OSS, "+ "but was rejected with an error response for some reason.");System.out.println("Error Message:" + oe.getErrorMessage());System.out.println("Error Code:" + oe.getErrorCode());System.out.println("Request ID:" + oe.getRequestId());System.out.println("Host ID:" + oe.getHostId());} catch (ClientException ce) {System.out.println("Caught an ClientException, which means the client encountered "+ "a serious internal problem while trying to communicate with OSS, "+ "such as not being able to access the network.");System.out.println("Error Message:" + ce.getMessage());} finally {if (ossClient != null) {ossClient.shutdown();}}//文件訪問路徑規則 https://BucketName.Endpoint/ObjectName/*最后,構建文件的訪問路徑,并使用日志記錄上傳文件的路徑。*/StringBuilder stringBuilder = new StringBuilder("https://");stringBuilder.append(bucketName).append(".").append(endpoint).append("/").append(objectName);log.info("文件上傳到:{}", stringBuilder.toString());return stringBuilder.toString();}
}
4.2 OssConfiguration
在server的config配置中定義。
① 在這個配置類中,定義了一個名為aliOssUtil的@Bean方法,用于創建一個AliOssUtil對象。
② @ConditionalOnMissingBean注解表示當不存在名為aliOssUtil的bean時,才會創建該bean。
這意味著如果已經有其他地方定義了名為aliOssUtil的bean,那么這個方法將不會執行。
③ 在方法體中,通過依賴注入的方式獲取AliOssProperties對象,并使用它的屬性值來創建AliOssUtil對象。
package com.sky.config;import com.sky.properties.AliOssProperties;
import com.sky.utils.AliOssUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;/*** 阿里云 OSS配置類* 用于創建AliOssUtil對象*/
@Configuration
@Slf4j
public class OssConfiguration {@Bean@ConditionalOnMissingBeanpublic AliOssUtil aliOssUtil(AliOssProperties aliOssProperties){log.info("開始創建阿里云文件上傳工具類對象:{}",aliOssProperties);return new AliOssUtil(aliOssProperties.getEndpoint(),aliOssProperties.getAccessKeyId(),aliOssProperties.getAccessKeySecret(),aliOssProperties.getBucketName());}}
2.5 CommonController
定義通用接口。
//原始文件名
/*首先通過file.getOriginalFilename()獲取原始文件名*/String originalFilename = file.getOriginalFilename();//截取原始文件名的后綴 dfdfdf.png/*然后通過originalFilename.lastIndexOf(".")獲取文件名的后綴。*/String extension = originalFilename.substring(originalFilename.lastIndexOf("."));//構造新文件名稱/*使用UUID.randomUUID().toString()生成一個隨機的文件名,并將后綴拼接在文件名后面,構造出新的文件名。*/String objectName = UUID.randomUUID().toString() + extension;//文件的請求路徑/*然后,調用aliOssUtil.upload方法將文件上傳到OSS,并獲取文件的請求路徑。*/String filePath = aliOssUtil.upload(file.getBytes(), objectName);/*最后,返回一個Result對象,其中包含上傳文件的請求路徑。*/return Result.success(filePath);
package com.sky.controller.admin;import com.sky.constant.MessageConstant;
import com.sky.result.Result;
import com.sky.utils.AliOssUtil;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;import java.util.UUID;/*** @author JY* @ClassName: CommonController* @Description: 通用接口*/
@RestController
@RequestMapping("/admin/common")
@Slf4j
@Api(tags = "通用接口")
public class CommonController {@Autowiredprivate AliOssUtil aliOssUtil;/*** 文件上傳接口* @param file* @return*/@PostMapping("/upload")@ApiOperation(value = "文件上傳接口")public Result<String> upload(MultipartFile file){log.info("文件上傳:{}",file.getOriginalFilename());try {//獲取原始的文件名String originalFilename = file.getOriginalFilename();//截取文件名的后綴String substring = originalFilename.substring(originalFilename.lastIndexOf("."));//構造新的文件名稱(UUID)String imageName = UUID.randomUUID().toString() + substring;//提交文件(文件路徑)String upload = aliOssUtil.upload(file.getBytes(), imageName);return Result.success(upload);}catch (Exception e){log.error(MessageConstant.UPLOAD_FAILED + ":{}", e);}return Result.error(MessageConstant.UPLOAD_FAILED);}}
三、測試文件上傳功能
1 直接在阿里云OSS上上傳文件
文件上傳成功!
2 前后端聯調測試
頁面點擊上傳圖片,測試CommonController類運行。
運行成功則文件成功上傳到OSS。