= Spring Data Couchbase image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-couchbase%2Fmain&subject=Build[link=https://jenkins.spring.io/view/SpringData/job/spring-data-couchbase/] https://gitter.im/spring-projects/spring-data[image:https://badges.gitter.im/spring-projects/spring-data.svg[Gitter]] image:https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A["Revved up by Develocity", link="https://ge.spring.io/scans?search.rootProjectNames=Spring Data Couchbase"]

https://www.springsource.org/spring-data[Spring Data]项目的主要目标是让构建使用新的数据访问技术（如非关系型数据库、MapReduce框架和基于云的数据服务）的Spring应用程序变得更加容易。

Spring Data Couchbase项目旨在为Couchbase Server作为文档数据库和缓存提供一个熟悉且一致的基于Spring的编程模型，同时保留特定存储的特性和功能。Spring Data Couchbase的主要功能领域包括以POJO为中心的模型，用于与Couchbase Server Bucket交互，以及轻松编写repository风格的数据访问层。

集成测试需要一个Couchbase服务器，其中有一个名为"protected"的bucket，密码设置为"password"。如果服务器允许用户，还应设置一个用户名为"protected"、密码为"password"的用户。运行测试的推荐方式是安装Docker并使用server.properties中的容器。

该项目由Couchbase, Inc.领导和维护。

== 特性

使用基于Java的@Configuration类或XML命名空间支持Couchbase驱动程序（Java SDK版本2.x）的Spring配置。
CouchbaseTemplate辅助类提高了执行常见Couchbase操作的生产力。包括文档和POJO之间的集成对象映射。
将异常转换为Spring的可移植数据访问异常层次结构。
功能丰富的对象映射，与Spring的转换服务集成。
基于注解的映射元数据，但可扩展以支持其他元数据格式。
自动实现Repository接口，包括支持自定义查找方法（由Couchbase的查询语言N1QL支持）和PagingAndSortingRepository。
对于Couchbase服务器版本<4.0，存储库仍可由Couchbase Views支持。
支持地理空间和多维查询（由Couchbase空间视图支持）
JMX管理和监控
可作为@Cacheable支持的后端，缓存任何需要高性能访问的对象（参见Couchbase GitHub中的兄弟Spring Cache项目，https://github.com/couchbaselabs/couchbase-spring-cache[couchbaselabs/couchbase-spring-cache]）。

== 版本兼容性

Spring-Data Couchbase是Couchbase Java SDK 2.x一代的Spring Data连接器。

SDK和这个Spring Data社区项目都是主要版本变更，与各自的前一版本有很多不同。

值得注意的是，此版本兼容Couchbase Server 4.0，支持N1QL查询语言。

== 行为准则

本项目受https://github.com/spring-projects/.github/blob/e3cc2ff230d8f1dca06535aa6b5a4a23815861d4/CODE_OF_CONDUCT.md[Spring行为准则]管理。参与者应遵守此行为准则。请将不可接受的行为报告给spring-code-of-conduct@pivotal.io。

== 入门

这里是一个使用Spring Data Repositories的Java应用程序的快速示例：

[source,java]

public interface PersonRepository extends CrudRepository<Person, Long> {

List<Person> findByLastname(String lastname);

List<Person> findByFirstnameLike(String firstname); }

@Service public class MyService {

private final PersonRepository repository;

public MyService(PersonRepository repository) { this.repository = repository; }

public void doWork() {

repository.deleteAll();

Person person = new Person();
person.setFirstname("Couch");
person.setLastname("Base");
repository.save(person);

List<Person> lastNameResults = repository.findByLastname("Base");
List<Person> firstNameResults = repository.findByFirstnameLike("Cou*");

} }

@Configuration @EnableCouchbaseRepositories public class Config extends AbstractCouchbaseConfiguration {

@Override
protected List<String> getBootstrapHosts() {
	return Arrays.asList("host1", "host2");
}

@Override
protected String getBucketName() {
	return "default";
}

@Override
protected String getPassword() {
	return "";
}

}

=== Maven配置

添加Maven依赖：

[source,xml]

<dependency> <groupId>org.springframework.data</groupId> <artifactId>spring-data-couchbase</artifactId> <version>${version}</version> </dependency> ----

如果你更喜欢即将发布的主要版本的最新快照，请使用我们的Maven快照仓库并声明适当的依赖版本。

[source,xml]

<dependency> <groupId>org.springframework.data</groupId> <artifactId>spring-data-couchbase</artifactId> <version>${version}-SNAPSHOT</version> </dependency> <repository> <id>spring-snapshot</id> <name>Spring Snapshot Repository</name> <url>https://repo.spring.io/snapshot</url> </repository> ----

== 获取帮助

使用Spring Data遇到问题？我们很乐意帮忙！

查看https://docs.spring.io/spring-data/couchbase/docs/current/reference/html/[参考文档]和https://docs.spring.io/spring-data/couchbase/docs/current/api/[Javadocs]。
学习Spring基础知识 – Spring Data建立在Spring Framework之上，请查看https://spring.io[spring.io]网站获取丰富的参考文档。如果你刚开始使用Spring，可以尝试https://spring.io/guides[指南]之一。
提问 - 我们监控https://stackoverflow.com[stackoverflow.com]上标记为https://stackoverflow.com/tags/spring-data[`spring-data-couchbase`]的问题。你也可以在https://gitter.im/spring-projects/spring-data[Gitter]上与社区交流。
在https://jira.spring.io/browse/DATACOUCH[jira.spring.io/browse/DATACOUCH]报告Spring Data Couchbase的bug。

== 报告问题

Spring Data使用GitHub作为问题跟踪系统来记录bug和功能请求。如果你想提出一个问题，请遵循以下建议：

在记录bug之前，请搜索https://github.com/spring-projects/spring-data-couchbase/issues[问题跟踪器]，看看是否有人已经报告了该问题。
如果该问题尚不存在，请https://github.com/spring-projects/spring-data-couchbase/issues/new[创建一个新问题]。
请在问题报告中提供尽可能多的信息，我们希望知道你使用的Spring Data版本和JVM版本。
如果需要粘贴代码或包含堆栈跟踪，请在文本前后使用Markdown +++```+++ 转义。
如果可能，请尝试创建一个重现该问题的测试用例或项目。附上你的代码链接或包含代码的压缩文件。

== 从源代码构建

你不需要从源代码构建来使用Spring Data（二进制文件在https://repo.spring.io[repo.spring.io]中），但如果你想尝试最新和最棒的功能，可以使用https://github.com/takari/maven-wrapper[maven wrapper]轻松构建Spring Data。你还需要JDK 17或更高版本。