Object Storage Service:OSS Java SDK V1

Persiapkan lingkungan

Instal Java 7 atau versi yang lebih baru. Anda dapat menjalankan perintah java -version untuk memeriksa versi Java Anda. Jika Java belum diinstal atau versinya lebih lama dari Java 7, unduh Java.

Instal SDK

Pilih metode instalasi berdasarkan lingkungan Anda. Gunakan versi terbaru OSS Java SDK V1.

Contoh berikut menggunakan OSS Java SDK V1 versi 3.17.4.

<dependency>
    <groupId>com.aliyun.oss</groupId>
    <artifactId>aliyun-sdk-oss</artifactId>
    <version>3.18.4</version>
</dependency>

<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>
<!-- tidak lebih dari 2.3.3-->
<dependency>
    <groupId>org.glassfish.jaxb</groupId>
    <artifactId>jaxb-runtime</artifactId>
    <version>2.3.3</version>
</dependency>

Konfigurasi kredensial akses

Konfigurasikan kredensial akses dengan pasangan AccessKey Pengguna RAM.

1. Di Konsol RAM, buat Pengguna RAM dengan Permanent AccessKey Pair. Simpan pasangan AccessKey tersebut dan berikan izin AliyunOSSFullAccess kepada pengguna.

2. Gunakan pasangan AccessKey Pengguna RAM untuk mengonfigurasi variabel lingkungan.

   Linux

   1. Jalankan perintah berikut di antarmuka baris perintah untuk menambahkan pengaturan variabel lingkungan ke file ~/.bashrc .

      echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bashrc
      echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bashrc

   2. Jalankan perintah berikut untuk menerapkan perubahan.

      source ~/.bashrc

   3. Jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah dikonfigurasi.

      echo $OSS_ACCESS_KEY_ID
      echo $OSS_ACCESS_KEY_SECRET

   macOS

   1. Jalankan perintah berikut di terminal untuk memeriksa jenis shell default.

      echo $SHELL

   2. Lakukan langkah berikut berdasarkan jenis shell default.

      Zsh

      1. Jalankan perintah berikut untuk menambahkan pengaturan variabel lingkungan ke file ~/.zshrc.

         echo "export OSS_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.zshrc
         echo "export OSS_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.zshrc

      2. Jalankan perintah berikut untuk menerapkan perubahan.

         source ~/.zshrc

      3. Jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah dikonfigurasi.

         echo $OSS_ACCESS_KEY_ID
         echo $OSS_ACCESS_KEY_SECRET

      Bash

      1. Jalankan perintah berikut untuk menambahkan pengaturan variabel lingkungan ke file ~/.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

      2. Jalankan perintah berikut untuk menerapkan perubahan.

         source ~/.bash_profile

      3. Jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah dikonfigurasi.

         echo $OSS_ACCESS_KEY_ID
         echo $OSS_ACCESS_KEY_SECRET

   Windows

   CMD

   1. Jalankan perintah berikut di CMD.

      setx OSS_ACCESS_KEY_ID "YOUR_ACCESS_KEY_ID"
      setx OSS_ACCESS_KEY_SECRET "YOUR_ACCESS_KEY_SECRET"

   2. Jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah dikonfigurasi.

      echo %OSS_ACCESS_KEY_ID%
      echo %OSS_ACCESS_KEY_SECRET%

   PowerShell

   1. Jalankan perintah berikut di 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)

   2. Jalankan perintah berikut untuk memverifikasi bahwa variabel lingkungan telah dikonfigurasi.

      [Environment]::GetEnvironmentVariable("OSS_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User)
      [Environment]::GetEnvironmentVariable("OSS_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)

Inisialisasi klien

Kode contoh berikut menggunakan titik akhir publik wilayah China (Hangzhou) untuk menginisialisasi klien, lalu mencantumkan semua bucket milik akun guna memverifikasi konfigurasi. Untuk daftar lengkap wilayah dan titik akhir, lihat Wilayah dan titik akhir.

import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.Bucket;

import java.util.List;

/**
 * Contoh integrasi cepat OSS SDK
 * Menunjukkan cara menginisialisasi klien OSS dan mendaftar semua bucket
 */
public class Test {

    public static void main(String[] args) {
        // Dapatkan kredensial akses dari variabel lingkungan
        String accessKeyId = System.getenv("OSS_ACCESS_KEY_ID");
        String accessKeySecret = System.getenv("OSS_ACCESS_KEY_SECRET");

        // Atur wilayah dan titik akhir OSS
        String region = "cn-hangzhou";
        String endpoint = "oss-cn-hangzhou.aliyuncs.com";

        // Buat penyedia kredensial
        DefaultCredentialProvider provider = new DefaultCredentialProvider(accessKeyId, accessKeySecret);

        // Konfigurasi parameter klien
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        // Secara eksplisit deklarasikan penggunaan algoritma tanda tangan V4
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);

        // Inisialisasi klien OSS
        OSS ossClient = OSSClientBuilder.create()
                .credentialsProvider(provider)
                .clientConfiguration(clientBuilderConfiguration)
                .region(region)
                .endpoint(endpoint)
                .build();

        // Daftar semua bucket milik pengguna saat ini
        List<Bucket> buckets = ossClient.listBuckets();
        System.out.println("Berhasil terhubung ke OSS. Bucket di bawah akun saat ini:");

        if (buckets.isEmpty()) {
            System.out.println("Tidak ditemukan bucket di bawah akun saat ini.");
        } else {
            for (Bucket bucket : buckets) {
                System.out.println("- " + bucket.getName());
            }
        }

        // Lepaskan sumber daya
        ossClient.shutdown();
        System.out.println("Klien OSS telah dimatikan.");
    }
}

Setelah menjalankan kode tersebut, bucket akun saat ini di semua wilayah akan ditampilkan:

Successfully connected to OSS. Buckets under the current account:
- example-bucket
OSS client has been shut down.

Pengecualian klien (ClientException)

Pengecualian klien terjadi selama pembuatan permintaan, pengiriman, atau transfer data. Skenario umum meliputi:

• Koneksi jaringan tidak tersedia, sehingga permintaan tidak dapat dikirim ke server.

• Terjadi pengecualian IO selama unggahan file.

• Terjadi pengecualian jaringan dasar, seperti timeout permintaan atau kegagalan verifikasi sertifikat.

ClientException berarti permintaan tidak dikirim ke server OSS atau terjadi kesalahan selama pemrosesan di sisi klien. Periksa koneksi jaringan dan konfigurasi klien.

Pengecualian server (OSSException)

Pengecualian server berarti permintaan sampai ke OSS tetapi ditolak. OSSException menyediakan:

• Berisi kode kesalahan dan pesan kesalahan terperinci untuk identifikasi masalah yang tepat.

• Kesalahan umum meliputi SignatureDoesNotMatch, AccessDenied, dan NoSuchKey.

• Menangani pengecualian ini berdasarkan kode kesalahan dapat secara signifikan meningkatkan ketangguhan program dan pengalaman pengguna.

Gunakan pasangan AccessKey Pengguna RAM

Cocok untuk aplikasi di lingkungan aman yang memerlukan akses OSS jangka panjang tanpa rotasi kredensial yang sering. Inisialisasi penyedia kredensial dengan pasangan AccessKey Pengguna RAM (ID AccessKey dan rahasia AccessKey). Metode ini memerlukan pemeliharaan pasangan AccessKey secara manual, yang meningkatkan risiko keamanan.

import com.aliyun.oss.ClientBuilderConfiguration;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.common.auth.CredentialsProvider;
import com.aliyun.oss.common.auth.DefaultCredentialProvider;
import com.aliyun.oss.common.comm.SignVersion;

public class AkDemoTest {
    public static void main(String[] args) throws Exception {
        // Masukkan ID AccessKey dan rahasia AccessKey Pengguna RAM.
        String accessKeyId = "yourAccessKeyID";
        String accessKeySecret = "yourAccessKeySecret";
        
        // Gunakan metode DefaultCredentialProvider untuk secara langsung mengatur ID AccessKey dan rahasia AccessKey.
        CredentialsProvider credentialsProvider = new DefaultCredentialProvider(accessKeyId, accessKeySecret);

        // Gunakan credentialsProvider untuk menginisialisasi klien.
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        // Secara eksplisit deklarasikan penggunaan algoritma tanda tangan V4.
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);  
        // Buat instance OSSClient.
        // Saat instance OSSClient tidak lagi diperlukan, panggil metode shutdown untuk melepaskan sumber daya.
        OSS ossClient = OSSClientBuilder.create()
                .endpoint("endpoint")
                .credentialsProvider(credentialsProvider)
                .clientConfiguration(clientBuilderConfiguration)
                .region("region")
                .build();

        ossClient.shutdown();

    }
}

