Menggunakan driver klien Cassandra Java untuk mengakses Amazon Keyspaces secara terprogram - Amazon Keyspaces (untuk Apache Cassandra)

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Menggunakan driver klien Cassandra Java untuk mengakses Amazon Keyspaces secara terprogram

Bagian ini menunjukkan kepada Anda cara terhubung ke Amazon Keyspaces dengan menggunakan driver klien Java.

catatan

Java 17 dan DataStax Java Driver 4.17 saat ini hanya dalam dukungan Beta. Untuk informasi selengkapnya, lihat https://docs.datastax.com/en/developer/java-driver/4.17/upgrade_guide/.

Untuk memberikan kredensi kepada pengguna dan aplikasi untuk akses terprogram ke sumber daya Amazon Keyspaces, Anda dapat melakukan salah satu hal berikut:

  • Buat kredenal khusus layanan yang terkait dengan pengguna () tertentu AWS Identity and Access Management . IAM

  • Untuk keamanan yang ditingkatkan, kami sarankan untuk membuat kunci IAM akses untuk IAM identitas yang digunakan di semua AWS layanan. Plugin otentikasi Amazon Keyspaces SigV4 untuk driver klien Cassandra memungkinkan Anda untuk mengautentikasi panggilan ke Amazon Keyspaces menggunakan kunci akses alih-alih nama pengguna dan kata sandi. IAM Untuk informasi selengkapnya, lihat Buat dan konfigurasikan AWS kredensi untuk Amazon Keyspaces.

catatan

Untuk contoh cara menggunakan Amazon Keyspaces dengan Spring Boot, lihat. https://github.com/aws-samples/amazon-keyspaces-examples/tree/main/java/datastax-v4/spring

Sebelum Anda mulai

Untuk terhubung ke Amazon Keyspaces, Anda harus menyelesaikan tugas-tugas berikut sebelum dapat memulai.

  1. Amazon Keyspaces memerlukan penggunaan Transport Layer Security (TLS) untuk membantu mengamankan koneksi dengan klien.

    1. Unduh sertifikat digital Starfield menggunakan perintah berikut dan simpan sf-class2-root.crt secara lokal atau di direktori home Anda.

      curl https://certs.secureserver.net/repository/sf-class2-root.crt -O
      catatan

      Anda juga dapat menggunakan sertifikat digital Amazon untuk terhubung ke Amazon Keyspaces dan dapat terus melakukannya jika klien Anda berhasil terhubung ke Amazon Keyspaces. Sertifikat Starfield memberikan kompatibilitas mundur tambahan untuk klien yang menggunakan otoritas sertifikat yang lebih lama.

    2. Ubah sertifikat digital Starfield menjadi trustStore file.

      openssl x509 -outform der -in sf-class2-root.crt -out temp_file.der keytool -import -alias cassandra -keystore cassandra_truststore.jks -file temp_file.der

      Pada langkah ini, Anda perlu membuat kata sandi untuk keystore dan mempercayai sertifikat ini. Perintah interaktif terlihat seperti ini.

      Enter keystore password: Re-enter new password: Owner: OU=Starfield Class 2 Certification Authority, O="Starfield Technologies, Inc.", C=US Issuer: OU=Starfield Class 2 Certification Authority, O="Starfield Technologies, Inc.", C=US Serial number: 0 Valid from: Tue Jun 29 17:39:16 UTC 2004 until: Thu Jun 29 17:39:16 UTC 2034 Certificate fingerprints: MD5: 32:4A:4B:BB:C8:63:69:9B:BE:74:9A:C6:DD:1D:46:24 SHA1: AD:7E:1C:28:B0:64:EF:8F:60:03:40:20:14:C3:D0:E3:37:0E:B5:8A SHA256: 14:65:FA:20:53:97:B8:76:FA:A6:F0:A9:95:8E:55:90:E4:0F:CC:7F:AA:4F:B7:C2:C8:67:75:21:FB:5F:B6:58 Signature algorithm name: SHA1withRSA Subject Public Key Algorithm: 2048-bit RSA key Version: 3 Extensions: #1: ObjectId: 2.5.29.35 Criticality=false AuthorityKeyIdentifier [ KeyIdentifier [ 0000: BF 5F B7 D1 CE DD 1F 86 F4 5B 55 AC DC D7 10 C2 ._.......[U..... 0010: 0E A9 88 E7 .... ] [OU=Starfield Class 2 Certification Authority, O="Starfield Technologies, Inc.", C=US] SerialNumber: [ 00] ] #2: ObjectId: 2.5.29.19 Criticality=false BasicConstraints:[ CA:true PathLen:2147483647 ] #3: ObjectId: 2.5.29.14 Criticality=false SubjectKeyIdentifier [ KeyIdentifier [ 0000: BF 5F B7 D1 CE DD 1F 86 F4 5B 55 AC DC D7 10 C2 ._.......[U..... 0010: 0E A9 88 E7 .... ] ] Trust this certificate? [no]: y
  2. Lampirkan trustStore file dalam JVM argumen:

    -Djavax.net.ssl.trustStore=path_to_file/cassandra_truststore.jks -Djavax.net.ssl.trustStorePassword=my_password

