Anotações Java para DynamoDB

Esta seção descreve as anotações que estão disponíveis para mapear suas classes e propriedades em tabelas e atributos no Amazon DynamoDB.

Para conhecer a documentação Javadoc correspondente, consulte Resumo de tipos de anotação na Referência da API do AWS SDK for Java.

nota

Nas seguintes anotações, apenas DynamoDBTable e DynamoDBHashKey são necessários.

DynamoDBAttribute

Mapeia uma propriedade para um atributo de tabela. Por padrão, cada propriedade de classe é mapeada para um atributo de item com o mesmo nome. No entanto, se os nomes não forem os mesmos, você poderá usar essa anotação para mapear uma propriedade para o atributo. No seguinte trecho de código Java, DynamoDBAttribute mapeia a propriedade BookAuthors para o nome de atributo Authors na tabela.

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

O DynamoDBMapper usa Authors como o nome do atributo ao salvar o objeto na tabela.

DynamoDB AutoGeneratedKey

Marca uma propriedade de chave de partição ou de chave de classificação como sendo gerada automaticamente. DynamoDBMapper gera um UUID aleatório ao salvar esses atributos. Apenas propriedades String podem ser marcadas como chaves geradas automaticamente.

O exemplo a seguir demonstra o uso de chaves geradas automaticamente.

@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());
    }
}

DynamoDB AutoGeneratedTimestamp

Gera automaticamente um carimbo de data/hora.

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

Opcionalmente, a estratégia de geração automática pode ser definida fornecendo um atributo de estratégia. O padrão é ALWAYS.

DynamoDBDocument

Indica que uma classe pode ser serializada como um documento do Amazon DynamoDB.

Por exemplo, vamos supor que você queria mapear um documento JSON em um atributo do DynamoDB do tipo Map (M). O exemplo de código a seguir define um item que contém um atributo aninhado (Pictures) do tipo Map.

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; }

     }
}

É possível salvar um novo item ProductCatalog, com Pictures, conforme mostrado no exemplo a seguir.

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); 

O item de ProductCatalog resultante seria semelhante ao seguinte (no formato JSON).

{
  "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"
  }
} 

DynamoDB HashKey

Mapeia uma propriedade de classe para a chave de partição da tabela. A propriedade deve ser uma string escalar, número ou tipos binários. A propriedade não pode ser um tipo de coleção.

Vamos supor que você tenha uma tabela, ProductCatalog, com Id como chave primária. O código Java a seguir define uma classe CatalogItem e mapeia sua propriedade Id para a chave primária da tabela ProductCatalog usando a tag @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.
}

DynamoDBIgnore

Indica à instância de DynamoDBMapper que a propriedade associada deve ser ignorada. Quando salvar dados na tabela, o DynamoDBMapper não salva essa propriedade na tabela.

Aplicado ao método getter ou ao campo de classe de uma propriedade não modelada. Se a anotação for aplicada diretamente ao campo de classe, o getter e o setter correspondentes deverão ser declarados na mesma classe.

DynamoDB IndexHashKey

Mapeia uma propriedade de classe na chave de partição de um índice secundário global. A propriedade deve ser uma string escalar, número ou tipos binários. A propriedade não pode ser um tipo de coleção.

Use essa anotação se você precisa realizar uma Query em um índice secundário global. É necessário especificar o nome de índice (globalSecondaryIndexName). Se o nome da propriedade da classe for diferente da chave de partição do índice, também será necessário especificar o nome desse atributo de índice (attributeName).

DynamoDB IndexRangeKey

Mapeia uma propriedade de classe na chave de classificação de um índice secundário global ou índice secundário local. A propriedade deve ser uma string escalar, número ou tipos binários. A propriedade não pode ser um tipo de coleção.

Use essa anotação se você precisa realizar uma Query em um índice secundário local ou índice secundário global e deseja refinar seus resultados usando a chave de classificação do índice. É necessário especificar o nome de índice (globalSecondaryIndexName ou localSecondaryIndexName). Se o nome da propriedade da classe for diferente da chave de classificação do índice, você também deve especificar o nome desse atributo de índice (attributeName).

DynamoDB RangeKey

Mapeia uma propriedade de classe para a chave de classificação da tabela. A propriedade deve ser uma string escalar, número ou tipos binários. Não pode ser um tipo de coleção.

Se a chave primária for composta (chave de partição e chave de classificação), você poderá usar essa tag para mapear seu campo de classe para a chave de classificação. Por exemplo, vamos supor que você tenha uma tabela Reply que armazena respostas para tópicos de fórum. Cada tópico pode ter muitas respostas. Portanto, a chave primária dessa tabela é tanto ThreadId quanto ReplyDateTime. ThreadId é a chave de partição, e ReplyDateTime é a chave de classificação.

O código Java a seguir define uma classe Reply e a mapeia para a tabela Reply. Ele usa ambas as tags @DynamoDBHashKey e @DynamoDBRangeKey para identificar propriedades de classes que são mapeadas para a chave primária.

@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.
}

DynamoDBTable

Identifica a tabela de destino no DynamoDB. Por exemplo, o seguinte código Java define uma classe Developer e a mapeia na tabela People no DynamoDB.

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

A anotação @DynamoDBTable pode ser herdada. Qualquer nova classe que herde da classe Developer também é mapeada para a tabela People. Por exemplo, suponha que você crie uma classe Lead que herde da classe Developer. Como você mapeou a classe Developer para a tabela People, e os objetos de classe Lead também são armazenados na mesma tabela.

Também é possível substituir @DynamoDBTable. Qualquer nova classe que herde da classe Developer por padrão é mapeada para a mesma tabela People. No entanto, você pode substituir esse mapeamento padrão. Por exemplo, se você criar uma classe que herda da classe Developer, será possível mapeá-la explicitamente para outra tabela adicionando a anotação @DynamoDBTable, conforme mostrado no seguinte exemplo de código Java.

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

DynamoDB TypeConverted

Uma anotação para marcar uma propriedade como usando um conversor de tipo personalizado. Pode ser anotada em uma anotação definida pelo usuário para transmitir propriedades adicionais a DynamoDBTypeConverter.

A interface DynamoDBTypeConverter permite que você mapeie seus próprios tipos de dados arbitrários em um tipo de dados com suporte nativo do DynamoDB. Para ter mais informações, consulte Mapear dados arbitrários.

DynamoDBTyped

Uma anotação para substituir a associação de tipo de atributo padrão. Tipos padrão não exigem a anotação se estiverem aplicando a associação de atributo padrão para esse tipo.

DynamoDB VersionAttribute

Identifica uma propriedade de classe para armazenar um número de versão de bloqueio otimista. DynamoDBMapper atribui um número de versão a essa propriedade ao salvar um novo item e o incrementa cada vez que você atualizar o item. Apenas há suporte para tipos de números escalares. Para obter informações sobre tipos de dados, consulte Tipos de dados. Para obter mais informações sobre versionamento, consulte Bloqueio positivo com número de versão.