Spring data jdbc module (#7)

* experimentation with spring data jdbc * fixed database in pom.xml for jdbc module * finished implementation of QuerydslJdbcRepository * added query type as a generic parameter to QuerydslJdbcRepository added reflective resolution of parameter * changed constructor resolution to use spring data jdbc infrastructure * added javadoc to QuerydslJdbcRepository * refactoring of jdbc tests * updated README.md * updated README.md * updated README.md * bumped to 3.0.0-SNAPSHOT * updated README.md breaking changes section * renamed CustomNamingStrategy to PascalCaseNamingStrategy
infobip · Jan 13, 2020 · 9b41403 · 9b41403
1 parent ac37cf9
commit 9b41403
Show file tree

Hide file tree

Showing 37 changed files with 1,190 additions and 188 deletions.
diff --git a/README.md b/README.md
@@ -1,52 +1,149 @@
-# Infobip Spring Data JPA Querydsl
+# Infobip Spring Data Querydsl
 
 [![Build Status](https://travis-ci.org/infobip/infobip-spring-data-jpa-querydsl.svg?branch=master)](https://travis-ci.org/infobip/infobip-spring-data-jpa-querydsl)
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.infobip/infobip-spring-data-jpa-querydsl/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.infobip/infobip-spring-data-jpa-querydsl)
 [![Coverage Status](https://coveralls.io/repos/github/infobip/infobip-spring-data-jpa-querydsl/badge.svg?branch=master)](https://coveralls.io/github/infobip/infobip-spring-data-jpa-querydsl?branch=master)
 
-Infobip Spring Data JPA Querydsl provides new functionality that enables the user to leverage the full power of Querydsl API on top of Spring Data repository infrastructure.
+Infobip Spring Data Querydsl provides new functionality that enables the user to leverage the full power of Querydsl API on top of Spring Data repository infrastructure.
+
+The project is divided into 2 modules: infobip-spring-data-jdbc-querydsl and infobip-spring-data-jpa-querydsl.
 
 ## Contents
 
 1. [News](#News)
-2. [Features and examples](#FeaturesAndExamples)
-    * [Native queries with Querydsl](#NativeQueriesWithQuerydsl)
-    * [Projections](#Projections)
-    * [Query](#Query)
-    * [Update](#Update)
-    * [Delete](#Delete)
-    * [List instead of Iterable return type](#ListInsteadOfIterableReturnType)
-    * [Transactional support](#TransactionalSupport)
-    * [Stored procedure builder](#StoredProcedureBuilder)
-3. [Setup](#Setup)
+2. [JDBC module:](#JDBC)
+    * [Requirements](#JDBCRequirements)
+    * [Setup](#JDBCSetup)
+3. [JPA module:](#JPA)
+    * [Requirements](#JPARequirements)
+    * [Setup](#JPASetup)
+    * [Features and examples:](#JPAFeaturesAndExamples)
+        * [Native queries with Querydsl](#JPANativeQueriesWithQuerydsl)
+        * [Projections](#JPAProjections)
+        * [Query](#JPAQuery)
+        * [Update](#JPAUpdate)
+        * [Delete](#JPADelete)
+        * [List instead of Iterable return type](#JPAListInsteadOfIterableReturnType)
+        * [Transactional support](#JPATransactionalSupport)
+        * [Stored procedure builder](#JPAStoredProcedureBuilder)
 4. [Domain Driven Design concerns](#DomainDrivenDesignConcerns)
-5. [Requirements](#Requirements)
-6. [Further reading](#FurtherReading)
-7. [Running tests](#RunningTests)
-8. [Contributing](#Contributing)
-9. [License](#License)
+5. [Further reading](#FurtherReading)
+6. [Running tests](#RunningTests)
+7. [Contributing](#Contributing)
+8. [License](#License)
 
 ## <a name="News"></a> News
 
-### 2.0.1
+### 3.0.0
+
+* Breaking changes: 
+    * renamed `@EnableExtendedRepositories` to `@EnableExtendedJpaRepositories`
+    * renamed `ExtendedQueryDslJpaRepository` to `ExtendedQuerydslJpaRepository`
+* Added new module - infobip-spring-data-jdbc-querydsl.
+
+## <a name="JDBC"></a> JDBC module:
+
+## <a name="JDBCRequirements"></a> Requirements:
+
+- Java 8 with [parameter names preserved in byte code](https://stackoverflow.com/a/20594685/607767) (used to map columns to constructor parameters)
+- Spring Data JDBC
+- Querydsl
+
+### <a name="JDBCSetup"></a> Setup:
+
+1. Generate [querydsl Q (query) classes](http://www.querydsl.com/static/querydsl/4.1.3/reference/html_single/#d0e725).
+   As an example how to do this check out infobip-spring-data-jdbc-querydsl pom.xml and test code.
+
+2. Dependency:
+
+```xml
+<dependency>
+   <groupId>com.infobip</groupId>
+   <artifactId>infobip-spring-data-jdbc-querydsl</artifactId>
+   <version>${infobip-spring-data-jdbc-querydsl.version}</version>
+</dependency>
+```
+
+3. Add @EnableQuerydslJdbcRepositories to your Main class:
+
+```java
+@EnableQuerydslJdbcRepositories // replaces @EnableJpaRepositories
+@SpringBootApplication
+public class Main {
+
+    public static void main(String[] args) {
+        new SpringApplicationBuilder(Main.class).run(args);
+    }
+}
+```
+
+3. Refactor repository interfaces to use `QuerydslJdbcRepository` instead of `CrudRepository`:
+
+```java
+interface FooRepository extends QuerydslJdbcRepository<Foo, QFoo, ID> {
+}
+```
+
+4. Done
+
+## <a name="JPA"></a> JPA module:
+
+## <a name="JPARequirements"></a> Requirements:
+
+- Java 8
+- Hibernate (if you need support for other JPA implementors please open an issue)
+- Spring Data JPA
+- Querydsl
+
+### <a name="JPASetup"></a> Setup:
+
+1. Dependency:
+
+```xml
+<dependency>
+   <groupId>com.infobip</groupId>
+   <artifactId>infobip-spring-data-jpa-querydsl</artifactId>
+   <version>${infobip-spring-data-jpa-querydsl.version}</version>
+</dependency>
+```
+
+As this project depends on querydsl-apt with jpa classifier you don't need to set up explicit Maven build phase for Q classes generation.
+For building Q classes without Maven, make sure your IDE has Annotation processing enabled.
 
-Changed scope of SimpleExtendedQueryDslJpaRepository to public.
+2. Add @EnableExtendedJpaRepositories to your Main class:
+
+```java
+@EnableExtendedJpaRepositories // replaces @EnableJpaRepositories
+@SpringBootApplication
+public class Main {
+
+    public static void main(String[] args) {
+        new SpringApplicationBuilder(Main.class).run(args);
+    }
+}
+```
 
+3. Refactor repository interfaces to use `ExtendedQueryDslJpaRepository` instead of `JpaRepository` and `QueryDslPredicateExecutor` (note that ExtendedQueryDslJpaRepository extends and provides the API of both):
 
-### 2.0.0
+```java
+// ExtendedQueryDslJpaRepository replaces both JpaRepository and QueryDslPredicateExecutor
+interface FooRepository extends ExtendedQueryDslJpaRepository<Foo, ID> {
+}
+```
 
-Upgrade to Spring Data 2 (Spring Boot 2).
+4. Done
 
-Breaking change: new repository methods introduced in Spring Data 2 `CrudRepository#findById(Object)` and
-`QuerydslPredicateExecutor#findOne(Predicate)` replace old `ExtendedQueryDslJpaRepository.findOneById(Object)`
-and `ExtendedQueryDslJpaRepository.findOneByPredicate(Predicate)` (they were removed).
+If you need other features from `@EnableJpaRepositories` you can use:
 
+```
+@EnableJpaRepositories(repositoryBaseClass = SimpleExtendedQueryDslJpaRepository.class)
+```
 
-## <a name="FeaturesAndExamples"></a> Features and examples:
+### <a name="JPAFeaturesAndExamples"></a> Features and examples:
 
 All examples have corresponding tests in the project and can be found [here](https://github.com/infobip/infobip-spring-data-jpa-querydsl/blob/master/src/test/java/com/infobip/spring/data/SqlServerQueryDslJpaRepositoryTest.java).
 
-### <a name="NativeQueriesWithQuerydsl"></a> Native queries with Querydsl:
+#### <a name="JPANativeQueriesWithQuerydsl"></a> Native queries with Querydsl:
 
 Example which uses union clause (unions aren't available in JPA):
 
@@ -67,7 +164,7 @@ List<Person> actual = repository.jpaSqlQuery(query -> query
 );
 ```
 
-### <a name="Projections"></a> Projections
+#### <a name="JPAProjections"></a> Projections
 
 For examples how to construct projections refer to the official documentation - [section result handling](http://www.querydsl.com/static/querydsl/latest/reference/html_single/#result_handling).
 
@@ -87,7 +184,7 @@ List<PersonProjection> actual = repository.query(query -> query
                                           .fetch());
 ```
 
-### <a name="Query"></a> Query
+#### <a name="JPAQuery"></a> Query
 
 Query exposes full API of JPAQuery ([QueryDslPredicateExecutor](https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data/querydsl/QuerydslPredicateExecutor.html) 
 only exposes where clause (Predicate) and order clause (OrderSpecifier)).
@@ -105,7 +202,7 @@ List<Person> actual = repository.query(query -> query
         .fetch());
 ```
 
-### <a name="Update"></a> Update
+#### <a name="JPAUpdate"></a> Update
 
 ```
 repository.update(query -> query
@@ -114,23 +211,23 @@ repository.update(query -> query
         .execute());
 ```
 
-### <a name="Delete"></a> Delete
+#### <a name="JPADelete"></a> Delete
 
 ```
 long numberOfAffectedRows = repository.deleteWhere(person.firstName.like("John%"));
 ```
 
-### <a name="ListInsteadOfIterableReturnType"></a> List instead of Iterable return type
+#### <a name="JPAListInsteadOfIterableReturnType"></a> List instead of Iterable return type
 
 [QueryDslPredicateExecutor](https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data/querydsl/QuerydslPredicateExecutor.html)#findAll methods return Iterable which can be cumbersome to use. 
 Those methods were overridden and now return a List which is easier to use and is easier to convert to Stream.
 
-### <a name="TransactionalSupport"></a> Transactional support
+#### <a name="JPATransactionalSupport"></a> Transactional support
 
 Query execution is always done inside the repository implementation (loan pattern) in a transaction so transactions don't have to be 
 handled manually (like they do if you are manually managing JPAQuery and other Querydsl constructs).
 
-### <a name="StoredProcedureBuilder"></a> Stored procedure builder
+#### <a name="JPAStoredProcedureBuilder"></a> Stored procedure builder
 
 JPA support for stored procedures is quite cumbersome and it also requires a reference to EntityManager which leads to code like this:
 
@@ -163,50 +260,6 @@ public List<Person> delete(Person personToDelete) {
 }
 ```
 
-## <a name="Setup"></a> Setup:
-
-1. Dependency:
-
-```xml
-<dependency>
-   <groupId>com.infobip</groupId>
-   <artifactId>infobip-spring-data-jpa-querydsl</artifactId>
-   <version>${infobip-spring-data-jpa-querydsl.version}</version>
-</dependency>
-```
-
-As this project depends on querydsl-apt with jpa classifier you don't need to set up explicit Maven build phase for Q classes generation.
-For building Q classes without Maven, make sure your IDE has Annotation processing enabled.
-
-2. Add @EnableExtendedRepositories to your Main class:
-
-```java
-@EnableExtendedRepositories // replaces @EnableJpaRepositories
-@SpringBootApplication
-public class Main {
-
-    public static void main(String[] args) {
-        new SpringApplicationBuilder(Main.class).run(args);
-    }
-}
-```
-
-3. Refactor repository interfaces to use `ExtendedQueryDslJpaRepository` instead of `JpaRepository` and `QueryDslPredicateExecutor` (note that ExtendedQueryDslJpaRepository extends and provides the API of both):
-
-```java
-// ExtendedQueryDslJpaRepository replaces both JpaRepository and QueryDslPredicateExecutor
-interface FooRepository extends ExtendedQueryDslJpaRepository<Foo, ID> {
-}
-```
-
-4. Done
-
-If you need other features from `@EnableJpaRepositories` you can use:
-
-```
-@EnableJpaRepositories(repositoryBaseClass = SimpleExtendedQueryDslJpaRepository.class)
-```
-
 ## <a name="DomainDrivenDesignConcerns"></a> Domain Driven Design concerns
 
 In following example one could argue that database related logic has leaked from repository to service layer:
@@ -291,13 +344,6 @@ class FooService {
 }
 ```
 
-## <a name="Requirements"></a> Requirements:
-
-- Java 8
-- Hibernate (if you need support for other JPA implementors please open an issue)
-- Spring Data
-- Querydsl
-
 ## <a name="FurtherReading"></a> Further reading
 
 - [Querydsl documentation](http://www.querydsl.com/static/querydsl/latest/reference/html_single/)