Step-by-step tutorial untuk terhubung ke Amazon Keyspaces menggunakan driver DataStax Java untuk Apache Cassandra menggunakan kredensil khusus layanan

step-by-stepTutorial berikut memandu Anda melalui koneksi ke Amazon Keyspaces menggunakan driver Java untuk Cassandra menggunakan kredenal khusus layanan. Secara khusus, Anda akan menggunakan versi 4.0 dari driver DataStax Java untuk Apache Cassandra.

Langkah 1: Prasyarat

Untuk mengikuti tutorial ini, Anda perlu menghasilkan kredensi khusus layanan dan menambahkan driver DataStax Java untuk Apache Cassandra ke proyek Java Anda.

Langkah 2: Konfigurasikan driver

Anda dapat menentukan pengaturan untuk driver DataStax Java Cassandra dengan membuat file konfigurasi untuk aplikasi Anda. File konfigurasi ini mengganti pengaturan default dan memberi tahu driver untuk terhubung ke titik akhir layanan Amazon Keyspaces menggunakan port 9142. Untuk daftar titik akhir layanan yang tersedia, lihatTitik akhir layanan untuk Amazon Keyspaces.

Buat file konfigurasi dan simpan file di folder sumber daya aplikasi—misalnya,. src/main/resources/application.conf Buka application.conf dan tambahkan pengaturan konfigurasi berikut.

  1. Penyedia otentikasi — Buat penyedia otentikasi dengan kelas. PlainTextAuthProvider ServiceUserName and ServicePassword harus sesuai dengan nama pengguna dan kata sandi yang Anda peroleh ketika Anda membuat kredensil khusus layanan dengan mengikuti langkah-langkah di. Buat kredensil khusus layanan untuk akses terprogram ke Amazon Keyspaces

    catatan

    Anda dapat menggunakan kredensi jangka pendek dengan menggunakan plugin otentikasi untuk driver DataStax Java untuk Apache Cassandra alih-alih kredensi hardcoding di file konfigurasi driver Anda. Untuk mempelajari lebih lanjut, ikuti instruksi untukStep-by-step tutorial untuk terhubung ke Amazon Keyspaces menggunakan driver DataStax Java 4.x untuk Apache Cassandra dan plugin otentikasi SiGv4.

  2. Pusat data lokal — Tetapkan nilai local-datacenter untuk Wilayah yang Anda sambungkan. Misalnya, jika aplikasi terhubung kecassandra.us-east-2.amazonaws.com, maka atur pusat data lokal keus-east-2. Untuk semua yang tersedia Wilayah AWS, lihatTitik akhir layanan untuk Amazon Keyspaces. Atur slow-replica-avoidance = false untuk memuat keseimbangan terhadap lebih sedikit node.

  3. SSL/TLS— Inisialisasi SSLEngineFactory dengan menambahkan bagian dalam file konfigurasi dengan satu baris yang menentukan kelas dengan. class = DefaultSslEngineFactory Berikan jalur ke trustStore file dan kata sandi yang Anda buat sebelumnya. Amazon Keyspaces tidak mendukung hostname-validation peer, jadi setel opsi ini ke false.

datastax-java-driver { basic.contact-points = [ "cassandra.us-east-2.amazonaws.com:9142"] advanced.auth-provider{ class = PlainTextAuthProvider username = "ServiceUserName" password = "ServicePassword" } basic.load-balancing-policy { local-datacenter = "us-east-2" slow-replica-avoidance = false } advanced.ssl-engine-factory { class = DefaultSslEngineFactory truststore-path = "./src/main/resources/cassandra_truststore.jks" truststore-password = "my_password" hostname-validation = false } }
catatan

Alih-alih menambahkan path ke trustStore dalam file konfigurasi, Anda juga dapat menambahkan trustStore path langsung dalam kode aplikasi atau Anda dapat menambahkan path trustStore ke JVM argumen Anda.

Langkah 3: Jalankan aplikasi sampel

