OSS Java SDK是一個Java庫，旨在與阿里云對象存儲服務（OSS）集成，為Java應用程序提供高效的存儲管理和訪問功能。本文介紹如何通過OSS Java SDK完成創建存儲空間（Bucket）、上傳文件、下載文件、列舉文件以及刪除文件和Bucket等操作。
前提條件
配置憑證
使用RAM用戶AccessKey配置環境變量。
Linux
在命令行界面執行以下命令來將環境變量設置追加到
~/.bashrc文件中。echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bashrc echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bashrc執行以下命令使變更生效。
source ~/.bashrc執行以下命令檢查環境變量是否生效。
echo $OSS_ACCESS_KEY_ID echo $OSS_ACCESS_KEY_SECRET
macOS
在終端中執行以下命令，查看默認Shell類型。
echo $SHELL根據默認Shell類型進行操作。
Zsh
執行以下命令來將環境變量設置追加到
~/.zshrc文件中。echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.zshrc echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.zshrc執行以下命令使變更生效。
source ~/.zshrc執行以下命令檢查環境變量是否生效。
echo $OSS_ACCESS_KEY_ID echo $OSS_ACCESS_KEY_SECRET
Bash
執行以下命令來將環境變量設置追加到
~/.bash_profile文件中。echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bash_profile echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bash_profile執行以下命令使變更生效。
source ~/.bash_profile執行以下命令檢查環境變量是否生效。
echo $OSS_ACCESS_KEY_ID echo $OSS_ACCESS_KEY_SECRET
Windows
CMD
在CMD中運行以下命令。
setx OSS_ACCESS_KEY_ID "YOUR_ACCESS_KEY_ID" setx OSS_ACCESS_KEY_SECRET "YOUR_ACCESS_KEY_SECRET"運行以下命令，檢查環境變量是否生效。
echo %OSS_ACCESS_KEY_ID% echo %OSS_ACCESS_KEY_SECRET%
PowerShell
在PowerShell中運行以下命令。
[Environment]::SetEnvironmentVariable("OSS_ACCESS_KEY_ID", "YOUR_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User) [Environment]::SetEnvironmentVariable("OSS_ACCESS_KEY_SECRET", "YOUR_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)運行以下命令，檢查環境變量是否生效。
[Environment]::GetEnvironmentVariable("OSS_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User) [Environment]::GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)
安裝SDK
已安裝Java 7 及以上版本。
通過以下命令查看Java版本。
java -version如果當前計算環境沒有Java或版本低于Java 7，請下載Java。
您可以通過以下三種方式安裝OSS Java SDK。
說明請根據需求選擇合適的OSS Java SDK版本，推薦您使用最新版本。關于版本功能的更多信息，請參見GitHub。
在Maven項目中加入依賴項（推薦方式）
在Maven工程中使用OSS Java SDK，只需在
pom.xml中加入相應依賴即可。以在<dependencies>中加入3.17.4版本的依賴為例：<dependency> <groupId>com.aliyun.oss</groupId> <artifactId>aliyun-sdk-oss</artifactId> <version>3.17.4</version> </dependency>如果使用的是Java 9及以上的版本，則需要添加以下JAXB相關依賴。
<dependency> <groupId>javax.xml.bind</groupId> <artifactId>jaxb-api</artifactId> <version>2.3.1</version> </dependency> <dependency> <groupId>javax.activation</groupId> <artifactId>activation</artifactId> <version>1.1.1</version> </dependency> <!-- no more than 2.3.3--> <dependency> <groupId>org.glassfish.jaxb</groupId> <artifactId>jaxb-runtime</artifactId> <version>2.3.3</version> </dependency>在Eclipse項目中導入JAR包
以3.17.4版本為例，步驟如下：
下載Java SDK開發包。
解壓該開發包。
將解壓后文件夾中的文件aliyun-sdk-oss-3.17.4.jar以及lib文件夾下的所有文件拷貝到您的項目中。
在Eclipse中選擇您的工程，右鍵選擇。
選中拷貝的所有JAR文件，導入到Libraries中。
在IntelliJ IDEA項目中導入JAR包
以3.17.4版本為例，步驟如下：
解壓該開發包。
將解壓后文件夾中的文件aliyun-sdk-oss-3.17.4.jar以及lib文件夾下的所有JAR文件拷貝到您的項目中。
在IntelliJ IDEA中選擇您的工程，右鍵選擇 。
選中拷貝的所有JAR文件，導入到External Libraries中。
運行示例
運行以下代碼示例以體驗OSS的完整使用流程：創建一個Bucket、上傳文件、下載文件、列舉文件以及刪除文件和Bucket。
import java.io.*;
import java.util.Random;
import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.common.auth.CredentialsProviderFactory;
import com.aliyun.oss.common.auth.EnvironmentVariableCredentialsProvider;
import com.aliyun.oss.model.OSSObject;
import com.aliyun.oss.model.ObjectListing;
import com.aliyun.oss.model.OSSObjectSummary;
public class OssJavaSdkQuickStart {
/** 生成一個唯一的 Bucket 名稱 */
public static String generateUniqueBucketName(String prefix) {
// 獲取當前時間戳
String timestamp = String.valueOf(System.currentTimeMillis());
// 生成一個 0 到 9999 之間的隨機數
Random random = new Random();
int randomNum = random.nextInt(10000); // 生成一個 0 到 9999 之間的隨機數
// 連接以形成一個唯一的 Bucket 名稱
return prefix + "-" + timestamp + "-" + randomNum;
}
public static void main(String[] args) throws com.aliyuncs.exceptions.ClientException {
// 設置 OSS Endpoint 和 Bucket 名稱
String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
String bucketName = generateUniqueBucketName("demo");
// 替換為您的 Bucket 區域
String region = "cn-hangzhou";
// 創建 OSSClient 實例
EnvironmentVariableCredentialsProvider credentialsProvider =
CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
OSS ossClient = OSSClientBuilder.create()
.endpoint(endpoint)
.credentialsProvider(credentialsProvider)
.region(region)
.build();
try {
// 1. 創建存儲空間（Bucket）
ossClient.createBucket(bucketName);
System.out.println("1. Bucket " + bucketName + " 創建成功。");
// 2. 上傳文件
String objectName = "exampledir/exampleobject.txt";
String content = "Hello OSS";
ossClient.putObject(bucketName, objectName, new ByteArrayInputStream(content.getBytes()));
System.out.println("2. 文件 " + objectName + " 上傳成功。");
// 3. 下載文件
OSSObject ossObject = ossClient.getObject(bucketName, objectName);
InputStream contentStream = ossObject.getObjectContent();
BufferedReader reader = new BufferedReader(new InputStreamReader(contentStream));
String line;
System.out.println("3. 下載的文件內容：");
while ((line = reader.readLine()) != null) {
System.out.println(line);
}
contentStream.close();
// 4. 列出文件
System.out.println("4. 列出 Bucket 中的文件：");
ObjectListing objectListing = ossClient.listObjects(bucketName);
for (OSSObjectSummary objectSummary : objectListing.getObjectSummaries()) {
System.out.println(" - " + objectSummary.getKey() + " (大小 = " + objectSummary.getSize() + ")");
}
// 5. 刪除文件
ossClient.deleteObject(bucketName, objectName);
System.out.println("5. 文件 " + objectName + " 刪除成功。");
// 6. 刪除存儲空間（Bucket）
ossClient.deleteBucket(bucketName);
System.out.println("6. Bucket " + bucketName + " 刪除成功。");
} 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 | IOException 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();
}
}
}
}成功的返回示例如下：
1. Bucket demo-1731651903982-4074 創建成功。
2. 文件 exampledir/exampleobject.txt 上傳成功。
3. 下載的文件內容：
Hello OSS
4. 列出 Bucket 中的文件：
- exampledir/exampleobject.txt (大小 = 9)
5. 文件 exampledir/exampleobject.txt 刪除成功。
6. Bucket demo-1731651903982-4074 刪除成功。文檔內容是否對您有幫助？