TOC

Spring Cache - カスタムKeyGeneratorの作成

Spring Cache-カスタムKeyGeneratorの作成

1. 概要

このクイックチュートリアルでは、Spring Cacheでカスタムキージェネレーターを作成する方法を説明します。

上記のモジュールの概要については、to this articleを参照してください。

2. KeyGenerator

これは、キャッシュ内の各データ項目のすべてのキーを生成し、取得時にデータ項目を検索するために使用されます。

ここでのデフォルトの実装は、キーを生成するために提供されたメソッドパラメータを使用するSimpleKeyGenerator – です。 つまり、同じキャッシュ名とパラメータタイプのセットを使用する2つのメソッドがある場合、衝突が発生する可能性が高くなります。

また、別の方法でキャッシュデータを上書きできることも意味します。

3. カスタムKeyGenerator

KeyGeneratorは、単一のメソッドを1つだけ実装する必要があります。 

Object generate(Object object, Method method, Object... params)

正しく実装または使用されていない場合、キャッシュデータが上書きされる可能性があります。

実装を見てみましょう： 

public class CustomKeyGenerator implements KeyGenerator {

    public Object generate(Object target, Method method, Object... params) {
        return target.getClass().getSimpleName() + "_"
          + method.getName() + "_"
          + StringUtils.arrayToDelimitedString(params, "_");
    }
}

その後、2つの使用方法があります。 1つ目は、ApplicationConfigでBeanを宣言することです。

クラスはCachingConfigurerSupportから拡張するか、CacheConfigurerを実装する必要があることに注意してください。 

@EnableCaching
@Configuration
public class ApplicationConfig extends CachingConfigurerSupport {

    @Bean
    public CacheManager cacheManager() {
        SimpleCacheManager cacheManager = new SimpleCacheManager();
        Cache booksCache = new ConcurrentMapCache("books");
        cacheManager.setCaches(Arrays.asList(booksCache));
        return cacheManager;
    }

    @Bean("customKeyGenerator")
    public KeyGenerator keyGenerator() {
        return new CustomKeyGenerator();
    }
}

2番目の方法は、特定のメソッドにのみ使用することです。 

@Component
public class BookService {

    @Cacheable(value = "books", keyGenerator = "customKeyGenerator")
    public List getBooks() {
        List books = new ArrayList<>();
        books.add(new Book("The Counterfeiters", "André Gide"));
        books.add(new Book("Peer Gynt and Hedda Gabler", "Henrik Ibsen"));
        return books;
    }
}

4. 結論

この記事では、カスタムSpring CacheのKeyGeneratorを実装する方法について説明しました。

いつものように、例の完全なソースコードはover on GitHubで入手できます。

Related