Cach\u00e9 de primavera<\/code> y Couchbase<\/code> como gerente de una tienda de respaldo.<\/p>\n\u00cdndice<\/strong>
\n<\/p>\n\n- Introducci\u00f3n<\/a><\/li>\n
- En
Cach\u00e9<\/code> Abstracci\u00f3n<\/a><\/li>\n- Implementaci\u00f3n de Couchbase<\/a><\/li>\n
- En
couchbase-spring-cache<\/code> y ponerlo en pr\u00e1ctica<\/a>\n\n- Descargar y construir el
couchbase-spring-cache<\/code> proyecto<\/a><\/li>\n- Iniciar un proyecto tutorial<\/a><\/li>\n
- A\u00f1adir entidad de gesti\u00f3n de libros y repositorio<\/a><\/li>\n
- Principal
Spring Boot<\/code> Aplicaci\u00f3n<\/a><\/li>\n- A\u00f1adir funciones de cach\u00e9<\/a><\/li>\n
- Activar cach\u00e9 en
SimpleBookRepository<\/code><\/a><\/li>\n- Ver los datos en Couchbase<\/a><\/li>\n<\/ul>\n<\/li>\n
- Conclusi\u00f3n<\/a>
\n<\/li>\n<\/ul>\nIntroducci\u00f3n<\/h2>\n
Hubo mucho trabajo relacionado con Primavera<\/code> \u00a1\u00faltimamente! Hemos estado ocupados trabajando en el Spring Data Couchbase<\/a><\/code> conector para actualizarlo a la generaci\u00f3n 2.x del SDK de Java, lo que conlleva una serie de nuevas funciones y mejoras<\/a> (pero hablaremos de ello m\u00e1s adelante)...<\/p>\nEn el camino, nos dimos cuenta de que hay algunas clases en el proyecto que no est\u00e1n realmente relacionadas directamente con Datos de primavera<\/code> y, como tal, no ha tenido que ce\u00f1irse a su ciclo formal de lanzamientos \"Release Train\": el cach\u00e9<\/code> paquete<\/strong>.<\/p>\nAs\u00ed que empezamos un nuevo y sencillo proyecto de ejemplo de Spring Boot Cache para alojar el 2.x<\/code> generaci\u00f3n del Cach\u00e9 Couchbase Spring<\/code> aplicaci\u00f3n<\/strong> en github (couchbaselabs\/couchbase-spring-cache<\/code><\/a>).<\/p>\nVeamos c\u00f3mo se puede aprovechar para introducir f\u00e1cilmente el almacenamiento en cach\u00e9 respaldado por Couchbase en un proyecto Spring.<\/p>\n
En Cach\u00e9<\/code> Abstracci\u00f3n<\/h2>\nSpring Framework viene con una abstracci\u00f3n ligera de un Cach\u00e9<\/code> que los desarrolladores pueden utilizar autom\u00e1ticamente anotando m\u00e9todos en sus clases (por ejemplo, en una clase @Repositorio<\/code> estereotipo).<\/p>\nPara hacer uso de los mecanismos de cach\u00e9 de arranque de Spring, basta con anotar los m\u00e9todos con un pu\u00f1ado de anotaciones relacionadas con la cach\u00e9:<\/p>\n
\n@Cacheable<\/code> dejar\u00e1 que se ejecute la primera invocaci\u00f3n del m\u00e9todo anotado con un conjunto determinado de par\u00e1metros de entrada, pero el resultado se almacenar\u00e1 en cach\u00e9 y las invocaciones posteriores (con el mismo conjunto) se servir\u00e1n de forma transparente desde la cach\u00e9.<\/li>\n@CachePut<\/code> siempre invocar\u00e1 el m\u00e9todo y almacenar\u00e1 en cach\u00e9 su resultado (a diferencia de @Cacheable<\/code> no optimiza el flujo de invocaci\u00f3n).<\/li>\n@CacheEvict<\/code> calcular\u00e1 una clave de cach\u00e9 a partir de los par\u00e1metros del m\u00e9todo anotado y la eliminar\u00e1 de la cach\u00e9 cuando se ejecute el m\u00e9todo (por ejemplo, porque invocar este m\u00e9todo hace que una entrada sea obsoleta).<\/li>\n@Caching<\/code> permite reagrupar comportamientos de la anotaci\u00f3n anterior en una sola.<\/li>\n@CacheConfig<\/code> nos permite tener par\u00e1metros de cach\u00e9 comunes establecidos en toda una clase.<\/li>\n<\/ul>\nImplementaci\u00f3n de Couchbase<\/h2>\n
El framework establece el mecanismo abstracto, pero debe elegirse una implementaci\u00f3n de respaldo real. Spring viene con algunas de ellas (en memoria Mapa<\/code>, EhCache<\/code>, Gemfire<\/code>...), pero es absolutamente posible definir otras personalizadas, simplemente implantando un Cach\u00e9<\/code> y un Gestor de cach\u00e9<\/code> y hacerlo visible en el contexto de Spring<\/strong>.<\/p>\nEse es el objetivo de couchbase-spring-cache<\/code>.<\/p>\nCada cach\u00e9 tiene un nombre, y cada valor en la cach\u00e9 tiene una clave de cach\u00e9. La implementaci\u00f3n de Couchbase traducir\u00e1 eso en una clave de documento que refleje ese...<\/p>\n
\n- este es un
Cach\u00e9<\/code> documento relacionado (por defecto utilizando el prefijo \"cach\u00e9:<\/code>“)<\/li>\n- se refiere a un determinado
Cach\u00e9<\/code> (a\u00f1adiendo el NOMBRE_DE_LA_CACHE<\/code> al prefijo anterior)<\/li>\n- almacena un valor de cach\u00e9 concreto en
CACHE_KEY<\/code> (as\u00ed que en general \"cache:CACHE_NAME:CACHE_KEY<\/code><\/strong>“).<\/li>\n<\/ul>\nPor ahora los valores deben ser Serializable<\/code> y se almacenan como SerializableDocument<\/code> del 2.x<\/code> Java SDK, pero en el futuro podr\u00edan ofrecerse alternativas de transcodificaci\u00f3n, por ejemplo JSON<\/code>\/JsonDocument<\/code>…<\/p>\nEn couchbase-spring-cache<\/code> y ponerlo en pr\u00e1ctica<\/h2>\nNota:<\/p>\n
En el momento de escribir estas l\u00edneas, el proyecto se encuentra en 1.0-SNAPSHOT<\/code> por lo que no est\u00e1 disponible en Maven Central<\/code> todav\u00eda. Tendr\u00e1s que compilar manualmente el jar y a\u00f1adirlo a tu repositorio local de Maven.<\/p><\/blockquote>\nDescargar y construir el couchbase-spring-cache<\/code> proyecto<\/h2>\nComienza clonando el proyecto desde github:<\/p>\n
git clone https:\/\/github.com\/couchbaselabs\/couchbase-spring-cache.git\r\ncd couchbase-spring-cache<\/code><\/pre>\nA continuaci\u00f3n, comp\u00edlelo e inst\u00e1lelo localmente utilizando Maven:<\/p>\n
mvn clean install<\/code><\/pre>\nDeber\u00eda ver un mensaje de \u00e9xito indicando la versi\u00f3n creada y d\u00f3nde se instal\u00f3:<\/p>\n
[INFO] Installing \/path\/to\/couchbase-spring-cache\/target\/couchbase-spring-cache-1.0-SNAPSHOT.jar<\/span>\r\n\r\na \/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>\nIniciar un proyecto tutorial<\/h2>\n
Construiremos un proyecto de ejemplo de Spring Cache utilizando Maven y Spring Boot<\/code> como base.
\nComience por crear la siguiente estructura de directorios para el proyecto en un directorio ra\u00edz de su elecci\u00f3n (utilizaremos cbcache<\/code> aqu\u00ed):<\/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 ejemplo, utilice el siguiente comando:<\/p>\n
mkdir -p cbcache\/src\/main\/java\/com\/couchbase\/demo\/\r\ncd cbcache<\/code><\/pre>\nA continuaci\u00f3n, inicie el POM en la ra\u00edz de cbcache en pom.xml<\/code> con el siguiente contenido:<\/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>\nA\u00f1adir entidad de gesti\u00f3n de libros y repositorio<\/h2>\n
Utilizaremos el ejemplo de un Reserve<\/code> (tal y como se encuentra en el repositorio \"COMENZAR - Almacenamiento de datos en cach\u00e9 con Spring<\/a>\"gu\u00eda oficial de Spring.io).<\/p>\nCrear el Reserve<\/code> clase de entidad en src\/main\/java\/com\/couchbase\/demo\/Libro.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>\nTenga en cuenta la Reserve<\/code> clase es Serializable<\/code>Esto es importante por ahora para el almacenamiento de Couchbase.<\/p><\/blockquote>\nCrear una interfaz de repositorio simple y una implementaci\u00f3n ingenua que simule un retraso:<\/p>\n
en 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>\nen 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>\nPrincipal Spring Boot<\/code> Aplicaci\u00f3n<\/h2>\nPor \u00faltimo, cree una Aplicaci\u00f3n que utilice el repositorio en 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>\nSi ejecuta la funci\u00f3n Aplicaci\u00f3n<\/code>'s principal<\/code> en su IDE (o si invoca \"mvn spring-boot:ejecutar<\/code>\" desde la l\u00ednea de comandos), observar\u00e1 que todas las llamadas son, en efecto, bastante 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>\nA\u00f1adir capacidades de almacenamiento en cach\u00e9 de Spring Boot<\/h2>\n
Para activar el almacenamiento en cach\u00e9, debe seguir algunos pasos: en primer lugar, debe ofrecer a Spring un archivo Gestor de cach\u00e9<\/code> @Bean<\/code>…<\/p>\nDado que vamos a utilizar el CouchbaseCacheManager<\/code> (por supuesto), necesitaremos conectarnos a un Grupo<\/code> y utilizar un Cubo<\/code> (la unidad de almacenamiento donde couchbase almacenar\u00e1 los documentos de la cach\u00e9).
\nAs\u00ed que el CouchbaseCacheManager<\/code> necesita una correspondencia entre Cach\u00e9<\/code> y los correspondientes Cubo<\/code> a utilizar, pasado como Mapa<\/code>.<\/p>\nEn src\/main\/java\/com\/couchbase\/demo\/Application.java<\/code>a\u00f1ade las siguientes declaraciones 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>\nA continuaci\u00f3n, desea activar el escaneo de anotaciones relacionadas con la cach\u00e9 y el proxy asociado colocando la etiqueta @HabilitarCach\u00e9<\/code> en el Aplicaci\u00f3n<\/code> clase.<\/p>\nActivar cach\u00e9 en SimpleBookRepository<\/code><\/h2>\nVeamos c\u00f3mo activar el almacenamiento en cach\u00e9 real en nuestro SimpleBookRepository<\/code> y compruebe c\u00f3mo se comporta la aplicaci\u00f3n despu\u00e9s de eso.<\/p>\nPara hacer getByIsbn<\/code> autom\u00e1ticamente en cach\u00e9 en la primera invocaci\u00f3n y servir las invocaciones posteriores con datos de la cach\u00e9, simplemente an\u00f3telo as\u00ed:<\/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 a ejecutar la aplicaci\u00f3n de nuevo y ver c\u00f3mo se comporta ahora:<\/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>\n\u00a1Vaya! Esto es mucho mejor para las invocaciones m\u00e1s all\u00e1 de la primera, parece que efectivamente se almacena en cach\u00e9 :-)<\/p>\n
Ver los datos en Couchbase<\/h2>\n
Echemos un vistazo r\u00e1pido a la consola web para verificar que estos magn\u00edficos tiempos pueden atribuirse a Couchbase:<\/p>\n
\n- abra una nueva pesta\u00f1a en su navegador y navegue hasta
https:\/\/localhost:8091<\/code><\/a>.<\/li>\n- conectarse a la consola web.<\/li>\n
- ir a la
Cubos de datos<\/code> y haga clic en Documentos<\/code> para el cubo que haya elegido utilizar (\"por defecto\").<\/li>\n<\/ul>\nLo que ve en esta pantalla (enlace r\u00e1pido<\/a> para los perezosos) deber\u00eda ser similar a esto:<\/p>\n![\"Spring](\"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/2015\/12\/cacheddocs.png\")
<\/p>\n