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

Anotasi Java untuk DynamoDB

Bagian ini menjelaskan anotasi yang tersedia untuk memetakan kelas dan properti ke tabel dan atribut di Amazon DynamoDB.

Untuk dokumentasi Javadoc yang sesuai, lihat Ringkasan Jenis Anotasi dalam Referensi.AWS SDK for Java API

D ynamoDBAttribute

Memetakan properti ke atribut tabel. Secara default, setiap properti kelas dipetakan ke atribut item dengan nama yang sama. Namun, jika nama tidak sama, Anda dapat menggunakan anotasi ini untuk memetakan properti ke atribut. Dalam cuplikan Java berikut, DynamoDBAttribute memetakan properti BookAuthors ke nama atribut Authors dalam tabel.

@DynamoDBAttribute(attributeName = "Authors")
public List<String> getBookAuthors() { return BookAuthors; }
public void setBookAuthors(List<String> BookAuthors) { this.BookAuthors = BookAuthors; }

DynamoDBMapper menggunakan Authors sebagai nama atribut saat menyimpan objek ke tabel.

D ynamoDBAuto GeneratedKey

Menandai kunci partisi atau mengurutkan properti kunci sebagai dibuat secara otomatis. DynamoDBMappermenghasilkan acak UUIDsaat menyimpan atribut ini. Hanya properti String yang dapat ditandai sebagai kunci yang dibuat otomatis.

Contoh berikut mendemonstrasikan menggunakan kunci yang dibuat otomatis.

@DynamoDBTable(tableName="AutoGeneratedKeysExample")
public class AutoGeneratedKeys {
    private String id;
    private String payload;

    @DynamoDBHashKey(attributeName = "Id")
    @DynamoDBAutoGeneratedKey
    public String getId() { return id; }
    public void setId(String id) { this.id = id; }

    @DynamoDBAttribute(attributeName="payload")
    public String getPayload() { return this.payload; }
    public void setPayload(String payload) { this.payload = payload; }

    public static void saveItem() {
        AutoGeneratedKeys obj = new AutoGeneratedKeys();
        obj.setPayload("abc123");

        // id field is null at this point
        DynamoDBMapper mapper = new DynamoDBMapper(dynamoDBClient);
        mapper.save(obj);

        System.out.println("Object was saved with id " + obj.getId());
    }
}

D ynamoDBAuto GeneratedTimestamp

Membuat stempel waktu secara otomatis.

@DynamoDBAutoGeneratedTimestamp(strategy=DynamoDBAutoGenerateStrategy.ALWAYS)
public Date getLastUpdatedDate() { return lastUpdatedDate; }
public void setLastUpdatedDate(Date lastUpdatedDate) { this.lastUpdatedDate = lastUpdatedDate; }

Secara opsional, strategi pembuatan otomatis dapat didefinisikan dengan menyediakan atribut strategi. Default-nya adalah ALWAYS.

D ynamoDBDocument

Menunjukkan bahwa kelas dapat diserialisasi sebagai dokumen Amazon DynamoDB.

Misalnya, misalkan Anda ingin memetakan JSON dokumen ke atribut DynamoDB tipe Map (). M Contoh kode berikut mendefinisikan item yang berisi atribut bersarang (Gambar) untuk jenis Peta.

public class ProductCatalogItem {

    private Integer id;  //partition key
    private Pictures pictures;
    /* ...other attributes omitted... */

    @DynamoDBHashKey(attributeName="Id")
    public Integer getId() { return id;}
    public void setId(Integer id) {this.id = id;}

    @DynamoDBAttribute(attributeName="Pictures")
    public Pictures getPictures() { return pictures;}
    public void setPictures(Pictures pictures) {this.pictures = pictures;}

    // Additional properties go here.

    @DynamoDBDocument
    public static class Pictures {
        private String frontView;
        private String rearView;
        private String sideView;

