如何在Spring Boot中通过代码创建Couchbase Bucket

本文基于Spring Boot + Spring Data Couchbase 3.x/4.x 版本实现，确保你已在项目中引入了spring-boot-starter-data-couchbase依赖。

前置说明 #

你原有连接固定Bucket的配置逻辑可以保留，创建新Bucket需要用到拥有集群管理权限的账号，普通Bucket读写账号无创建权限。

步骤1：扩展Couchbase基础配置 #

在原有继承AbstractCouchbaseConfiguration的配置类中，新增Cluster实例的注册，用于执行集群层面的Bucket管理操作：

import com.couchbase.client.java.Cluster;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.couchbase.config.AbstractCouchbaseConfiguration;

@Configuration
public class CouchbaseConfig extends AbstractCouchbaseConfiguration {

    // 替换为你的Couchbase集群连接地址
    @Override
    public String getConnectionString() {
        return "couchbase://127.0.0.1";
    }

    // 填写集群管理员账号，而非普通Bucket读写账号
    @Override
    public String getUserName() {
        return "Administrator";
    }

    // 填写集群管理员密码
    @Override
    public String getPassword() {
        return "your_admin_password";
    }

    // 原有默认Bucket配置，可填写一个已存在的Bucket名称即可，不影响动态Bucket操作
    @Override
    public String getBucketName() {
        return "default_exist_bucket";
    }

    // 注册集群实例到Spring容器
    @Bean
    public Cluster couchbaseCluster() {
        return Cluster.connect(getConnectionString(), getUserName(), getPassword());
    }
}

步骤2：编写Bucket创建工具类 #

封装Bucket创建逻辑，可根据业务需求自定义Bucket参数：

import com.couchbase.client.java.Cluster;
import com.couchbase.client.java.manager.bucket.BucketSettings;
import com.couchbase.client.java.manager.bucket.BucketType;
import org.springframework.stereotype.Component;
import javax.annotation.Resource;
import java.time.Duration;

@Component
public class CouchbaseBucketManager {

    @Resource
    private Cluster couchbaseCluster;

    /**
     * 创建自定义Bucket
     * @param bucketName 新Bucket名称，不能和已有Bucket重名
     * @param ramQuotaMB Bucket内存配额，最小为100MB
     */
    public void createNewBucket(String bucketName, int ramQuotaMB) {
        BucketSettings bucketSettings = BucketSettings.create(bucketName)
                // 指定Bucket类型为持久化类型
                .bucketType(BucketType.COUCHBASE)
                .ramQuotaMB(ramQuotaMB)
                // 副本数量，单节点测试环境可设置为0
                .numReplicas(1)
                // 文档默认过期时间，按需配置，永久有效可设为Duration.ZERO
                .maxExpiry(Duration.ofDays(30))
                // 是否允许清空Bucket，生产环境建议关闭
                .flushEnabled(false);

        // 执行Bucket创建
        couchbaseCluster.buckets().createBucket(bucketSettings);
        // 等待Bucket初始化完成，避免后续读写操作报错
        couchbaseCluster.waitUntilReady(Duration.ofSeconds(10));
    }
}

步骤3：对新Bucket执行CRUD操作 #

场景1：新Bucket名称固定 #

如果创建的Bucket名称是固定值，直接在实体类的@Document注解中指定Bucket名称，原有继承AbstractCouchbaseRepository的开发逻辑完全不用改：

import org.springframework.data.annotation.Id;
import org.springframework.data.couchbase.core.mapping.Document;

// 注解中指定新建的Bucket名称即可
@Document(bucketName = "your_new_bucket_name")
public class BusinessDocument {
    @Id
    private String id;
    private String data;
    // 省略getter、setter、构造方法
}

Repository正常定义即可：

import org.springframework.data.couchbase.repository.AbstractCouchbaseRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface BusinessDocumentRepository extends AbstractCouchbaseRepository<BusinessDocument, String> {
    // 按需自定义查询方法
}

场景2：新Bucket名称动态生成 #

如果Bucket名称是运行时动态生成的，没有固定值，使用CouchbaseTemplate实现动态Bucket的读写操作：

import org.springframework.data.couchbase.core.CouchbaseTemplate;
import org.springframework.stereotype.Component;
import javax.annotation.Resource;

@Component
public class DynamicBucketService {
    @Resource
    private CouchbaseTemplate couchbaseTemplate;

    // 向指定Bucket保存文档
    public <T> T saveDoc(String bucketName, T document) {
        return couchbaseTemplate.withBucket(bucketName).save(document);
    }

    // 从指定Bucket查询文档
    public <T> T getDoc(String bucketName, String docId, Class<T> docClazz) {
        return couchbaseTemplate.withBucket(bucketName).findById(docId, docClazz);
    }
}

注意事项 #

• 集群管理员账号权限较高，生产环境建议单独封装Bucket管理逻辑，做好权限控制
• Bucket创建后默认没有创建索引，如果需要使用N1QL查询，需要手动为新Bucket创建对应索引
• 内存配额不能低于Couchbase要求的最小值，否则会抛出参数错误异常

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