Contoh kode ini menunjukkan aplikasi baris perintah sederhana yang membuat kumpulan koneksi ke Amazon Keyspaces dengan menggunakan file konfigurasi yang kita buat sebelumnya. Ini menegaskan bahwa koneksi dibuat dengan menjalankan kueri sederhana.

package <your package>; // add the following imports to your project import com.datastax.oss.driver.api.core.CqlSession; import com.datastax.oss.driver.api.core.config.DriverConfigLoader; import com.datastax.oss.driver.api.core.cql.ResultSet; import com.datastax.oss.driver.api.core.cql.Row; public class App { public static void main( String[] args ) { //Use DriverConfigLoader to load your configuration file DriverConfigLoader loader = DriverConfigLoader.fromClasspath("application.conf"); try (CqlSession session = CqlSession.builder() .withConfigLoader(loader) .build()) { ResultSet rs = session.execute("select * from system_schema.keyspaces"); Row row = rs.one(); System.out.println(row.getString("keyspace_name")); } } }
catatan

Gunakan try blok untuk membuat koneksi untuk memastikan bahwa itu selalu tertutup. Jika Anda tidak menggunakan try blok, ingatlah untuk menutup koneksi Anda untuk menghindari kebocoran sumber daya.

Step-by-step tutorial untuk terhubung ke Amazon Keyspaces menggunakan driver DataStax Java 4.x untuk Apache Cassandra dan plugin otentikasi SiGv4

Bagian berikut menjelaskan cara menggunakan plugin otentikasi SiGv4 untuk driver DataStax Java 4.x open-source untuk Apache Cassandra untuk mengakses Amazon Keyspaces (untuk Apache Cassandra). Plugin tersedia dari GitHubrepositori.

Plugin otentikasi SiGv4 memungkinkan Anda menggunakan IAM kredensi untuk pengguna atau peran saat menghubungkan ke Amazon Keyspaces. Alih-alih memerlukan nama pengguna dan kata sandi, plugin ini menandatangani API permintaan menggunakan kunci akses. Untuk informasi selengkapnya, lihat Buat dan konfigurasikan AWS kredensi untuk Amazon Keyspaces.

Langkah 1: Prasyarat

Untuk mengikuti tutorial ini, Anda harus menyelesaikan tugas-tugas berikut.

  • Jika Anda belum melakukannya, buat kredensi untuk IAM pengguna atau peran Anda mengikuti langkah-langkah di. Buat dan konfigurasikan AWS kredensi untuk Amazon Keyspaces Tutorial ini mengasumsikan bahwa kunci akses disimpan sebagai variabel lingkungan. Untuk informasi selengkapnya, lihat Simpan kunci akses untuk IAM pengguna.

  • Tambahkan driver DataStax Java untuk Apache Cassandra ke proyek Java Anda. Pastikan Anda menggunakan versi driver yang mendukung Apache Cassandra 3.11.2. Untuk informasi selengkapnya, lihat Driver DataStax Java untuk dokumentasi Apache Cassandra.

  • Tambahkan plugin otentikasi ke aplikasi Anda. Plugin otentikasi mendukung versi 4.x dari driver DataStax Java untuk Apache Cassandra. Jika Anda menggunakan Apache Maven, atau sistem build yang dapat menggunakan dependensi Maven, tambahkan dependensi berikut ke file Anda. pom.xml

    penting

    Ganti versi plugin dengan versi terbaru seperti yang ditunjukkan di GitHub repositori.

    <dependency> <groupId>software.aws.mcs</groupId> <artifactId>aws-sigv4-auth-cassandra-java-driver-plugin</artifactId> <version>4.0.9</version> </dependency>

Langkah 2: Konfigurasikan driver

Anda dapat menentukan pengaturan untuk driver DataStax Java Cassandra dengan membuat file konfigurasi untuk aplikasi Anda. File konfigurasi ini mengganti pengaturan default dan memberi tahu driver untuk terhubung ke titik akhir layanan Amazon Keyspaces menggunakan port 9142. Untuk daftar titik akhir layanan yang tersedia, lihatTitik akhir layanan untuk Amazon Keyspaces.

