{"id":2226,"date":"2016-04-14T17:44:31","date_gmt":"2016-04-14T17:44:30","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=2226"},"modified":"2023-08-11T11:37:47","modified_gmt":"2023-08-11T18:37:47","slug":"spring-boot-couchbase-integration","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/spring-boot-couchbase-integration\/","title":{"rendered":"Couchbase as a First Class Citizen of Spring Boot 1.4"},"content":{"rendered":"

Spring Boot 1.4.0<\/code> MILESTONE 2<\/a> is out! This is a good time to tell you about the joint effort between Spring Boot team members and the Couchbase Java SDK team to offer a first class integration of Couchbase into Spring Boot :)<\/p>\n

<\/p>\n

In Spring Boot 1.4.0<\/code>, Couchbase becomes a first class citizen of the Spring Boot ecosystem!<\/p>\n

Couchbase SDK Integration<\/h2>\n

Spring Boot now directly recognizes when you have the Couchbase SDK<\/code> in your classpath. And when that’s the case, it instantiates a Cluster<\/code> and a Bucket<\/code> bean for you using autoconfiguration<\/em>.<\/p>\n

Spring Boot can pick up properties to further configure these core SDK classes, even the CouchbaseEnvironment<\/code>!<\/p>\n

The following bootstrapping properties are recognized:<\/p>\n

spring.couchbase.bootstrap-hosts\r\nspring.couchbase.bucket.name\r\nspring.couchbase.bucket.password\r\n<\/pre>\n
Environment tuning (IO endpoints, SSL support and default sync API timeouts) are exposed through the following properties:<\/p>\n
spring.couchbase.env.endpoints.key-value\r\nspring.couchbase.env.endpoints.query\r\nspring.couchbase.env.endpoints.view\r\n\r\nspring.couchbase.env.ssl.enabled\r\nspring.couchbase.env.ssl.key-store\r\nspring.couchbase.env.ssl.key-store-password\r\n\r\nspring.couchbase.env.timeouts.connect\r\nspring.couchbase.env.timeouts.key-value\r\nspring.couchbase.env.timeouts.query\r\nspring.couchbase.env.timeouts.view\r\n<\/pre>\n
Now this is \u2b50\ufe0f\u2b50\ufe0f\u2b50\ufe0f\u2b50\ufe0f\u2b50\ufe0f support!<\/p>\n
WARNING<\/strong>: Note that in the previous milestone the bootstrapping properties were prefixed with ” spring.*data*.couchbase<\/code> “, now becoming ” spring.couchbase<\/code> “.<\/p><\/blockquote>\n
Spring Cache Implementation<\/h2>\n
The Spring Cache<\/a> abstraction has a Couchbase 2.x implementation, couchbase-spring-cache<\/code><\/a>.<\/p>\n
Spring Boot now recognizes this cache implementation when both the Java SDK and the couchbase-spring-cache<\/code> artifacts are on the classpath.<\/p>\n
This integrates nicely with the previous section, seeing as the default underlying storage Bucket<\/code> for the caches is the one autoconfigured by Spring Boot :)<\/p>\n
NOTE<\/strong>: The cache implementation has been pulled out of the Spring Data Couchbase project into its own project (in Couchbase’s github repository), so that it could be used and released separately from Spring Data.<\/p><\/blockquote>\n
TIP<\/strong>: Don’t forget to at least configure the spring.couchbase.bootstrap-hosts<\/code> property.<\/p><\/blockquote>\n
This implementation of the CacheManager<\/code> allows for storing data from several caches into the same Couchbase bucket, by automatically prefixing the keys in Couchbase with the name of each cache.<\/p>\n
The CouchbaseCacheManager<\/code> will automatically reuse the Bucket<\/code> autoconfigured by Spring Boot. By simply adding a property to declaratively list cache names, the corresponding caches will be pre-loaded:<\/p>\n
spring.cache.type=couchbase\r\nspring.cache.cache-names=foo,bar\r\n<\/pre>\n
Five-star support, we tell you!<\/p>\n
You can even configure it to store data for different caches into multiple buckets. The caches can then be configured using a fluent builder pattern (eg. in a CacheManagerCustomizer<\/code>). This CacheBuilder<\/code> also allows you to further tune the caches, like setting a default expiration time:<\/p>\n
@Configuration\r\npublic class CouchbaseCacheConfiguration {\r\n\r\n  private final Cluster cluster;\r\n\r\n  \/\/inject the Cluster from Boot core Couchbase support\r\n  public CouchbaseCacheConfiguration(Cluster cluster) {\r\n    this.cluster = cluster;\r\n  }\r\n\r\n  @Bean\r\n  public Bucket anotherBucket() {\r\n    return this.cluster.openBucket(\"another\", \"secret\");\r\n  }\r\n\r\n  @Bean\r\n  public CacheManagerCustomizer cmCustomizer() {\r\n    return c -> {\r\n      c.prepareCache(\"biz\", CacheBuilder\r\n              .newInstance(anotherBucket())\r\n              .withExpirationInMillis(2000));\r\n    };\r\n  }\r\n}<\/code><\/pre>\n
This implementation can use views to selectively clear caches that are collocated in the same Bucket.<\/p>\n
Finally, it supports dynamic creation of caches as they are requested. To activate that, simply omit to declare any cache name and just activate Couchbase caching with the relevant property:<\/p>\n
spring.cache.type=couchbase\r\n<\/pre>\n
This will use the Spring Boot autoconfigured Bucket<\/code> as the default bucket for all dynamically created caches.<\/p>\n
Fun with @Cacheable<\/code> awaits ?<\/p>\n
Spring Data Integration<\/h2>\n
Spring Data Couchbase 2.1.0<\/code><\/a> (release train Hopper) has included several modifications that makes integration with Spring Boot a breeze.<\/p>\n
First the usual suspect: by default Spring Boot will autoconfigure Spring Data Couchbase to use the Bucket<\/code> it created. This is made possible by having separated the core SDK configuration parts into a CouchbaseConfigurer<\/code> class, while what is really specific to Spring Data is located in a new base class, AbstractCouchbaseDataConfiguration<\/code>.<\/p>\n
If you use only Spring Data, you can go ahead and continue using the AbstractCouchbaseConfiguration<\/code>, which is now both a CouchbaseConfigurer and an AbstractCouchbaseDataConfiguration.<\/p>\n
If you use Spring Boot however, it will autoconfigure a CouchbaseConfigurer<\/code>. You can always tune your own AbstractCouchbaseDataConfiguration<\/code> and inject the configurer in it.<\/p>\n
Other Spring Data Couchbase Features<\/h3>\n
The 2.1.0 release also includes a few new features:<\/p>\n