= Spring Data Commons image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-commons%2F&subject=Build[link=https://jenkins.spring.io/view/SpringData/job/spring-data-commons/] 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 Core"]
https://projects.spring.io/spring-data/[Spring Data Commons]是Spring Data项目伞下的一部分,为Spring Data项目提供共享基础设施。它包含技术中立的存储库接口以及用于持久化Java类的元数据模型。
我们的主要目标是:
- 强大的Repository和自定义对象映射抽象
- 支持跨存储持久化
- 从查询方法名动态生成查询
- 实现提供基本属性的领域基类
- 支持透明审计(创建、最后更改)
- 集成自定义存储库代码的可能性
- 通过自定义命名空间轻松集成Spring
== 行为准则
== 入门指南
=== Maven配置
添加Maven依赖:
[source,xml]
如果你更愿意使用即将发布的主要版本的最新快照,请使用我们的Maven快照仓库并声明相应的依赖版本。
[source,xml]
== 获取帮助
在使用Spring Data时遇到问题?我们很乐意帮忙!
- 查阅https://docs.spring.io/spring-data/commons/docs/current/reference/html/[参考文档]和https://docs.spring.io/spring-data/commons/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/releases[GitHub发布]和https://github.com/spring-projects/spring-data-commons/wiki#release-notes[发行说明]了解"新特性和值得注意的功能"。
- 提问 - 我们监控https://stackoverflow.com[stackoverflow.com]上标记为https://stackoverflow.com/tags/spring-data[`spring-data`]的问题。你也可以在https://gitter.im/spring-projects/spring-data[Gitter]上与社区交流。
- 在https://github.com/spring-projects/spring-data-commons/issues[github.com/spring-projects/spring-data-commons/issues]报告Spring Data Commons的bug。
== 报告问题
Spring Data使用GitHub作为问题跟踪系统来记录bug和功能请求。如果你想提出问题,请遵循以下建议:
- 在记录bug之前,请搜索https://github.com/spring-projects/spring-data-commons/issues[问题跟踪器],看是否有人已经报告了该问题。
- 如果问题尚不存在,https://github.com/spring-projects/spring-data-commons/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或更高版本。
[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 -Pdistribute
生成的文档可在target/site/reference/html/index.html
找到。
== 许可证
Spring Data Commons是根据https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0许可证]发布的开源软件。