        @DynamoDBAttribute(attributeName = "FrontView")
        public String getFrontView() { return frontView; }
        public void setFrontView(String frontView) { this.frontView = frontView; }

        @DynamoDBAttribute(attributeName = "RearView")
        public String getRearView() { return rearView; }
        public void setRearView(String rearView) { this.rearView = rearView; }

        @DynamoDBAttribute(attributeName = "SideView")
        public String getSideView() { return sideView; }
        public void setSideView(String sideView) { this.sideView = sideView; }

     }
}

Kemudian, Anda dapat menyimpan item ProductCatalog, dengan Pictures, seperti yang ditunjukkan dalam contoh berikut.

ProductCatalogItem item = new ProductCatalogItem();

Pictures pix = new Pictures();
pix.setFrontView("http://example.com/products/123_front.jpg");
pix.setRearView("http://example.com/products/123_rear.jpg");
pix.setSideView("http://example.com/products/123_left_side.jpg");
item.setPictures(pix);

item.setId(123);

mapper.save(item); 

ProductCatalogItem yang dihasilkan akan terlihat seperti berikut (dalam JSON format).

{
  "Id" : 123
  "Pictures" : {
    "SideView" : "http://example.com/products/123_left_side.jpg",
    "RearView" : "http://example.com/products/123_rear.jpg",
    "FrontView" : "http://example.com/products/123_front.jpg"
  }
} 

D ynamoDBHash Kunci

Memetakan properti kelas ke kunci partisi tabel. Properti harus berupa salah satu string skalar, angka, atau jenis biner. Properti tidak dapat berupa jenis koleksi.

Asumsikan bahwa Anda memiliki tabel, ProductCatalog, yang memiliki Id sebagai kunci primer. Kode Java berikut mendefinisikan kelas CatalogItem dan memetakan properti Id-nya ke kunci primer dari tabel ProductCatalog menggunakan tanda @DynamoDBHashKey.

@DynamoDBTable(tableName="ProductCatalog")
public class CatalogItem {
    private Integer Id;
   @DynamoDBHashKey(attributeName="Id")
   public Integer getId() {
        return Id;
   }
   public void setId(Integer Id) {
        this.Id = Id;
   }
   // Additional properties go here.
}

D ynamoDBIgnore

Menunjukkan ke instans DynamoDBMapper bahwa properti terkait harus diabaikan. Saat menyimpan data ke tabel, DynamoDBMapper tidak menyimpan properti ini ke tabel.

Diterapkan pada metode getter atau bidang kelas untuk properti yang tidak dimodelkan. Jika anotasi diterapkan langsung ke bidang kelas, getter dan setter yang sesuai harus dinyatakan di kelas yang sama.

D ynamoDBIndex HashKey

Memetakan properti kelas ke kunci partisi untuk indeks sekunder global. Properti harus berupa salah satu string skalar, angka, atau jenis biner. Properti tidak dapat berupa jenis koleksi.

Gunakan anotasi ini jika Anda perlu Query indeks sekunder global. Anda harus menentukan nama indeks (globalSecondaryIndexName). Jika nama properti kelas berbeda dari kunci partisi indeks, Anda juga harus menentukan nama atribut indeks (attributeName).

D ynamoDBIndex RangeKey

Memetakan properti kelas untuk kunci urutan indeks sekunder global atau indeks sekunder lokal. Properti harus berupa salah satu string skalar, angka, atau jenis biner. Properti tidak dapat berupa jenis koleksi.

Gunakan anotasi ini jika anda perlu Query indeks sekunder lokal atau indeks sekunder global dan ingin menyempurnakan hasil menggunakan kunci urutan indeks. Anda harus menentukan nama indeks (baik globalSecondaryIndexName maupun localSecondaryIndexName). Jika nama properti kelas berbeda dari kunci urutan indeks, Anda juga harus menentukan nama atribut indeks (attributeName).

D ynamoDBRange Kunci