Gunakan token STS

Cocok untuk aplikasi yang memerlukan akses OSS sementara. Inisialisasi penyedia kredensial dengan kredensial sementara (ID AccessKey, rahasia AccessKey, dan token keamanan) dari STS. Anda harus melakukan refresh token STS secara manual untuk akses berulang.

import com.aliyun.oss.ClientBuilderConfiguration;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.common.auth.CredentialsProvider;
import com.aliyun.oss.common.auth.DefaultCredentialProvider;
import com.aliyun.oss.common.comm.SignVersion;

public class StsDemoTest {
    public static void main(String[] args) throws Exception {
        // Atur ini ke ID AccessKey sementara, rahasia AccessKey, dan token keamanan yang diperoleh dari layanan STS, bukan informasi kredensial Pengguna RAM.
        // Perhatikan bahwa ID AccessKey yang diperoleh dari layanan STS diawali dengan "STS", seperti yang ditunjukkan di bawah.
        String accessKeyId = "STS.****************";
        String accessKeySecret = "yourAccessKeySecret";
        String stsToken= "yourSecurityToken";

        // Gunakan metode DefaultCredentialProvider untuk secara langsung mengatur ID AccessKey dan rahasia AccessKey.
        CredentialsProvider credentialsProvider = new DefaultCredentialProvider(accessKeyId, accessKeySecret, stsToken);

        // Gunakan credentialsProvider untuk menginisialisasi klien.
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        // Secara eksplisit deklarasikan penggunaan algoritma tanda tangan V4.
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);
        // Buat instance OSSClient.
        // Saat instance OSSClient tidak lagi diperlukan, panggil metode shutdown untuk melepaskan sumber daya.
        OSS ossClient = OSSClientBuilder.create()
                .endpoint("endpoint")
                .credentialsProvider(credentialsProvider)
                .clientConfiguration(clientBuilderConfiguration)
                .region("region")
                .build();

        ossClient.shutdown();
    }
}

Gunakan RAMRoleARN

Cocok untuk aplikasi yang memerlukan akses resmi ke OSS, seperti akses lintas akun. Inisialisasi penyedia kredensial dengan menentukan ARN peran RAM. SDK secara otomatis mendapatkan dan merefresh token STS dengan memanggil API AssumeRole. Anda juga dapat menggunakan parameter policy untuk membatasi peran RAM ke izin yang lebih sedikit.

1. Tambahkan dependensi kredensial.

   <!-- https://mvnrepository.com/artifact/com.aliyun/credentials-java -->
   <dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>credentials-java</artifactId>
       <version>LATEST</version>
   </dependency>

2. Konfigurasikan pasangan AccessKey dan RAMRoleARN sebagai kredensial akses.

   import com.aliyun.credentials.models.CredentialModel;
   import com.aliyun.oss.ClientBuilderConfiguration;
   import com.aliyun.oss.OSS;
   import com.aliyun.oss.OSSClientBuilder;
   import com.aliyun.oss.common.auth.Credentials;
   import com.aliyun.oss.common.auth.CredentialsProvider;
   import com.aliyun.oss.common.auth.DefaultCredentials;
   import com.aliyun.oss.common.comm.SignVersion;
   
   public class RamRoleArnAkDemoTest {
   
       public static void main(String[] args) {
   
           com.aliyun.credentials.models.Config config = new com.aliyun.credentials.models.Config();
           // Jenis kredensial akses. Atur ke ram_role_arn.
           config.setType("ram_role_arn");
           // ARN peran RAM yang akan diasumsikan. Contoh: acs:ram::123456789012****:role/adminrole. Anda dapat mengatur RoleArn melalui variabel lingkungan ALIBABA_CLOUD_ROLE_ARN.
           config.setRoleArn("<RoleArn>");
           // Dapatkan ID AccessKey dari variabel lingkungan.
           config.setAccessKeyId(System.getenv().get("ALIBABA_CLOUD_ACCESS_KEY_ID"));
           // Dapatkan rahasia AccessKey dari variabel lingkungan.
           config.setAccessKeySecret(System.getenv().get("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
           // Nama sesi peran. Anda dapat mengatur RoleSessionName melalui variabel lingkungan ALIBABA_CLOUD_ROLE_SESSION_NAME.
           config.setRoleName("<RoleSessionName>");
           // Atur kebijakan izin yang lebih kecil. Ini opsional. Contoh: {"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"}
           config.setPolicy("<Policy>");
           // Atur periode validitas sesi peran. Ini opsional.
           config.setRoleSessionExpiration(3600);
   
           final com.aliyun.credentials.Client credentialsClient = new com.aliyun.credentials.Client(config);
   
           CredentialsProvider credentialsProvider = new CredentialsProvider(){
               @Override
               public void setCredentials(Credentials credentials) {
               }
   
               @Override
               public Credentials getCredentials() {
                   CredentialModel credential = credentialsClient.getCredential();
                   return  new DefaultCredentials(credential.getAccessKeyId(), credential.getAccessKeySecret(), credential.getSecurityToken());
               }
           };
           // Gunakan credentialsProvider untuk menginisialisasi klien.
           ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
           // Secara eksplisit deklarasikan penggunaan algoritma tanda tangan V4.
           clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);  
           // Buat instance OSSClient.
           // Saat instance OSSClient tidak lagi diperlukan, panggil metode shutdown untuk melepaskan sumber daya.
           OSS ossClient = OSSClientBuilder.create()
                   .endpoint("endpoint")
                   .credentialsProvider(credentialsProvider)
                   .clientConfiguration(clientBuilderConfiguration)
                   .region("region")
                   .build();
   
           ossClient.shutdown();
       }
   }

Gunakan ECSRAMRole

Cocok untuk aplikasi pada instance ECS, instance ECI, atau node pekerja Container Service for Kubernetes. Dengan melampirkan peran RAM ke instance, token STS secara otomatis diperoleh dan direfresh dalam Container Service for Kubernetes atau ECS tanpa manajemen kredensial manual. Untuk mendapatkan ECSRAMRole, lihat Buat peran RAM. Untuk melampirkan peran, lihat Peran RAM instans.

1. Tambahkan dependensi kredensial.

   <!-- https://mvnrepository.com/artifact/com.aliyun/credentials-java -->
   <dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>credentials-java</artifactId>
       <version>LATEST</version>
   </dependency>

2. Konfigurasikan ECSRAMRole sebagai kredensial akses.

   import com.aliyun.credentials.models.CredentialModel;
   import com.aliyun.oss.ClientBuilderConfiguration;
   import com.aliyun.oss.OSS;
   import com.aliyun.oss.OSSClientBuilder;
   import com.aliyun.oss.common.auth.Credentials;
   import com.aliyun.oss.common.auth.CredentialsProvider;
   import com.aliyun.oss.common.auth.DefaultCredentials;
   import com.aliyun.oss.common.comm.SignVersion;
   
   public class EcsRamRoleDemoTest {
       public static void main(String[] args) {
   
           com.aliyun.credentials.models.Config config = new com.aliyun.credentials.models.Config();
           // Jenis kredensial akses. Atur ke ecs_ram_role.
           config.setType("ecs_ram_role");
           // Nama peran RAM yang ditetapkan ke instance ECS.
           config.setRoleName("<RoleName>");
   
           final com.aliyun.credentials.Client credentialsClient = new com.aliyun.credentials.Client(config);
   
           CredentialsProvider credentialsProvider = new CredentialsProvider(){
               @Override
               public void setCredentials(Credentials credentials) {
               }
   
               @Override
               public Credentials getCredentials() {
                   CredentialModel credential = credentialsClient.getCredential();
                   return  new DefaultCredentials(credential.getAccessKeyId(), credential.getAccessKeySecret(), credential.getSecurityToken());
               }
           };
           // Gunakan credentialsProvider untuk menginisialisasi klien.
           ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
           // Secara eksplisit deklarasikan penggunaan algoritma tanda tangan V4.
           clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);  
           // Buat instance OSSClient.
           // Saat instance OSSClient tidak lagi diperlukan, panggil metode shutdown untuk melepaskan sumber daya.
           OSS ossClient = OSSClientBuilder.create()
                   .endpoint("endpoint")
                   .credentialsProvider(credentialsProvider)
                   .clientConfiguration(clientBuilderConfiguration)
                   .region("region")
                   .build();
   
           ossClient.shutdown();
       }
   }

Gunakan OIDCRoleARN

