spring-cache-dynamodb

KO | EN

gitlite — search

#hacktoberfest #llm #go #deep-learning #macos #windows #awesome #cli #awesome-list #vue #pytorch #security #ios #open-source

spring-cache-dynamodb

(★ 17)

Provides support to increase developer productivity in Java when using Amazons DynamoDB as a key-value store. Uses familiar Spring concepts such as a template classes for core API usage and lightweight repository style data access.

spring-cache-dynamodb Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# spring-cache-dynamodb

[![Apache 2.0 License][license-image]][license-url]
[![Build Status](https://www.travis-ci.com/das-buro-am-draht/spring-cache-dynamodb.svg?branch=master)](https://www.travis-ci.com/das-buro-am-draht/spring-cache-dynamodb)
[![Coverage Status](https://coveralls.io/repos/github/das-buro-am-draht/spring-cache-dynamodb/badge.svg)](https://coveralls.io/github/das-buro-am-draht/spring-cache-dynamodb)

> Spring Cache implementation based on Amazon DynamoDB

## Install

To integrate this Git repository into your project, simply add the maven dependency

```xml
<dependency>
    <groupId>com.dasburo</groupId>
    <artifactId>spring-cache-dynamodb</artifactId>
    <version>2.0.0</version>
</dependency>
```
This release is using the AWS Java SDK v2.x. If you must use v1.x, please use a version prior to 2.0.0 of this library.

## Usage

### Quick start

There is an autoconfiguration class that will set up a simple key-value cache for you, provided you have specified the following properties.

#### Properties

```properties
# TTL (in seconds). Default is Duration.ZERO and disables TTL.
spring.cache.dynamo.caches[0].ttl = 10s

# Cache name for the @Cacheable annotation.
spring.cache.dynamo.caches[0].cacheName = myCache

# Value that indicates if the cache must be flushed on application start.
spring.cache.dynamo.caches[0].flushOnBoot = true
```

#### YAML

```yaml
spring:
  cache:
    dynamo:
      caches:
        - # TTL.
          ttl: 10s
          # Cache name for the @Cacheable annotation.
          cacheName: myCache
          # Value that indicates if the cache table must be flushed when the application starts.
          flushOnBoot: true
```

### Custom configuration

To customize the creation of a cache manager, create a Java Bean in a [configuration class](http://docs.spring.io/spring-boot/docs/current/reference/html/using-boot-configuration-classes.html):

```java
@Bean
public AwsCredentials awsCredentials() {
    return AwsBasicCredentials.create(amazonAWSAccessKey, amazonAWSSecretKey);
}

@Bean
public AwsCredentialsProvider awsCredentialsProvider(AwsCredentials awsCredentials) {
    return StaticCredentialsProvider.create(awsCredentials);
}

@Bean
public DynamoDbClient amazonDynamoDB(AwsCredentialsProvider awsCredentialsProvider) {
    return DynamoDbClient.builder()
        .credentialsProvider(awsCredentialsProvider)
        .region(Region.of(amazonAWSRegion))
        .build();
}

@Bean
public CacheManager cacheManager(DynamoDbClient ddb) {
    List<DynamoCacheBuilder> cacheBuilders = new ArrayList<>();
    cacheBuilders.add(DynamoCacheBuilder.newInstance(cacheName, ddb)
      .withTTL(Duration.ofSeconds(cacheTtl)));
    
    return new DynamoCacheManager(cacheBuilders);
}
```

#### Serializers

By default, the included `StringSerializer` is used. But it's also possible to define a custom Serializer 
of type `DynamoSerializer` for each cache.

### How to use the cache?

#### @Cacheable

After the cache has been configured, you can use the `Cacheable` [annotation](http://docs.spring.io/spring/docs/current/spring-framework-reference/html/cache.html). 
In the following example, the cache "myCache" is used like this:

```java
@Cacheable(value = "myCache", key = "#id")
public Data getData(String id) {
  // ...
}
```

The `id` parameter is used as document identifier. 
Note that the cache key must be of type `java.lang.String`.
It is also possible to use [SpEL](https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#expressions-beandef-annotation-based) to generate a combined key.

The `Data` object will be stored in a DynamoDB table for future use (as the TTL has not expired). 
Note that cache elements must be serializable (i.e. implement `java.io.Serializable`).

## License

Spring Cache DynamoDB is Open Source software released under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0.html).

[license-image]: https://img.shields.io/badge/license-Apache%202-blue.svg
[license-url]: http://www.apache.org/licenses/LICENSE-2.0
[travis-image]: https://travis-ci.com/bad-opensource/spring-cache-dynamodb.svg?branch=master
[travis-url]: https://travis-ci.com/bad-opensource/spring-cache-dynamodb
[coveralls-image]: https://coveralls.io/repos/github/bad-opensource/spring-cache-dynamodb/badge.svg
[coveralls-url]: https://coveralls.io/github/bad-opensource/spring-cache-dynamodb

spring-cache-dynamodb

spring-cache-dynamodb Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

spring-cache-dynamodb

spring-cache-dynamodb Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README