DATAJPA-580 - Moved to Asciidoctor for reference documentation.
This commit is contained in:
Oliver Gierke
committed by
Oliver Gierke
Oliver Gierke
parent
cd34005349
commit
255651956d
4
pom.xml
4
pom.xml
@@ -431,6 +431,10 @@
|
||||
<groupId>org.codehaus.mojo</groupId>
|
||||
<artifactId>wagon-maven-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.asciidoctor</groupId>
|
||||
<artifactId>asciidoctor-maven-plugin</artifactId>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
|
||||
|
||||
@@ -1,86 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
|
||||
<appendix id="faq">
|
||||
<title>Frequently asked questions</title>
|
||||
|
||||
<qandaset>
|
||||
<qandadiv>
|
||||
<title>Common</title>
|
||||
|
||||
<qandaentry>
|
||||
<question>
|
||||
<para>I'd like to get more detailed logging information on what
|
||||
methods are called inside
|
||||
<interfacename>JpaRepository</interfacename>, e.g. How can I gain
|
||||
them?</para>
|
||||
</question>
|
||||
|
||||
<answer>
|
||||
<para>You can make use of
|
||||
<classname>CustomizableTraceInterceptor</classname> provided by
|
||||
Spring:</para>
|
||||
|
||||
<programlisting language="xml"><bean id="customizableTraceInterceptor" class="
|
||||
org.springframework.aop.interceptor.CustomizableTraceInterceptor">
|
||||
<property name="enterMessage" value="Entering $[methodName]($[arguments])"/>
|
||||
<property name="exitMessage" value="Leaving $[methodName](): $[returnValue]"/>
|
||||
</bean>
|
||||
|
||||
<aop:config>
|
||||
<aop:advisor advice-ref="customizableTraceInterceptor"
|
||||
pointcut="execution(public * org.springframework.data.jpa.repository.JpaRepository+.*(..))"/>
|
||||
</aop:config></programlisting>
|
||||
</answer>
|
||||
</qandaentry>
|
||||
</qandadiv>
|
||||
|
||||
<qandadiv>
|
||||
<title>Infrastructure</title>
|
||||
|
||||
<qandaentry>
|
||||
<question>
|
||||
<para>Currently I have implemented a repository layer based on
|
||||
<classname>HibernateDaoSupport</classname>. I create a
|
||||
<classname>SessionFactory</classname> by using Spring's
|
||||
<classname>AnnotationSessionFactoryBean</classname>. How do I get
|
||||
Spring Data repositories working in this environment?</para>
|
||||
</question>
|
||||
|
||||
<answer>
|
||||
<para>You have to replace
|
||||
<classname>AnnotationSessionFactoryBean</classname> with the
|
||||
<classname>HibernateJpaSessionFactoryBean</classname> as
|
||||
follows:</para>
|
||||
|
||||
<example>
|
||||
<title>Looking up a SessionFactory from a
|
||||
HibernateEntityManagerFactory</title>
|
||||
|
||||
<programlisting language="xml"><bean id="sessionFactory" class="org.springframework.orm.jpa.vendor.HibernateJpaSessionFactoryBean">
|
||||
<property name="entityManagerFactory" ref="entityManagerFactory"/>
|
||||
</bean></programlisting>
|
||||
</example>
|
||||
</answer>
|
||||
</qandaentry>
|
||||
</qandadiv>
|
||||
|
||||
<qandadiv>
|
||||
<title>Auditing</title>
|
||||
|
||||
<qandaentry>
|
||||
<question>
|
||||
<para>I want to use Spring Data JPA auditing capabilities but have
|
||||
my database already set up to set modification and creation date on
|
||||
entities. How to prevent Spring Data from setting the date
|
||||
programmatically.</para>
|
||||
</question>
|
||||
|
||||
<answer>
|
||||
<para>Just use the <code>set-dates</code> attribute of the
|
||||
<code>auditing</code> namespace element to false.</para>
|
||||
</answer>
|
||||
</qandaentry>
|
||||
</qandadiv>
|
||||
</qandaset>
|
||||
</appendix>
|
||||
@@ -1,114 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
|
||||
<glossary id="glossary">
|
||||
<glossdiv>
|
||||
<title>A</title>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>AOP</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>Aspect oriented programming</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv>
|
||||
<title>C</title>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>Commons DBCP</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>Commons DataBase Connection Pools - Library of the Apache
|
||||
foundation offering pooling implementations of the
|
||||
<interfacename>DataSource</interfacename> interface.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>CRUD</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>Create, Read, Update, Delete - Basic persistence
|
||||
operations</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv>
|
||||
<title>D</title>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>DAO</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>Data Access Object - Pattern to separate persisting logic from
|
||||
the object to be persisted</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>Dependency Injection</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>Pattern to hand a component's dependency to the component from
|
||||
outside, freeing the component to lookup the dependant itself. For
|
||||
more information see <ulink
|
||||
url="http://en.wikipedia.org/wiki/Dependency_Injection">http://en.wikipedia.org/wiki/Dependency_Injection</ulink>.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv>
|
||||
<title>E</title>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>EclipseLink</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>Object relational mapper implementing JPA - <ulink
|
||||
url="http://www.eclipselink.org">http://www.eclipselink.org</ulink></para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv>
|
||||
<title>H</title>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>Hibernate</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>Object relational mapper implementing JPA - <ulink
|
||||
url="http://www.hibernate.org">http://www.hibernate.org</ulink></para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv>
|
||||
<title>J</title>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>JPA</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>Java Persistence Api</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv>
|
||||
<title>S</title>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>Spring</glossterm>
|
||||
|
||||
<glossdef>
|
||||
<para>Java application framework - <ulink
|
||||
url="http://projects.spring.io/spring-framework">http://projects.spring.io/spring-framework</ulink></para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
</glossary>
|
||||
@@ -1,102 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
|
||||
<book>
|
||||
<bookinfo>
|
||||
<title>Spring Data JPA - Reference Documentation</title>
|
||||
|
||||
<releaseinfo>version;</releaseinfo>
|
||||
|
||||
<authorgroup>
|
||||
<author>
|
||||
<firstname>Oliver</firstname>
|
||||
|
||||
<surname>Gierke</surname>
|
||||
|
||||
<affiliation>
|
||||
<jobtitle>Software Engineer</jobtitle>
|
||||
|
||||
<orgname>Pivotal Software, Inc.</orgname>
|
||||
</affiliation>
|
||||
|
||||
<email>ogierke@gopivotal.com</email>
|
||||
</author>
|
||||
|
||||
<author>
|
||||
<firstname>Thomas</firstname>
|
||||
|
||||
<surname>Darimont</surname>
|
||||
|
||||
<affiliation>
|
||||
<jobtitle>Software Engineer</jobtitle>
|
||||
|
||||
<orgname>Pivotal Software, Inc.</orgname>
|
||||
</affiliation>
|
||||
|
||||
<email>tdarimont@gopivotal.com</email>
|
||||
</author>
|
||||
|
||||
<author>
|
||||
<firstname>Christoph</firstname>
|
||||
|
||||
<surname>Strobl</surname>
|
||||
|
||||
<affiliation>
|
||||
<jobtitle>Software Engineer</jobtitle>
|
||||
|
||||
<orgname>Pivotal Software, Inc.</orgname>
|
||||
</affiliation>
|
||||
|
||||
<email>cstrobl@gopivotal.com</email>
|
||||
</author>
|
||||
</authorgroup>
|
||||
|
||||
<legalnotice>
|
||||
<para>Copies of this document may be made for your own use and for
|
||||
distribution to others, provided that you do not charge any fee for such
|
||||
copies and further provided that each copy contains this Copyright
|
||||
Notice, whether distributed in print or electronically.</para>
|
||||
</legalnotice>
|
||||
|
||||
<copyright>
|
||||
<year>2008-2014</year>
|
||||
|
||||
<holder>The original authors.</holder>
|
||||
</copyright>
|
||||
|
||||
<productname>Spring Data JPA - Reference Documentation</productname>
|
||||
</bookinfo>
|
||||
|
||||
<toc/>
|
||||
|
||||
<xi:include href="preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||
|
||||
<part id="reference">
|
||||
<title>Reference Documentation</title>
|
||||
|
||||
<xi:include href="https://raw.github.com/SpringSource/spring-data-commons/1.9.0.M1/src/docbkx/repositories.xml"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
<xi:fallback href="../../../spring-data-commons/src/docbkx/repositories.xml" />
|
||||
</xi:include>
|
||||
|
||||
<xi:include href="jpa.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||
</part>
|
||||
|
||||
<part id="appendix">
|
||||
<title>Appendix</title>
|
||||
|
||||
<xi:include href="https://raw.github.com/SpringSource/spring-data-commons/1.9.0.M1/src/docbkx/repository-namespace-reference.xml"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
<xi:fallback href="../../../spring-data-commons/src/docbkx/repository-namespace-reference.xml" />
|
||||
</xi:include>
|
||||
|
||||
<xi:include href="https://raw.github.com/SpringSource/spring-data-commons/1.9.0.M1/src/docbkx/repository-query-keywords-reference.xml"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
<xi:fallback href="../../../spring-data-commons/src/docbkx/repository-query-keywords-reference.xml" />
|
||||
</xi:include>
|
||||
|
||||
<xi:include href="faq.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||
|
||||
<xi:include href="glossary.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
||||
</part>
|
||||
</book>
|
||||
1509
src/docbkx/jpa.xml
1509
src/docbkx/jpa.xml
File diff suppressed because it is too large
Load Diff
@@ -1,37 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
|
||||
<preface id="preface">
|
||||
<title>Preface</title>
|
||||
|
||||
<section id="project">
|
||||
<title>Project metadata</title>
|
||||
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Version control - <ulink
|
||||
url="git://github.com/spring-projects/spring-data-jpa.git">git://github.com/spring-projects/spring-data-jpa.git</ulink></para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Bugtracker - <ulink
|
||||
url="https://jira.springsource.org/browse/DATAJPA">https://jira.springsource.org/browse/DATAJPA</ulink></para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Release repository - <ulink
|
||||
url="http://repo.spring.io/libs-release">http://repo.spring.io/libs-release</ulink></para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Milestone repository - <ulink
|
||||
url="http://repo.spring.io/libs-milestone">http://repo.spring.io/libs-milestone</ulink></para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Snapshot repository - <ulink
|
||||
url="http://repo.spring.io/libs-snapshot">http://repo.spring.io/libs-snapshot</ulink></para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
</preface>
|
||||
45
src/main/asciidoc/faq.adoc
Normal file
45
src/main/asciidoc/faq.adoc
Normal file
@@ -0,0 +1,45 @@
|
||||
[[faq]]
|
||||
[appendix]
|
||||
= Frequently asked questions
|
||||
|
||||
== Common
|
||||
|
||||
[qanda]
|
||||
I'd like to get more detailed logging information on what methods are called inside `JpaRepository`, e.g. How can I gain them?::
|
||||
You can make use of `CustomizableTraceInterceptor` provided by Spring:
|
||||
+
|
||||
[source, xml]
|
||||
----
|
||||
<bean id="customizableTraceInterceptor" class="
|
||||
org.springframework.aop.interceptor.CustomizableTraceInterceptor">
|
||||
<property name="enterMessage" value="Entering $[methodName]($[arguments])"/>
|
||||
<property name="exitMessage" value="Leaving $[methodName](): $[returnValue]"/>
|
||||
</bean>
|
||||
|
||||
<aop:config>
|
||||
<aop:advisor advice-ref="customizableTraceInterceptor"
|
||||
pointcut="execution(public * org.springframework.data.jpa.repository.JpaRepository+.*(..))"/>
|
||||
</aop:config>
|
||||
----
|
||||
|
||||
== Infrastructure
|
||||
|
||||
[qanda]
|
||||
Currently I have implemented a repository layer based on `HibernateDaoSupport`. I create a `SessionFactory` by using Spring's `AnnotationSessionFactoryBean`. How do I get Spring Data repositories working in this environment?::
|
||||
You have to replace `AnnotationSessionFactoryBean` with the `HibernateJpaSessionFactoryBean` as follows:
|
||||
+
|
||||
.Looking up a SessionFactory from a HibernateEntityManagerFactory
|
||||
====
|
||||
[source, xml]
|
||||
----
|
||||
<bean id="sessionFactory" class="org.springframework.orm.jpa.vendor.HibernateJpaSessionFactoryBean">
|
||||
<property name="entityManagerFactory" ref="entityManagerFactory"/>
|
||||
</bean>
|
||||
----
|
||||
====
|
||||
|
||||
== Auditing
|
||||
|
||||
[qanda]
|
||||
I want to use Spring Data JPA auditing capabilities but have my database already set up to set modification and creation date on entities. How to prevent Spring Data from setting the date programmatically.::
|
||||
Just use the `set-dates` attribute of the `auditing` namespace element to false.
|
||||
30
src/main/asciidoc/glossary.adoc
Normal file
30
src/main/asciidoc/glossary.adoc
Normal file
@@ -0,0 +1,30 @@
|
||||
[[glossary]]
|
||||
[appendix, glossary]
|
||||
= Glossary
|
||||
|
||||
AOP::
|
||||
Aspect oriented programming
|
||||
|
||||
Commons DBCP::
|
||||
Commons DataBase Connection Pools - Library of the Apache foundation offering pooling implementations of the DataSource interface.
|
||||
|
||||
CRUD::
|
||||
Create, Read, Update, Delete - Basic persistence operations
|
||||
|
||||
DAO::
|
||||
Data Access Object - Pattern to separate persisting logic from the object to be persisted
|
||||
|
||||
Dependency Injection::
|
||||
Pattern to hand a component's dependency to the component from outside, freeing the component to lookup the dependant itself. For more information see link:$$http://en.wikipedia.org/wiki/Dependency_Injection$$[http://en.wikipedia.org/wiki/Dependency_Injection].
|
||||
|
||||
EclipseLink::
|
||||
Object relational mapper implementing JPA - link:$$http://www.eclipselink.org$$[http://www.eclipselink.org]
|
||||
|
||||
Hibernate::
|
||||
Object relational mapper implementing JPA - link:$$http://www.hibernate.org$$[http://www.hibernate.org]
|
||||
|
||||
JPA::
|
||||
Java Persistence API
|
||||
|
||||
Spring::
|
||||
Java application framework - link:$$http://projects.spring.io/spring-framework$$[http://projects.spring.io/spring-framework]
|
||||
28
src/main/asciidoc/index.adoc
Normal file
28
src/main/asciidoc/index.adoc
Normal file
@@ -0,0 +1,28 @@
|
||||
= Spring Data JPA - Reference Documentation
|
||||
Oliver Gierke; Thomas Darimont; Christoph Strobl
|
||||
{version}
|
||||
:toc:
|
||||
:spring-data-commons-docs: https://raw.githubusercontent.com/spring-projects/spring-data-commons/master/src/main/asciidoc
|
||||
:spring-framework-docs: http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/html
|
||||
|
||||
NOTE: Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically.
|
||||
|
||||
include::preface.adoc[]
|
||||
|
||||
[[reference]]
|
||||
= Reference Documentation
|
||||
:leveloffset: 1
|
||||
include::{spring-data-commons-docs}/repositories.adoc[]
|
||||
include::jpa.adoc[]
|
||||
:leveloffset: 0
|
||||
|
||||
[[appendix]]
|
||||
= Appendix
|
||||
:numbered!:
|
||||
:leveloffset: 1
|
||||
include::{spring-data-commons-docs}/repository-namespace-reference.adoc[]
|
||||
include::{spring-data-commons-docs}/repository-populator-namespace-reference.adoc[]
|
||||
include::{spring-data-commons-docs}/repository-query-keywords-reference.adoc[]
|
||||
include::faq.adoc[]
|
||||
include::glossary.adoc[]
|
||||
:leveloffset: 0
|
||||
885
src/main/asciidoc/jpa.adoc
Normal file
885
src/main/asciidoc/jpa.adoc
Normal file
@@ -0,0 +1,885 @@
|
||||
[[jpa.repositories]]
|
||||
= JPA Repositories
|
||||
|
||||
This chapter includes details of the JPA repository implementation.
|
||||
|
||||
[[jpa.introduction]]
|
||||
== Introduction
|
||||
|
||||
[[jpa.namespace]]
|
||||
=== Spring namespace
|
||||
|
||||
The JPA module of Spring Data contains a custom namespace that allows defining repository beans. It also contains certain features and element attributes that are special to JPA. Generally the JPA repositories can be set up using the `repositories` element:
|
||||
|
||||
.Setting up JPA repositories using the namespace
|
||||
====
|
||||
[source, xml]
|
||||
----
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<beans xmlns="http://www.springframework.org/schema/beans"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xmlns:jpa="http://www.springframework.org/schema/data/jpa"
|
||||
xsi:schemaLocation="http://www.springframework.org/schema/beans
|
||||
http://www.springframework.org/schema/beans/spring-beans.xsd
|
||||
http://www.springframework.org/schema/data/jpa
|
||||
http://www.springframework.org/schema/data/jpa/spring-jpa.xsd">
|
||||
|
||||
<jpa:repositories base-package="com.acme.repositories" />
|
||||
|
||||
</beans>
|
||||
----
|
||||
====
|
||||
|
||||
Using this element looks up Spring Data repositories as described in <<repositories.create-instances>>. Beyond that it activates persistence exception translation for all beans annotated with `@Repository` to let exceptions being thrown by the JPA persistence providers be converted into Spring's `DataAccessException` hierarchy.
|
||||
|
||||
==== Custom namespace attributes
|
||||
Beyond the default attributes of the `repositories` element the JPA namespace offers additional attributes to gain more detailed control over the setup of the repositories:
|
||||
|
||||
.Custom JPA-specific attributes of the repositories element
|
||||
[cols="1,3"]
|
||||
|===============
|
||||
|`entity-manager-factory-ref`|Explicitly wire the `EntityManagerFactory` to be used with the repositories being detected by the `repositories` element. Usually used if multiple `EntityManagerFactory` beans are used within the application. If not configured we will automatically lookup the `EntityManagerFactory` bean with the name `entityManagerFactory` in the `ApplicationContext`.
|
||||
|`transaction-manager-ref`|Explicitly wire the `PlatformTransactionManager` to be used with the repositories being detected by the `repositories` element. Usually only necessary if multiple transaction managers and/or `EntityManagerFactory` beans have been configured. Default to a single defined `PlatformTransactionManager` inside the current `ApplicationContext`.
|
||||
|===============
|
||||
|
||||
Note that we require a `PlatformTransactionManager` bean named `transactionManager` to be present if no explicit `transaction-manager-ref` is defined.
|
||||
|
||||
[[jpa.java-config]]
|
||||
=== Annotation based configuration
|
||||
The Spring Data JPA repositories support cannot only be activated through an XML namespace but also using an annotation through JavaConfig.
|
||||
|
||||
.Spring Data JPA repositories using JavaConfig
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
@Configuration
|
||||
@EnableJpaRepositories
|
||||
@EnableTransactionManagement
|
||||
class ApplicationConfig {
|
||||
|
||||
@Bean
|
||||
public DataSource dataSource() {
|
||||
|
||||
EmbeddedDatabaseBuilder builder = new EmbeddedDatabaseBuilder();
|
||||
return builder.setType(EmbeddedDatabaseType.HSQL).build();
|
||||
}
|
||||
|
||||
@Bean
|
||||
public EntityManagerFactory entityManagerFactory() {
|
||||
|
||||
HibernateJpaVendorAdapter vendorAdapter = new HibernateJpaVendorAdapter();
|
||||
vendorAdapter.setGenerateDdl(true);
|
||||
|
||||
LocalContainerEntityManagerFactoryBean factory = new LocalContainerEntityManagerFactoryBean();
|
||||
factory.setJpaVendorAdapter(vendorAdapter);
|
||||
factory.setPackagesToScan("com.acme.domain");
|
||||
factory.setDataSource(dataSource());
|
||||
factory.afterPropertiesSet();
|
||||
|
||||
return factory.getObject();
|
||||
}
|
||||
|
||||
@Bean
|
||||
public PlatformTransactionManager transactionManager() {
|
||||
|
||||
JpaTransactionManager txManager = new JpaTransactionManager();
|
||||
txManager.setEntityManagerFactory(entityManagerFactory());
|
||||
return txManager;
|
||||
}
|
||||
}
|
||||
----
|
||||
====
|
||||
|
||||
The just shown configuration class sets up an embedded HSQL database using the `EmbeddedDatabaseBuilder` API of spring-jdbc. We then set up a `EntityManagerFactory` and use Hibernate as sample persistence provider. The last infrastructure component declared here is the `JpaTransactionManager`. We finally activate Spring Data JPA repositories using the `@EnableJpaRepositories` annotation which essentially carries the same attributes as the XML namespace does. If no base package is configured it will use the one the configuration class resides in.
|
||||
|
||||
[[jpa.entity-persistence]]
|
||||
== Persisting entities
|
||||
|
||||
[[jpa.entity-persistence.saving-entites]]
|
||||
=== Saving entities
|
||||
|
||||
Saving an entity can be performed via the `CrudRepository.save(…)`-Method. It will persist or merge the given entity using the underlying JPA `EntityManager`. If the entity has not been persisted yet Spring Data JPA will save the entity via a call to the `entityManager.persist(…)` method, otherwise the `entityManager.merge(…)` method will be called.
|
||||
|
||||
==== Entity state detection strategies
|
||||
Spring Data JPA offers the following strategies to detect whether an entity is new or not:
|
||||
|
||||
.Options for detection whether an entity is new in Spring Data JPA
|
||||
[cols="1,3"]
|
||||
|===============
|
||||
|Id-Property inspection (*default*)|By default Spring Data JPA inspects the identifier property of the given entity. If the identifier property is `null`, then the entity will be assumed as new, otherwise as not new.
|
||||
|Implementing `Persistable`|If an entity implements `Persistable`, Spring Data JPA will delegate the new detection to the `isNew(…)` method of the entity. See the link:$$http://docs.spring.io/spring-data/data-commons/docs/current/api/index.html?org/springframework/data/domain/Persistable.html$$[JavaDoc] for details.
|
||||
|Implementing `EntityInformation`|You can customize the `EntityInformation` abstraction used in the `SimpleJpaRepository` implementation by creating a subclass of `JpaRepositoryFactory` and overriding the `getEntityInformation(…)` method accordingly. You then have to register the custom implementation of `JpaRepositoryFactory` as a Spring bean. Note that this should be rarely necessary. See the link:$$http://docs.spring.io/spring-data/data-jpa/docs/current/api/index.html?org/springframework/data/jpa/repository/support/JpaRepositoryFactory.html$$[JavaDoc] for details.
|
||||
|===============
|
||||
|
||||
[[jpa.query-methods]]
|
||||
== Query methods
|
||||
|
||||
[[jpa.sample-app.finders.strategies]]
|
||||
=== Query lookup strategies
|
||||
|
||||
The JPA module supports defining a query manually as String or have it being derived from the method name.
|
||||
|
||||
==== Declared queries
|
||||
Although getting a query derived from the method name is quite convenient, one might face the situation in which either the method name parser does not support the keyword one wants to use or the method name would get unnecessarily ugly. So you can either use JPA named queries through a naming convention (see <<jpa.query-methods.named-queries>> for more information) or rather annotate your query method with @Query (see <<jpa.query-methods.at-query>> for details).
|
||||
|
||||
[[jpa.query-methods.query-creation]]
|
||||
=== Query creation
|
||||
|
||||
Generally the query creation mechanism for JPA works as described in <<repositories.query-methods>>. Here's a short example of what a JPA query method translates into:
|
||||
|
||||
.Query creation from method names
|
||||
====
|
||||
----
|
||||
public interface UserRepository extends Repository<User, Long> {
|
||||
|
||||
List<User> findByEmailAddressAndLastname(String emailAddress, String lastname);
|
||||
}
|
||||
----
|
||||
We will create a query using the JPA criteria API from this but essentially this translates into the following query: `select u from User u where u.emailAddress = ?1 and u.lastname = ?2`. Spring Data JPA will do a property check and traverse nested properties as described in . Here's an overview of the keywords supported for JPA and what a method containing that keyword essentially translates to.
|
||||
====
|
||||
|
||||
.Supported keywords inside method names
|
||||
[options="header", cols="1,1,2"]
|
||||
|===============
|
||||
|Keyword|Sample|JPQL snippet
|
||||
|`And`|`findByLastnameAndFirstname`|`… where x.lastname = ?1 and x.firstname = ?2`
|
||||
|`Or`|`findByLastnameOrFirstname`|`… where x.lastname = ?1 or x.firstname = ?2`
|
||||
|`Is,Equals`|`findByFirstname`,`findByFirstnameIs`,`findByFirstnameEquals`|`… where x.firstname = 1?`
|
||||
|`Between`|`findByStartDateBetween`|`… where x.startDate between 1? and ?2`
|
||||
|`LessThan`|`findByAgeLessThan`|`… where x.age < ?1`
|
||||
|`LessThanEqual`|`findByAgeLessThanEqual`|`… where x.age <= ?1`
|
||||
|`GreaterThan`|`findByAgeGreaterThan`|`… where x.age > ?1`
|
||||
|`GreaterThanEqual`|`findByAgeGreaterThanEqual`|`… where x.age >= ?1`
|
||||
|`After`|`findByStartDateAfter`|`… where x.startDate > ?1`
|
||||
|`Before`|`findByStartDateBefore`|`… where x.startDate < ?1`
|
||||
|`IsNull`|`findByAgeIsNull`|`… where x.age is null`
|
||||
|`IsNotNull,NotNull`|`findByAge(Is)NotNull`|`… where x.age not null`
|
||||
|`Like`|`findByFirstnameLike`|`… where x.firstname like ?1`
|
||||
|`NotLike`|`findByFirstnameNotLike`|`… where x.firstname not like ?1`
|
||||
|`StartingWith`|`findByFirstnameStartingWith`|`… where x.firstname like ?1` (parameter bound with appended `%`)
|
||||
|`EndingWith`|`findByFirstnameEndingWith`|`… where x.firstname like ?1` (parameter bound with prepended `%`)
|
||||
|`Containing`|`findByFirstnameContaining`|`… where x.firstname like ?1` (parameter bound wrapped in `%`)
|
||||
|`OrderBy`|`findByAgeOrderByLastnameDesc`|`… where x.age = ?1 order by x.lastname desc`
|
||||
|`Not`|`findByLastnameNot`|`… where x.lastname <> ?1`
|
||||
|`In`|`findByAgeIn(Collection<Age> ages)`|`… where x.age in ?1`
|
||||
|`NotIn`|`findByAgeNotIn(Collection<Age> age)`|`… where x.age not in ?1`
|
||||
|`True`|`findByActiveTrue()`|`… where x.active = true`
|
||||
|`False`|`findByActiveFalse()`|`… where x.active = false`
|
||||
|`IgnoreCase`|`findByFirstnameIgnoreCase`|`… where UPPER(x.firstame) = UPPER(?1)`
|
||||
|===============
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
`In` and `NotIn` also take any subclass of `Collection` as parameter as well as arrays or varargs. For other syntactical versions of the very same logical operator check <<repository-query-keywords>>.
|
||||
====
|
||||
|
||||
[[jpa.query-methods.named-queries]]
|
||||
=== Using JPA NamedQueries
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
The examples use simple `<named-query />` element and `@NamedQuery` annotation. The queries for these configuration elements have to be defined in JPA query language. Of course you can use `<named-native-query />` or `@NamedNativeQuery` too. These elements allow you to define the query in native SQL by losing the database platform independence.
|
||||
====
|
||||
|
||||
==== XML named query definition
|
||||
To use XML configuration simply add the necessary `<named-query />` element to the `orm.xml` JPA configuration file located in `META-INF` folder of your classpath. Automatic invocation of named queries is enabled by using some defined naming convention. For more details see below.
|
||||
|
||||
.XML named query configuration
|
||||
====
|
||||
[source, xml]
|
||||
----
|
||||
<named-query name="User.findByLastname">
|
||||
<query>select u from User u where u.lastname = ?1</query>
|
||||
</named-query>
|
||||
----
|
||||
====
|
||||
|
||||
As you can see the query has a special name which will be used to resolve it at runtime.
|
||||
|
||||
==== Annotation configuration
|
||||
Annotation configuration has the advantage of not needing another configuration file to be edited, probably lowering maintenance costs. You pay for that benefit by the need to recompile your domain class for every new query declaration.
|
||||
|
||||
.Annotation based named query configuration
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
@Entity
|
||||
@NamedQuery(name = "User.findByEmailAddress",
|
||||
query = "select u from User u where u.emailAddress = ?1")
|
||||
public class User {
|
||||
|
||||
}
|
||||
----
|
||||
====
|
||||
|
||||
==== Declaring interfaces
|
||||
To allow execution of these named queries all you need to do is to specify the `UserRepository` as follows:
|
||||
|
||||
.Query method declaration in UserRepository
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
public interface UserRepository extends JpaRepository<User, Long> {
|
||||
|
||||
List<User> findByLastname(String lastname);
|
||||
|
||||
User findByEmailAddress(String emailAddress);
|
||||
}
|
||||
----
|
||||
====
|
||||
|
||||
Spring Data will try to resolve a call to these methods to a named query, starting with the simple name of the configured domain class, followed by the method name separated by a dot. So the example here would use the named queries defined above instead of trying to create a query from the method name.
|
||||
|
||||
[[jpa.query-methods.at-query]]
|
||||
=== Using @Query
|
||||
|
||||
Using named queries to declare queries for entities is a valid approach and works fine for a small number of queries. As the queries themselves are tied to the Java method that executes them you actually can bind them directly using the Spring Data JPA `@Query` annotation rather than annotating them to the domain class. This will free the domain class from persistence specific information and co-locate the query to the repository interface.
|
||||
|
||||
Queries annotated to the query method will take precedence over queries defined using `@NamedQuery` or named queries declared in `orm.xml`.
|
||||
|
||||
.Declare query at the query method using @Query
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
public interface UserRepository extends JpaRepository<User, Long> {
|
||||
|
||||
@Query("select u from User u where u.emailAddress = ?1")
|
||||
User findByEmailAddress(String emailAddress);
|
||||
}
|
||||
----
|
||||
====
|
||||
|
||||
Using advanced `LIKE` expressionsThe query execution mechanism for manually defined queries using @Query allow the definition of advanced `LIKE` expressions inside the query definition.
|
||||
|
||||
.Advanced `LIKE` expressions in @Query
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
public interface UserRepository extends JpaRepository<User, Long> {
|
||||
|
||||
@Query("select u from User u where u.firstname like %?1")
|
||||
List<User> findByFirstnameEndsWith(String firstname);
|
||||
}
|
||||
----
|
||||
====
|
||||
|
||||
In the just shown sample `LIKE` delimiter character `%` is recognized and the query transformed into a valid JPQL query (removing the `%`). Upon query execution the parameter handed into the method call gets augmented with the previously recognized `LIKE` pattern.
|
||||
|
||||
Native queriesThe `@Query` annotation allows to execute native queries by setting the `nativeQuery` flag to true. Note, that we currently don't support execution of pagination or dynamic sorting for native queries as we'd have to manipulate the actual query declared and we cannot do this reliably for native SQL.
|
||||
|
||||
.Declare a native query at the query method using @Query
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
public interface UserRepository extends JpaRepository<User, Long> {
|
||||
|
||||
@Query(value = "SELECT * FROM USERS WHERE EMAIL`ADDRESS = ?0", nativeQuery = true)
|
||||
User findByEmailAddress(String emailAddress);
|
||||
}
|
||||
----
|
||||
|
||||
====
|
||||
|
||||
[[jpa.named-parameters]]
|
||||
=== Using named parameters
|
||||
|
||||
By default Spring Data JPA will use position based parameter binding as described in all the samples above. This makes query methods a little error prone to refactoring regarding the parameter position. To solve this issue you can use `@Param` annotation to give a method parameter a concrete name and bind the name in the query.
|
||||
|
||||
.Using named parameters
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
public interface UserRepository extends JpaRepository<User, Long> {
|
||||
|
||||
@Query("select u from User u where u.firstname = :firstname or u.lastname = :lastname")
|
||||
User findByLastnameOrFirstname(@Param("lastname") String lastname,
|
||||
@Param("firstname") String firstname);
|
||||
}
|
||||
----
|
||||
Note that the method parameters are switched according to the occurrence in the query defined.
|
||||
====
|
||||
|
||||
[[jpa.query.spel-expressions]]
|
||||
=== Using SpEL expressions
|
||||
|
||||
As of Spring Data JPA release 1.4 we support the usage of restricted SpEL template expressions in manually defined queries via `@Query`. Upon query execution these expressions are evaluated against a predefined set of variables. We support the following list of variables to be used in a manual query.
|
||||
|
||||
.Supported variables inside SpEL based query templates
|
||||
[options="header", cols="1,3"]
|
||||
|===============
|
||||
|Variable|Usage|Description
|
||||
|`entityName`|`select x from #{#entityName} x`|Inserts the `entityName` of the domain type associated with the given Repository. The `entityName` is resolved as follows: If the domain type has set the name property on the `@Entity` annotation then it will be used. Otherwise the simple class-name of the domain type will be used.
|
||||
|===============
|
||||
|
||||
The following example demonstrates one use case for the `#{#entityName}` expression in a query string where you want to define a repository interface with a query method with a manually defined query. In order not to have to state the actual entity name in the query string of a `@Query` annotation one can use the `#{#entityName}` Variable.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
The `entityName` can be customized via the `@Entity` annotation. Customizations via `orm.xml` are not supported for the SpEL expressions.
|
||||
====
|
||||
|
||||
.Using SpEL expressions in repository query methods - entityName
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
@Entity
|
||||
public class User {
|
||||
|
||||
@Id
|
||||
@GeneratedValue
|
||||
Long id;
|
||||
|
||||
String lastname;
|
||||
}
|
||||
|
||||
public interface UserRepository extends JpaRepository<User,Long> {
|
||||
|
||||
@Query("select u from #{#entityName} u where u.lastname = ?1")
|
||||
List<User> findByLastname(String lastname);
|
||||
}
|
||||
----
|
||||
====
|
||||
|
||||
Of course you could have just used User in the query declaration directly but that would require you to change the query as well. The reference to `#entityName` will pick up potential future remappings of the User class to a different entity name (e.g. by using `@Entity(name = "MyUser")`.
|
||||
|
||||
Another use case for the `#{#entityName}` expression in a query string is if you want to define a generic repository interface with specialized repository interfaces for a concrete domain type. In order not to have to repeat the definition of custom query methods on the concrete interfaces you can use the entity name expression in the query string of the `@Query` annotation in the generic repository interface.
|
||||
|
||||
.Using SpEL expressions in repository query methods - entityName with inheritance
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
@MappedSuperclass
|
||||
public abstract class AbstractMappedType {
|
||||
…
|
||||
String attribute
|
||||
}
|
||||
|
||||
@Entity
|
||||
public class ConcreteType extends AbstractMappedType { … }
|
||||
|
||||
@NoRepositoryBean
|
||||
public interface MappedTypeRepository<T extends AbstractMappedType>
|
||||
extends Repository<T, Long> {
|
||||
|
||||
@Query("select t from #{#entityName} t where t.attribute = ?1")
|
||||
List<T> findAllByAttribute(String attribute);
|
||||
}
|
||||
|
||||
public interface ConcreteRepository
|
||||
extends MappedTypeRepository<ConcreteType> { … }
|
||||
----
|
||||
====
|
||||
|
||||
In the example the interface `MappedTypeRepository` is the common parent interface for a few domain types extending `AbstractMappedType`. It also defines the generic method `findAllByAttribute(…)` which can be used on instances of the specialized repository interfaces. If you now invoke `findByAllAttribute(…)` on `ConcreteRepository` the query being executed will be `select t from ConcreteType t where t.attribute = ?1`.
|
||||
|
||||
[[jpa.modifying-queries]]
|
||||
=== Modifying queries
|
||||
|
||||
All the sections above describe how to declare queries to access a given entity or collection of entities. Of course you can add custom modifying behaviour by using facilities described in <<repositories.custom-implementations>>. As this approach is feasible for comprehensive custom functionality, you can achieve the execution of modifying queries that actually only need parameter binding by annotating the query method with `@Modifying`:
|
||||
|
||||
.Declaring manipulating queries
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
@Modifying
|
||||
@Query("update User u set u.firstname = ?1 where u.lastname = ?2")
|
||||
int setFixedFirstnameFor(String firstname, String lastname);
|
||||
----
|
||||
|
||||
====
|
||||
|
||||
This will trigger the query annotated to the method as updating query instead of a selecting one. As the `EntityManager` might contain outdated entities after the execution of the modifying query, we do not automatically clear it (see JavaDoc of `EntityManager.clear()` for details) since this will effectively drop all non-flushed changes still pending in the `EntityManager`. If you wish the `EntityManager` to be cleared automatically you can set `@Modifying` annotation's `clearAutomatically` attribute to `true`.
|
||||
|
||||
[[jpa.query-hints]]
|
||||
=== Applying query hints
|
||||
To apply JPA query hints to the queries declared in your repository interface you can use the `@QueryHints` annotation. It takes an array of JPA `@QueryHint` annotations plus a boolean flag to potentially disable the hints applied to the addtional count query triggered when applying pagination.
|
||||
|
||||
.Using QueryHints with a repository method
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
public interface UserRepository extends Repository<User, Long> {
|
||||
|
||||
@QueryHints(value = { @QueryHint(name = "name", value = "value")},
|
||||
forCounting = false)
|
||||
Page<User> findByLastname(String lastname, Pageable pageable);
|
||||
}
|
||||
----
|
||||
The just shown declaration would apply the configured `@QueryHint` for that actually query but omit applying it to the count query triggered to calculate the total number of pages.
|
||||
====
|
||||
|
||||
[[jpa.entity-graph]]
|
||||
=== Configuring Fetch- and LoadGraphs
|
||||
|
||||
The JPA 2.1 specification introduced support for specifiying Fetch- and LoadGraphs that we also support via the `@EntityGraph` annotation which allows to reference a `@NamedEntityGraph` definition, that can be annotated on an entity, to be used to configure the fetch plan of the resulting query. The type (Fetch / Load) of the fetching can be configured via the `type` attribute on the `@EntityGraph` annotation. Please have a look at the JPA 2.1 Spec 3.7.4 for further reference.
|
||||
|
||||
.Defining a named entity graph on an entity.
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
@Entity
|
||||
@NamedEntityGraph(name = "GroupInfo.detail",
|
||||
attributeNodes = @NamedAttributeNode("members"))
|
||||
public class GroupInfo {
|
||||
|
||||
// default fetch mode is lazy.
|
||||
@ManyToMany
|
||||
List<GroupMember> members = new ArrayList<GroupMember>();
|
||||
|
||||
…
|
||||
}
|
||||
----
|
||||
====
|
||||
|
||||
.Referencing a named entity graph definition on an repository query method.
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
@Repository
|
||||
public interface GroupRepository extends CrudRepository<GroupInfo, String> {
|
||||
|
||||
@EntityGraph(value = "GroupInfo.detail", type = EntityGraphType.LOAD)
|
||||
GroupInfo getByGroupName(String name);
|
||||
|
||||
}
|
||||
----
|
||||
====
|
||||
|
||||
[[jpa.stored-procedures]]
|
||||
== Stored procedures
|
||||
The JPA 2.1 specification introduced support for calling stored procedures via the JPA criteria query API. We Introduced the `@Procedure` annotation for declaring stored procedure metadata on a repository method.
|
||||
|
||||
.The definition of the pus1inout procedure in HSQL DB.
|
||||
====
|
||||
[source, sql]
|
||||
----
|
||||
/;
|
||||
DROP procedure IF EXISTS plus1inout
|
||||
/;
|
||||
CREATE procedure plus1inout (IN arg int, OUT res int)
|
||||
BEGIN ATOMIC
|
||||
set res = arg ` 1;
|
||||
END
|
||||
/;
|
||||
----
|
||||
====
|
||||
|
||||
Metadata for stored procedures can be configured via the `NamedStoredProcedureQuery` annotation on an entity type.
|
||||
|
||||
[[jpa.stored-procedure-entity-metadata]]
|
||||
.StoredProcedure metadata definitions on an entity.
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
@Entity
|
||||
@NamedStoredProcedureQuery(name = "User.plus1", procedureName = "plus1inout", parameters = {
|
||||
@StoredProcedureParameter(mode = ParameterMode.IN, name = "arg", type = Integer.class),
|
||||
@StoredProcedureParameter(mode = ParameterMode.OUT, name = "res", type = Integer.class) })
|
||||
public class User {}
|
||||
----
|
||||
====
|
||||
|
||||
Stored procedures can be referenced from a repository method in multiple ways. The stored procedure to be called can either be defined directly via the `value` or `procedureName` attribute of the `@Procedure` annotation or indirectly via the `name` attribute. If no name is configured the name of the repository method is used as a fallback.
|
||||
|
||||
[[jpa.stored-procedure-reference]]
|
||||
.Referencing explicitly mapped procedure with name "plus1inout" in database.
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
@Procedure("plus1inout")
|
||||
Integer explicitlyNamedPlus1inout(Integer arg);
|
||||
----
|
||||
====
|
||||
|
||||
.Referencing implicitly mapped procedure with name "plus1inout" in database via `procedureName` alias.
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
@Procedure(procedureName = "plus1inout")
|
||||
Integer plus1inout(Integer arg);
|
||||
----
|
||||
====
|
||||
|
||||
.Referencing explicitly mapped named stored procedure "User.plus1IO" in EntityManager.
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
@Procedure(name = "User.plus1IO")
|
||||
Integer entityAnnotatedCustomNamedProcedurePlus1IO(@Param("arg") Integer arg);
|
||||
----
|
||||
====
|
||||
|
||||
.Referencing implicitly mapped named stored procedure "User.plus1" in EntityManager via method-name.
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
@Procedure
|
||||
Integer plus1(@Param("arg") Integer arg);
|
||||
----
|
||||
====
|
||||
|
||||
[[specifications]]
|
||||
== Specifications
|
||||
|
||||
JPA 2 introduces a criteria API that can be used to build queries programmatically. Writing a `criteria` you actually define the where-clause of a query for a domain class. Taking another step back these criteria can be regarded as predicate over the entity that is described by the JPA criteria API constraints.
|
||||
|
||||
Spring Data JPA takes the concept of a specification from Eric Evans' book "Domain Driven Design", following the same semantics and providing an API to define such specifications using the JPA criteria API. To support specifications you can extend your repository interface with the `JpaSpecificationExecutor` interface:
|
||||
|
||||
[source, java]
|
||||
----
|
||||
public interface CustomerRepository extends CrudRepository<Customer, Long>, JpaSpecificationExecutor {
|
||||
…
|
||||
}
|
||||
----
|
||||
|
||||
The additional interface carries methods that allow you to execute specifications in a variety of ways. For example, the `findAll` method will return all entities that match the specification:
|
||||
|
||||
[source, java]
|
||||
----
|
||||
List<T> findAll(Specification<T> spec);
|
||||
----
|
||||
|
||||
The `Specification` interface is defined as follows:
|
||||
|
||||
[source, java]
|
||||
----
|
||||
public interface Specification<T> {
|
||||
Predicate toPredicate(Root<T> root, CriteriaQuery<?> query,
|
||||
CriteriaBuilder builder);
|
||||
}
|
||||
----
|
||||
|
||||
Okay, so what is the typical use case? Specifications can easily be used to build an extensible set of predicates on top of an entity that then can be combined and used with `JpaRepository` without the need to declare a query (method) for every needed combination. Here's an example:
|
||||
|
||||
.Specifications for a Customer
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
public class CustomerSpecs {
|
||||
|
||||
public static Specification<Customer> isLongTermCustomer() {
|
||||
return new Specification<Customer>() {
|
||||
public Predicate toPredicate(Root<Customer> root, CriteriaQuery<?> query,
|
||||
CriteriaBuilder builder) {
|
||||
|
||||
LocalDate date = new LocalDate().minusYears(2);
|
||||
return builder.lessThan(root.get(_Customer.createdAt), date);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
public static Specification<Customer> hasSalesOfMoreThan(MontaryAmount value) {
|
||||
return new Specification<Customer>() {
|
||||
public Predicate toPredicate(Root<T> root, CriteriaQuery<?> query,
|
||||
CriteriaBuilder builder) {
|
||||
|
||||
// build query here
|
||||
}
|
||||
};
|
||||
}
|
||||
}
|
||||
----
|
||||
====
|
||||
|
||||
Admittedly the amount of boilerplate leaves room for improvement (that will hopefully be reduced by Java 8 closures) but the client side becomes much nicer as you will see below. The `_Customer` type is a metamodel type generated using the JPA Metamodel generator (see the link:$$http://docs.jboss.org/hibernate/jpamodelgen/1.0/reference/en-US/html_single/#whatisit$$[Hibernate implementation's documentation for example]). So the expression `_Customer.createdAt` is asuming the `Customer` having a `createdAt` attribute of type `Date`. Besides that we have expressed some criteria on a business requirement abstraction level and created executable `Specifications`. So a client might use a `Specification` as follows:
|
||||
|
||||
.Using a simple Specification
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
List<Customer> customers = customerRepository.findAll(isLongTermCustomer());
|
||||
----
|
||||
====
|
||||
|
||||
Okay, why not simply create a query for this kind of data access? You're right. Using a single `Specification` does not gain a lot of benefit over a plain query declaration. The power of specifications really shines when you combine them to create new `Specification` objects. You can achieve this through the `Specifications` helper class we provide to build expressions like this:
|
||||
|
||||
.Combined Specifications
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
MonetaryAmount amount = new MonetaryAmount(200.0, Currencies.DOLLAR);
|
||||
List<Customer> customers = customerRepository.findAll(
|
||||
where(isLongTermCustomer()).or(hasSalesOfMoreThan(amount)));
|
||||
----
|
||||
As you can see, `Specifications` offers some glue-code methods to chain and combine `Specification` instances. Thus extending your data access layer is just a matter of creating new `Specification` implementations and combining them with ones already existing.
|
||||
====
|
||||
|
||||
[[transactions]]
|
||||
== Transactionality
|
||||
CRUD methods on repository instances are transactional by default. For reading operations the transaction configuration `readOnly` flag is set to true, all others are configured with a plain `@Transactional` so that default transaction configuration applies. For details see JavaDoc of `CrudRepository`. If you need to tweak transaction configuration for one of the methods declared in a repository simply redeclare the method in your repository interface as follows:
|
||||
|
||||
.Custom transaction configuration for CRUD
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
public interface UserRepository extends CrudRepository<User, Long> {
|
||||
|
||||
@Override
|
||||
@Transactional(timeout = 10)
|
||||
public List<User> findAll();
|
||||
|
||||
// Further query method declarations
|
||||
}
|
||||
----
|
||||
This will cause the `findAll()` method to be executed with a timeout of 10 seconds and without the `readOnly` flag.
|
||||
====
|
||||
|
||||
Another possibility to alter transactional behaviour is using a facade or service implementation that typically covers more than one repository. Its purpose is to define transactional boundaries for non-CRUD operations:
|
||||
|
||||
.Using a facade to define transactions for multiple repository calls
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
@Service
|
||||
class UserManagementImpl implements UserManagement {
|
||||
|
||||
private final UserRepository userRepository;
|
||||
private final RoleRepository roleRepository;
|
||||
|
||||
@Autowired
|
||||
public UserManagementImpl(UserRepository userRepository,
|
||||
RoleRepository roleRepository) {
|
||||
this.userRepository = userRepository;
|
||||
this.roleRepository = roleRepository;
|
||||
}
|
||||
|
||||
@Transactional
|
||||
public void addRoleToAllUsers(String roleName) {
|
||||
|
||||
Role role = roleRepository.findByName(roleName);
|
||||
|
||||
for (User user : userRepository.findAll()) {
|
||||
user.addRole(role);
|
||||
userRepository.save(user);
|
||||
}
|
||||
}
|
||||
----
|
||||
This will cause call to `addRoleToAllUsers(…)` to run inside a transaction (participating in an existing one or create a new one if none already running). The transaction configuration at the repositories will be neglected then as the outer transaction configuration determines the actual one used. Note that you will have to activate `<tx:annotation-driven />` or use `@EnableTransactionManagement` explicitly to get annotation based configuration at facades working. The example above assumes you are using component scanning.
|
||||
====
|
||||
|
||||
[[transactional-query-methods]]
|
||||
=== Transactional query methods
|
||||
To allow your query methods to be transactional simply use `@Transactional` at the repository interface you define.
|
||||
|
||||
.Using @Transactional at query methods
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
@Transactional(readOnly = true)
|
||||
public interface UserRepository extends JpaRepository<User, Long> {
|
||||
|
||||
List<User> findByLastname(String lastname);
|
||||
|
||||
@Modifying
|
||||
@Transactional
|
||||
@Query("delete from User u where u.active = false")
|
||||
void deleteInactiveUsers();
|
||||
}
|
||||
----
|
||||
Typically you will want the readOnly flag set to true as most of the query methods will only read data. In contrast to that `deleteInactiveUsers()` makes use of the `@Modifying` annotation and overrides the transaction configuration. Thus the method will be executed with `readOnly` flag set to `false`.
|
||||
====
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
It's definitely reasonable to use transactions for read only queries and we can mark them as such by setting the `readOnly` flag. This will not, however, act as check that you do not trigger a manipulating query (although some databases reject `INSERT` and `UPDATE` statements inside a read only transaction). The `readOnly` flag instead is propagated as hint to the underlying JDBC driver for performance optimizations. Furthermore, Spring will perform some optimizations on the underlying JPA provider. E.g. when used with Hibernate the flush mode is set to `NEVER` when you configure a transaction as `readOnly` which causes Hibernate to skip dirty checks (a noticeable improvement on large object trees).
|
||||
====
|
||||
|
||||
[[locking]]
|
||||
== Locking
|
||||
To specify the lock mode to be used the `@Lock` annotation can be used on query methods:
|
||||
|
||||
.Defining lock metadata on query methods
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
interface UserRepository extends Repository<User, Long> {
|
||||
|
||||
// Plain query method
|
||||
@Lock(LockModeType.READ)
|
||||
List<User> findByLastname(String lastname);
|
||||
}
|
||||
----
|
||||
====
|
||||
|
||||
This method declaration will cause the query being triggered to be equipped with the `LockModeType` `READ`. You can also define locking for CRUD methods by redeclaring them in your repository interface and adding the `@Lock` annotation:
|
||||
|
||||
.Defining lock metadata on CRUD methods
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
interface UserRepository extends Repository<User, Long> {
|
||||
|
||||
// Redeclaration of a CRUD method
|
||||
@Lock(LockModeType.READ);
|
||||
List<User> findAll();
|
||||
}
|
||||
----
|
||||
====
|
||||
|
||||
:leveloffset: 2
|
||||
include::{spring-data-commons-docs}/auditing.adoc[]
|
||||
:leveloffset: 0
|
||||
|
||||
[[jpa.auditing]]
|
||||
== JPA Auditing
|
||||
|
||||
[[jpa.auditing.configuration]]
|
||||
=== General auditing configuration
|
||||
|
||||
Spring Data JPA ships with an entity listener that can be used to trigger capturing auditing information. So first you have to register the `AuditingEntityListener` inside your `orm.xml` to be used for all entities in your persistence contexts:
|
||||
|
||||
Note that the auditing feature requires `spring-aspects.jar` to be on the classpath.
|
||||
|
||||
.Auditing configuration orm.xml
|
||||
====
|
||||
[source, xml]
|
||||
----
|
||||
<persistence-unit-metadata>
|
||||
<persistence-unit-defaults>
|
||||
<entity-listeners>
|
||||
<entity-listener class="….data.jpa.domain.support.AuditingEntityListener" />
|
||||
</entity-listeners>
|
||||
</persistence-unit-defaults>
|
||||
</persistence-unit-metadata>
|
||||
----
|
||||
====
|
||||
|
||||
Now activating auditing functionality is just a matter of adding the Spring Data JPA `auditing` namespace element to your configuration:
|
||||
|
||||
.Activating auditing using XML configuration
|
||||
====
|
||||
[source, xml]
|
||||
----
|
||||
<jpa:auditing auditor-aware-ref="yourAuditorAwareBean" />
|
||||
----
|
||||
====
|
||||
|
||||
As of Spring Data JPA 1.5, auditing can be enabled by annotating a configuration class with the @EnableJpaAuditing annotation.
|
||||
|
||||
.Activating auditing via Java configuration
|
||||
====
|
||||
[source, java]
|
||||
----
|
||||
@Configuration
|
||||
@EnableJpaAuditing
|
||||
class Config {
|
||||
|
||||
@Bean
|
||||
public AuditorAware<AuditableUser> auditorProvider() {
|
||||
return new AuditorAwareImpl();
|
||||
}
|
||||
}
|
||||
----
|
||||
====
|
||||
|
||||
If you expose a bean of type AuditorAware to the ApplicationContext, the auditing infrastructure will pick it up automatically and use it to determine the current user to be set on domain types. If you have multiple implementations registered in the ApplicationContext, you can select the one to be used by explicitly setting the `auditorAwareRef` attribute of @EnableJpaAuditing.
|
||||
|
||||
[[jpa.misc]]
|
||||
= Miscellaneous
|
||||
|
||||
[[jpa.misc.merging-persistence-units]]
|
||||
== Merging persistence units
|
||||
|
||||
Spring supports having multiple persistence units out of the box. Sometimes, however, you might want to modularize your application but still make sure that all these modules run inside a single persistence unit at runtime. To do so Spring Data JPA offers a `PersistenceUnitManager` implementation that automatically merges persistence units based on their name.
|
||||
|
||||
.Using MergingPersistenceUnitmanager
|
||||
====
|
||||
[source, xml]
|
||||
----
|
||||
<bean class="….LocalContainerEntityManagerFactoryBean">
|
||||
<property name="persistenceUnitManager">
|
||||
<bean class="….MergingPersistenceUnitManager" />
|
||||
</property>
|
||||
</bean>
|
||||
----
|
||||
====
|
||||
|
||||
[[jpa.misc.entity-scanning]]
|
||||
=== Classpath scanning for @Entity classes and JPA mapping files
|
||||
|
||||
A plain JPA setup requires all annotation mapped entity classes listed in `orm.xml`. Same applies to XML mapping files. Spring Data JPA provides a ClasspathScanningPersistenceUnitPostProcessor that gets a base package configured and optionally takes a mapping filename pattern. It will then scan the given package for classes annotated with @Entity or @MappedSuperclass and also loads the configuration files matching the filename pattern and hands them to the JPA configuration. The PostProcessor has to be configured like this:
|
||||
|
||||
.Using ClasspathScanningPersistenceUnitPostProcessor
|
||||
====
|
||||
[source, xml]
|
||||
----
|
||||
<bean class="….LocalContainerEntityManagerFactoryBean">
|
||||
<property name="persistenceUnitPostProcessors">
|
||||
<list>
|
||||
<bean class="org.springframework.data.jpa.support.ClasspathScanningPersistenceUnitPostProcessor">
|
||||
<constructor-arg value="com.acme.domain" />
|
||||
<property name="mappingFileNamePattern" value="**/*Mapping.xml" />
|
||||
</bean>
|
||||
</list>
|
||||
</property>
|
||||
</bean>
|
||||
----
|
||||
====
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
As of Spring 3.1 a package to scan can be configured on the LocalContainerEntityManagerFactoryBean directly to enable classpath scanning for entity classes. See the link:$$http://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/orm/jpa/LocalContainerEntityManagerFactoryBean.html#setPackagesToScan(java.lang.String...)$$[JavaDoc] for details.
|
||||
====
|
||||
|
||||
[[jpd.misc.cdi-integration]]
|
||||
== CDI integration
|
||||
|
||||
Instances of the repository interfaces are usually created by a container, which Spring is the most natural choice when working with Spring Data. There's sophisticated support to easily set up Spring to create bean instances documented in <<repositories.create-instances>>. As of version 1.1.0 Spring Data JPA ships with a custom CDI extension that allows using the repository abstraction in CDI environments. The extension is part of the JAR so all you need to do to activate it is dropping the Spring Data JPA JAR into your classpath.
|
||||
|
||||
You can now set up the infrastructure by implementing a CDI Producer for the `EntityManagerFactory` and `EntityManager`:
|
||||
|
||||
[source, java]
|
||||
----
|
||||
class EntityManagerFactoryProducer {
|
||||
|
||||
@Produces
|
||||
@ApplicationScoped
|
||||
public EntityManagerFactory createEntityManagerFactory() {
|
||||
return Persistence.createEntityManagerFactory("my-presistence-unit");
|
||||
}
|
||||
|
||||
public void close(@Disposes EntityManagerFactory entityManagerFactory) {
|
||||
entityManagerFactory.close();
|
||||
}
|
||||
|
||||
@Produces
|
||||
@RequestScoped
|
||||
public EntityManager createEntityManager(EntityManagerFactory entityManagerFactory) {
|
||||
return entityManagerFactory.createEntityManager();
|
||||
}
|
||||
|
||||
public void close(@Disposes EntityManager entityManager) {
|
||||
entityManager.close();
|
||||
}
|
||||
}
|
||||
----
|
||||
|
||||
The necessary setup can vary depending on the JavaEE environment you run in. It might also just be enough to redeclare a `EntityManager` as CDI bean as follows:
|
||||
|
||||
[source, java]
|
||||
----
|
||||
class CdiConfig {
|
||||
|
||||
@Produces
|
||||
@RequestScoped
|
||||
@PersistenceContext
|
||||
public EntityManager entityManager;
|
||||
}
|
||||
----
|
||||
|
||||
In this example, the container has to be capable of creating JPA `EntityManagers` itself. All the configuration does is re-exporting the JPA `EntityManager` as CDI bean.
|
||||
|
||||
The Spring Data JPA CDI extension will pick up all EntityManagers availables as CDI beans and create a proxy for a Spring Data repository whenever an bean of a repository type is requested by the container. Thus obtaining an instance of a Spring Data repository is a matter of declaring an `@Injected` property:
|
||||
|
||||
[source, java]
|
||||
----
|
||||
class RepositoryClient {
|
||||
|
||||
@Inject
|
||||
PersonRepository repository;
|
||||
|
||||
public void businessMethod() {
|
||||
List<Person> people = repository.findAll();
|
||||
}
|
||||
}
|
||||
----
|
||||
13
src/main/asciidoc/preface.adoc
Normal file
13
src/main/asciidoc/preface.adoc
Normal file
@@ -0,0 +1,13 @@
|
||||
[[preface]]
|
||||
[preface]
|
||||
= Preface
|
||||
|
||||
[[project]]
|
||||
== Project metadata
|
||||
|
||||
[options="compact"]
|
||||
- Version control - link:$$git://github.com/spring-projects/spring-data-jpa.git$$[git://github.com/spring-projects/spring-data-jpa.git]
|
||||
- Bugtracker - link:$$https://jira.springsource.org/browse/DATAJPA$$[https://jira.springsource.org/browse/DATAJPA]
|
||||
- Release repository - link:$$http://repo.spring.io/libs-release$$[http://repo.spring.io/libs-release]
|
||||
- Milestone repository - link:$$http://repo.spring.io/libs-milestone$$[http://repo.spring.io/libs-milestone]
|
||||
- Snapshot repository - link:$$http://repo.spring.io/libs-snapshot$$[http://repo.spring.io/libs-snapshot]
|
||||
Reference in New Issue
Block a user