Setelah Anda mengonfigurasi peran RAM node pekerja di Container Service for Kubernetes, aplikasi dalam pod pada node yang sesuai dapat memperoleh token STS dari peran yang dilampirkan melalui layanan meta global, sama seperti aplikasi yang dideploy di ECS. Namun, jika aplikasi tidak tepercaya dideploy pada kluster container (misalnya, aplikasi yang diajukan oleh pelanggan Anda dengan kode yang tidak terbuka untuk Anda), Anda mungkin tidak ingin mereka memperoleh token STS dari peran RAM instans yang dilampirkan pada node pekerja melalui layanan meta global. Untuk menghindari memengaruhi keamanan sumber daya cloud Anda sekaligus memungkinkan aplikasi tidak tepercaya ini memperoleh token STS yang diperlukan secara aman dan mencapai minimalisasi izin tingkat aplikasi, Anda dapat menggunakan fitur RAM Roles for Service Accounts (RRSA). Implementasi dasar metode ini didasarkan pada token STS. Kluster container Alibaba Cloud membuat dan memasang file token OIDC yang sesuai untuk pod aplikasi yang berbeda dan menyuntikkan informasi konfigurasi yang relevan ke variabel lingkungan. SDK memperoleh token STS dari peran yang terikat dengan memanggil operasi API AssumeRoleWithOIDC dari layanan STS menggunakan informasi konfigurasi dari variabel lingkungan. Metode ini menghilangkan risiko memelihara pasangan AccessKey atau token STS secara manual karena Anda tidak perlu menyediakannya. Untuk informasi lebih lanjut, lihat Konfigurasi izin RAM untuk ServiceAccount melalui RRSA untuk mencapai isolasi izin pod.

1. Tambahkan dependensi kredensial.

   <!-- https://mvnrepository.com/artifact/com.aliyun/credentials-java -->
   <dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>credentials-java</artifactId>
       <version>LATEST</version>
   </dependency>

2. Konfigurasikan peran RAM OIDC sebagai kredensial akses.

   import com.aliyun.credentials.models.CredentialModel;
   import com.aliyun.oss.ClientBuilderConfiguration;
   import com.aliyun.oss.OSS;
   import com.aliyun.oss.OSSClientBuilder;
   import com.aliyun.oss.common.auth.Credentials;
   import com.aliyun.oss.common.auth.CredentialsProvider;
   import com.aliyun.oss.common.auth.DefaultCredentials;
   import com.aliyun.oss.common.comm.SignVersion;
   
   public class OidcRoleArnDemoTest {
       public static void main(String[] args) {
   
           com.aliyun.credentials.models.Config config = new com.aliyun.credentials.models.Config();
           // Tentukan jenis Credential. Atur ke oidc_role_arn.
           config.setType("oidc_role_arn");
           // ARN peran RAM. Anda dapat mengatur RoleArn melalui variabel lingkungan ALIBABA_CLOUD_ROLE_ARN.
           config.setRoleArn("<RoleArn>");
           // ARN penyedia OIDC. Anda dapat mengatur OidcProviderArn melalui variabel lingkungan ALIBABA_CLOUD_OIDC_PROVIDER_ARN.
           config.setOidcProviderArn("<OidcProviderArn>");
           // Path ke file token OIDC. Anda dapat mengatur OidcTokenFilePath melalui variabel lingkungan ALIBABA_CLOUD_OIDC_TOKEN_FILE.
           config.setOidcTokenFilePath("<OidcTokenFilePath>");
           // Nama sesi peran. Anda dapat mengatur RoleSessionName melalui variabel lingkungan ALIBABA_CLOUD_ROLE_SESSION_NAME.
           config.setRoleSessionName("<RoleSessionName>");
           // Atur kebijakan izin yang lebih kecil. Ini opsional. Contoh: {"Statement": [{"Action": ["*"],"Effect": "Allow","Resource": ["*"]}],"Version":"1"}
           config.setPolicy("<Policy>");
           // Atur waktu kedaluwarsa sesi.
           config.setRoleSessionExpiration(3600);
   
           final com.aliyun.credentials.Client credentialsClient = new com.aliyun.credentials.Client(config);
   
           CredentialsProvider credentialsProvider = new CredentialsProvider(){
               @Override
               public void setCredentials(Credentials credentials) {
               }
   
               @Override
               public Credentials getCredentials() {
                   CredentialModel credential = credentialsClient.getCredential();
                   return  new DefaultCredentials(credential.getAccessKeyId(), credential.getAccessKeySecret(), credential.getSecurityToken());
               }
           };
           // Gunakan credentialsProvider untuk menginisialisasi klien.
           ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
           // Secara eksplisit deklarasikan penggunaan algoritma tanda tangan V4.
           clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);  
           // Buat instance OSSClient.
           // Saat instance OSSClient tidak lagi diperlukan, panggil metode shutdown untuk melepaskan sumber daya.
           OSS ossClient = OSSClientBuilder.create()
                   .endpoint("endpoint")
                   .credentialsProvider(credentialsProvider)
                   .clientConfiguration(clientBuilderConfiguration)
                   .region("region")
                   .build();
   
           ossClient.shutdown();
       }
   }

Gunakan kredensial dari konteks Function Compute

Metode ini untuk fungsi aplikasi yang dideploy di Function Compute. Anda dapat menginisialisasi penyedia kredensial dengan kredensial dari konteks Function Compute. Implementasi dasarnya didasarkan pada token STS. Function Compute memperoleh token STS dengan mengasumsikan peran layanan yang dikonfigurasi untuk fungsi tersebut dan kemudian meneruskan token STS ke aplikasi Anda melalui parameter Credentials dalam konteks. Token STS ini berlaku selama 36 jam dan tidak dapat dimodifikasi. Waktu eksekusi maksimum fungsi adalah 24 jam, sehingga token STS tidak akan kedaluwarsa selama eksekusi fungsi, dan Anda tidak perlu mempertimbangkan refresh-nya. Metode ini menghilangkan risiko memelihara pasangan AccessKey atau token STS secara manual karena Anda tidak perlu menyediakannya. Untuk memberikan izin Function Compute untuk mengakses OSS, lihat Gunakan peran fungsi untuk memberikan izin Function Compute untuk mengakses layanan Alibaba Cloud lainnya.

1. Tambahkan dependensi konteks Function Compute.

   <!-- https://mvnrepository.com/artifact/com.aliyun.fc.runtime/fc-java-core -->
   <dependency>
       <groupId>com.aliyun.fc.runtime</groupId>
       <artifactId>fc-java-core</artifactId>
       <version>1.4.1</version>
   </dependency>

2. Inisialisasi penyedia kredensial dengan kredensial dari konteks Function Compute.

   import java.io.IOException;
   import java.io.InputStream;
   import java.io.OutputStream;
   
   import com.aliyun.fc.runtime.Context;
   import com.aliyun.fc.runtime.Credentials;
   import com.aliyun.fc.runtime.StreamRequestHandler;
   import com.aliyun.oss.ClientBuilderConfiguration;
   import com.aliyun.oss.OSS;
   import com.aliyun.oss.OSSClientBuilder;
   import com.aliyun.oss.common.auth.*;
   import com.aliyun.oss.common.comm.SignVersion;
   
   public class App implements StreamRequestHandler {
   
       @Override
       public void handleRequest(
           InputStream inputStream, OutputStream outputStream, Context context) throws IOException {
   
           // Dapatkan informasi kunci. Sebelum eksekusi, pastikan layanan tempat fungsi berada dikonfigurasi dengan informasi peran, dan peran tersebut memiliki izin OSS yang diperlukan. Kami merekomendasikan menggunakan peran AliyunFCDefaultRole.
           Credentials creds = context.getExecutionCredentials();
   
           // Gunakan kredensial yang diperoleh untuk membuat instance penyedia kredensial.
           CredentialsProvider credentialsProvider = new DefaultCredentialProvider(creds.getAccessKeyId(), creds.getAccessKeySecret(), creds.getSecurityToken());
   
           // Gunakan credentialsProvider untuk menginisialisasi klien.
           ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
           // Secara eksplisit deklarasikan penggunaan algoritma tanda tangan V4.
           clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);  
           // Buat instance OSSClient.
           // Saat instance OSSClient tidak lagi diperlukan, panggil metode shutdown untuk melepaskan sumber daya.
           OSS ossClient = OSSClientBuilder.create()
                   .endpoint("endpoint")
                   .credentialsProvider(credentialsProvider)
                   .clientConfiguration(clientBuilderConfiguration)
                   .region("region")
                   .build();
   
           ossClient.shutdown();
   
           outputStream.write(new String("done").getBytes());
       }
   }

Gunakan CredentialsURI

Cocok untuk aplikasi yang mengambil kredensial dari sistem eksternal untuk manajemen kredensial yang fleksibel. Inisialisasi penyedia kredensial dengan URI yang mengembalikan token STS. SDK secara otomatis memperoleh dan merefresh token dari URI yang ditentukan.