Memetakan properti kelas untuk kunci urutan tabel. Properti harus berupa salah satu string skalar, angka, atau jenis biner. Properti ini tidak boleh berupa jenis koleksi.

Jika kunci primer adalah komposit (kunci partisi dan kunci urutan), Anda dapat menggunakan tanda ini untuk memetakan bidang kelas Anda ke kunci urutan. Misalnya, Anda memiliki tabel Reply yang menyimpan balasan untuk utas forum. Setiap utas dapat berisi banyak balasan. Jadi, kunci primer tabel ini adalah ThreadId dan ReplyDateTime. ThreadId adalah kunci partisinya, dan ReplyDateTime adalah kunci urutannya.

Kode Java berikut akan mendefinisikan Reply dan memetakannya ke tabel Reply. Kode tersebut menggunakan tanda @DynamoDBHashKey dan @DynamoDBRangeKey untuk mengidentifikasi properti kelas yang dipetakan ke kunci primer.

@DynamoDBTable(tableName="Reply")
public class Reply {
    private Integer id;
    private String replyDateTime;

    @DynamoDBHashKey(attributeName="Id")
    public Integer getId() { return id; }
    public void setId(Integer id) { this.id = id; }

    @DynamoDBRangeKey(attributeName="ReplyDateTime")
    public String getReplyDateTime() { return replyDateTime; }
    public void setReplyDateTime(String replyDateTime) { this.replyDateTime = replyDateTime; }

   // Additional properties go here.
}

D ynamoDBTable

Mengidentifikasi tabel target di DynamoDB. Misalnya, kode Java berikut menentukan kelas Developer dan memetakannya ke tabel People di DynamoDB.

@DynamoDBTable(tableName="People")
public class Developer { ...} 

Anotasi @DynamoDBTable dapat diwariskan. Setiap kelas baru yang diwariskan dari kelas Developer juga dipetakan ke tabel People yang sama. Misalnya, Anda membuat kelas Lead yang diwariskan dari kelas Developer. Karena Anda memetakan kelas Developer ke tabel People, objek kelas Lead juga disimpan dalam tabel yang sama.

@DynamoDBTable juga dapat diganti. Setiap kelas baru yang diwariskan dari kelas Developer secara default dipetakan ke tabel People yang sama. Namun, Anda dapat mengganti pemetaan default ini. Misalnya, jika Anda membuat kelas yang diwariskan dari kelas Developer, Anda dapat secara eksplisit memetakannya ke tabel lain dengan menambahkan anotasi @DynamoDBTable seperti yang ditunjukkan dalam contoh kode Java berikut.

@DynamoDBTable(tableName="Managers")
public class Manager extends Developer { ...} 

D ynamoDBType Dikonversi

Anotasi untuk menandai properti sebagai menggunakan konverter jenis khusus. Dapat dianotasikan pada anotasi yang ditetapkan pengguna untuk meneruskan properti tambahan ke DynamoDBTypeConverter.

Antarmuka DynamoDBTypeConverter memungkinkan Anda memetakan jenis data arbitrer Anda sendiri ke jenis data yang secara asli didukung oleh DynamoDB. Untuk informasi selengkapnya, lihat Memetakan data arbitrer di DynamoDB.

D ynamoDBTyped

Anotasi untuk menimpa pengikatan jenis atribut standar. Jenis standar tidak memerlukan anotasi jika menerapkan pengikatan atribut default untuk jenis tersebut.

D ynamoDBVersion Atribut

Mengidentifikasi properti kelas untuk menyimpan nomor versi penguncian optimis. DynamoDBMapper menetapkan nomor versi untuk properti ini ketika menyimpan item baru, dan menambahkannya setiap kali Anda memperbarui item. Hanya jenis skalar nomor yang didukung. Untuk informasi selengkapnya tentang jenis data, lihat Jenis Data. Untuk informasi selengkapnya tentang penentuan versi, lihat DynamoDB dan penguncian optimis dengan nomor versi.