Buat file konfigurasi dan simpan file di folder sumber daya aplikasi—misalnya,. src/main/resources/application.conf Buka application.conf dan tambahkan pengaturan konfigurasi berikut.

  1. Penyedia otentikasi - Atur advanced.auth-provider.class ke instance baru. software.aws.mcs.auth.SigV4AuthProvider SiGv4 AuthProvider adalah penangan otentikasi yang disediakan oleh plugin untuk melakukan otentikasi SiGv4.

  2. Pusat data lokal — Tetapkan nilai local-datacenter untuk Wilayah yang Anda sambungkan. Misalnya, jika aplikasi terhubung kecassandra.us-east-2.amazonaws.com, maka atur pusat data lokal keus-east-2. Untuk semua yang tersedia Wilayah AWS, lihatTitik akhir layanan untuk Amazon Keyspaces. Atur slow-replica-avoidance = false untuk memuat keseimbangan terhadap semua node yang tersedia.

  3. Idempotence - Mengatur default idempotence untuk aplikasi untuk mengkonfigurasi driver untuk selalu mencoba kembali gagal true membaca/menulis/menyiapkan/mengeksekusi permintaan. Ini adalah praktik terbaik untuk aplikasi terdistribusi yang membantu menangani kegagalan sementara dengan mencoba kembali permintaan yang gagal.

  4. SSL/TLS— Inisialisasi SSLEngineFactory dengan menambahkan bagian dalam file konfigurasi dengan satu baris yang menentukan kelas dengan. class = DefaultSslEngineFactory Berikan jalur ke trustStore file dan kata sandi yang Anda buat sebelumnya. Amazon Keyspaces tidak mendukung hostname-validation peer, jadi setel opsi ini ke false.

  5. Koneksi — Buat setidaknya 3 koneksi lokal per titik akhir dengan pengaturanlocal.size = 3. Ini adalah praktik terbaik yang membantu aplikasi Anda menangani ledakan overhead dan lalu lintas. Untuk informasi selengkapnya tentang cara menghitung berapa banyak koneksi lokal per titik akhir yang dibutuhkan aplikasi Anda berdasarkan pola lalu lintas yang diharapkan, lihatCara mengonfigurasi koneksi di Amazon Keyspaces.

  6. Kebijakan coba lagi — Terapkan AmazonKeyspacesExponentialRetryPolicy kebijakan coba ulang Amazon Keyspaces alih-alih yang disertakan dengan driver DefaultRetryPolicy Cassandra. Ini memungkinkan Anda untuk mengonfigurasi jumlah upaya coba lagi untuk AmazonKeyspacesExponentialRetryPolicy yang memenuhi kebutuhan Anda. Secara default, jumlah percobaan ulang untuk AmazonKeyspacesExponentialRetryPolicy diatur ke 3. Untuk informasi selengkapnya, lihat Cara mengonfigurasi kebijakan coba lagi untuk koneksi di Amazon Keyspaces.

  7. Pernyataan yang disiapkan - Setel prepare-on-all-nodes ke false untuk mengoptimalkan penggunaan jaringan.

datastax-java-driver { basic { contact-points = [ "cassandra.us-east-2.amazonaws.com:9142"] request { timeout = 2 seconds consistency = LOCAL_QUORUM page-size = 1024 default-idempotence = true } load-balancing-policy { local-datacenter = "us-east-2" class = DefaultLoadBalancingPolicy slow-replica-avoidance = false } } advanced { auth-provider { class = software.aws.mcs.auth.SigV4AuthProvider aws-region = us-east-2 } ssl-engine-factory { class = DefaultSslEngineFactory truststore-path = "./src/main/resources/cassandra_truststore.jks" truststore-password = "my_password" hostname-validation = false } connection { connect-timeout = 5 seconds max-requests-per-connection = 512 pool { local.size = 3 } } retry-policy { class = com.aws.ssa.keyspaces.retry.AmazonKeyspacesExponentialRetryPolicy max-attempts = 3 min-wait = 10 mills max-wait = 100 mills } prepared-statements { prepare-on-all-nodes = false } } }
catatan

Alih-alih menambahkan path ke trustStore dalam file konfigurasi, Anda juga dapat menambahkan trustStore path langsung dalam kode aplikasi atau Anda dapat menambahkan path trustStore ke JVM argumen Anda.

Langkah 3: Jalankan aplikasi

Contoh kode ini menunjukkan aplikasi baris perintah sederhana yang membuat kumpulan koneksi ke Amazon Keyspaces dengan menggunakan file konfigurasi yang kita buat sebelumnya. Ini menegaskan bahwa koneksi dibuat dengan menjalankan kueri sederhana.