1. Agar SDK dapat mengurai dan menggunakan token STS dengan benar, URI harus mengikuti protokol respons berikut:

   • Kode status respons: 200

   • Struktur isi respons:

     {
         "Code": "Success",
         "AccessKeySecret": "AccessKeySecret",
         "AccessKeyId": "AccessKeyId",
         "Expiration": "2021-09-26T03:46:38Z",
         "SecurityToken": "SecurityToken"
     }

2. Tambahkan dependensi kredensial.

   <!-- https://mvnrepository.com/artifact/com.aliyun/credentials-java -->
   <dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>credentials-java</artifactId>
       <version>LATEST</version>
   </dependency>

3. Konfigurasikan CredentialsURI sebagai kredensial akses.

   import com.aliyun.credentials.models.CredentialModel;
   import com.aliyun.oss.ClientBuilderConfiguration;
   import com.aliyun.oss.OSS;
   import com.aliyun.oss.OSSClientBuilder;
   import com.aliyun.oss.common.auth.Credentials;
   import com.aliyun.oss.common.auth.CredentialsProvider;
   import com.aliyun.oss.common.auth.DefaultCredentials;
   import com.aliyun.oss.common.comm.SignVersion;
   
   public class CredentialsUriDemoTest {
       public static void main(String[] args) {
   
           com.aliyun.credentials.models.Config config = new com.aliyun.credentials.models.Config();
           // Jenis kredensial akses. Atur ke credentials_uri.
           config.setType("credentials_uri");
           // URI kredensial, yaitu alamat server Anda yang menghasilkan token STS, dalam format http://local_or_remote_uri/. Anda dapat mengatur CredentialsUri melalui variabel lingkungan ALIBABA_CLOUD_CREDENTIALS_URI.
           config.setCredentialsUri("<CredentialsUri>");
   
           final com.aliyun.credentials.Client credentialsClient = new com.aliyun.credentials.Client(config);
   
           CredentialsProvider credentialsProvider = new CredentialsProvider(){
               @Override
               public void setCredentials(Credentials credentials) {
               }
   
               @Override
               public Credentials getCredentials() {
                   CredentialModel credential = credentialsClient.getCredential();
                   return  new DefaultCredentials(credential.getAccessKeyId(), credential.getAccessKeySecret(), credential.getSecurityToken());
               }
           };
           // Gunakan credentialsProvider untuk menginisialisasi klien.
           ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
           // Secara eksplisit deklarasikan penggunaan algoritma tanda tangan V4.
           clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);  
           // Buat instance OSSClient.
           // Saat instance OSSClient tidak lagi diperlukan, panggil metode shutdown untuk melepaskan sumber daya.
           OSS ossClient = OSSClientBuilder.create()
                   .endpoint("endpoint")
                   .credentialsProvider(credentialsProvider)
                   .clientConfiguration(clientBuilderConfiguration)
                   .region("region")
                   .build();
   
           ossClient.shutdown();
       }
   }

Gunakan pasangan AccessKey yang berotasi otomatis

Cocok untuk aplikasi yang memerlukan akses OSS jangka panjang di lingkungan dengan risiko kebocoran AccessKey. Inisialisasi penyedia kredensial dengan ClientKey. KMS secara otomatis merotasi pasangan AccessKey Pengguna RAM yang dikelola, menjadikan kredensial statis menjadi dinamis dan mengurangi risiko kebocoran. KMS juga mendukung rotasi segera. Untuk mendapatkan ClientKey, lihat Buat titik akses aplikasi.

1. Tambahkan dependensi klien kredensial.

   <!-- https://mvnrepository.com/artifact/com.aliyun/alibabacloud-secretsmanager-client -->
   <dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>alibabacloud-secretsmanager-client</artifactId>
       <version>1.3.7</version>
   </dependency>
   <!-- https://mvnrepository.com/artifact/com.aliyun/aliyun-java-sdk-core -->
   <dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>aliyun-java-sdk-core</artifactId>
       <version>4.7.0</version>
   </dependency>

2. Buat file konfigurasi secretsmanager.properties.

   # Jenis kredensial akses, tetap sebagai client_key
   credentials_type=client_key
   
   # Kata sandi dekripsi untuk membaca Client Key: mendukung pembacaan dari variabel lingkungan atau file, cukup atur salah satu
   client_key_password_from_env_variable=<nama variabel lingkungan kata sandi kunci privat client key Anda>
   client_key_password_from_file_path=<path file kata sandi kunci privat client key Anda>
   
   # Path ke file kunci privat Client Key
   client_key_private_key_path=<path file kunci privat client key Anda>
   
   # Wilayah layanan KMS terkait
   cache_client_region_id=[{"regionId":"<regionId>"}]

3. Gunakan file konfigurasi untuk meneruskan informasi kredensial.

   import com.aliyun.oss.ClientBuilderConfiguration;
   import com.aliyun.oss.OSS;
   import com.aliyun.oss.OSSClientBuilder;
   import com.aliyun.oss.common.auth.Credentials;
   import com.aliyun.oss.common.auth.CredentialsProvider;
   import com.aliyun.oss.common.auth.DefaultCredentials;
   import com.aliyun.oss.common.comm.SignVersion;
   import com.aliyuncs.kms.secretsmanager.client.SecretCacheClient;
   import com.aliyuncs.kms.secretsmanager.client.SecretCacheClientBuilder;
   import com.aliyuncs.kms.secretsmanager.client.exception.CacheSecretException;
   import com.aliyuncs.kms.secretsmanager.client.model.SecretInfo;
   import org.codehaus.jettison.json.JSONException;
   import org.codehaus.jettison.json.JSONObject;
   
   public class ClientKeyDemoTest {
       public static void main(String[] args) throws CacheSecretException {
           final SecretCacheClient client = SecretCacheClientBuilder.newClient();
           CredentialsProvider credentialsProvider = new CredentialsProvider() {
               @Override
               public void setCredentials(Credentials credentials) {
               }
   
               @Override
               public Credentials getCredentials() {
                   try {
                       SecretInfo secretInfo = client.getSecretInfo("<secretName>");
                       JSONObject jsonObject = new JSONObject(secretInfo.getSecretValue());
   
                       String accessKeyId = jsonObject.getString("AccessKeyId");
                       String accessKeySecret = jsonObject.getString("AccessKeySecret");
   
                       return new DefaultCredentials(accessKeyId, accessKeySecret);
                   } catch (CacheSecretException | JSONException e) {
                       return null;
                   }
               }
           };
           // Gunakan credentialsProvider untuk menginisialisasi klien.
           ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
           // Secara eksplisit deklarasikan penggunaan algoritma tanda tangan V4.
           clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);  
           // Buat instance OSSClient.
           // Saat instance OSSClient tidak lagi diperlukan, panggil metode shutdown untuk melepaskan sumber daya.
           OSS ossClient = OSSClientBuilder.create()
                   .endpoint("endpoint")
                   .credentialsProvider(credentialsProvider)
                   .clientConfiguration(clientBuilderConfiguration)
                   .region("region")
                   .build();
   
           ossClient.shutdown();
       }
   }
   

Gunakan kredensial akses kustom

Jika metode konfigurasi kredensial sebelumnya tidak memenuhi kebutuhan Anda, Anda dapat menyesuaikan penyedia kredensial dengan mengimplementasikan antarmuka Credential Providers. Perhatikan bahwa jika implementasi dasarnya didasarkan pada token STS, Anda perlu menyediakan dukungan untuk pembaruan kredensial.

import com.aliyun.oss.ClientBuilderConfiguration;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.common.auth.Credentials;
import com.aliyun.oss.common.auth.CredentialsProvider;
import com.aliyun.oss.common.auth.DefaultCredentials;
import com.aliyun.oss.common.comm.SignVersion;

public class CustomCredentialProviderDemoTest {

    public static void main(String[] args) {

        CredentialsProvider credentialsProvider = new CredentialsProvider(){

            // Inisialisasi variabel
            String accessKeyId = null;
            // Inisialisasi variabel
            String accessKeySecrect = null;
            // Inisialisasi variabel
            // String token = null;

            @Override
            public void setCredentials(Credentials credentials) {
            }

            @Override
            public Credentials getCredentials() {
                //TODO
                //Sesuaikan metode untuk mendapatkan kredensial akses.

                // Kembalikan kredensial jangka panjang: access_key_id, access_key_secrect  
                return new DefaultCredentials(accessKeyId, accessKeySecrect);

                // Kembalikan kredensial sementara: access_key_id, access_key_secrect, token
                // Untuk kredensial sementara, Anda perlu merefresh berdasarkan waktu kedaluwarsanya.
                // return new DefaultCredentials(accessKeyId, accessKeySecrect, token);
            }
        };
        // Gunakan credentialsProvider untuk menginisialisasi klien.
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        // Secara eksplisit deklarasikan penggunaan algoritma tanda tangan V4.
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);  
        // Buat instance OSSClient.
        // Saat instance OSSClient tidak lagi diperlukan, panggil metode shutdown untuk melepaskan sumber daya.
        OSS ossClient = OSSClientBuilder.create()
                .endpoint("endpoint")
                .credentialsProvider(credentialsProvider)
                .clientConfiguration(clientBuilderConfiguration)
                .region("region")
                .build();

