示例說明
該案例是OSS Java SDK的示例程序,您可以修改endpoint、accessKeyId、accessKeySecret、bucketName后直接運行。
本示例中的並不包括OSS Java SDK的所有功能,詳細功能及使用方法,請參看“SDK手冊 > Java-SDK”,
鏈接地址是:https://help.aliyun.com/document_detail/oss/sdk/java-sdk/preface.html?spm=5176.docoss/sdk/java-sdk/
調用OSS Java SDK的方法時,拋出異常表示有錯誤發生;沒有拋出異常表示成功執行。
當錯誤發生時,OSS Java SDK的方法會拋出異常,異常中包括錯誤碼、錯誤信息,詳細請參看“SDK手冊 > Java-SDK > 異常處理”,
鏈接地址是:https://help.aliyun.com/document_detail/oss/sdk/java-sdk/exception.html?spm=5176.docoss/api-reference/error-response
OSS控制台可以直觀的看到您調用OSS Java SDK的結果,OSS控制台地址是:https://oss.console.aliyun.com/index#/
OSS控制台使用方法請參看文檔中心的“控制台用戶指南”指南的鏈接地址是:
https://help.aliyun.com/document_detail/oss/getting-started/get-started.html?spm=5176.docoss/user_guide
OSS的文檔中心地址是:https://help.aliyun.com/document_detail/oss/user_guide/overview.html
OSS Java SDK的文檔地址是:https://help.aliyun.com/document_detail/oss/sdk/java-sdk/install.html?spm=5176.docoss/sdk/java-sdk
OSS開發過程中常見問題鏈接地址:https://help.aliyun.com/document_detail/32024.html?spm=5176.product31815.6.665.JuvIOS
依賴
<dependency> <groupId>com.aliyun.oss</groupId> <artifactId>aliyun-sdk-oss</artifactId> <version>2.5.0</version> </dependency>
OSS Java SDK依賴下列包:
- aliyun-sdk-oss-2.2.1.jar
- hamcrest-core-1.1.jar
- jdom-1.1.jar
- commons-codec-1.9.jar
- httpclient-4.4.1.jar(重點)
- commons-logging-1.2.jar
- httpcore-4.4.1.jar(重點)
- log4j-1.2.15.jar
OSSClientConstants:阿里雲OSS對象存儲常量
package com.qianjiang.util.aliyunoss; /** * @class:OSSClientConstants * @descript:阿里雲注冊用戶基本常量 * @date:2017年3月16日 下午5:52:34 * @author liuzhihao */ public class OSSClientConstants { //阿里雲API的外網域名 public static final String ENDPOINT = "oss-cn-shanghai.aliyuncs.com"; //阿里雲API的密鑰Access Key ID public static final String ACCESS_KEY_ID = "AAASDA56456432"; //阿里雲API的密鑰Access Key Secret public static final String ACCESS_KEY_SECRET = "123456"; //阿里雲API的bucket名稱 public static final String BACKET_NAME = "uploadpicture"; //阿里雲API的文件夾名稱 public static final String FOLDER="somnus/"; }
阿里雲基本參數詳解:
endpoint是訪問OSS的域名。如果您已經在OSS的控制台上 創建了Bucket,請在控制台上查看域名。
如果您還沒有創建Bucket,endpoint選擇請參看文檔中心的“開發人員指南 > 基本概念 > 訪問域名”,
鏈接地址是:https://help.aliyun.com/document_detail/oss/user_guide/oss_concept/endpoint.html?spm=5176.docoss/user_guide/endpoint_region
endpoint的格式形如“http://oss-cn-hangzhou.aliyuncs.com/”,注意http://后不帶bucket名稱,
比如“http://bucket-name.oss-cn-hangzhou.aliyuncs.com”,是錯誤的endpoint,請去掉其中的“bucket-name”。
accessKeyId和accessKeySecret是OSS的訪問密鑰,您可以在控制台上創建和查看,
創建和查看訪問密鑰的鏈接地址是:https://ak-console.aliyun.com/#/
注意:accessKeyId和accessKeySecret前后都沒有空格,從控制台復制時請檢查並去除多余的空格。
Bucket用來管理所存儲Object的存儲空間,詳細描述請參看“開發人員指南 > 基本概念 > OSS基本概念介紹”。
Bucket命名規范如下:只能包括小寫字母,數字和短橫線(-),必須以小寫字母或者數字開頭,長度必須在3-63字節之間。
Object是OSS存儲數據的基本單元,稱為OSS的對象,也被稱為OSS的文件。詳細描述請參看“開發人員指南 > 基本概念 > OSS基本概念介紹”。
Object命名規范如下:使用UTF-8編碼,長度必須在1-1023字節之間,不能以“/”或者“\”字符開頭。
就是上傳文件名的名稱,名稱唯一
創建模擬文件夾
OSS是沒有文件夾這個概念的,所有元素都是以Object來存儲。
創建模擬文件夾本質上來說是創建了一個size為0的Object。
對於這個Object可以上傳下載,只是控制台會對以”/“結尾的Object以文件夾的方式展示。
鏈接地址:https://help.aliyun.com/document_detail/32015.html?spm=5176.doc32013.2.5.ITwaY2
AliyunOSSclientUtil:上傳工具類
package com.qianjiang.util.aliyunoss; import java.io.ByteArrayInputStream; import java.io.File; import java.io.FileInputStream; import java.io.InputStream; import org.apache.log4j.Logger; import com.aliyun.oss.OSSClient; import com.aliyun.oss.model.Bucket; import com.aliyun.oss.model.OSSObject; import com.aliyun.oss.model.ObjectMetadata; import com.aliyun.oss.model.PutObjectResult; /** * @class:AliyunOSSClientUtil * @descript:java使用阿里雲OSS存儲對象上傳圖片 * @date:2021年9月14日 下午5:58:08 * @author 劉智豪 */ public class AliyunOSSClientUtil { //log日志 private static Logger logger = Logger.getLogger(AliyunOSSClientUtil.class); //阿里雲API的內或外網域名 private static String ENDPOINT; //阿里雲API的密鑰Access Key ID private static String ACCESS_KEY_ID; //阿里雲API的密鑰Access Key Secret private static String ACCESS_KEY_SECRET; //阿里雲API的bucket名稱 private static String BACKET_NAME; //阿里雲API的文件夾名稱 private static String FOLDER; //初始化屬性 static{ ENDPOINT = OSSClientConstants.ENDPOINT; ACCESS_KEY_ID = OSSClientConstants.ACCESS_KEY_ID; ACCESS_KEY_SECRET = OSSClientConstants.ACCESS_KEY_SECRET; BACKET_NAME = OSSClientConstants.BACKET_NAME; FOLDER = OSSClientConstants.FOLDER; } /** * 獲取阿里雲OSS客戶端對象 * @return ossClient */ public static OSSClient getOSSClient(){ return new OSSClient(ENDPOINT,ACCESS_KEY_ID, ACCESS_KEY_SECRET); } /** * 創建存儲空間 * @param ossClient OSS連接 * @param bucketName 存儲空間 * @return */ public static String createBucketName(OSSClient ossClient,String bucketName){ //存儲空間 final String bucketNames=bucketName; if(!ossClient.doesBucketExist(bucketName)){ //創建存儲空間 Bucket bucket=ossClient.createBucket(bucketName); logger.info("創建存儲空間成功"); return bucket.getName(); } return bucketNames; } /** * 刪除存儲空間buckName * @param ossClient oss對象 * @param bucketName 存儲空間 */ public static void deleteBucket(OSSClient ossClient, String bucketName){ ossClient.deleteBucket(bucketName); logger.info("刪除" + bucketName + "Bucket成功"); } /** * 創建模擬文件夾 * @param ossClient oss連接 * @param bucketName 存儲空間 * @param folder 模擬文件夾名如"qj_nanjing/" * @return 文件夾名 */ public static String createFolder(OSSClient ossClient,String bucketName,String folder){ //文件夾名 final String keySuffixWithSlash =folder; //判斷文件夾是否存在,不存在則創建 if(!ossClient.doesObjectExist(bucketName, keySuffixWithSlash)){ //創建文件夾 ossClient.putObject(bucketName, keySuffixWithSlash, new ByteArrayInputStream(new byte[0])); logger.info("創建文件夾成功"); //得到文件夾名 OSSObject object = ossClient.getObject(bucketName, keySuffixWithSlash); String fileDir=object.getKey(); return fileDir; } return keySuffixWithSlash; } /** * 根據key刪除OSS服務器上的文件 * @param ossClient oss連接 * @param bucketName 存儲空間 * @param folder 模擬文件夾名 如"qj_nanjing/" * @param key Bucket下的文件的路徑名+文件名 如:"upload/cake.jpg" */ public static void deleteFile(OSSClient ossClient, String bucketName, String folder, String key){ ossClient.deleteObject(bucketName, folder + key); logger.info("刪除" + bucketName + "下的文件" + folder + key + "成功"); } /** * 上傳圖片至OSS * @param ossClient oss連接 * @param file 上傳文件(文件全路徑如:D:\\image\\cake.jpg) * @param bucketName 存儲空間 * @param folder 模擬文件夾名 如"qj_nanjing/" * @return String 返回的唯一MD5數字簽名 * */ public static String uploadObject2OSS(OSSClient ossClient, File file, String bucketName, String folder) { String resultStr = null; try { //以輸入流的形式上傳文件 InputStream is = new FileInputStream(file); //文件名 String fileName = file.getName(); //文件大小 Long fileSize = file.length(); //創建上傳Object的Metadata ObjectMetadata metadata = new ObjectMetadata(); //上傳的文件的長度 metadata.setContentLength(is.available()); //指定該Object被下載時的網頁的緩存行為 metadata.setCacheControl("no-cache"); //指定該Object下設置Header metadata.setHeader("Pragma", "no-cache"); //指定該Object被下載時的內容編碼格式 metadata.setContentEncoding("utf-8"); //文件的MIME,定義文件的類型及網頁編碼,決定瀏覽器將以什么形式、什么編碼讀取文件。如果用戶沒有指定則根據Key或文件名的擴展名生成, //如果沒有擴展名則填默認值application/octet-stream metadata.setContentType(getContentType(fileName)); //指定該Object被下載時的名稱(指示MINME用戶代理如何顯示附加的文件,打開或下載,及文件名稱) metadata.setContentDisposition("filename/filesize=" + fileName + "/" + fileSize + "Byte."); //上傳文件 (上傳文件流的形式) PutObjectResult putResult = ossClient.putObject(bucketName, folder + fileName, is, metadata); //解析結果 resultStr = putResult.getETag(); } catch (Exception e) { e.printStackTrace(); logger.error("上傳阿里雲OSS服務器異常." + e.getMessage(), e); } return resultStr; } /** * 通過文件名判斷並獲取OSS服務文件上傳時文件的contentType * @param fileName 文件名 * @return 文件的contentType */ public static String getContentType(String fileName){ //文件的后綴名 String fileExtension = fileName.substring(fileName.lastIndexOf(".")); if(".bmp".equalsIgnoreCase(fileExtension)) { return "image/bmp"; } if(".gif".equalsIgnoreCase(fileExtension)) { return "image/gif"; } if(".jpeg".equalsIgnoreCase(fileExtension) || ".jpg".equalsIgnoreCase(fileExtension) || ".png".equalsIgnoreCase(fileExtension) ) { return "image/jpeg"; } if(".html".equalsIgnoreCase(fileExtension)) { return "text/html"; } if(".txt".equalsIgnoreCase(fileExtension)) { return "text/plain"; } if(".vsd".equalsIgnoreCase(fileExtension)) { return "application/vnd.visio"; } if(".ppt".equalsIgnoreCase(fileExtension) || "pptx".equalsIgnoreCase(fileExtension)) { return "application/vnd.ms-powerpoint"; } if(".doc".equalsIgnoreCase(fileExtension) || "docx".equalsIgnoreCase(fileExtension)) { return "application/msword"; } if(".xml".equalsIgnoreCase(fileExtension)) { return "text/xml"; } //默認返回類型 return "image/jpeg"; } //測試 public static void main(String[] args) { //初始化OSSClient OSSClient ossClient=AliyunOSSClientUtil.getOSSClient(); //上傳文件 String files="D:\\image\\1010.jpg,D:\\image\\1111.jpg,D:\\image\\1212.jpg,D:\\image\\1313.jpg,D:\\image\\2222.jpg,D:\\image\\3333.jpg," + "D:\\image\\4444.jpg,D:\\image\\5555.jpg,D:\\image\\6666.jpg,D:\\image\\7777.jpg,D:\\image\\8888.jpg"; String[] file=files.split(","); for(String filename:file){ //System.out.println("filename:"+filename); File filess=new File(filename); String md5key = AliyunOSSClientUtil.uploadObject2OSS(ossClient, filess, BACKET_NAME, FOLDER); logger.info("上傳后的文件MD5數字唯一簽名:" + md5key); //上傳后的文件MD5數字唯一簽名:40F4131427068E08451D37F02021473A } } }