当前位置：首页 > article >正文

Spring Boot 与 Couchbase 整合教程

article 2025/3/29 2:56:04

精心整理了最新的面试资料和简历模板，有需要的可以自行获取

点击前往百度网盘获取
点击前往夸克网盘获取

Spring Boot 与 Couchbase 整合教程

环境要求

JDK 8+
Spring Boot 2.7.x
Couchbase Server 7.x
Maven/Gradle

步骤 1：创建Spring Boot项目

使用 start.spring.io 创建项目，添加以下依赖：

Spring Web（可选，用于REST API）
Spring Data Couchbase

或手动添加Maven依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-couchbase</artifactId>
</dependency>

步骤 2：配置Couchbase连接

在 application.yml 或 application.properties 中添加配置：

spring:
  couchbase:
    connection-string: couchbase://localhost
    username: your-username
    password: your-password
    bucket:
      name: your-bucket
  data:
    couchbase:
      auto-index: true # 自动生成索引（开发环境建议开启）

步骤 3：定义实体类

创建一个实体类并使用注解标记：

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

@Document
public class User {
    @Id
    private String id;
    private String name;
    private String email;

    // 省略构造方法、Getter/Setter
}

步骤 4：创建Repository接口

继承 CouchbaseRepository 实现基本CRUD：

import org.springframework.data.couchbase.repository.CouchbaseRepository;

public interface UserRepository extends CouchbaseRepository<User, String> {
    // 自定义查询方法
    List<User> findByName(String name);
}

步骤 5：编写Service层

import org.springframework.stereotype.Service;

@Service
public class UserService {
    private final UserRepository userRepository;

    public UserService(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    public User createUser(User user) {
        return userRepository.save(user);
    }

    public Optional<User> getUserById(String id) {
        return userRepository.findById(id);
    }
}

步骤 6：创建REST Controller（可选）

import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/users")
public class UserController {
    private final UserService userService;

    public UserController(UserService userService) {
        this.userService = userService;
    }

    @PostMapping
    public User createUser(@RequestBody User user) {
        return userService.createUser(user);
    }

    @GetMapping("/{id}")
    public Optional<User> getUser(@PathVariable String id) {
        return userService.getUserById(id);
    }
}

步骤 7：高级配置（可选）

自定义 CouchbaseConfig 类以调整连接池、超时等参数：

@Configuration
public class CouchbaseConfig extends AbstractCouchbaseConfiguration {
    @Override
    public String getConnectionString() {
        return "couchbase://localhost";
    }

    @Override
    public String getUserName() {
        return "your-username";
    }

    @Override
    public String getPassword() {
        return "your-password";
    }

    @Override
    public String getBucketName() {
        return "your-bucket";
    }

    @Override
    protected void configurePoolOptions(Builder builder) {
        builder.connectTimeout(Duration.ofSeconds(10)); // 自定义超时设置
    }
}

步骤 8：测试API

使用 curl 或 Postman 测试：

# 创建用户
curl -X POST -H "Content-Type: application/json" -d '{"name":"John", "email":"john@example.com"}' http://localhost:8080/users

# 查询用户
curl http://localhost:8080/users/{id}

常见问题排查

连接失败
- 检查Couchbase服务是否运行
- 验证 connection-string 格式是否为 couchbase://ip
- 确认用户名/密码和Bucket名称正确
N1QL查询错误
- 确保Bucket已创建Primary索引：
```
CREATE PRIMARY INDEX ON `your-bucket`
```