        ossClient.shutdown();
    }
}

Gunakan rantai kredensial default

Saat Anda menginisialisasi klien kredensial tanpa parameter, SDK menggunakan rantai kredensial default. Untuk logika rantai kredensial, lihat Rantai kredensial default.

1. Tambahkan dependensi kredensial.

   <!-- https://mvnrepository.com/artifact/com.aliyun/credentials-java -->
   <dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>credentials-java</artifactId>
       <version>LATEST</version>
   </dependency>

2. Konfigurasikan Credentials sebagai kredensial akses.

   import com.aliyun.credentials.models.CredentialModel;
   import com.aliyun.oss.*;
   import com.aliyun.oss.common.auth.Credentials;
   import com.aliyun.oss.common.auth.CredentialsProvider;
   import com.aliyun.oss.common.auth.DefaultCredentials;
   import com.aliyun.oss.common.comm.SignVersion;
   
   public class Demo {
       public static void main(String[] args) {
           com.aliyun.credentials.Client credentialsClient = new com.aliyun.credentials.Client();
           CredentialsProvider credentialsProvider = new CredentialsProvider(){
               @Override
               public void setCredentials(Credentials credentials) {
               }
   
               @Override
               public Credentials getCredentials() {
                   CredentialModel credential = credentialsClient.getCredential();
                   return  new DefaultCredentials(credential.getAccessKeyId(), credential.getAccessKeySecret(), credential.getSecurityToken());
               }
           };
           ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
           // Secara eksplisit deklarasikan penggunaan algoritma tanda tangan V4.
           clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);  
           // Gunakan credentialsProvider untuk menginisialisasi klien.
           // Buat instance OSSClient.
           // Saat instance OSSClient tidak lagi diperlukan, panggil metode shutdown untuk melepaskan sumber daya.
           OSS ossClient = OSSClientBuilder.create()
                   .endpoint("endpoint")
                   .credentialsProvider(credentialsProvider)
                   .clientConfiguration(clientBuilderConfiguration)
                   .region("region")
                   .build();
           ossClient.shutdown();
       }
   }

Konflik paket

• Penyebab

  Saat Anda menggunakan OSS Java SDK V1, kesalahan serupa berikut menunjukkan adanya konflik paket dalam proyek Anda.

  Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/http/ssl/TrustStrategy
      at com.aliyun.oss.OSSClient.<init>(OSSClient.java:268)
      at com.aliyun.oss.OSSClient.<init>(OSSClient.java:193)
      at com.aliyun.oss.demo.HelloOSS.main(HelloOSS.java:77)
  Caused by: java.lang.ClassNotFoundException: org.apache.http.ssl.TrustStrategy
      at java.net.URLClassLoader$1.run(URLClassLoader.java:366)
      at java.net.URLClassLoader$1.run(URLClassLoader.java:355)
      at java.security.AccessController.doPrivileged(Native Method)
      at java.net.URLClassLoader.findClass(URLClassLoader.java:354)
      at java.lang.ClassLoader.loadClass(ClassLoader.java:425)
      at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:308)
      at java.lang.ClassLoader.loadClass(ClassLoader.java:358)
      ... 3 more
                      

  atau

  Exception in thread "main" java.lang.NoSuchFieldError: INSTANCE
   at org.apache.http.impl.io.DefaultHttpRequestWriterFactory.<init>(DefaultHttpRequestWriterFactory.java:52)
   at org.apache.http.impl.io.DefaultHttpRequestWriterFactory.<init>(DefaultHttpRequestWriterFactory.java:56)
   at org.apache.http.impl.io.DefaultHttpRequestWriterFactory.<clinit>(DefaultHttpRequestWriterFactory.java:46)
   at org.apache.http.impl.conn.ManagedHttpClientConnectionFactory.<init>(ManagedHttpClientConnectionFactory.java:82)
   at org.apache.http.impl.conn.ManagedHttpClientConnectionFactory.<init>(ManagedHttpClientConnectionFactory.java:95)
   at org.apache.http.impl.conn.ManagedHttpClientConnectionFactory.<init>(ManagedHttpClientConnectionFactory.java:104)
   at org.apache.http.impl.conn.ManagedHttpClientConnectionFactory.<clinit>(ManagedHttpClientConnectionFactory.java:62)
   at org.apache.http.impl.conn.PoolingHttpClientConnectionManager$InternalConnectionFactory.<init>(PoolingHttpClientConnectionManager.java:572)
   at org.apache.http.impl.conn.PoolingHttpClientConnectionManager.<init>(PoolingHttpClientConnectionManager.java:174)
   at org.apache.http.impl.conn.PoolingHttpClientConnectionManager.<init>(PoolingHttpClientConnectionManager.java:158)
   at org.apache.http.impl.conn.PoolingHttpClientConnectionManager.<init>(PoolingHttpClientConnectionManager.java:149)
   at org.apache.http.impl.conn.PoolingHttpClientConnectionManager.<init>(PoolingHttpClientConnectionManager.java:125)
   at com.aliyun.oss.common.comm.DefaultServiceClient.createHttpClientConnectionManager(DefaultServiceClient.java:237)
   at com.aliyun.oss.common.comm.DefaultServiceClient.<init>(DefaultServiceClient.java:78)
   at com.aliyun.oss.OSSClient.<init>(OSSClient.java:268)
   at com.aliyun.oss.OSSClient.<init>(OSSClient.java:193)
   at OSSManagerImpl.upload(OSSManagerImpl.java:42)
   at OSSManagerImpl.main(OSSManagerImpl.java:63)
                      

  Kesalahan terjadi karena OSS Java SDK V1 menggunakan Apache HttpClient 4.4.1, tetapi proyek Anda menggunakan versi Apache HttpClient yang bertentangan atau paket JAR commons-httpclient. Anda dapat menjalankan perintah mvn dependency:tree di direktori proyek Anda untuk melihat paket JAR dan versinya yang digunakan oleh proyek Anda. Seperti yang ditunjukkan pada gambar berikut, proyek menggunakan Apache HttpClient 4.3, yang bertentangan dengan versi standar:

  

• Solusi

  Selesaikan konflik paket dengan salah satu dari dua cara berikut:

  • Samakan versi: Jika proyek Anda menggunakan versi yang bertentangan dengan Apache HttpClient 4.4.1, perbarui proyek Anda untuk menggunakan versi 4.4.1 dan hapus dependensi pada versi Apache HttpClient lainnya dari file `pom.xml`. Jika proyek Anda menggunakan commons-httpclient, konflik juga dapat terjadi. Hapus dependensi commons-httpclient.

  • Selesaikan konflik dependensi: Jika proyek Anda bergantung pada beberapa paket pihak ketiga, dan paket-paket ini pada gilirannya bergantung pada versi Apache HttpClient yang berbeda, proyek Anda akan mengalami konflik dependensi. Anda dapat menggunakan tag exclusion untuk menyelesaikannya. Untuk informasi lebih lanjut, lihat Panduan Maven.

  OSS Java SDK V1 bergantung pada versi paket berikut. Metode penyelesaian konflik serupa dengan HttpClient.

  

Paket yang hilang

