diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml index 6be701032a..44832c6fca 100644 --- a/.github/workflows/examples.yml +++ b/.github/workflows/examples.yml @@ -79,7 +79,10 @@ jobs: || ([[ $? -eq 124 ]] && echo "Timeout reached, but that's OK") - name: Write-behind (rxjava) working-directory: examples/write-behind-rxjava - run: mvn test + run: ./mvnw test - name: Coalescing Bulkloader working-directory: examples/coalescing-bulkloader - run: mvn test + run: ./mvnw test + - name: Hibernate JCache + working-directory: examples/hibernate + run: ./gradlew build diff --git a/examples/hibernate/build.gradle b/examples/hibernate/build.gradle new file mode 100644 index 0000000000..fbc4f64b05 --- /dev/null +++ b/examples/hibernate/build.gradle @@ -0,0 +1,18 @@ +plugins { + id 'java-library' + alias libs.plugins.versions +} + +dependencies { + implementation libs.bundles.hibernate + implementation libs.caffeine + implementation libs.slf4j + runtimeOnly libs.h2 + + testImplementation libs.junit + testImplementation libs.truth +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/examples/hibernate/gradle/libs.versions.toml b/examples/hibernate/gradle/libs.versions.toml new file mode 100644 index 0000000000..99d5e8c6ac --- /dev/null +++ b/examples/hibernate/gradle/libs.versions.toml @@ -0,0 +1,24 @@ +[versions] +caffeine = "3.1.4" +h2 = "2.1.214" +hibernate = "6.2.0.CR3" +junit = "5.9.2" +slf4j = "2.0.6" +truth = "1.1.3" +versions = "0.46.0" + +[libraries] +caffeine = { module = "com.github.ben-manes.caffeine:jcache", version.ref = "caffeine" } +h2 = { module = "com.h2database:h2", version.ref = "h2" } +hibernate-core = { module = "org.hibernate.orm:hibernate-core", version.ref = "hibernate" } +hibernate-jcache = { module = "org.hibernate.orm:hibernate-jcache", version.ref = "hibernate" } +hibernate-hikaricp = { module = "org.hibernate.orm:hibernate-hikaricp", version.ref = "hibernate" } +junit = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit" } +slf4j = { module = "org.slf4j:slf4j-jdk14", version.ref = "slf4j" } +truth = { module = "com.google.truth:truth", version.ref = "truth" } + +[bundles] +hibernate = ["hibernate-core", "hibernate-jcache", "hibernate-hikaricp"] + +[plugins] +versions = { id = "com.github.ben-manes.versions", version.ref = "versions" } diff --git a/examples/hibernate/gradle/wrapper/gradle-wrapper.jar b/examples/hibernate/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000000..ccebba7710 Binary files /dev/null and b/examples/hibernate/gradle/wrapper/gradle-wrapper.jar differ diff --git a/examples/hibernate/gradle/wrapper/gradle-wrapper.properties b/examples/hibernate/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000000..bdc9a83b1e --- /dev/null +++ b/examples/hibernate/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.2-bin.zip +networkTimeout=10000 +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/examples/hibernate/gradlew b/examples/hibernate/gradlew new file mode 100755 index 0000000000..79a61d421c --- /dev/null +++ b/examples/hibernate/gradlew @@ -0,0 +1,244 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed 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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +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 + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/examples/hibernate/gradlew.bat b/examples/hibernate/gradlew.bat new file mode 100644 index 0000000000..93e3f59f13 --- /dev/null +++ b/examples/hibernate/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem 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, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/examples/hibernate/settings.gradle b/examples/hibernate/settings.gradle new file mode 100644 index 0000000000..ce1ea86928 --- /dev/null +++ b/examples/hibernate/settings.gradle @@ -0,0 +1,7 @@ +rootProject.name = 'hibernate' + +dependencyResolutionManagement { + repositories { + mavenCentral() + } +} diff --git a/examples/hibernate/src/main/java/com/github/benmanes/caffeine/examples/hibernate/Project.java b/examples/hibernate/src/main/java/com/github/benmanes/caffeine/examples/hibernate/Project.java new file mode 100644 index 0000000000..dddb42164f --- /dev/null +++ b/examples/hibernate/src/main/java/com/github/benmanes/caffeine/examples/hibernate/Project.java @@ -0,0 +1,67 @@ +/* + * Copyright 2023 Ben Manes. All Rights Reserved. + * + * Licensed 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 + * + * http://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. + */ +package com.github.benmanes.caffeine.examples.hibernate; + +import static jakarta.persistence.AccessType.FIELD; +import static org.hibernate.annotations.CacheConcurrencyStrategy.READ_WRITE; + +import org.hibernate.annotations.Cache; + +import jakarta.persistence.Access; +import jakarta.persistence.Cacheable; +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.Id; +import jakarta.persistence.ManyToOne; + +/** + * @author ben.manes@gmail.com (Ben Manes) + */ +@Entity +@Cacheable +@Access(FIELD) +@Cache(usage = READ_WRITE) +public class Project { + + @Id + @GeneratedValue + private long id; + + private String name; + + @ManyToOne + private User assignee; + + public long getId() { + return id; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public User getAssignee() { + return assignee; + } + + public void setAssignee(User assignee) { + this.assignee = assignee; + } +} diff --git a/examples/hibernate/src/main/java/com/github/benmanes/caffeine/examples/hibernate/Repository.java b/examples/hibernate/src/main/java/com/github/benmanes/caffeine/examples/hibernate/Repository.java new file mode 100644 index 0000000000..ebca68f4a5 --- /dev/null +++ b/examples/hibernate/src/main/java/com/github/benmanes/caffeine/examples/hibernate/Repository.java @@ -0,0 +1,87 @@ +/* + * Copyright 2023 Ben Manes. All Rights Reserved. + * + * Licensed 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 + * + * http://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. + */ +package com.github.benmanes.caffeine.examples.hibernate; + +import static java.util.Objects.requireNonNull; + +import java.util.List; + +import org.hibernate.SessionFactory; + +/** + * @author ben.manes@gmail.com (Ben Manes) + */ +public final class Repository { + private final SessionFactory sessionFactory; + + public Repository(SessionFactory sessionFactory) { + this.sessionFactory = requireNonNull(sessionFactory); + } + + public Project getProject(long id) { + try (var session = sessionFactory.openSession()) { + return session.get(Project.class, id); + } + } + + public User getUser(long id) { + try (var session = sessionFactory.openSession()) { + return session.get(User.class, id); + } + } + + public Project findProject(long id) { + try (var session = sessionFactory.openSession()) { + var query = session.createQuery("FROM Project WHERE id = :id", Project.class); + query.setParameter("id", id); + return query.uniqueResult(); + } + } + + public List findProjects() { + try (var session = sessionFactory.openSession()) { + return session.createQuery("FROM Project", Project.class).list(); + } + } + + public void updateProject(long id, String name) { + try (var session = sessionFactory.openSession()) { + var txn = session.beginTransaction(); + var project = session.get(Project.class, id); + project.setName(name); + session.merge(project); + txn.commit(); + } + } + + public void persist(Project project, User user, Skill skill) { + try (var session = sessionFactory.openSession()) { + var txn = session.beginTransaction(); + session.persist(project); + session.persist(skill); + session.persist(user); + txn.commit(); + } + } + + public void evictProject(long projectId) { + sessionFactory.getCache().evictEntityData(Project.class, projectId); + } + + public void evictAll() { + sessionFactory.getCache().evictDefaultQueryRegion(); + } +} diff --git a/examples/hibernate/src/main/java/com/github/benmanes/caffeine/examples/hibernate/Skill.java b/examples/hibernate/src/main/java/com/github/benmanes/caffeine/examples/hibernate/Skill.java new file mode 100644 index 0000000000..4ca78ad19b --- /dev/null +++ b/examples/hibernate/src/main/java/com/github/benmanes/caffeine/examples/hibernate/Skill.java @@ -0,0 +1,50 @@ +/* + * Copyright 2023 Ben Manes. All Rights Reserved. + * + * Licensed 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 + * + * http://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. + */ +package com.github.benmanes.caffeine.examples.hibernate; + +import static jakarta.persistence.AccessType.FIELD; +import static org.hibernate.annotations.CacheConcurrencyStrategy.READ_WRITE; + +import org.hibernate.annotations.Cache; + +import jakarta.persistence.Access; +import jakarta.persistence.Cacheable; +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.Id; + +/** + * @author ben.manes@gmail.com (Ben Manes) + */ +@Entity +@Cacheable +@Access(FIELD) +@Cache(usage = READ_WRITE) +public class Skill { + @Id + @GeneratedValue + private int id; + + private String name; + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } +} diff --git a/examples/hibernate/src/main/java/com/github/benmanes/caffeine/examples/hibernate/User.java b/examples/hibernate/src/main/java/com/github/benmanes/caffeine/examples/hibernate/User.java new file mode 100644 index 0000000000..268f873f87 --- /dev/null +++ b/examples/hibernate/src/main/java/com/github/benmanes/caffeine/examples/hibernate/User.java @@ -0,0 +1,85 @@ +/* + * Copyright 2023 Ben Manes. All Rights Reserved. + * + * Licensed 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 + * + * http://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. + */ +package com.github.benmanes.caffeine.examples.hibernate; + +import static jakarta.persistence.AccessType.FIELD; +import static org.hibernate.annotations.CacheConcurrencyStrategy.READ_WRITE; + +import java.util.ArrayList; +import java.util.List; + +import org.hibernate.annotations.Cache; + +import jakarta.persistence.Access; +import jakarta.persistence.Cacheable; +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.Id; +import jakarta.persistence.ManyToMany; +import jakarta.persistence.OneToMany; + +/** + * @author ben.manes@gmail.com (Ben Manes) + */ +@Entity +@Cacheable +@Access(FIELD) +@Cache(usage = READ_WRITE) +public class User { + @Id + @GeneratedValue + private long id; + + private String name; + + @OneToMany(mappedBy = "assignee") + private List projects = new ArrayList(); + + @ManyToMany + private List skills = new ArrayList(); + + public long getId() { + return id; + } + + public void setId(long id) { + this.id = id; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public List getProjects() { + return projects; + } + + public void setProjects(List projects) { + this.projects = projects; + } + + public List getSkills() { + return skills; + } + + public void setSkills(List skills) { + this.skills = skills; + } +} diff --git a/examples/hibernate/src/main/resources/application.conf b/examples/hibernate/src/main/resources/application.conf new file mode 100644 index 0000000000..2a26d770f1 --- /dev/null +++ b/examples/hibernate/src/main/resources/application.conf @@ -0,0 +1,14 @@ +caffeine.jcache { + default { + policy.maximum.size = 500 + } + + # Hibernate framework caches + default-query-results-region {} + default-update-timestamps-region {} + + # Hibernate application caches + com.github.benmanes.caffeine.examples.hibernate.User {} + com.github.benmanes.caffeine.examples.hibernate.Skill {} + com.github.benmanes.caffeine.examples.hibernate.Project {} +} diff --git a/examples/hibernate/src/main/resources/hibernate.properties b/examples/hibernate/src/main/resources/hibernate.properties new file mode 100644 index 0000000000..a2f35caee9 --- /dev/null +++ b/examples/hibernate/src/main/resources/hibernate.properties @@ -0,0 +1,22 @@ +hibernate.dialect=org.hibernate.dialect.H2Dialect + +hibernate.connection.provider_class=org.hibernate.hikaricp.internal.HikariCPConnectionProvider +hibernate.connection.driver_class=org.h2.Driver +hibernate.connection.url=jdbc:h2:mem:test +hibernate.connection.username=sa + +hibernate.show_sql=false +hibernate.format_sql=true +hibernate.globally_quoted_identifiers=true + +hibernate.hbm2ddl.auto=create-drop + +hibernate.cache.use_query_cache=true +hibernate.cache.use_second_level_cache=true +hibernate.cache.region.factory_class=jcache +hibernate.javax.cache.provider=com.github.benmanes.caffeine.jcache.spi.CaffeineCachingProvider + +# Specify a custom configuration file if there is a name conflict with the defaults +#hibernate.javax.cache.uri=application.conf + +hibernate.generate_statistics=true diff --git a/examples/hibernate/src/test/java/com/github/benmanes/caffeine/examples/hibernate/HibernateCacheTest.java b/examples/hibernate/src/test/java/com/github/benmanes/caffeine/examples/hibernate/HibernateCacheTest.java new file mode 100644 index 0000000000..23f0849c98 --- /dev/null +++ b/examples/hibernate/src/test/java/com/github/benmanes/caffeine/examples/hibernate/HibernateCacheTest.java @@ -0,0 +1,143 @@ +/* + * Copyright 2023 Ben Manes. All Rights Reserved. + * + * Licensed 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 + * + * http://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. + */ +package com.github.benmanes.caffeine.examples.hibernate; + +import static com.github.benmanes.caffeine.examples.hibernate.HibernateSubject.assertThat; + +import java.util.logging.Level; +import java.util.logging.Logger; + +import org.hibernate.SessionFactory; +import org.hibernate.boot.registry.StandardServiceRegistryBuilder; +import org.hibernate.cfg.Configuration; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +/** + * @author ben.manes@gmail.com (Ben Manes) + */ +public final class HibernateCacheTest { + SessionFactory sessionFactory; + Repository repository; + + @BeforeEach + public void beforeEach() { + Logger.getLogger("").setLevel(Level.WARNING); + sessionFactory = new Configuration().addAnnotatedClass(User.class) + .addAnnotatedClass(Skill.class).addAnnotatedClass(Project.class) + .buildSessionFactory(new StandardServiceRegistryBuilder().build()); + repository = new Repository(sessionFactory); + } + + @AfterEach + public void afterEach() { + sessionFactory.close(); + } + + @Test + public void lookup() { + long projectId = createData("Ben", "Caffeine", "Hibernate"); + + // db hit + Project project = repository.getProject(projectId); + + // cache hit + project = repository.getProject(projectId); + assertThat(sessionFactory).hits(4).misses(0).puts(3); + + // cache hit due to project associations + repository.getUser(project.getAssignee().getId()); + assertThat(sessionFactory).hits(5).misses(0).puts(3); + + // cache hit due to only the project being explicitly evicted + repository.evictProject(projectId); + repository.getUser(project.getAssignee().getId()); + assertThat(sessionFactory).hits(6).misses(0).puts(3); + + // db hit + project = repository.getProject(projectId); + assertThat(sessionFactory).hits(6).misses(1).puts(4); + } + + @Test + public void query() { + long projectId = createData("Ben", "Caffeine", "Hibernate"); + + // db hit + repository.findProject(projectId); + assertThat(sessionFactory).hits(1).misses(0).puts(3); + + // cache hit + repository.findProject(projectId); + assertThat(sessionFactory).hits(2).misses(0).puts(3); + + // db hit + repository.findProjects(); + assertThat(sessionFactory).hits(3).misses(0).puts(3); + + // cache hit + repository.findProjects(); + assertThat(sessionFactory).hits(4).misses(0).puts(3); + + // db hit + repository.evictAll(); + repository.findProject(projectId); + assertThat(sessionFactory).hits(5).misses(0).puts(3); + + // query cache hit + repository.findProject(projectId); + assertThat(sessionFactory).hits(6).misses(0).puts(3); + + // db hit + repository.findProjects(); + assertThat(sessionFactory).hits(7).misses(0).puts(3); + + // cache hit + repository.findProjects(); + assertThat(sessionFactory).hits(8).misses(0).puts(3); + + // automatically evicts project-related queries in the cache + repository.updateProject(projectId, "Updated"); + assertThat(sessionFactory).hits(10).misses(0).puts(4); + + // db hit + repository.findProject(projectId); + assertThat(sessionFactory).hits(11).misses(0).puts(4); + + // db hit + repository.findProjects(); + assertThat(sessionFactory).hits(12).misses(0).puts(4); + } + + private long createData(String userName, String projectName, String skillName) { + var project = new Project(); + var skill = new Skill(); + var user = new User(); + + user.setName(userName); + user.getSkills().add(skill); + user.getProjects().add(project); + + project.setName(projectName); + project.setAssignee(user); + + skill.setName(skillName); + + repository.persist(project, user, skill); + return project.getId(); + } +} diff --git a/examples/hibernate/src/test/java/com/github/benmanes/caffeine/examples/hibernate/HibernateSubject.java b/examples/hibernate/src/test/java/com/github/benmanes/caffeine/examples/hibernate/HibernateSubject.java new file mode 100644 index 0000000000..fd7e7c4bcb --- /dev/null +++ b/examples/hibernate/src/test/java/com/github/benmanes/caffeine/examples/hibernate/HibernateSubject.java @@ -0,0 +1,59 @@ +/* + * Copyright 2023 Ben Manes. All Rights Reserved. + * + * Licensed 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 + * + * http://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. + */ +package com.github.benmanes.caffeine.examples.hibernate; + +import static com.google.common.truth.Truth.assertAbout; + +import org.hibernate.SessionFactory; + +import com.google.common.truth.FailureMetadata; +import com.google.common.truth.Subject; + +/** + * Propositions for {@link SessionFactory}. + * + * @author ben.manes@gmail.com (Ben Manes) + */ +public final class HibernateSubject extends Subject { + private final SessionFactory actual; + + private HibernateSubject(FailureMetadata metadata, SessionFactory sessionFactory) { + super(metadata, sessionFactory); + this.actual = sessionFactory; + } + + public static HibernateSubject assertThat(SessionFactory actual) { + return assertAbout(HibernateSubject::new).that(actual); + } + + public HibernateSubject hits(int hitCount) { + check("hits").that(actual.getStatistics() + .getSecondLevelCacheHitCount()).isEqualTo(hitCount); + return this; + } + + public HibernateSubject misses(int missCount) { + check("misses").that(actual.getStatistics() + .getSecondLevelCacheMissCount()).isEqualTo(missCount); + return this; + } + + public HibernateSubject puts(int putCount) { + check("puts").that(actual.getStatistics() + .getSecondLevelCachePutCount()).isEqualTo(putCount); + return this; + } +} diff --git a/jcache/src/main/java/com/github/benmanes/caffeine/jcache/configuration/TypesafeConfigurator.java b/jcache/src/main/java/com/github/benmanes/caffeine/jcache/configuration/TypesafeConfigurator.java index 4538f33aec..7de379c66d 100644 --- a/jcache/src/main/java/com/github/benmanes/caffeine/jcache/configuration/TypesafeConfigurator.java +++ b/jcache/src/main/java/com/github/benmanes/caffeine/jcache/configuration/TypesafeConfigurator.java @@ -160,9 +160,13 @@ private static Config resolveConfig(URI uri, ClassLoader classloader) { requireNonNull(classloader); var options = ConfigParseOptions.defaults().setAllowMissing(false); if ((uri.getScheme() != null) && uri.getScheme().equalsIgnoreCase("file")) { - return ConfigFactory.parseFile(new File(uri), options); + return ConfigFactory.defaultOverrides(classloader) + .withFallback(ConfigFactory.parseFile(new File(uri), options)) + .withFallback(ConfigFactory.defaultReferenceUnresolved(classloader)); } else if (isResource(uri)) { - return ConfigFactory.parseResources(uri.getSchemeSpecificPart(), options); + return ConfigFactory.defaultOverrides(classloader) + .withFallback(ConfigFactory.parseResources(uri.getSchemeSpecificPart(), options)) + .withFallback(ConfigFactory.defaultReferenceUnresolved(classloader)); } return ConfigFactory.load(classloader); } diff --git a/jcache/src/test/java/com/github/benmanes/caffeine/jcache/configuration/TypesafeConfigurationTest.java b/jcache/src/test/java/com/github/benmanes/caffeine/jcache/configuration/TypesafeConfigurationTest.java index 864e769e46..19b3aae802 100644 --- a/jcache/src/test/java/com/github/benmanes/caffeine/jcache/configuration/TypesafeConfigurationTest.java +++ b/jcache/src/test/java/com/github/benmanes/caffeine/jcache/configuration/TypesafeConfigurationTest.java @@ -84,15 +84,21 @@ public void configSource_load() { .isSameInstanceAs(ConfigFactory.load()); assertThat(configSource().get(URI.create("rmi:/abc"), classloader)) .isSameInstanceAs(ConfigFactory.load()); + assertThat(ConfigFactory.load().hasPath("caffeine.jcache.default.key-type")).isTrue(); + assertThat(ConfigFactory.load().hasPath("caffeine.jcache.test-cache")).isTrue(); } @Test public void configSource_classpath_present() { var inferred = configSource().get(URI.create("custom.properties"), classloader); assertThat(inferred.getInt("caffeine.jcache.classpath.policy.maximum.size")).isEqualTo(500); + assertThat(inferred.hasPath("caffeine.jcache.default.key-type")).isTrue(); + assertThat(inferred.hasPath("caffeine.jcache.test-cache")).isFalse(); var explicit = configSource().get(URI.create("classpath:custom.properties"), classloader); assertThat(explicit.getInt("caffeine.jcache.classpath.policy.maximum.size")).isEqualTo(500); + assertThat(explicit.hasPath("caffeine.jcache.default.key-type")).isTrue(); + assertThat(explicit.hasPath("caffeine.jcache.test-cache")).isFalse(); } @Test @@ -114,6 +120,8 @@ public void configSource_file() throws URISyntaxException { var config = configSource().get( getClass().getResource("/custom.properties").toURI(), classloader); assertThat(config.getInt("caffeine.jcache.classpath.policy.maximum.size")).isEqualTo(500); + assertThat(config.hasPath("caffeine.jcache.default.key-type")).isTrue(); + assertThat(config.hasPath("caffeine.jcache.test-cache")).isFalse(); } @Test