diff --git a/integration/spring_jpa/.gitignore b/integration/spring_jpa/.gitignore new file mode 100644 index 0000000..549e00a --- /dev/null +++ b/integration/spring_jpa/.gitignore @@ -0,0 +1,33 @@ +HELP.md +target/ +!.mvn/wrapper/maven-wrapper.jar +!**/src/main/**/target/ +!**/src/test/**/target/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ +build/ +!**/src/main/**/build/ +!**/src/test/**/build/ + +### VS Code ### +.vscode/ diff --git a/integration/spring_jpa/.mvn/wrapper/maven-wrapper.jar b/integration/spring_jpa/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 0000000..c1dd12f Binary files /dev/null and b/integration/spring_jpa/.mvn/wrapper/maven-wrapper.jar differ diff --git a/integration/spring_jpa/.mvn/wrapper/maven-wrapper.properties b/integration/spring_jpa/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..b74bf7f --- /dev/null +++ b/integration/spring_jpa/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,2 @@ +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.6/apache-maven-3.8.6-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar diff --git a/integration/spring_jpa/README.adoc b/integration/spring_jpa/README.adoc new file mode 100644 index 0000000..1e1aa00 --- /dev/null +++ b/integration/spring_jpa/README.adoc @@ -0,0 +1,31 @@ += JPA Example + +Examples prepared to explain the below concepts. + +1. Use Lazy loading +2. Usage of java.time.localdate. +3. Enum usage with converter + + +=== Lazy loading + +Always advised to use lazy loading. Lazy loading fetches data only when it is really required. This example uses FetchType Lazy, the invited guests will be loaded only on demand. + +A `SELECT` query applied for fetching booking or bookings will not fetch any invited guests. The below statement fetches all guests for a particular booking. It executes a `SELECT` query with booking id as arguement. + `BookingEntity.getInvitedGuests()` + + +=== Enum + +Using Converter annotation convert an entity attribute to a database value and vice versa. In this example, enum defined as BOOKED("B"), and NOTBOOKED("N") and CANCELED ("C"). This helps to make sure the code is not broken by refactorings. + +The other two ways to deal with enums are by their `Ordinal` or by `name`. `Ordinal` may not be a good choice, if someone changes the places of the items in enum, wrong integer value may be stored. + +=== LocalDateTime + +java.time.LocalDateTime used instead of java.util.date, major benefits are: + +* LocalDateTime API has its own format/parse methods. +* Addition/subtraction operation are easier (minusMinutes,plusDays etc.) + + diff --git a/integration/spring_jpa/mvnw b/integration/spring_jpa/mvnw new file mode 100644 index 0000000..8a8fb22 --- /dev/null +++ b/integration/spring_jpa/mvnw @@ -0,0 +1,316 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Maven Start Up Batch script +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# M2_HOME - location of maven2's installed home dir +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /usr/local/etc/mavenrc ] ; then + . /usr/local/etc/mavenrc + fi + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "`uname`" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home + # See https://developer.apple.com/library/mac/qa/qa1170/_index.html + if [ -z "$JAVA_HOME" ]; then + if [ -x "/usr/libexec/java_home" ]; then + export JAVA_HOME="`/usr/libexec/java_home`" + else + export JAVA_HOME="/Library/Java/Home" + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=`java-config --jre-home` + fi +fi + +if [ -z "$M2_HOME" ] ; then + ## resolve links - $0 may be a link to maven's home + PRG="$0" + + # need this for relative symlinks + while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG="`dirname "$PRG"`/$link" + fi + done + + saveddir=`pwd` + + M2_HOME=`dirname "$PRG"`/.. + + # make it fully qualified + M2_HOME=`cd "$M2_HOME" && pwd` + + cd "$saveddir" + # echo Using m2 at $M2_HOME +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$M2_HOME" ] && + M2_HOME=`cygpath --unix "$M2_HOME"` + [ -n "$JAVA_HOME" ] && + JAVA_HOME=`cygpath --unix "$JAVA_HOME"` + [ -n "$CLASSPATH" ] && + CLASSPATH=`cygpath --path --unix "$CLASSPATH"` +fi + +# For Mingw, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$M2_HOME" ] && + M2_HOME="`(cd "$M2_HOME"; pwd)`" + [ -n "$JAVA_HOME" ] && + JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="`which javac`" + if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=`which readlink` + if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then + if $darwin ; then + javaHome="`dirname \"$javaExecutable\"`" + javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" + else + javaExecutable="`readlink -f \"$javaExecutable\"`" + fi + javaHome="`dirname \"$javaExecutable\"`" + javaHome=`expr "$javaHome" : '\(.*\)/bin'` + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + else + JAVACMD="`\\unset -f command; \\command -v java`" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + + if [ -z "$1" ] + then + echo "Path not specified to find_maven_basedir" + return 1 + fi + + basedir="$1" + wdir="$1" + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + # workaround for JBEAP-8937 (on Solaris 10/Sparc) + if [ -d "${wdir}" ]; then + wdir=`cd "$wdir/.."; pwd` + fi + # end of workaround + done + echo "${basedir}" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + echo "$(tr -s '\n' ' ' < "$1")" + fi +} + +BASE_DIR=`find_maven_basedir "$(pwd)"` +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +########################################################################################## +# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +# This allows using the maven wrapper in projects that prohibit checking in binary data. +########################################################################################## +if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found .mvn/wrapper/maven-wrapper.jar" + fi +else + if [ "$MVNW_VERBOSE" = true ]; then + echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." + fi + if [ -n "$MVNW_REPOURL" ]; then + jarUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" + else + jarUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" + fi + while IFS="=" read key value; do + case "$key" in (wrapperUrl) jarUrl="$value"; break ;; + esac + done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" + if [ "$MVNW_VERBOSE" = true ]; then + echo "Downloading from: $jarUrl" + fi + wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" + if $cygwin; then + wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"` + fi + + if command -v wget > /dev/null; then + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found wget ... using wget" + fi + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + else + wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + fi + elif command -v curl > /dev/null; then + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found curl ... using curl" + fi + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl -o "$wrapperJarPath" "$jarUrl" -f + else + curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f + fi + + else + if [ "$MVNW_VERBOSE" = true ]; then + echo "Falling back to using Java to download" + fi + javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaClass=`cygpath --path --windows "$javaClass"` + fi + if [ -e "$javaClass" ]; then + if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then + if [ "$MVNW_VERBOSE" = true ]; then + echo " - Compiling MavenWrapperDownloader.java ..." + fi + # Compiling the Java class + ("$JAVA_HOME/bin/javac" "$javaClass") + fi + if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then + # Running the downloader + if [ "$MVNW_VERBOSE" = true ]; then + echo " - Running MavenWrapperDownloader.java ..." + fi + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} +if [ "$MVNW_VERBOSE" = true ]; then + echo $MAVEN_PROJECTBASEDIR +fi +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$M2_HOME" ] && + M2_HOME=`cygpath --path --windows "$M2_HOME"` + [ -n "$JAVA_HOME" ] && + JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` + [ -n "$CLASSPATH" ] && + CLASSPATH=`cygpath --path --windows "$CLASSPATH"` + [ -n "$MAVEN_PROJECTBASEDIR" ] && + MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` +fi + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +exec "$JAVACMD" \ + $MAVEN_OPTS \ + $MAVEN_DEBUG_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.home=${M2_HOME}" \ + "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/integration/spring_jpa/mvnw.cmd b/integration/spring_jpa/mvnw.cmd new file mode 100644 index 0000000..1d8ab01 --- /dev/null +++ b/integration/spring_jpa/mvnw.cmd @@ -0,0 +1,188 @@ +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM https://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Maven Start Up Batch script +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM M2_HOME - location of maven2's installed home dir +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM set title of command window +title %0 +@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* +if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" +set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" + +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B +) + +@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +@REM This allows using the maven wrapper in projects that prohibit checking in binary data. +if exist %WRAPPER_JAR% ( + if "%MVNW_VERBOSE%" == "true" ( + echo Found %WRAPPER_JAR% + ) +) else ( + if not "%MVNW_REPOURL%" == "" ( + SET DOWNLOAD_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" + ) + if "%MVNW_VERBOSE%" == "true" ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %DOWNLOAD_URL% + ) + + powershell -Command "&{"^ + "$webclient = new-object System.Net.WebClient;"^ + "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ + "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ + "}"^ + "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^ + "}" + if "%MVNW_VERBOSE%" == "true" ( + echo Finished downloading %WRAPPER_JAR% + ) +) +@REM End of extension + +@REM Provide a "standardized" way to retrieve the CLI args that will +@REM work with both Windows and non-Windows executions. +set MAVEN_CMD_LINE_ARGS=%* + +%MAVEN_JAVA_EXE% ^ + %JVM_CONFIG_MAVEN_PROPS% ^ + %MAVEN_OPTS% ^ + %MAVEN_DEBUG_OPTS% ^ + -classpath %WRAPPER_JAR% ^ + "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ + %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" +if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%"=="on" pause + +if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% + +cmd /C exit /B %ERROR_CODE% diff --git a/integration/spring_jpa/pom.xml b/integration/spring_jpa/pom.xml new file mode 100644 index 0000000..b62d5e0 --- /dev/null +++ b/integration/spring_jpa/pom.xml @@ -0,0 +1,80 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 2.7.3 + + + com.devonfw.examples.dataaccess.springjpa + spring_jpa + 0.0.1-SNAPSHOT + spring_jpa + devonfw jpa example (lazy loading, timestamp, enums) + + 11 + + + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.boot + spring-boot-starter-data-jpa + + + javax.persistence + javax.persistence-api + + + org.springframework.data + spring-data-jpa + + + + + com.h2database + h2 + + + + + org.flywaydb + flyway-core + + + + org.projectlombok + lombok + true + + + + org.springframework.boot + spring-boot-starter-test + test + + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + org.projectlombok + lombok + + + + + + + + diff --git a/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/SpringJpaApplication.java b/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/SpringJpaApplication.java new file mode 100644 index 0000000..63ea02d --- /dev/null +++ b/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/SpringJpaApplication.java @@ -0,0 +1,13 @@ +package com.devonfw.examples.dataaccess.springjpa; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class SpringJpaApplication { + + public static void main(String[] args) { + SpringApplication.run(SpringJpaApplication.class, args); + } + +} diff --git a/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/domain/model/BookingEntity.java b/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/domain/model/BookingEntity.java new file mode 100644 index 0000000..af2d139 --- /dev/null +++ b/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/domain/model/BookingEntity.java @@ -0,0 +1,45 @@ +package com.devonfw.examples.dataaccess.springjpa.domain.model; + +import static javax.persistence.CascadeType.ALL; + +import java.time.LocalDateTime; +import java.util.Set; + +import javax.persistence.Entity; +import javax.persistence.FetchType; +import javax.persistence.JoinColumn; +import javax.persistence.OneToMany; +import javax.persistence.Table; + +import org.hibernate.annotations.BatchSize; + +import com.devonfw.examples.dataaccess.springjpa.general.domain.model.ApplicationPersistenceEntity; + +import lombok.Getter; +import lombok.Setter; +import lombok.ToString; + +@Setter +@Getter +@ToString(callSuper = true, includeFieldNames = true) +@Entity +@Table (name="booking") +public class BookingEntity extends ApplicationPersistenceEntity { + + private String name; + + private String bookingToken; + + private String comment; + + private LocalDateTime bookingDate; + + private String email; + + private BookingStatus bookingStatus; + + @OneToMany(cascade = ALL, fetch = FetchType.LAZY, orphanRemoval = true) + @JoinColumn(name = "id_booking") + @BatchSize(size = 2) + private Set invitedGuests; +} diff --git a/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/domain/model/BookingStatus.java b/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/domain/model/BookingStatus.java new file mode 100644 index 0000000..a5c5f57 --- /dev/null +++ b/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/domain/model/BookingStatus.java @@ -0,0 +1,22 @@ +package com.devonfw.examples.dataaccess.springjpa.domain.model; + +/** + * BookingStatus enumerator helps to handle Status in a better way. Here the + * code associated with each enum is persisted to the database instead of the + * whole string, by the BookingStatusConverter. + */ +public enum BookingStatus { + BOOKED("B"), CANCELED("C"), NOTBOOKED("N"); + + private String code; + + BookingStatus(String code) { + + this.code = code; + } + + public String getCode() { + + return this.code; + } +} diff --git a/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/domain/model/InvitedGuestEntity.java b/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/domain/model/InvitedGuestEntity.java new file mode 100644 index 0000000..31f90c9 --- /dev/null +++ b/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/domain/model/InvitedGuestEntity.java @@ -0,0 +1,22 @@ +package com.devonfw.examples.dataaccess.springjpa.domain.model; + +import javax.persistence.Entity; +import javax.persistence.Table; + +import com.devonfw.examples.dataaccess.springjpa.general.domain.model.ApplicationPersistenceEntity; + +import lombok.Getter; +import lombok.Setter; +import lombok.ToString; +@Setter +@Getter +@ToString(callSuper = true, includeFieldNames = true) +@Entity +@Table (name="Invited_Guest") +public class InvitedGuestEntity extends ApplicationPersistenceEntity { + + private String guestToken; + + private String email; + +} diff --git a/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/domain/model/converter/BookingStatusConverter.java b/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/domain/model/converter/BookingStatusConverter.java new file mode 100644 index 0000000..b3aeefe --- /dev/null +++ b/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/domain/model/converter/BookingStatusConverter.java @@ -0,0 +1,46 @@ +package com.devonfw.examples.dataaccess.springjpa.domain.model.converter; + +import java.util.stream.Stream; + +import javax.persistence.AttributeConverter; +import javax.persistence.Converter; + +import com.devonfw.examples.dataaccess.springjpa.domain.model.BookingStatus; +/** + * BookingStatusConverter defines a mapping between BookinStatus enum and the + * database column booking_status at booking table. + * + */ +@Converter(autoApply = true) +public class BookingStatusConverter + implements + AttributeConverter { + + /** + * Converts BookingStatus to string 'code', eg: `BOOKED` to 'B'. + */ + @Override + public String convertToDatabaseColumn(BookingStatus status) { + + if (status == null) { + return null; + } + return status.getCode(); + } + + /** + * Converts the string 'code' to BookingStatus eg: 'B' to `BOOKED` + */ + @Override + public BookingStatus convertToEntityAttribute(final String code) { + + if (code == null) { + return null; + } + + return Stream.of(BookingStatus.values()) + .filter(c -> c.getCode().equals(code)).findFirst() + .orElseThrow(IllegalArgumentException::new); + } + +} diff --git a/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/domain/repository/BookingRepository.java b/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/domain/repository/BookingRepository.java new file mode 100644 index 0000000..9af33ce --- /dev/null +++ b/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/domain/repository/BookingRepository.java @@ -0,0 +1,11 @@ +package com.devonfw.examples.dataaccess.springjpa.domain.repository; + +import org.springframework.data.repository.CrudRepository; +import org.springframework.stereotype.Repository; + +import com.devonfw.examples.dataaccess.springjpa.domain.model.BookingEntity; + +@Repository +public interface BookingRepository extends CrudRepository { + +} diff --git a/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/general/domain/model/ApplicationPersistenceEntity.java b/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/general/domain/model/ApplicationPersistenceEntity.java new file mode 100644 index 0000000..e4fa679 --- /dev/null +++ b/integration/spring_jpa/src/main/java/com/devonfw/examples/dataaccess/springjpa/general/domain/model/ApplicationPersistenceEntity.java @@ -0,0 +1,28 @@ +package com.devonfw.examples.dataaccess.springjpa.general.domain.model; + +import javax.persistence.GeneratedValue; +import javax.persistence.GenerationType; +import javax.persistence.Id; +import javax.persistence.MappedSuperclass; +import javax.persistence.Version; + +import lombok.Getter; +import lombok.Setter; + +/** + * Abstract Entity for all Entities with an id and a version field. + * + */ + +@Setter +@Getter +@MappedSuperclass +public abstract class ApplicationPersistenceEntity { + + @Id + @GeneratedValue(strategy = GenerationType.SEQUENCE) + private Long id; + + @Version + private Integer modificationCounter; +} \ No newline at end of file diff --git a/integration/spring_jpa/src/main/resources/application.properties b/integration/spring_jpa/src/main/resources/application.properties new file mode 100644 index 0000000..8ae5125 --- /dev/null +++ b/integration/spring_jpa/src/main/resources/application.properties @@ -0,0 +1,11 @@ +logging.level.org.hibernate.SQL=DEBUG +spring.jpa.show-sql=true +spring.jpa.properties.hibernate.format_sql=true +logging.level.org.hibernate.type=DEBUG + +logging.level.org.hibernate.type.descriptor.sql.BasicBinder=DEBUG + +# Flyway for Database Setup and Migrations +spring.flyway.enabled=true +spring.flyway.clean-on-validation-error=true +spring.flyway.locations=classpath:db/migration \ No newline at end of file diff --git a/integration/spring_jpa/src/main/resources/db/migration/V0001__R002_Create_schema.sql b/integration/spring_jpa/src/main/resources/db/migration/V0001__R002_Create_schema.sql new file mode 100644 index 0000000..45d28bb --- /dev/null +++ b/integration/spring_jpa/src/main/resources/db/migration/V0001__R002_Create_schema.sql @@ -0,0 +1,27 @@ +CREATE SEQUENCE HIBERNATE_SEQUENCE START WITH 100000; + + +CREATE TABLE Booking ( + id BIGINT NOT NULL AUTO_INCREMENT, + modification_counter INTEGER NOT NULL, + id_user BIGINT, + name VARCHAR (255) NOT NULL, + booking_token VARCHAR (255), + comment VARCHAR (4000), + email VARCHAR(255) NOT NULL, + booking_date TIMESTAMP NOT NULL, + expiration_date TIMESTAMP, + booking_status VARCHAR(1), + CONSTRAINT PK_Booking PRIMARY KEY(id) +); + +CREATE TABLE Invited_Guest ( + id BIGINT NOT NULL AUTO_INCREMENT, + modification_counter INTEGER NOT NULL, + id_booking BIGINT , + guest_token VARCHAR (255), + email VARCHAR (60), + accepted BOOLEAN, + CONSTRAINT PK_InvitedGuest PRIMARY KEY(id), + CONSTRAINT FK_InvitedGuest_idBooking FOREIGN KEY(id_booking) REFERENCES Booking(id) NOCHECK +); diff --git a/integration/spring_jpa/src/main/resources/db/migration/V0002__R002_Master_data.sql b/integration/spring_jpa/src/main/resources/db/migration/V0002__R002_Master_data.sql new file mode 100644 index 0000000..c9c3f80 --- /dev/null +++ b/integration/spring_jpa/src/main/resources/db/migration/V0002__R002_Master_data.sql @@ -0,0 +1,31 @@ +INSERT INTO booking( + id, modification_counter, id_user, + NAME, booking_token, comment, email, + booking_date, expiration_date, + booking_status +) +VALUES + ( + 0, 0, 0, + 'user0', 'CB_20170509_123502555Z', 'Booking Type CSR', 'user0@mail.com', + Dateadd('DAY', 5, CURRENT_TIMESTAMP), + Dateadd( + 'DAY', + 5, + Dateadd('HOUR', -1, CURRENT_TIMESTAMP) + ), + 'C' + ); +INSERT INTO Invited_Guest( + id, modification_counter, id_booking, + guest_token, email, accepted +) +VALUES + ( + 0, + 0, + 0, + 'GB_20170510_02350266501Z', + 'guest0@mail.com', + true + ); \ No newline at end of file diff --git a/integration/spring_jpa/src/test/java/com/devonfw/examples/dataaccess/springjpa/BookingRepositoryTest.java b/integration/spring_jpa/src/test/java/com/devonfw/examples/dataaccess/springjpa/BookingRepositoryTest.java new file mode 100644 index 0000000..947c71b --- /dev/null +++ b/integration/spring_jpa/src/test/java/com/devonfw/examples/dataaccess/springjpa/BookingRepositoryTest.java @@ -0,0 +1,111 @@ +package com.devonfw.examples.dataaccess.springjpa; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +import java.time.LocalDateTime; +import java.util.HashSet; +import java.util.List; +import java.util.Optional; +import java.util.Set; + +import javax.persistence.EntityManager; +import javax.persistence.PersistenceContext; +import javax.persistence.Query; +import javax.transaction.Transactional; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +import com.devonfw.examples.dataaccess.springjpa.domain.model.BookingEntity; +import com.devonfw.examples.dataaccess.springjpa.domain.model.BookingStatus; +import com.devonfw.examples.dataaccess.springjpa.domain.model.InvitedGuestEntity; +import com.devonfw.examples.dataaccess.springjpa.domain.repository.BookingRepository; + +/** + * Unit test prepared to test the following features: + * + * LocalDateTime - BookingDate is time.LocalDateTime instead of util.Date + * + * Enum (using converter) - BookingStatus is assigned BOOKED but + * the database stores only the code 'B'. To verify actual value (code) from the database, applying native + * query to retrieve row data. + * + * Lazy loading - Lazy loading verified by looking at queries applied against database from the logs. + * While applying findById executes query to fetch data from booking table not querying against invited + * guests. But when we verify `getInvitedGuests().size()` the invited guests query executes. + * + */ +@ExtendWith(SpringExtension.class) +@SpringBootTest +public class BookingRepositoryTest { + + @Autowired + private BookingRepository bookingRepository; + + @PersistenceContext + private EntityManager em; + + @Test + @Transactional + public void givenBooking_whenSave_thenGetOk() { + + // Booking + Invited Guests creation + BookingEntity newBooking = getBooking("booking1"); + BookingEntity booking = this.bookingRepository.save(newBooking); + + // Retrieving the booking: + Optional foundBooking = this.bookingRepository + .findById(booking.getId()); + if (foundBooking.isPresent()) { + booking = foundBooking.get(); + assertEquals(booking.getName(), newBooking.getName()); + assertEquals(booking.getBookingDate(), newBooking.getBookingDate()); + assertEquals(booking.getInvitedGuests().size(), 10); + } + + // Native query used here to get the exact Enum data from the DB. + + Query q = this.em.createNativeQuery( + "SELECT b.name,b.booking_status FROM Booking b where id=" + + booking.getId()); + List bookings = q.getResultList(); + assertEquals(bookings.size(), 1); + for (Object[] bookingObject : bookings) { + assertEquals(bookingObject[0], newBooking.getName()); + assertEquals(bookingObject[1], BookingStatus.BOOKED.getCode()); + } + + } + + private BookingEntity getBooking(String bookingName) { + + BookingEntity booking = new BookingEntity(); + booking.setName(bookingName); + booking.setBookingStatus(BookingStatus.BOOKED); + booking.setBookingDate(LocalDateTime.now()); + booking.setName(bookingName); + booking.setBookingToken("token"); + booking.setComment("comment"); + booking.setEmail(bookingName + "@gmail.com"); + booking.setInvitedGuests(getInvitedGuest(bookingName)); + return booking; + } + + private Set getInvitedGuest(String bookingName) { + + Set guests = new HashSet<>(); + for (int i = 0; i < 10; i++) { + InvitedGuestEntity guest = new InvitedGuestEntity(); + guest.setGuestToken( + String.format("%s-guest%stoken", bookingName, i)); + guest.setEmail( + String.format("%s.user%s@gmail.com", bookingName, i)); + guests.add(guest); + } + return guests; + } + +}