• Penyebab

  Saat Anda menggunakan OSS Java SDK V1, kesalahan serupa berikut menunjukkan bahwa proyek Anda mungkin kehilangan paket yang diperlukan untuk mengompilasi atau menjalankan OSS Java SDK V1.

  Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/http/auth/Credentials
          at com.aliyun.oss.OSSClient.<init>(OSSClient.java:268)
          at com.aliyun.oss.OSSClient.<init>(OSSClient.java:193)
          at com.aliyun.oss.demo.HelloOSS.main(HelloOSS.java:76)
  Caused by: java.lang.ClassNotFoundException: org.apache.http.auth.Credentials
          at java.net.URLClassLoader$1.run(URLClassLoader.java:366)
          at java.net.URLClassLoader$1.run(URLClassLoader.java:355)
          at java.security.AccessController.doPrivileged(Native Method)
          at java.net.URLClassLoader.findClass(URLClassLoader.java:354)
          at java.lang.ClassLoader.loadClass(ClassLoader.java:425)
          at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:308)
          at java.lang.ClassLoader.loadClass(ClassLoader.java:358)
          ... 3 more
                      

  atau

  Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/http/protocol/HttpContext
          at com.aliyun.oss.OSSClient.<init>(OSSClient.java:268)
          at com.aliyun.oss.OSSClient.<init>(OSSClient.java:193)
          at com.aliyun.oss.demo.HelloOSS.main(HelloOSS.java:76)
  Caused by: java.lang.ClassNotFoundException: org.apache.http.protocol.HttpContext
          at java.net.URLClassLoader$1.run(URLClassLoader.java:366)
          at java.net.URLClassLoader$1.run(URLClassLoader.java:355)
          at java.security.AccessController.doPrivileged(Native Method)
          at java.net.URLClassLoader.findClass(URLClassLoader.java:354)
          at java.lang.ClassLoader.loadClass(ClassLoader.java:425)
          at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:308)
          at java.lang.ClassLoader.loadClass(ClassLoader.java:358)
          ... 3 more
                      

  atau

  Exception in thread "main" java.lang.NoClassDefFoundError: org/jdom/input/SAXBuilder
          at com.aliyun.oss.internal.ResponseParsers.getXmlRootElement(ResponseParsers.java:645)
          at … … 
          at com.aliyun.oss.OSSClient.doesBucketExist(OSSClient.java:471)
          at com.aliyun.oss.OSSClient.doesBucketExist(OSSClient.java:465)
          at com.aliyun.oss.demo.HelloOSS.main(HelloOSS.java:82)
  Caused by: java.lang.ClassNotFoundException: org.jdom.input.SAXBuilder
          at java.net.URLClassLoader$1.run(URLClassLoader.java:366)
          at java.net.URLClassLoader$1.run(URLClassLoader.java:355)
          at java.security.AccessController.doPrivileged(Native Method)
          at java.net.URLClassLoader.findClass(URLClassLoader.java:354)
          at java.lang.ClassLoader.loadClass(ClassLoader.java:425)
          at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:308)
          at java.lang.ClassLoader.loadClass(ClassLoader.java:358)
          ... 11 more
                      

  OSS Java SDK V1 bergantung pada paket-paket berikut:

  • 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

  Di antara ini, log4j-1.2.15.jar adalah dependensi opsional. Tambahkan paket ini hanya saat Anda memerlukan fungsionalitas logging. Paket lainnya wajib.

• Solusi

  Tambahkan paket yang dibutuhkan OSS Java SDK V1 ke proyek Anda. Anda dapat menggunakan salah satu metode berikut:

  • Proyek Eclipse: lihat Instal SDK.

  • Proyek Ant: Tempatkan paket yang dibutuhkan OSS Java SDK V1 ke direktori lib proyek Anda.

  • Kompilasi langsung: Gunakan perintah -classpath atau -cp untuk menentukan path paket yang dibutuhkan OSS Java SDK V1, atau tempatkan paket-paket ini di classpath.

Timeout koneksi

• Penyebab

  Saat Anda menjalankan program OSS Java SDK V1, kesalahan serupa berikut dapat terjadi karena titik akhir salah atau masalah konektivitas jaringan.

  com.aliyun.oss.ClientException: SocketException
      at com.aliyun.oss.common.utils.ExceptionFactory.createNetworkException(ExceptionFactory.java:71)
      at com.aliyun.oss.common.comm.DefaultServiceClient.sendRequestCore(DefaultServiceClient.java:116)
      at com.aliyun.oss.common.comm.ServiceClient.sendRequestImpl(ServiceClient.java:121)
      at com.aliyun.oss.common.comm.ServiceClient.sendRequest(ServiceClient.java:67)
      at com.aliyun.oss.internal.OSSOperation.send(OSSOperation.java:92)
      at com.aliyun.oss.internal.OSSOperation.doOperation(OSSOperation.java:140)
      at com.aliyun.oss.internal.OSSOperation.doOperation(OSSOperation.java:111)
      at com.aliyun.oss.internal.OSSBucketOperation.getBucketInfo(OSSBucketOperation.java:1152)
      at com.aliyun.oss.OSSClient.getBucketInfo(OSSClient.java:1220)
      at com.aliyun.oss.OSSClient.getBucketInfo(OSSClient.java:1214)
      at com.aliyun.oss.demo.HelloOSS.main(HelloOSS.java:94)
  Caused by: org.apache.http.conn.HttpHostConnectException: Connect to oss-test.oss-cn-hangzhou-internal.aliyuncs.com:80 [oss-test.oss-cn-hangzhou-internal.aliyuncs.com/10.84.135.99] failed: Connection timed out: connect
      at org.apache.http.impl.conn.DefaultHttpClientConnectionOperator.connect(DefaultHttpClientConnectionOperator.java:151)
      at org.apache.http.impl.conn.PoolingHttpClientConnectionManager.connect(PoolingHttpClientConnectionManager.java:353)
      at org.apache.http.impl.execchain.MainClientExec.establishRoute(MainClientExec.java:380)
      at org.apache.http.impl.execchain.MainClientExec.execute(MainClientExec.java:236)
      at org.apache.http.impl.execchain.ProtocolExec.execute(ProtocolExec.java:184)
      at org.apache.http.impl.execchain.RedirectExec.execute(RedirectExec.java:110)
      at org.apache.http.impl.client.InternalHttpClient.doExecute(InternalHttpClient.java:184)
      at org.apache.http.impl.client.CloseableHttpClient.execute(CloseableHttpClient.java:82)
      at com.aliyun.oss.common.comm.DefaultServiceClient.sendRequestCore(DefaultServiceClient.java:113)
      ... 9 more
                      

• Solusi

  Anda dapat menggunakan alat ossutil untuk segera menemukan penyebab kesalahan dan menyelesaikan masalah.

Kesalahan SignatureDoesNotMatch

• Penyebab 1: Informasi pasangan AccessKey tidak cocok

  ID AccessKey dan rahasia AccessKey tidak cocok. Untuk informasi tentang cara mendapatkan ID AccessKey dan rahasia AccessKey, lihat Buat pasangan AccessKey.

• Penyebab 2: Penggunaan URL yang ditandatangani salah

  Berikut adalah contoh penggunaan URL yang ditandatangani yang salah:

  GeneratePresignedUrlRequest request = new GeneratePresignedUrlRequest(bucketName, object);
  request.setExpiration( new Date(new Date().getTime() + 3600 * 1000));
  request.addUserMetadata("author");
  URL url = ossClient.generatePresignedUrl(request);
  
  Map<String, String> header = new HashMap<String, String>();
  header.put("author");
  ossClient.putObject(url, new ByteArrayInputStream("Hello OSS".getBytes()), -1, header);

  Jika parameter Method tidak ditentukan, metode GET digunakan secara default. Namun, contoh di atas adalah permintaan PutObject. Oleh karena itu, parameter Method harus ditentukan dan diatur ke PUT.

  Saat Anda mengirim permintaan PutObject, metadata kustom dalam header permintaan harus diawali dengan x-oss-meta-. Dalam contoh di atas, metadata kustom harus diubah menjadi x-oss-meta-author.

  Solusi:

  Tentukan parameter Method dan modifikasi awalan header:

  request.addUserMetadata("author");
  request.setMethod(HttpMethod.PUT);
  URL url = ossClient.generatePresignedUrl(request);
  
  Map<String, String> header = new HashMap<String, String>();
  header.put("x-oss-meta-" + "author");
  ossClient.putObject(url, new ByteArrayInputStream("Hello OSS".getBytes()), -1, header);

• Penyebab 3: Masalah kompatibilitas versi HttpClient

  • SDK OSS versi lebih lama dari 3.7.0 digunakan, dan HttpClient 4.5.9 atau yang lebih baru diperkenalkan dalam proyek.

  • Nama file yang diunggah berisi karakter +, dan HttpClient 4.5.9 tidak melakukan encode URL pada karakter +. Hal ini menyebabkan tanda tangan yang dihitung oleh klien dan server tidak konsisten.

  

  Solusi:

  • Upgrade SDK OSS ke versi 3.11.1 atau yang lebih baru agar kompatibel dengan HttpClient 4.5.9.

  • Hapus dependensi HttpClient yang berlebihan. Saat Anda memperkenalkan SDK OSS, dependensi HttpClient secara otomatis diperkenalkan. Jika pustaka pihak ketiga juga memperkenalkan HttpClient, lihat solusi untuk Konflik paket.

