|
| 1 | += Spring Data Commons image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-commons%2Fmaster&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]] |
| 2 | + |
| 3 | +https://projects.spring.io/spring-data/[Spring Data Commons] is part of the umbrella Spring Data project that provides shared infrastructure across the Spring Data projects. It contains technology neutral repository interfaces as well as a metadata model for persisting Java classes. |
| 4 | + |
| 5 | +Our primary goals are: |
| 6 | + |
| 7 | +* Powerful Repository and custom object-mapping abstractions |
| 8 | +* Support for cross-store persistence |
| 9 | +* Dynamic query generation from query method names |
| 10 | +* Implementation domain base classes providing basic properties |
| 11 | +* Support for transparent auditing (created, last changed) |
| 12 | +* Possibility to integrate custom repository code |
| 13 | +* Easy Spring integration with custom namespace |
| 14 | +
|
| 15 | +== Code of Conduct |
| 16 | + |
| 17 | +This project is governed by the link:CODE_OF_CONDUCT.adoc[Spring Code of Conduct]. By participating, you are expected to uphold this code of conduct. Please report unacceptable behavior to [email protected]. |
| 18 | + |
| 19 | +== Getting Started |
| 20 | + |
| 21 | +=== Maven configuration |
| 22 | + |
| 23 | +Add the Maven dependency: |
| 24 | + |
| 25 | +[source,xml] |
| 26 | +---- |
| 27 | +<dependency> |
| 28 | + <groupId>org.springframework.data</groupId> |
| 29 | + <artifactId>spring-data-commons</artifactId> |
| 30 | + <version>${version}.RELEASE</version> |
| 31 | +</dependency> |
| 32 | +---- |
| 33 | + |
| 34 | +If you'd rather like the latest snapshots of the upcoming major version, use our Maven snapshot repository and declare the appropriate dependency version. |
| 35 | + |
| 36 | +[source,xml] |
| 37 | +---- |
| 38 | +<dependency> |
| 39 | + <groupId>org.springframework.data</groupId> |
| 40 | + <artifactId>spring-data-commons</artifactId> |
| 41 | + <version>${version}.BUILD-SNAPSHOT</version> |
| 42 | +</dependency> |
| 43 | +
|
| 44 | +<repository> |
| 45 | + <id>spring-libs-snapshot</id> |
| 46 | + <name>Spring Snapshot Repository</name> |
| 47 | + <url>https://repo.spring.io/libs-snapshot</url> |
| 48 | +</repository> |
| 49 | +---- |
| 50 | + |
| 51 | +== Getting Help |
| 52 | + |
| 53 | +Having trouble with Spring Data? We’d love to help! |
| 54 | + |
| 55 | +* Check the |
| 56 | +https://docs.spring.io/spring-data/commons/docs/current/reference/html/[reference documentation], and https://docs.spring.io/spring-data/commons/docs/current/api/[Javadocs]. |
| 57 | +* Learn the Spring basics – Spring Data builds on Spring Framework, check the https://spring.io[spring.io] web-site for a wealth of reference documentation. |
| 58 | +If you are just starting out with Spring, try one of the https://spring.io/guides[guides]. |
| 59 | +* If you are upgrading, check out the https://docs.spring.io/spring-data/commons/docs/current/changelog.txt[changelog] for "`new and noteworthy`" features. |
| 60 | +* Ask a question - we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-data[`spring-data`]. |
| 61 | +You can also chat with the community on https://gitter.im/spring-projects/spring-data[Gitter]. |
| 62 | +* Report bugs with Spring Data Commons at https://jira.spring.io/browse/DATACMNS[jira.spring.io/browse/DATACMNS]. |
| 63 | + |
| 64 | +== Reporting Issues |
| 65 | + |
| 66 | +Spring Data uses JIRA as issue tracking system to record bugs and |
| 67 | +feature requests. If you want to raise an issue, please follow the |
| 68 | +recommendations below: |
| 69 | + |
| 70 | +* Before you log a bug, please search the |
| 71 | +https://jira.spring.io/browse/DATACMNS[issue tracker] to see if someone has already reported the problem. |
| 72 | +* If the issue doesn’t already exist, https://jira.spring.io/browse/DATACMNS[create a new issue]. |
| 73 | +* Please provide as much information as possible with the issue report, we like to know the version of Spring Data that you are using and JVM |
| 74 | +version. |
| 75 | +* If you need to paste code, or include a stack trace use JIRA `{code}…{code}` escapes before and after your text. |
| 76 | +* If possible try to create a test-case or project that replicates the issue. Attach a link to your code or a compressed file containing your code. |
| 77 | + |
| 78 | +== Building from Source |
| 79 | + |
| 80 | +You don’t need to build from source to use Spring Data (binaries in https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and greatest, Spring Data can be easily built with the https://github.com/takari/maven-wrapper[maven wrapper]. |
| 81 | +You also need JDK 1.8. |
| 82 | + |
| 83 | +[source,bash] |
| 84 | +---- |
| 85 | + $ ./mvnw clean install |
| 86 | +---- |
| 87 | + |
| 88 | +If you want to build with the regular `mvn` command, you will need https://maven.apache.org/run-maven/index.html[Maven v3.5.0 or above]. |
| 89 | + |
| 90 | +_Also see link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] if you wish to submit pull requests, and in particular please sign the https://cla.pivotal.io/sign/spring[Contributor’s Agreement] before your first change, is trivial._ |
| 91 | + |
| 92 | +=== Building reference documentation |
| 93 | + |
| 94 | +Building the documentation builds also the project without running tests. |
| 95 | + |
| 96 | +[source,bash] |
| 97 | +---- |
| 98 | + $ ./mvnw clean install -Pdistribute |
| 99 | +---- |
| 100 | + |
| 101 | +The generated documentation is available from `target/site/reference/html/index.html`. |
| 102 | + |
| 103 | +== License |
| 104 | + |
| 105 | +Spring Data Commons is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license]. |
0 commit comments