全部產品
Search
文件中心

Object Storage Service:Java斷點續傳上傳

更新時間:Apr 29, 2025

通過斷點續傳上傳的方式將檔案上傳到OSS前,您可以指定斷點記錄點。上傳過程中,如果出現網路異常或程式崩潰導致檔案上傳失敗時,將從斷點記錄處繼續上傳未上傳完成的部分。

注意事項

  • 本文以華東1(杭州)外網Endpoint為例。如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS,請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係,請參見OSS地區和訪問網域名稱

  • 本文以從環境變數讀取存取憑證為例。如何配置訪問憑證,請參見Java配置訪問憑證

  • 本文以OSS網域名稱建立OSSClient為例。如果您希望通過自訂網域名、STS等方式建立OSSClient,請參見常見情境配置樣本

  • 要斷點續傳上傳,您必須有oss:PutObject許可權。具體操作,請參見為RAM使用者授予自訂的權限原則

範例程式碼

以下代碼用於斷點續傳上傳。

import com.aliyun.oss.ClientBuilderConfiguration;
import com.aliyun.oss.OSS;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.*;

public class UploadFile {
        public static void main(String[] args) throws Exception {
            // Endpoint以華東1(杭州)為例,其它Region請按實際情況填寫。
            String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
            // 填寫Bucket所在地區。以華東1(杭州)為例,Region填寫為cn-hangzhou。
            String region = "cn-hangzhou";
            // 從環境變數中擷取訪問憑證。運行本程式碼範例之前,請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
            EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();

            // 建立OSSClient執行個體。
            ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
            clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);
            OSS ossClient = OSSClientBuilder.create()
                    .endpoint(endpoint)
                    .credentialsProvider(credentialsProvider)
                    .clientConfiguration(clientBuilderConfiguration)
                    .region(region)
                    .build();

            try {
                ObjectMetadata meta = new ObjectMetadata();
                // 指定上傳的內容類型。
                // meta.setContentType("text/plain");

                // 檔案上傳時設定存取權限ACL。
                // meta.setObjectAcl(CannedAccessControlList.Private);

                // 通過UploadFileRequest設定多個參數。
                // 依次填寫Bucket名稱(例如examplebucket)以及Object完整路徑(例如exampledir/exampleobject.txt),Object完整路徑中不能包含Bucket名稱。
                UploadFileRequest uploadFileRequest = new UploadFileRequest("examplebucket","exampledir/exampleobject.txt");

                // 通過UploadFileRequest設定單個參數。
                // 填寫本地檔案的完整路徑,例如D:\\localpath\\examplefile.txt。如果未指定本地路徑,則預設從樣本程式所屬專案對應本地路徑中上傳檔案。
                uploadFileRequest.setUploadFile("D:\\localpath\\examplefile.txt");
                // 指定上傳並發線程數,預設值為1。
                uploadFileRequest.setTaskNum(5);
                // 指定上傳的分區大小,單位為位元組,取值範圍為100 KB~5 GB。預設值為100 KB。
                uploadFileRequest.setPartSize(1 * 1024 * 1024);
                // 開啟斷點續傳,預設關閉。
                uploadFileRequest.setEnableCheckpoint(true);
                // 記錄本地分區上傳結果的檔案。上傳過程中的進度資訊會儲存在該檔案中,如果某一分區上傳失敗,再次上傳時會根據檔案中記錄的點繼續上傳。上傳完成後,該檔案會被刪除。
                // 如果未設定該值,預設與待上傳的本地檔案同路徑,名稱為${uploadFile}.ucp。
                uploadFileRequest.setCheckpointFile("yourCheckpointFile");
                // 檔案的中繼資料。
                uploadFileRequest.setObjectMetadata(meta);
                // 設定上傳回調,參數為Callback類型。
                //uploadFileRequest.setCallback("yourCallbackEvent");

                // 斷點續傳上傳。
                ossClient.uploadFile(uploadFileRequest);

            } 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 (Throwable 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 {
                // 關閉OSSClient。
                if (ossClient != null) {
                    ossClient.shutdown();
                }
            }
        }
}

相關文檔

關於斷點續傳上傳的完整範例程式碼,請參見GitHub樣本