• Penyebab 4: Masalah kompatibilitas set karakter HttpClient

  HttpClient 4.5.10 tidak mendukung karakter di luar standar ISO-8859-1 dalam header. Dalam proyek yang menggunakan versi HttpClient lebih baru dari 4.5.10, masalah terjadi jika header permintaan berisi karakter di luar standar ISO-8859-1, seperti karakter Cina dalam metadata kustom yang diawali dengan x-oss-meta-.

  Solusi:

  • Lihat solusi untuk Konflik paket untuk menghapus versi HttpClient yang bertentangan.

  • Hanya gunakan karakter yang sesuai dengan standar ISO-8859-1 dalam header permintaan.

Pengecualian "Gagal mengurai hasil respons"

• Penyebab

  Perangkat lunak khusus tertentu di sisi klien mencegat permintaan HTTP, atau rute jaringan publik membajak permintaan HTTP.

  Anda menggunakan OSS Java SDK V1 pada Java 9 atau yang lebih baru, dan Anda belum menambahkan dependensi terkait JAXB ke file pom.xml.

• Solusi

  Beralih ke permintaan HTTPS.

  Tambahkan dependensi terkait JAXB. Untuk prosedurnya, lihat Instal SDK.

org.apache.http.NoHttpResponseException: Server target gagal merespons

• Penyebab

  Saat Anda menjalankan program OSS Java SDK V1, kesalahan serupa berikut dilaporkan:

  

  Menggunakan koneksi yang kedaluwarsa menyebabkan kesalahan di atas. Kesalahan ini hanya terjadi pada versi Java SDK lebih lama dari 2.1.2.

• Solusi

  Upgrade OSS Java SDK V1 ke versi 2.1.2 atau yang lebih baru.

Banyak instance org.apache.http.impl.conn.PoolingHttpClientConnectionManager ada di JVM

• Penyebab

  ossClient tidak ditutup dengan benar.

• Solusi

  Tutup ossClient setelah selesai dieksekusi, atau gunakan pola singleton.

Panggilan OSS Java SDK V1 tidak merespons

• Penyebab

  Panggilan OSS Java SDK V1 tidak merespons. Dengan menjalankan perintah jstack -l pid untuk melihat stack, Anda dapat menemukan masalah pada posisi berikut:

  "main" prio=6 tid=0x000000000291e000 nid=0xc40 waiting on condition [0x0000000002dae000]
  java.lang.Thread.State: WAITING (parking)
      at sun.misc.Unsafe.park(Native Method)
      - parking to wait for  <0x00000007d85697f8> (a java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject)
      at java.util.concurrent.locks.LockSupport.park(LockSupport.java:186)
      at java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject.await(AbstractQueuedSynchronizer.java:2043)
      at org.apache.http.pool.PoolEntryFuture.await(PoolEntryFuture.java:138)
      at org.apache.http.pool.AbstractConnPool.getPoolEntryBlocking(AbstractConnPool.java:306)
      at org.apache.http.pool.AbstractConnPool.access$000(AbstractConnPool.java:64)
      at org.apache.http.pool.AbstractConnPool$2.getPoolEntry(AbstractConnPool.java:192)
      at org.apache.http.pool.AbstractConnPool$2.getPoolEntry(AbstractConnPool.java:185)
      at org.apache.http.pool.PoolEntryFuture.get(PoolEntryFuture.java:107)
      at org.apache.http.impl.conn.PoolingHttpClientConnectionManager.leaseConnection(PoolingHttpClientConnectionManager.java:276)
      at org.apache.http.impl.conn.PoolingHttpClientConnectionManager$1.get(PoolingHttpClientConnectionManager.java:263)
      at org.apache.http.impl.execchain.MainClientExec.execute(MainClientExec.java:190)
      at org.apache.http.impl.execchain.ProtocolExec.execute(ProtocolExec.java:184)
      at org.apache.http.impl.execchain.RedirectExec.execute(RedirectExec.java:110)
      at org.apache.http.impl.client.InternalHttpClient.doExecute(InternalHttpClient.java:184)
      at org.apache.http.impl.client.CloseableHttpClient.execute(CloseableHttpClient.java:82)
      at com.aliyun.oss.common.comm.DefaultServiceClient.sendRequestCore(DefaultServiceClient.java:113)
      at com.aliyun.oss.common.comm.ServiceClient.sendRequestImpl(ServiceClient.java:123)
      at com.aliyun.oss.common.comm.ServiceClient.sendRequest(ServiceClient.java:68)
      at com.aliyun.oss.internal.OSSOperation.send(OSSOperation.java:94)
      at com.aliyun.oss.internal.OSSOperation.doOperation(OSSOperation.java:146)
      at com.aliyun.oss.internal.OSSOperation.doOperation(OSSOperation.java:113)
      at com.aliyun.oss.internal.OSSObjectOperation.getObject(OSSObjectOperation.java:229)
      at com.aliyun.oss.OSSClient.getObject(OSSClient.java:629)
      at com.aliyun.oss.OSSClient.getObject(OSSClient.java:617)
      at samples.HelloOSS.main(HelloOSS.java:49)
                      

  Penyebabnya adalah kebocoran koneksi di kolam koneksi, kemungkinan karena ossObject tidak ditutup dengan benar setelah digunakan.

• Solusi

  Periksa program Anda untuk memastikan tidak ada kebocoran koneksi. Gunakan metode berikut untuk menutup koneksi dengan benar:

  // Baca file.
  OSSObject ossObject = ossClient.getObject(bucketName, objectName);
  // Operasi OSS
  // Tutup ossObject.
  ossObject.close();                

  Untuk langkah troubleshooting terperinci, lihat Troubleshoot unresponsive OSS Java SDK V1.

Koneksi ditutup

• Penyebab

  Jika Anda mengalami kesalahan serupa berikut saat menggunakan ossClient.getObject:

  Exception in thread "main" org.apache.http.ConnectionClosedException: Premature end of Content-Length delimited message body (expected: 11990526; received: 202880)
      at org.apache.http.impl.io.ContentLengthInputStream.read(ContentLengthInputStream.java:180)
      at org.apache.http.impl.io.ContentLengthInputStream.read(ContentLengthInputStream.java:200)
      at org.apache.http.impl.io.ContentLengthInputStream.close(ContentLengthInputStream.java:103)
      at org.apache.http.impl.execchain.ResponseEntityProxy.streamClosed(ResponseEntityProxy.java:128)
      at org.apache.http.conn.EofSensorInputStream.checkClose(EofSensorInputStream.java:228)
      at org.apache.http.conn.EofSensorInputStream.close(EofSensorInputStream.java:174)
      at java.io.FilterInputStream.close(FilterInputStream.java:181)
      at java.io.FilterInputStream.close(FilterInputStream.java:181)
      at com.aliyun.oss.event.ProgressInputStream.close(ProgressInputStream.java:147)
      at java.io.FilterInputStream.close(FilterInputStream.java:181)
      at samples.HelloOSS.main(HelloOSS.java:39)
                      

  Penyebabnya adalah interval antara dua pembacaan data melebihi 1 menit. OSS menutup koneksi yang idle lebih dari 1 menit.

• Solusi

  Jika Anda hanya membaca sebagian data setiap kali dan waktu pemrosesan bervariasi, gunakan unduhan rentang untuk menghindari penutupan koneksi. Koneksi akan ditutup secara otomatis setelah unduhan rentang selesai. Unduhan rentang (OSS Java SDK V1).

Kebocoran memori

• Penyebab

  Program yang memanggil OSS Java SDK V1 mengalami kebocoran memori setelah berjalan selama periode waktu tertentu (dari beberapa jam hingga beberapa hari, tergantung volume bisnis). Kami merekomendasikan menggunakan Eclipse Memory Analyzer (MAT) untuk menganalisis penggunaan memori. Untuk informasi lebih lanjut, lihat Analisis file heap dump dengan MAT.

  Jika hasil analisis serupa dengan gambar di bawah (PoolingHttpClientConnectionManager menempati 96% memori), penyebabnya adalah new OSSClient mungkin telah dieksekusi beberapa kali dalam program, tetapi ossClient.shutdown tidak dipanggil, yang mengakibatkan kebocoran memori.

  

• Solusi

  Setelah operasi new OSSClient selesai, panggil metode shutdown untuk menutupnya. Pastikan new OSSClient dan ossClient.shutdown digunakan berpasangan.

InterruptedException dilaporkan saat memanggil ossClient.shutdown

