= Spring Data KeyValue image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-keyvalue%2Fmain&subject=Build[link=https://jenkins.spring.io/view/SpringData/job/spring-data-keyvalue/] 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 KeyValue"]
https://projects.spring.io/spring-data[Spring Data]项目的主要目标是使构建使用新数据访问技术(如非关系型数据库、map-reduce框架和基于云的数据服务)的Spring应用程序变得更加容易。
该模块提供了基础设施组件,用于构建处理键值对存储的仓库抽象,并附带了一个基于默认java.util.Map
的实现。
== 特性
- 用于在键值实现之上构建仓库的基础设施。
- 基于查询方法名称的动态SpEL查询生成。
- 集成自定义仓库代码的可能性。
== 行为准则
== 入门
以下是使用Java中Spring Data仓库的应用程序快速示例:
[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("Oliver");
person.setLastname("Gierke");
repository.save(person);
List<Person> lastNameResults = repository.findByLastname("Gierke");
List<Person> firstNameResults = repository.findByFirstnameLike("Oli*");
}
}
@KeySpace("person") class Person {
@Id String uuid;
String firstname;
String lastname;
// 为简洁起见,省略了getter和setter方法
}
@Configuration @EnableMapRepositories("com.acme.repositories") class AppConfig { … }
=== Maven配置
添加Maven依赖:
[source,xml]
如果您更喜欢即将发布的主要版本的最新快照,请使用我们的Maven快照仓库并声明适当的依赖版本。
[source,xml]
== 获取帮助
在使用Spring Data时遇到问题?我们很乐意提供帮助!
- 查阅https://docs.spring.io/spring-data/keyvalue/reference/[参考文档]和https://docs.spring.io/spring-data/keyvalue/docs/current/api/[Javadocs]。
- 学习Spring基础知识 – Spring Data建立在Spring Framework之上,请查看https://spring.io[spring.io]网站获取大量参考文档。如果您刚开始使用Spring,可以尝试其中一个https://spring.io/guides[指南]。
- 如果您正在升级,请查看https://github.com/spring-projects/spring-data-commons/wiki#release-notes[发行说明]了解"新特性和值得注意的功能"。
- 提问 - 我们会关注https://stackoverflow.com[stackoverflow.com]上标记为https://stackoverflow.com/tags/spring-data[`spring-data-keyvalue`]的问题。您也可以在https://gitter.im/spring-projects/spring-data[Gitter]上与社区交流。
- 通过https://github.com/spring-projects/spring-data-keyvalue/issues[Github]报告Spring Data KeyValue的bug。
== 报告问题
Spring Data使用Github作为问题跟踪系统来记录bug和功能请求。如果您想提出问题,请遵循以下建议:
- 在记录bug之前,请搜索https://github.com/spring-projects/spring-data-keyvalue/issues[问题跟踪器],看看是否有人已经报告了该问题。
- 如果该问题尚不存在,请https://github.com/spring-projects/spring-data-keyvalue/issues/new[创建一个新问题]。
- 请尽可能提供更多信息,包括您使用的Spring Data版本、JVM版本、堆栈跟踪等。
- 如果需要粘贴代码或包含堆栈跟踪,请使用https://guides.github.com/features/mastering-markdown/[Markdown]代码围栏+++```+++。
- 如果可能,请尝试创建一个复现问题的测试用例或项目。附上您的代码链接或包含代码的压缩文件。
== 从源码构建
您不需要从源码构建来使用Spring Data(二进制文件可在https://repo.spring.io[repo.spring.io]获取),但如果您想尝试最新版本,可以使用https://github.com/takari/maven-wrapper[maven wrapper]轻松构建Spring Data。您还需要JDK 17。
[source,bash]
$ ./mvnw clean install
如果您想使用常规的mvn
命令构建,您需要https://maven.apache.org/run-maven/index.html[Maven v3.5.0或更高版本]。
另请参阅link:CONTRIBUTING.adoc[CONTRIBUTING.adoc],如果您希望提交拉取请求,特别是在进行第一次更改之前,请签署https://cla.pivotal.io/sign/spring[贡献者协议],即使是微小的更改。
=== 构建参考文档
构建文档的同时也会构建项目,但不运行测试。
[source,bash]
$ ./mvnw clean install -Pantora
生成的文档可在target/antora/site/index.html
中找到。
== 示例
- https://github.com/spring-projects/spring-data-examples/[Spring Data Examples]包含了更详细解释特定功能的示例项目。
== 许可证
Spring Data KeyValue是根据https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0许可证]发布的开源软件。