image:https://spring.io/badges/spring-data-mongodb/ga.svg[Spring Data MongoDB,link=https://spring.io/projects/spring-data-mongodb#quick-start] image:https://spring.io/badges/spring-data-mongodb/snapshot.svg[Spring Data MongoDB,link=https://spring.io/projects/spring-data-mongodb#quick-start]
= Spring Data MongoDB image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-mongodb%2Fmain&subject=Build[link=https://jenkins.spring.io/view/SpringData/job/spring-data-mongodb/] 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["由Develocity提供支持", link="https://ge.spring.io/scans?search.rootProjectNames=Spring Data MongoDB"]
https://spring.io/projects/spring-data[Spring Data]项目的主要目标是使构建使用新数据访问技术(如非关系型数据库、map-reduce框架和基于云的数据服务)的Spring应用程序变得更加容易。
Spring Data MongoDB项目旨在为新的数据存储提供熟悉且一致的基于Spring的编程模型,同时保留特定存储的特性和功能。Spring Data MongoDB项目提供了与MongoDB文档数据库的集成。Spring Data MongoDB的主要功能领域包括一个以POJO为中心的模型,用于与MongoDB的+Document+
进行交互,以及轻松编写仓库风格的数据访问层。
[[code-of-conduct]] == 行为准则
[[getting-started]] == 入门指南
以下是一个使用Java编写的Spring Data Repositories的应用程序示例:
[source,java]
public interface PersonRepository extends CrudRepository<Person, Long> {
List
List
@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("Oliver");
person.setLastname("Gierke");
repository.save(person);
List<Person> lastNameResults = repository.findByLastname("Gierke");
List<Person> firstNameResults = repository.findByFirstnameLike("Oli*");
} }
@Configuration @EnableMongoRepositories class ApplicationConfig extends AbstractMongoClientConfiguration {
@Override protected String getDatabaseName() { return "springdata"; } }
[[maven-configuration]] === Maven配置
添加Maven依赖:
[source,xml]
如果您更喜欢使用即将发布的主要版本的最新快照,请使用我们的Maven快照仓库并声明适当的依赖版本。
[source,xml]
[[upgrading]] == 升级
有关如何从Spring Data早期版本升级的说明,请参阅项目https://github.com/spring-projects/spring-data-commons/wiki[wiki]。请点击https://github.com/spring-projects/spring-data-commons/wiki#release-notes[发布说明]部分的链接,找到您想要升级到的版本。
[[getting-help]] == 获取帮助
在使用Spring Data时遇到问题?我们很乐意为您提供帮助!
- 查看https://docs.spring.io/spring-data/mongodb/reference/[参考文档]和https://docs.spring.io/spring-data/mongodb/docs/current/api/[Javadocs]
- 学习Spring基础知识 – Spring Data建立在Spring Framework之上,请查看https://spring.io[spring.io]网站获取丰富的参考文档。如果您刚开始接触Spring,可以尝试其中一个https://spring.io/guides[指南]。
- 如果您正在升级,请查看https://docs.spring.io/spring-data/mongodb/docs/current/changelog.txt[更新日志]了解"新特性和值得注意的功能"。
- 提问 - 我们监控https://stackoverflow.com[stackoverflow.com]上标记为https://stackoverflow.com/tags/spring-data[`spring-data-mongodb`]的问题。您也可以在https://gitter.im/spring-projects/spring-data[Gitter]上与社区交流。
- 在https://github.com/spring-projects/spring-data-mongodb/issues[github.com/spring-projects/spring-data-mongodb/issues]报告Spring Data MongoDB的bug。
[[reporting-issues]] == 报告问题
Spring Data使用Github作为问题跟踪系统来记录bug和功能请求。如果您想提出问题,请遵循以下建议:
- 在记录bug之前,请先在https://github.com/spring-projects/spring-data-mongodb/issues[问题跟踪器]中搜索,看是否有人已经报告了该问题。
- 如果该问题尚不存在,请https://github.com/spring-projects/spring-data-mongodb/issues/new[创建一个新问题]。
- 请尽可能提供更多信息,我们希望了解您使用的Spring Data版本、JVM版本、堆栈跟踪等信息。
- 如果需要粘贴代码或包含堆栈跟踪,请使用https://guides.github.com/features/mastering-markdown/[Markdown]代码围栏+++```+++。
[[guides]] == 指南
https://spring.io/[spring.io]网站包含几个逐步展示如何使用Spring Data的指南:
-
https://spring.io/guides/gs/accessing-mongodb-data-rest/[通过REST访问MongoDB数据]是一个指南,介绍如何创建一个REST Web服务,通过仓库公开存储在MongoDB中的数据。 [[examples]] == 示例
-
https://github.com/spring-projects/spring-data-examples/[Spring Data 示例] 包含详细解释特定功能的示例项目。
[[building-from-source]] == 从源代码构建
使用 Spring Data 无需从源代码构建。二进制文件可在 https://repo.spring.io[repo.spring.io] 获取,并可通过上述 <<maven-configuration,Maven 配置>> 访问。
注意:Gradle 的配置与 Maven 类似。
最好的入门方式是在 https://start.spring.io[start.spring.io] 上创建一个使用 MongoDB 的 Spring Boot 项目。 点击此 https://start.spring.io/#type=maven-project&language=java&platformVersion=3.0.0&packaging=jar&jvmVersion=17&groupId=com.example&artifactId=demo&name=demo&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.demo&dependencies=data-mongodb[链接] 构建一个命令式应用程序,或点击此 https://start.spring.io/#type=maven-project&language=java&platformVersion=3.0.0&packaging=jar&jvmVersion=17&groupId=com.example&artifactId=demo&name=demo&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.demo&dependencies=data-mongodb-reactive[链接] 构建一个响应式应用程序。
但是,如果你想尝试最新最好的版本,Spring Data MongoDB 可以使用 https://github.com/takari/maven-wrapper[Maven wrapper] 轻松构建, 最低要求是 JDK 17 (https://www.oracle.com/java/technologies/downloads/[JDK 下载])。
要构建 Spring Data MongoDB,你需要 https://www.mongodb.com/try/download/community[下载] 并 https://docs.mongodb.com/manual/installation/[安装 MongoDB 发行版]。
安装 MongoDB 后,你需要启动 MongoDB 服务器。最好将 MongoDB 安装目录设置为环境变量(例如 MONGODB_HOME
)。
要运行完整的测试套件,需要一个 https://docs.mongodb.com/manual/tutorial/deploy-replica-set/[MongoDB 副本集]。
要运行 MongoDB 服务器,在命令行中输入以下命令:
[source,bash]
$ $MONGODB_HOME/bin/mongod --dbpath $MONGODB_HOME/runtime/data --ipv6 --port 27017 --replSet rs0 ... "msg":"Successfully connected to host"
MongoDB 服务器启动后,你应该会看到消息(msg
)"Successfully connected to host"。
注意 mongod
命令中的 --dbpath
选项。你可以将其设置为任何你喜欢的路径,但在这个例子中,我们将其设置为 MongoDB 安装目录($MONGODB_HOME
)下的子目录(runtime/data/
)的绝对路径。
你只需在第一次启动 MongoDB 服务器时初始化一次 MongoDB 副本集。 要初始化副本集,启动一个 mongo 客户端:
[source,bash]
$ $MONGODB_HOME/bin/mongo MongoDB server version: 6.0.0 ...
然后输入以下命令:
[source,bash]
mongo> rs.initiate({ _id: 'rs0', members: [ { _id: 0, host: '127.0.0.1:27017' } ] })
最后,在基于 UNIX 的系统(例如 Linux 或 Mac OS X)上,你可能需要调整 ulimit
。
如果需要,你可以使用以下命令调整 ulimit
(32768 只是一个建议值):
[source,bash]
$ ulimit -n 32768
你可以再次使用 ulimit -a
来验证"打开文件"的 ulimit
是否设置正确。
现在你已经准备好构建 Spring Data MongoDB 了。只需输入以下 mvnw
(Maven Wrapper)命令:
[source,bash]
$ ./mvnw clean install
如果你想使用常规的 mvn
命令构建,你需要 https://maven.apache.org/run-maven/index.html[Maven v3.8.0 或更高版本]。
如果你希望提交拉取请求,请同时查看 link:CONTRIBUTING.adoc[CONTRIBUTING.adoc],特别是在进行第一次非微小更改之前,请签署 https://cla.pivotal.io/sign/spring[贡献者协议]。
=== 构建参考文档
构建文档的同时也会构建项目,但不运行测试。
[source,bash]
$ ./mvnw clean install -Pantora
生成的文档可在 target/antora/site/index.html
中找到。
[[license]] == 许可证
Spring Data MongoDB 是根据 https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 许可证] 发布的开源软件。