• Penyebab

  Versi OSS Java SDK V1 lebih lama dari 2.3.0 melaporkan pengecualian berikut saat memanggil ossClient.shutdown:

  java.lang.InterruptedException: sleep interrupted
          at java.lang.Thread.sleep(Native Method)
          at com.aliyun.oss.common.comm.IdleConnectionReaper.run(IdleConnectionReaper:76)      

  Penyebabnya adalah thread backend ossClient IdleConnectionReaper secara berkala menutup koneksi idle. Jika ossClient.shutdown dipanggil saat IdleConnectionReaper sedang dalam Sleep, pengecualian di atas dilaporkan.

• Solusi

  Gunakan kode berikut untuk mengabaikan pengecualian:

  try {
      ossClient.shutdown();
  } catch(Exception e) {
  }                  

Pengecualian "SDK.ServerUnreachable : Speicified endpoint or uri is not valid"

• Penyebab

  • Klien mengirim terlalu banyak permintaan konkuren ke STS.

  • Koneksi jaringan ke server timeout.

  • STS SDK dan SDK core yang digunakan bukan versi terbaru.

• Solusi

  • Kurangi konkurensi OSS. Jika klien mengirim terlalu banyak permintaan konkuren ke STS, instance ECS klien atau komputer lokal mungkin tidak dapat menangani beban tersebut.

  • Koneksi jaringan dari pengguna ke server timeout. Anda dapat menangkap paket untuk memverifikasi hal ini.

  • Upgrade STS SDK dan SDK core ke versi terbaru.

NoSuchKey

• Penyebab

  File sumber tidak ada.

• Solusi

  Kesalahan 404.

SocketException

• Penyebab

  Socket mungkin gagal selama fase inisialisasi, menyebabkan permintaan gagal sebelum mencapai OSS.

• Solusi

  Kami merekomendasikan Anda memeriksa aspek-aspek berikut:

  • Apakah fluktuasi jaringan terjadi saat masalah tersebut muncul?

  • Apakah jumlah koneksi socket pada host telah mencapai batasnya.

  • Konfirmasi apakah jumlah koneksi melebihi pengaturan maxconnection di SDK saat masalah terjadi. Jika jumlah koneksi melebihi pengaturan maxconnection, pengecualian socket juga akan terjadi.

  Jika tidak ada masalah dengan hal-hal di atas, kami merekomendasikan Anda menerapkan tcpdump atau Wireshark untuk menangkap paket, lalu menganalisis paket data setelah masalah muncul kembali.

Callback OSS PostObject tidak dipicu

Callback OSS PostObject tidak dipicu, tetapi callback yang sama dipicu oleh PutObject. Umumnya, jika format JSON salah atau callback gagal, pesan yang sesuai akan dikembalikan. Dalam kasus ini, Anda perlu menguji perilaku callback Put dan Post secara terpisah:

• Penyebab

  Saat mengirim permintaan, parameter `callback` salah ditempatkan di dalam parameter `file`.

• Solusi

  Sesuaikan posisi parameter callback dan file.

  Pada titik ini, hasil pengujian menunjukkan bahwa server bisnis berhasil menangkap permintaan.

Kolam koneksi dimatikan

Caused by: java.lang.IllegalStateException: Connection pool shut down
  at org.apache.http.util.Asserts.check(Asserts.java:34)
  at org.apache.http.pool.AbstractConnPool.lease(AbstractConnPool.java:184)
  at org.apache.http.impl.conn.PoolingHttpClientConnectionManager.requestConnection(PoolingHttpClientConnectionManager.java:251)
  at org.apache.http.impl.execchain.MainClientExec.execute(MainClientExec.java:175)
  at org.apache.http.impl.execchain.ProtocolExec.execute(ProtocolExec.java:184)
  at org.apache.http.impl.execchain.RedirectExec.execute(RedirectExec.java:110)
  at org.apache.http.impl.client.InternalHttpClient.doExecute(InternalHttpClient.java:184)
  at org.apache.http.impl.client.CloseableHttpClient.execute(CloseableHttpClient.java:82)
  at com.aliyun.oss.common.comm.DefaultServiceClient.sendRequestCore(DefaultServiceClient.java:124)
  at com.aliyun.oss.common.comm.ServiceClient.sendRequestImpl(ServiceClient.java:133)
  ... 8 more

• Penyebab

  Anda terus mengirim permintaan melalui ossClient setelah memanggil metode ossClient.shutdown().

• Solusi

  Periksa logika pemanggilan Anda untuk memastikan bahwa setelah Anda memanggil metode ossClient.shutdown(), Anda tidak lagi mengirim permintaan melalui ossClient.

Kesalahan "Request has expired" terjadi untuk permintaan yang dihasilkan oleh generatePresignedUrl dari Java SDK

• Penyebab

  Overflow integer menyebabkan masalah timestamp terkait masalah tahun 2038.

  Permintaan unggahan dimulai setelah waktu kedaluwarsa yang ditetapkan untuk URL.

• Solusi

  Jika ini adalah overflow integer, kami merekomendasikan agar durasi kedaluwarsa di Java SDK tidak melebihi tahun 2038.

  Jika permintaan unggahan dimulai setelah waktu kedaluwarsa yang ditetapkan untuk URL, atur waktu kedaluwarsa yang wajar untuk memastikan waktu kedaluwarsa lebih lambat dari waktu Anda memulai permintaan.

Kesalahan "Invalid Response" atau "Implementation of JAXB-API has not been found on module path or classpath"

• Penyebab

  Anda menggunakan Java 9 atau yang lebih baru dan belum menambahkan dependensi JAXB.

• Solusi

  Untuk informasi tentang cara menambahkan dependensi JAXB, lihat Instal SDK.

Apakah OSSClient di OSS Java SDK V1 thread-safe?

1. OSSClient bersifat thread-safe, memungkinkan beberapa thread mengakses instance yang sama. Bergantung pada kebutuhan bisnis Anda, Anda dapat menggunakan kembali satu instance OSSClient atau membuat beberapa instance.

2. Instance OSSClient mempertahankan kolam koneksi internal. Saat instance OSSClient tidak lagi diperlukan, Anda harus memanggil metode shutdown untuk menutupnya dan menghindari kehabisan sumber daya akibat membuat terlalu banyak instance OSSClient.

Kesalahan "AccessDenied Hierarchical namespace is disabled" dilaporkan

• Penyebab

  Ruang nama hierarkis tidak diaktifkan sebelum Anda memanggil operasi API CreateDirectory, Rename, atau DeleteDirectory.

• Solusi

  Aktifkan ruang nama hierarkis saat Anda membuat bucket. Untuk prosedur spesifiknya, lihat Buat bucket.

Jaringan klien normal, tetapi kesalahan "Connection reset" dilaporkan selama akses HTTP. Bagaimana cara menanganinya?

Operator di beberapa wilayah mungkin membajak nama domain OSS. Konfigurasikan HTTPS melalui titik akhir. Konfigurasi klien.

Java 17 Cannot invoke "java.lang.reflect.Method.invoke(Object, Object[])" because "com.sun.xml.bind.v2.runtime.reflect.opt.Injector.defineClass" is null

• Penyebab

  JAXB ditandai sebagai deprecated di Java 9 dan dihapus di Java 11.

• Solusi

  Tambahkan dependensi berikut:

      <dependency>
          <groupId>com.sun.xml.bind</groupId>
          <artifactId>jaxb-impl</artifactId>
          <version>2.3.1</version>
      </dependency>
      <dependency>
          <groupId>com.sun.xml.messaging.saaj</groupId>
          <artifactId>saaj-impl</artifactId>
          <version>1.5.1</version>
      </dependency>

Bagaimana cara mengonfigurasi pencetakan log internal untuk Java SDK?

Java SDK menggunakan framework Apache Commons Logging (JCL) untuk pencetakan log. JCL dapat menggunakan beberapa framework implementasi logging. Untuk informasi lebih lanjut, lihat JCL-Konfigurasi. Yang paling umum adalah JCL over log4j atau JCL over SLF4j. Metode implementasinya sebagai berikut:

• JCL over log4j: Anda perlu memperkenalkan dependensi log4j (log4j 2.x memiliki beberapa framework implementasi untuk dipilih, default adalah log4j-api+log4j-core) dan mengonfigurasinya sesuai metode konfigurasi log4j. Untuk proses spesifiknya, lihat APACHE LOG4J-API Separation.

• JCL over slf4j: Anda perlu memperkenalkan dependensi jcl-over-slf4j dan slf4j (slf4j juga memiliki beberapa framework implementasi untuk dipilih, seperti slf4j-api+logback-classic) dan mengonfigurasinya sesuai metode konfigurasi slf4j. Untuk proses spesifiknya, lihat SJF4J-Bridging legacy APIs.

Apache Log4j mendefinisikan berbagai level log, termasuk OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, dan ALL.

Anda dapat mengaktifkan atau menonaktifkan log SDK dengan mengonfigurasi properti log4j: