Spring Boot中配置多Couchbase Bucket的可行性及实现方法

当然可以在单个Spring Boot应用里同时连接多个Couchbase Bucket！针对你用的5.1版本，我给你两种常用的实现方式，都是新手友好的操作步骤：

方法一：配置多个CouchbaseTemplate实例 #

这种方式适合需要更灵活操作不同Bucket的场景，手动创建对应每个Bucket的操作模板：

1. 在配置文件中添加多Bucket信息
   打开你的application.properties（或者application.yml），添加两个Bucket的连接配置：

   # 集群基础配置
   spring.couchbase.connection-string=couchbase://localhost
   spring.couchbase.username=admin
   spring.couchbase.password=your-cluster-password
   
   # 第一个Bucket配置
   spring.couchbase.buckets.first.name=my-first-bucket
   spring.couchbase.buckets.first.password= # 如果Bucket没密码就留空
   
   # 第二个Bucket配置
   spring.couchbase.buckets.second.name=my-second-bucket
   spring.couchbase.buckets.second.password=
   

2. 创建多Bucket配置类
   新建一个配置类，继承AbstractCouchbaseConfiguration，然后分别初始化两个Bucket对应的CouchbaseTemplate：

   import org.springframework.context.annotation.Bean;
   import org.springframework.context.annotation.Configuration;
   import org.springframework.data.couchbase.config.AbstractCouchbaseConfiguration;
   import org.springframework.data.couchbase.core.CouchbaseTemplate;
   import com.couchbase.client.java.Cluster;
   import com.couchbase.client.java.Bucket;
   
   @Configuration
   public class MultipleCouchbaseConfig extends AbstractCouchbaseConfiguration {
   
       @Override
       public String getConnectionString() {
           return "couchbase://localhost";
       }
   
       @Override
       public String getUserName() {
           return "admin";
       }
   
       @Override
       public String getPassword() {
           return "your-cluster-password";
       }
   
       // 第一个Bucket的操作模板
       @Bean(name = "firstBucketTemplate")
       public CouchbaseTemplate firstBucketTemplate() throws Exception {
           Cluster cluster = couchbaseCluster();
           Bucket firstBucket = cluster.bucket("my-first-bucket");
           // 等待Bucket就绪，避免连接失败
           firstBucket.waitUntilReady(java.time.Duration.ofSeconds(10));
           return new CouchbaseTemplate(couchbaseClusterInfo(), firstBucket, mappingCouchbaseConverter());
       }
   
       // 第二个Bucket的操作模板
       @Bean(name = "secondBucketTemplate")
       public CouchbaseTemplate secondBucketTemplate() throws Exception {
           Cluster cluster = couchbaseCluster();
           Bucket secondBucket = cluster.bucket("my-second-bucket");
           secondBucket.waitUntilReady(java.time.Duration.ofSeconds(10));
           return new CouchbaseTemplate(couchbaseClusterInfo(), secondBucket, mappingCouchbaseConverter());
       }
   }
   

3. 在业务类中使用指定的Template
   通过@Qualifier注解指定要使用哪个Bucket的模板，就可以分别操作不同Bucket了：

   import org.springframework.beans.factory.annotation.Qualifier;
   import org.springframework.data.couchbase.core.CouchbaseTemplate;
   import org.springframework.stereotype.Service;
   
   @Service
   public class MultiBucketService {
   
       private final CouchbaseTemplate firstTemplate;
       private final CouchbaseTemplate secondTemplate;
   
       // 构造注入时指定对应的模板
       public MultiBucketService(@Qualifier("firstBucketTemplate") CouchbaseTemplate firstTemplate,
                                @Qualifier("secondBucketTemplate") CouchbaseTemplate secondTemplate) {
           this.firstTemplate = firstTemplate;
           this.secondTemplate = secondTemplate;
       }
   
       public void saveToFirstBucket(Object entity) {
           firstTemplate.save(entity);
       }
   
       public void saveToSecondBucket(Object entity) {
           secondTemplate.save(entity);
       }
   }
   

方法二：使用@Bucket注解结合Spring Data Repository #

如果习惯用Spring Data的Repository模式，这种方式更简洁，通过注解指定实体对应的Bucket：

1. 给实体类指定Bucket
   在你的实体类上添加@Bucket注解，明确它属于哪个Bucket：

   import org.springframework.data.annotation.Id;
   import org.springframework.data.couchbase.core.mapping.Bucket;
   import org.springframework.data.couchbase.core.mapping.Document;
   
   @Document
   @Bucket(name = "my-first-bucket") // 这个实体存在first-bucket里
   public class User {
       @Id
       private String userId;
       private String userName;
       // getter、setter方法省略
   }
   
   @Document
   @Bucket(name = "my-second-bucket") // 这个实体存在second-bucket里
   public class Order {
       @Id
       private String orderId;
       private Double amount;
       // getter、setter方法省略
   }
   

2. 创建对应的Repository接口
   分别为每个实体创建继承CouchbaseRepository的接口：

   import org.springframework.data.couchbase.repository.CouchbaseRepository;
   import org.springframework.stereotype.Repository;
   
   @Repository
   public interface UserRepository extends CouchbaseRepository<User, String> {
   }
   
   @Repository
   public interface OrderRepository extends CouchbaseRepository<Order, String> {
   }
   

3. 基础Couchbase配置
   新建一个基础配置类，启用Couchbase Repository并配置集群信息：

   import org.springframework.context.annotation.Configuration;
   import org.springframework.data.couchbase.config.AbstractCouchbaseConfiguration;
   import org.springframework.data.couchbase.repository.config.EnableCouchbaseRepositories;
   
   @Configuration
   @EnableCouchbaseRepositories(basePackages = "com.your-project.repository") // 替换成你的Repository包路径
   public class CouchbaseConfig extends AbstractCouchbaseConfiguration {
   
       @Override
       public String getConnectionString() {
           return "couchbase://localhost";
       }
   
       @Override
       public String getUserName() {
           return "admin";
       }
   
       @Override
       public String getPassword() {
           return "your-cluster-password";
       }
   }
   

4. 在业务类中注入Repository使用
   直接注入对应的Repository，Spring会自动关联到指定的Bucket：

   import org.springframework.stereotype.Service;
   
   @Service
   public class EntityService {
   
       private final UserRepository userRepo;
       private final OrderRepository orderRepo;
   
       public EntityService(UserRepository userRepo, OrderRepository orderRepo) {
           this.userRepo = userRepo;
           this.orderRepo = orderRepo;
       }
   
       public void saveUser(User user) {
           userRepo.save(user);
       }
   
       public void saveOrder(Order order) {
           orderRepo.save(order);
       }
   }
   

一些注意事项 #

• 确保你的Spring Data Couchbase版本和Couchbase 5.1兼容：一般Spring Boot 2.x对应的Spring Data Couchbase 3.x是适配5.x版本的，别搞错版本哦。
• 如果Bucket设置了密码，一定要在配置文件里填上对应的密码项。
• 初始化Bucket时加上waitUntilReady可以避免刚启动时连接未就绪的问题。

内容的提问来源于stack exchange，提问作者Sourav