Spring Cache<\/code> e Couchbase<\/code> como gerente de loja de apoio.<\/p>\n\u00cdndice<\/strong>
\n<\/p>\n\n- Uma palavra de apresenta\u00e7\u00e3o<\/a><\/li>\n
- O
Cache<\/code> Abstra\u00e7\u00e3o<\/a><\/li>\n- A implementa\u00e7\u00e3o do Couchbase<\/a><\/li>\n
- Obtendo
couchbase-spring-cache<\/code> e colocando-o em pr\u00e1tica<\/a>\n\n- Download e cria\u00e7\u00e3o do
couchbase-spring-cache<\/code> projeto<\/a><\/li>\n- Iniciando um projeto de tutorial<\/a><\/li>\n
- Adicionar entidade e reposit\u00f3rio de gerenciamento de livros<\/a><\/li>\n
- O principal
Inicializa\u00e7\u00e3o do Spring<\/code> Aplicativo<\/a><\/li>\n- Adi\u00e7\u00e3o de recursos de cache<\/a><\/li>\n
- Ativar o cache em
SimpleBookRepository<\/code><\/a><\/li>\n- Como ver os dados no Couchbase<\/a><\/li>\n<\/ul>\n<\/li>\n
- Conclus\u00e3o<\/a>
\n<\/li>\n<\/ul>\nUma palavra de apresenta\u00e7\u00e3o<\/h2>\n
Houve muito trabalho relacionado a Primavera<\/code> ultimamente! Temos estado ocupados trabalhando no Dados do Spring Couchbase<\/a><\/code> para atualiz\u00e1-lo para a gera\u00e7\u00e3o 2.x do Java SDK, trazendo consigo uma s\u00e9rie de novos recursos e aprimoramentos<\/a> (mas falaremos mais sobre isso em uma postagem posterior no blog)...<\/p>\nAo longo do caminho, percebemos que h\u00e1 algumas classes no projeto que n\u00e3o est\u00e3o realmente relacionadas diretamente a Dados do Spring<\/code> e, como tal, n\u00e3o precisou aderir ao seu ciclo formal de lan\u00e7amento \"Release Train\": o cache<\/code> pacote<\/strong>.<\/p>\nPortanto, iniciamos um novo projeto de exemplo simples do Spring Boot Cache para hospedar o 2.x<\/code> gera\u00e7\u00e3o do Couchbase Spring Cache<\/code> implementa\u00e7\u00e3o<\/strong> no github (couchbaselabs\/couchbase-spring-cache<\/code><\/a>).<\/p>\nVamos dar uma olhada em como ele pode ser aproveitado para introduzir facilmente o cache com base no Couchbase em um projeto Spring!<\/p>\n
O Cache<\/code> Abstra\u00e7\u00e3o<\/h2>\nO Spring Framework vem com uma abstra\u00e7\u00e3o leve de um Cache<\/code> que os desenvolvedores podem usar automaticamente ao anotar m\u00e9todos em suas classes (por exemplo, em um @Reposit\u00f3rio<\/code> estere\u00f3tipo).<\/p>\nPara usar os mecanismos de cache de inicializa\u00e7\u00e3o do Spring, basta anotar seus m\u00e9todos com um punhado de anota\u00e7\u00f5es relacionadas ao cache:<\/p>\n
\n@Cacheable<\/code> permitir\u00e1 que a primeira invoca\u00e7\u00e3o do m\u00e9todo anotado com um determinado conjunto de par\u00e2metros de entrada seja executada, mas o resultado ser\u00e1 armazenado em cache e as invoca\u00e7\u00f5es subsequentes (com o mesmo conjunto) ser\u00e3o atendidas de forma transparente a partir do cache.<\/li>\n@CachePut<\/code> sempre invocar\u00e1 o m\u00e9todo e armazenar\u00e1 em cache seu resultado (ao contr\u00e1rio de @Cacheable<\/code> n\u00e3o otimiza o fluxo de invoca\u00e7\u00e3o).<\/li>\n@CacheEvict<\/code> calcular\u00e1 uma chave de cache a partir dos par\u00e2metros do m\u00e9todo anotado e a remover\u00e1 do cache quando o m\u00e9todo for executado (por exemplo, porque a invoca\u00e7\u00e3o desse m\u00e9todo torna uma entrada obsoleta).<\/li>\n@Caching<\/code> permite reagrupar o comportamento da anota\u00e7\u00e3o anterior em uma \u00fanica anota\u00e7\u00e3o.<\/li>\n@CacheConfig<\/code> permite que tenhamos par\u00e2metros de cache comuns definidos em uma classe inteira.<\/li>\n<\/ul>\nA implementa\u00e7\u00e3o do Couchbase<\/h2>\n
O mecanismo abstrato \u00e9 implementado pela estrutura, mas \u00e9 necess\u00e1rio escolher uma implementa\u00e7\u00e3o de apoio real. O Spring vem com alguns deles (na mem\u00f3ria Mapa<\/code>, EhCache<\/code>, Gemfire<\/code>...), mas \u00e9 absolutamente poss\u00edvel definir personalizados, simplesmente implementando um Cache<\/code> e um Gerenciador de cache<\/code> e torn\u00e1-lo vis\u00edvel no contexto do Spring<\/strong>.<\/p>\nEsse \u00e9 o foco de couchbase-spring-cache<\/code>.<\/p>\nCada cache tem um nome, e cada valor no cache tem uma chave de cache. A implementa\u00e7\u00e3o do Couchbase traduzir\u00e1 isso em uma chave de documento que reflete esse...<\/p>\n
\n- este \u00e9 um
Cache<\/code> documento relacionado (por padr\u00e3o, usando o prefixo \"cache:<\/code>“)<\/li>\n- est\u00e1 relacionado a um determinado
Cache<\/code> (adicionando o NOME DO CACHE<\/code> para o prefixo acima)<\/li>\n- ele armazena um determinado valor de cache em
CACHE_KEY<\/code> (portanto, no final das contas \"cache:CACHE_NAME:CACHE_KEY<\/code><\/strong>“).<\/li>\n<\/ul>\nPor enquanto, os valores devem ser Serializ\u00e1vel<\/code> e s\u00e3o armazenados como um Documento serializ\u00e1vel<\/code> do 2.x<\/code> Java SDK, mas a transcodifica\u00e7\u00e3o alternativa poder\u00e1 ser oferecida no futuro, por exemplo. JSON<\/code>\/JsonDocument<\/code>…<\/p>\nObtendo couchbase-spring-cache<\/code> e colocando-o em pr\u00e1tica<\/h2>\nObserva\u00e7\u00e3o:<\/p>\n
No momento em que este texto foi escrito, o projeto estava em 1.0-SNAPSHOT<\/code> portanto, n\u00e3o est\u00e1 dispon\u00edvel na vers\u00e3o Central Maven<\/code> ainda. Voc\u00ea ter\u00e1 que compilar manualmente o jar e adicion\u00e1-lo ao seu reposit\u00f3rio Maven local.<\/p><\/blockquote>\nDownload e cria\u00e7\u00e3o do couchbase-spring-cache<\/code> projeto<\/h2>\nComece clonando o projeto do github:<\/p>\n
git clone https:\/\/github.com\/couchbaselabs\/couchbase-spring-cache.git\r\ncd couchbase-spring-cache<\/code><\/pre>\nEm seguida, crie e instale-o localmente usando o Maven:<\/p>\n
mvn instala\u00e7\u00e3o limpa<\/code><\/pre>\nVoc\u00ea dever\u00e1 ver uma mensagem de sucesso indicando a vers\u00e3o criada e onde ela foi instalada:<\/p>\n
[INFO] Installing \/path\/to\/couchbase-spring-cache\/target\/couchbase-spring-cache-1.0-SNAPSHOT.jar<\/span>\r\n\r\npara \/path\/to\/.m2\/repository\/<\/span>com\/couchbase\/client\/couchbase-spring-cache\/1.0-SNAPSHOT\/couchbase-spring-cache-1.0-SNAPSHOT.jar<\/span>\r\n\r\n[INFO] Installing \/path\/to\/couchbase-spring-cache\/pom.xml\r\n\r\nto \/path\/to\/.m2\/repository\/com\/couchbase\/client\/couchbase-spring-cache\/1.0-SNAPSHOT\/couchbase-spring-cache-1.0-SNAPSHOT.pom\r\n\r\n[INFO] ------------------------------------------------------------------------\r\n\r\n[INFO] BUILD SUCCESS\r\n\r\n[INFO] ------------------------------------------------------------------------\r\n\r\n<\/pre>\nIniciando um projeto de tutorial<\/h2>\n
Criaremos um projeto de exemplo do Spring Cache usando o Maven e o Inicializa\u00e7\u00e3o do Spring<\/code> como base.
\nComece criando a seguinte estrutura de diret\u00f3rios para o projeto em um diret\u00f3rio raiz de sua escolha (usaremos cbcache<\/code> aqui):<\/p>\n cbcache\r\n \u2514\u2500\u2500 src\r\n \u2514\u2500\u2500 main\r\n \u2514\u2500\u2500 java\r\n \u2514\u2500\u2500 com\r\n \u2514\u2500\u2500 couchbase\r\n \u2514\u2500\u2500 demo<\/code><\/pre>\nPor exemplo, use o seguinte comando:<\/p>\n
mkdir -p cbcache\/src\/main\/java\/com\/couchbase\/demo\/\r\ncd cbcache<\/code><\/pre>\nEm seguida, inicie o POM na raiz do cbcache em pom.xml<\/code> com o seguinte conte\u00fado:<\/p>\n\r\n\r\n 4.0.0\r\n\r\n com.couchbase.demo\r\n cbcache\r\n 0.1.0\r\n\r\n \r\n org.springframework.boot\r\n spring-boot-starter-parent\r\n 1.3.0.RELEASE\r\n \r\n\r\n \r\n 1.8\r\n \r\n\r\n \r\n \r\n org.springframework.boot\r\n spring-boot-starter\r\n \r\n \r\n org.springframework\r\n spring-context\r\n \r\n \r\n \r\n com.couchbase.client\r\n couchbase-spring-cache\r\n 1.0-SNAPSHOT\r\n \r\n \r\n\r\n \r\n \r\n \r\n org.springframework.boot\r\n spring-boot-maven-plugin\r\n \r\n \r\n \r\n\r\n<\/code><\/pre>\nAdicionar entidade e reposit\u00f3rio de gerenciamento de livros<\/h2>\n
Usaremos o exemplo de um Livro<\/code> (conforme encontrado no reposit\u00f3rio \"COME\u00c7ANDO - Armazenamento de dados em cache com o Spring<\/a>\" guia oficial do Spring.io).<\/p>\nCriar o Livro<\/code> classe de entidade em src\/main\/java\/com\/couchbase\/demo\/Book.java<\/code>:<\/p>\nimport java.io.Serializable;\r\n\r\npublic class Book implements Serializable {\r\n\r\n private static final long serialVersionUID = -7674163614777124381L;\r\n\r\n private String isbn;\r\n private String title;\r\n\r\n public Book(String isbn, String title) {\r\n this.isbn = isbn;\r\n this.title = title;\r\n }\r\n\r\n public String getIsbn() {\r\n return isbn;\r\n }\r\n\r\n public void setIsbn(String isbn) {\r\n this.isbn = isbn;\r\n }\r\n\r\n public String getTitle() {\r\n return title;\r\n }\r\n\r\n public void setTitle(String title) {\r\n this.title = title;\r\n }\r\n\r\n @Override\r\n public String toString() {\r\n return \"Book{\" + \"isbn='\" + isbn + ''' + \", title='\" + title + ''' + '}';\r\n }\r\n}<\/code><\/pre>\nObserve o Livro<\/code> classe \u00e9 Serializ\u00e1vel<\/code>Por enquanto, isso \u00e9 importante para o armazenamento do Couchbase.<\/p><\/blockquote>\nCrie uma interface de reposit\u00f3rio simples e uma implementa\u00e7\u00e3o ing\u00eanua que simule um atraso:<\/p>\n
em src\/main\/java\/com\/couchbase\/demo\/BookRepository.java<\/code>:<\/p>\npackage com.couchbase.demo;\r\n\r\npublic interface BookRepository {\r\n\r\n Book getByIsbn(String isbn);\r\n\r\n}<\/code><\/pre>\nem src\/main\/java\/com\/couchbase\/demo\/SimpleBookRepository.java<\/code>:<\/p>\npackage com.couchbase.demo;\r\n\r\nimport org.slf4j.Logger;\r\nimport org.slf4j.LoggerFactory;\r\n\r\nimport org.springframework.stereotype.Component;\r\n\r\n@Component\r\npublic class SimpleBookRepository implements BookRepository {\r\n\r\n private static final Logger log = LoggerFactory.getLogger(SimpleBookRepository.class);\r\n\r\n @Override\r\n public Book getByIsbn(String isbn) {\r\n simulateSlowService();\r\n Book result = new Book(isbn, \"Some book\");\r\n log.info(\"Actual fetch of \" + isbn);\r\n return result;\r\n }\r\n\r\n \/\/ Don't do this at home\r\n private void simulateSlowService() {\r\n try {\r\n long time = 5000L;\r\n Thread.sleep(time);\r\n } catch (InterruptedException e) {\r\n throw new IllegalStateException(e);\r\n }\r\n }\r\n\r\n}<\/code><\/pre>\nO principal Inicializa\u00e7\u00e3o do Spring<\/code> Aplicativo<\/h2>\nPor fim, crie um aplicativo que use o reposit\u00f3rio em src\/main\/java\/com\/couchbase\/demo\/Application.java<\/code>:<\/p>\npackage com.couchbase.demo;\r\n\r\nimport org.slf4j.Logger;\r\nimport org.slf4j.LoggerFactory;\r\n\r\nimport org.springframework.beans.factory.annotation.Autowired;\r\nimport org.springframework.boot.CommandLineRunner;\r\nimport org.springframework.boot.SpringApplication;\r\nimport org.springframework.boot.autoconfigure.SpringBootApplication;\r\nimport org.springframework.stereotype.Component;\r\n\r\n@SpringBootApplication\r\npublic class Application {\r\n\r\n private static final Logger log = LoggerFactory.getLogger(Application.class);\r\n\r\n @Component\r\n static class Runner implements CommandLineRunner {\r\n @Autowired\r\n private BookRepository bookRepository;\r\n\r\n @Override\r\n public void run(String... args) throws Exception {\r\n long start;\r\n log.info(\".... Fetching books\");\r\n fetchAndLog(\"isbn-1234\");\r\n fetchAndLog(\"isbn-1234\");\r\n fetchAndLog(\"isbn-1234\");\r\n fetchAndLog(\"isbn-8888\");\r\n fetchAndLog(\"isbn-8888\");\r\n }\r\n\r\n private void fetchAndLog(String isbn) {\r\n long start = System.currentTimeMillis();\r\n Book book = bookRepository.getByIsbn(isbn);\r\n long time = System.currentTimeMillis() - start;\r\n log.info(isbn + \" --> \" + book + \" in \" + time + \"ms\");\r\n }\r\n }\r\n\r\n public static void main(String[] args) {\r\n SpringApplication.run(Application.class, args);\r\n }\r\n}<\/code><\/pre>\nSe voc\u00ea executar o Aplicativo<\/code>'s principal<\/code> em seu IDE (ou se voc\u00ea invocar o m\u00e9todo \"mvn spring-boot:run<\/code>\" na linha de comando), voc\u00ea perceber\u00e1 que todas as chamadas s\u00e3o de fato muito lentas:<\/p>\n[...] .... Fetching books\r\n[...] Actual fetch of isbn-1234\r\n[...] isbn-1234 --> Book{isbn='isbn-1234', title='Some book'} in 5001ms\r\n[...] Actual fetch of isbn-1234\r\n[...] isbn-1234 --> Book{isbn='isbn-1234', title='Some book'} in 5004ms\r\n[...] Actual fetch of isbn-1234\r\n[...] isbn-1234 --> Book{isbn='isbn-1234', title='Some book'} in 5004ms\r\n[...] Actual fetch of isbn-8888\r\n[...] isbn-8888 --> Book{isbn='isbn-8888', title='Some book'} in 5003ms\r\n[...] Actual fetch of isbn-8888\r\n[...] isbn-8888 --> Book{isbn='isbn-8888', title='Some book'} in 5003ms<\/code><\/pre>\nAdi\u00e7\u00e3o de recursos de cache do Spring Boot<\/h2>\n
Para ativar o armazenamento em cache, voc\u00ea deve seguir algumas etapas: primeiro, voc\u00ea deve oferecer ao Spring um Gerenciador de cache<\/code> @Bean<\/code>…<\/p>\nComo estaremos usando o CouchbaseCacheManager<\/code> (\u00e9 claro), precisaremos nos conectar a um Aglomerado<\/code> e usar um Balde<\/code> (a unidade de armazenamento onde o couchbase armazenar\u00e1 os documentos do cache).
\nPortanto, o CouchbaseCacheManager<\/code> precisa de um mapeamento entre Cache<\/code> e os correspondentes nomes Balde<\/code> para usar, passado como um Mapa<\/code>.<\/p>\nEm src\/main\/java\/com\/couchbase\/demo\/Application.java<\/code>adicione as seguintes declara\u00e7\u00f5es de bean:<\/p>\n public static final String BOOK_CACHE = \"books\";\r\n\r\n @Bean(destroyMethod = \"disconnect\")\r\n public Cluster cluster() {\r\n \/\/this connects to a Couchbase instance running on localhost\r\n return CouchbaseCluster.create();\r\n }\r\n\r\n @Bean(destroyMethod = \"close\")\r\n public Bucket bucket() {\r\n \/\/this will be the bucket where every cache-related data will be stored\r\n \/\/note that the bucket \"default\" must exist\r\n return cluster().openBucket(\"default\", \"\");\r\n }\r\n\r\n @Bean\r\n public CacheManager cacheManager() {\r\n Map<String, Bucket> mapping = new HashMap<String, Bucket>();\r\n \/\/we'll make this cache manager recognize a single cache named \"books\"\r\n mapping.put(BOOK_CACHE, bucket());\r\n return new CouchbaseCacheManager(mapping);\r\n }<\/code><\/pre>\nEm seguida, voc\u00ea deseja ativar a varredura de anota\u00e7\u00f5es relacionadas ao cache e o proxy associado, colocando a op\u00e7\u00e3o @EnableCaching<\/code> na anota\u00e7\u00e3o Aplicativo<\/code> classe.<\/p>\nAtivar o cache em SimpleBookRepository<\/code><\/h2>\nVamos ver como ativar o cache real em nosso SimpleBookRepository<\/code> e verifique como o aplicativo se comporta depois disso.<\/p>\nPara fazer getByIsbn<\/code> automaticamente no cache na primeira chamada e servir as chamadas subsequentes com dados do cache, basta anot\u00e1-lo dessa forma:<\/p>\n @Override\r\n @Cacheable(Application.BOOK_CACHE) \/\/using the name of the cache we declared earlier\r\n public Book getByIsbn(String isbn) {\r\n simulateSlowService();\r\n Book result = new Book(isbn, \"Some book\");\r\n log.info(\"Actual fetch of \" + isbn);\r\n return result;\r\n }<\/code><\/pre>\nVamos executar o aplicativo novamente e ver como ele se comporta agora:<\/p>\n
[...] .... Fetching books\r\n[...] Actual fetch of isbn-1234\r\n[...] isbn-1234 --> Book{isbn='isbn-1234', title='Some book'} in 5022ms\r\n[...] isbn-1234 --> Book{isbn='isbn-1234', title='Some book'} in 3ms\r\n[...] isbn-1234 --> Book{isbn='isbn-1234', title='Some book'} in 1ms\r\n[...] Actual fetch of isbn-8888\r\n[...] isbn-8888 --> Book{isbn='isbn-8888', title='Some book'} in 5007ms\r\n[...] isbn-8888 --> Book{isbn='isbn-8888', title='Some book'} in 1ms<\/code><\/pre>\nUau! Isso \u00e9 muito melhor para invoca\u00e7\u00f5es ap\u00f3s a primeira, parece que est\u00e1 de fato em cache :-)<\/p>\n
Como ver os dados no Couchbase<\/h2>\n
Vamos dar uma olhada r\u00e1pida no console da Web para verificar se esses \u00f3timos tempos podem ser atribu\u00eddos ao Couchbase:<\/p>\n
\n- abra uma nova guia em seu navegador e navegue at\u00e9
https:\/\/localhost:8091<\/code><\/a>.<\/li>\n- Conecte-se ao console da Web.<\/li>\n
- ir para o
Compartimentos de dados<\/code> e clique na guia Documentos<\/code> para o balde que voc\u00ea escolheu usar (\"padr\u00e3o\").<\/li>\n<\/ul>\nO que voc\u00ea v\u00ea nessa tela (link r\u00e1pido<\/a> para os pregui\u00e7osos) deve ser semelhante a este:<\/p>\n![\"Spring](\"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/2015\/12\/cacheddocs.png\")
<\/p>\n