package <your package>; // add the following imports to your project import com.datastax.oss.driver.api.core.CqlSession; import com.datastax.oss.driver.api.core.config.DriverConfigLoader; import com.datastax.oss.driver.api.core.cql.ResultSet; import com.datastax.oss.driver.api.core.cql.Row; public class App { public static void main( String[] args ) { //Use DriverConfigLoader to load your configuration file DriverConfigLoader loader = DriverConfigLoader.fromClasspath("application.conf"); try (CqlSession session = CqlSession.builder() .withConfigLoader(loader) .build()) { ResultSet rs = session.execute("select * from system_schema.keyspaces"); Row row = rs.one(); System.out.println(row.getString("keyspace_name")); } } }
catatan

Gunakan try blok untuk membuat koneksi untuk memastikan bahwa itu selalu tertutup. Jika Anda tidak menggunakan try blok, ingatlah untuk menutup koneksi Anda untuk menghindari kebocoran sumber daya.

Connect ke Amazon Keyspaces menggunakan driver DataStax Java 3.x untuk Apache Cassandra dan plugin otentikasi SiGv4

Bagian berikut menjelaskan cara menggunakan plugin otentikasi SiGv4 untuk driver DataStax Java sumber terbuka 3.x untuk Apache Cassandra untuk mengakses Amazon Keyspaces. Plugin tersedia dari GitHub repositori.

Plugin otentikasi SiGv4 memungkinkan Anda menggunakan IAM kredensi untuk pengguna dan peran saat menghubungkan ke Amazon Keyspaces. Alih-alih memerlukan nama pengguna dan kata sandi, plugin ini menandatangani API permintaan menggunakan kunci akses. Untuk informasi selengkapnya, lihat Buat dan konfigurasikan AWS kredensi untuk Amazon Keyspaces.

Langkah 1: Prasyarat

Untuk menjalankan contoh kode ini, pertama-tama Anda harus menyelesaikan tugas-tugas berikut.

  • Buat kredensi untuk IAM pengguna atau peran Anda mengikuti langkah-langkah di. Buat dan konfigurasikan AWS kredensi untuk Amazon Keyspaces Tutorial ini mengasumsikan bahwa kunci akses disimpan sebagai variabel lingkungan. Untuk informasi selengkapnya, lihat Simpan kunci akses untuk IAM pengguna.

  • Ikuti langkah-langkah di Sebelum Anda mulai untuk mengunduh sertifikat digital Starfield, mengubahnya menjadi trustStore file, dan melampirkan trustStore file dalam JVM argumen ke aplikasi Anda.

  • Tambahkan driver DataStax Java untuk Apache Cassandra ke proyek Java Anda. Pastikan Anda menggunakan versi driver yang mendukung Apache Cassandra 3.11.2. Untuk informasi selengkapnya, lihat Driver DataStax Java untuk dokumentasi Apache Cassandra.

  • Tambahkan plugin otentikasi ke aplikasi Anda. Plugin otentikasi mendukung versi 3.x dari driver DataStax Java untuk Apache Cassandra. Jika Anda menggunakan Apache Maven, atau sistem build yang dapat menggunakan dependensi Maven, tambahkan dependensi berikut ke file Anda. pom.xml Ganti versi plugin dengan versi terbaru seperti yang ditunjukkan di GitHub repositori.

    <dependency> <groupId>software.aws.mcs</groupId> <artifactId>aws-sigv4-auth-cassandra-java-driver-plugin_3</artifactId> <version>3.0.3</version> </dependency>

Langkah 2: Jalankan aplikasi

Contoh kode ini menunjukkan aplikasi baris perintah sederhana yang membuat kumpulan koneksi ke Amazon Keyspaces. Ini menegaskan bahwa koneksi dibuat dengan menjalankan kueri sederhana.

package <your package>; // add the following imports to your project import software.aws.mcs.auth.SigV4AuthProvider; import com.datastax.driver.core.Cluster; import com.datastax.driver.core.ResultSet; import com.datastax.driver.core.Row; import com.datastax.driver.core.Session; public class App { public static void main( String[] args ) { String endPoint = "cassandra.us-east-2.amazonaws.com"; int portNumber = 9142; Session session = Cluster.builder() .addContactPoint(endPoint) .withPort(portNumber) .withAuthProvider(new SigV4AuthProvider("us-east-2")) .withSSL() .build() .connect(); ResultSet rs = session.execute("select * from system_schema.keyspaces"); Row row = rs.one(); System.out.println(row.getString("keyspace_name")); } }

Catatan penggunaan:

Untuk daftar titik akhir yang tersedia, lihatTitik akhir layanan untuk Amazon Keyspaces.

Lihat repositori berikut untuk kebijakan driver Java yang bermanfaat, contoh, dan praktik terbaik saat menggunakan Driver Java dengan Amazon Keyspaces:. https://github.com/aws-samples/amazon-keyspaces-java-driver-helpers