├── .gitignore ├── README.md ├── build.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat └── src ├── main ├── java │ └── com │ │ └── example │ │ └── demo │ │ ├── DemoApplication.java │ │ ├── InheritanceAwareMongoRepositoryFactory.java │ │ ├── InheritanceAwareMongoRepositoryFactoryBean.java │ │ ├── InheritanceAwarePartTreeMongoQuery.java │ │ ├── InheritanceAwareSimpleMongoRepository.java │ │ ├── MongoConfigurer.java │ │ ├── domain │ │ ├── Boat.java │ │ ├── Car.java │ │ └── Thing.java │ │ └── repository │ │ ├── BoatRepository.java │ │ ├── CarRepository.java │ │ └── ThingRepository.java └── resources │ └── application.properties └── test ├── java └── com │ └── example │ └── demo │ └── DemoApplicationTests.java └── resources └── application-test.properties /.gitignore: -------------------------------------------------------------------------------- 1 | .gradle 2 | /build/ 3 | !gradle/wrapper/gradle-wrapper.jar 4 | 5 | ### STS ### 6 | .apt_generated 7 | .classpath 8 | .factorypath 9 | .project 10 | .settings 11 | .springBeans 12 | 13 | ### IntelliJ IDEA ### 14 | .idea 15 | *.iws 16 | *.iml 17 | *.ipr 18 | 19 | ### NetBeans ### 20 | nbproject/private/ 21 | build/ 22 | nbbuild/ 23 | dist/ 24 | nbdist/ 25 | .nb-gradle/ -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # What is this? 2 | 3 | This repo is a very simple example of how inheritance support could be added to Spring Data for MongoDB. 4 | 5 | **Please note, this code only solves inheritance in my use-case!** This is why inheritance in general is not part of 6 | Spring Data for MongoDB as such. It is difficult to provide a solution that would work for all possible use-cases. 7 | 8 | ## My use-case 9 | 10 | These are the rules I followed in my code: 11 | 12 | * All entity classes for which a repository interface is to de declared have a ```@Document``` annotation. 13 | * All entity classes that share a common superclass **are stored in the same collection**. 14 | * The shared common superclasses are usually abstract classes. They don't have to be, but usually are. 15 | * To support inheritance, all subclasses (concrete classes) use ```@TypeAlias``` annotation to specify a specific 16 | marker used to identify class type once stored in the database. See below why I use that annotation! 17 | 18 | Following these rules, here is the functionality I was looking for: 19 | 20 | * Superclass repositories should work on all data within a collection. 21 | * Subclass repositories should only work on data that are of the subclass type - meaning that a condition involving 22 | the ```_class``` field should be automatically added to all queries before they reach MongoDB. 23 | 24 | The code in this repository showcases a simple implementation that achieves this. There is room for improvement, 25 | but this should be a nice starter for further experimentation. 26 | 27 | ## Why use @TypeAlias ? 28 | 29 | By default Spring Data for MongoDB will put a fully qualified class name into the ```_class``` field of the entity 30 | class (the field is added to the model automatically by Spring). This may seem fine, however if your code goes 31 | through any refactoring where package or class names change, you will be stuck with a lot of documents inside 32 | MongoDB with "legacy" class names. I don't really like that, so I always use the ```@TypeAlias``` annotation 33 | with some identifier that makes sense to me. This way any refactoring I do will not affect inheritance in any way. And 34 | I can also use a short identifier, because a full class name can get pretty lengthy sometimes. 35 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | buildscript { 2 | ext { 3 | springBootVersion = '2.0.0.RC1' 4 | } 5 | repositories { 6 | mavenCentral() 7 | maven { url "https://repo.spring.io/snapshot" } 8 | maven { url "https://repo.spring.io/milestone" } 9 | } 10 | dependencies { 11 | classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}") 12 | } 13 | } 14 | 15 | apply plugin: 'java' 16 | apply plugin: 'eclipse' 17 | apply plugin: 'org.springframework.boot' 18 | apply plugin: 'io.spring.dependency-management' 19 | 20 | group = 'com.example' 21 | version = '0.0.1-SNAPSHOT' 22 | sourceCompatibility = 1.8 23 | 24 | repositories { 25 | mavenCentral() 26 | maven { url "https://repo.spring.io/snapshot" } 27 | maven { url "https://repo.spring.io/milestone" } 28 | } 29 | 30 | 31 | dependencies { 32 | compile('org.springframework.boot:spring-boot-starter-data-mongodb') 33 | compile('com.google.guava:guava:24.0-jre') 34 | testCompile('org.springframework.boot:spring-boot-starter-test') 35 | testCompile('de.flapdoodle.embed:de.flapdoodle.embed.mongo:2.0.1') 36 | } 37 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mmaravich/spring-data-mongodb-inheritance-test/836b68f8278a8ed426ab0ffe26f43b34eb9c500e/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Fri Jul 28 13:37:07 BST 2017 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-4.2-bin.zip 7 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/DemoApplication.java: -------------------------------------------------------------------------------- 1 | package com.example.demo; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | 6 | @SpringBootApplication 7 | public class DemoApplication { 8 | 9 | public static void main(String[] args) { 10 | SpringApplication.run(DemoApplication.class, args); 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/InheritanceAwareMongoRepositoryFactory.java: -------------------------------------------------------------------------------- 1 | package com.example.demo; 2 | 3 | import java.lang.reflect.Method; 4 | import java.util.Optional; 5 | import org.springframework.data.mapping.context.MappingContext; 6 | import org.springframework.data.mongodb.core.MongoOperations; 7 | import org.springframework.data.mongodb.core.mapping.MongoPersistentEntity; 8 | import org.springframework.data.mongodb.core.mapping.MongoPersistentProperty; 9 | import org.springframework.data.mongodb.repository.query.MongoQueryMethod; 10 | import org.springframework.data.mongodb.repository.query.PartTreeMongoQuery; 11 | import org.springframework.data.mongodb.repository.query.StringBasedMongoQuery; 12 | import org.springframework.data.mongodb.repository.support.MongoRepositoryFactory; 13 | import org.springframework.data.projection.ProjectionFactory; 14 | import org.springframework.data.repository.core.NamedQueries; 15 | import org.springframework.data.repository.core.RepositoryMetadata; 16 | import org.springframework.data.repository.query.EvaluationContextProvider; 17 | import org.springframework.data.repository.query.QueryLookupStrategy; 18 | import org.springframework.data.repository.query.QueryLookupStrategy.Key; 19 | import org.springframework.data.repository.query.RepositoryQuery; 20 | import org.springframework.expression.spel.standard.SpelExpressionParser; 21 | import org.springframework.lang.Nullable; 22 | 23 | public class InheritanceAwareMongoRepositoryFactory extends MongoRepositoryFactory { 24 | 25 | private static final SpelExpressionParser EXPRESSION_PARSER = new SpelExpressionParser(); 26 | 27 | private final MongoOperations operations; 28 | 29 | /** 30 | * Creates a new {@link MongoRepositoryFactory} with the given {@link MongoOperations}. 31 | * 32 | * @param mongoOperations must not be {@literal null}. 33 | */ 34 | public InheritanceAwareMongoRepositoryFactory(MongoOperations mongoOperations) { 35 | super(mongoOperations); 36 | this.operations = mongoOperations; 37 | } 38 | 39 | /** 40 | * Switch to our MongoQueryLookupStrategy. 41 | */ 42 | @Override 43 | protected Optional getQueryLookupStrategy(@Nullable Key key, 44 | EvaluationContextProvider evaluationContextProvider) { 45 | return Optional.of(new MongoQueryLookupStrategy(operations, evaluationContextProvider, 46 | operations.getConverter().getMappingContext())); 47 | } 48 | 49 | /** 50 | * Taken from the Spring Data for MongoDB source code and modified to return InheritanceAwarePartTreeMongoQuery 51 | * instead of PartTreeMongoQuery. It's a static private part so copy/paste was the only way... 52 | */ 53 | private static class MongoQueryLookupStrategy implements QueryLookupStrategy { 54 | 55 | private final MongoOperations operations; 56 | private final EvaluationContextProvider evaluationContextProvider; 57 | MappingContext, MongoPersistentProperty> mappingContext; 58 | 59 | public MongoQueryLookupStrategy(MongoOperations operations, EvaluationContextProvider evaluationContextProvider, 60 | MappingContext, MongoPersistentProperty> mappingContext) { 61 | 62 | this.operations = operations; 63 | this.evaluationContextProvider = evaluationContextProvider; 64 | this.mappingContext = mappingContext; 65 | } 66 | 67 | @Override 68 | public RepositoryQuery resolveQuery(Method method, RepositoryMetadata metadata, ProjectionFactory factory, 69 | NamedQueries namedQueries) { 70 | 71 | MongoQueryMethod queryMethod = new MongoQueryMethod(method, metadata, factory, mappingContext); 72 | String namedQueryName = queryMethod.getNamedQueryName(); 73 | 74 | if (namedQueries.hasQuery(namedQueryName)) { 75 | String namedQuery = namedQueries.getQuery(namedQueryName); 76 | return new StringBasedMongoQuery(namedQuery, queryMethod, operations, EXPRESSION_PARSER, 77 | evaluationContextProvider); 78 | } else if (queryMethod.hasAnnotatedQuery()) { 79 | return new StringBasedMongoQuery(queryMethod, operations, EXPRESSION_PARSER, evaluationContextProvider); 80 | } else { 81 | return new InheritanceAwarePartTreeMongoQuery(queryMethod, operations); 82 | } 83 | } 84 | } 85 | } 86 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/InheritanceAwareMongoRepositoryFactoryBean.java: -------------------------------------------------------------------------------- 1 | package com.example.demo; 2 | 3 | import java.io.Serializable; 4 | import org.springframework.data.mongodb.core.MongoOperations; 5 | import org.springframework.data.mongodb.repository.support.MongoRepositoryFactoryBean; 6 | import org.springframework.data.repository.Repository; 7 | import org.springframework.data.repository.core.support.RepositoryFactorySupport; 8 | import org.springframework.data.repository.query.QueryLookupStrategy.Key; 9 | 10 | public class InheritanceAwareMongoRepositoryFactoryBean, S, ID extends Serializable> extends 11 | MongoRepositoryFactoryBean { 12 | 13 | public InheritanceAwareMongoRepositoryFactoryBean(Class repositoryInterface) { 14 | super(repositoryInterface); 15 | } 16 | 17 | 18 | @Override 19 | protected RepositoryFactorySupport getFactoryInstance(MongoOperations operations) { 20 | return new InheritanceAwareMongoRepositoryFactory(operations); 21 | } 22 | 23 | } 24 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/InheritanceAwarePartTreeMongoQuery.java: -------------------------------------------------------------------------------- 1 | package com.example.demo; 2 | 3 | import static org.springframework.data.mongodb.core.query.Criteria.where; 4 | 5 | import org.springframework.data.annotation.TypeAlias; 6 | import org.springframework.data.mongodb.core.MongoOperations; 7 | import org.springframework.data.mongodb.core.query.Criteria; 8 | import org.springframework.data.mongodb.core.query.Query; 9 | import org.springframework.data.mongodb.repository.query.ConvertingParameterAccessor; 10 | import org.springframework.data.mongodb.repository.query.MongoQueryMethod; 11 | import org.springframework.data.mongodb.repository.query.PartTreeMongoQuery; 12 | 13 | public class InheritanceAwarePartTreeMongoQuery extends PartTreeMongoQuery { 14 | 15 | private final Criteria inheritanceCriteria; 16 | 17 | public InheritanceAwarePartTreeMongoQuery(MongoQueryMethod method, MongoOperations mongoOperations) { 18 | super(method, mongoOperations); 19 | 20 | inheritanceCriteria = 21 | method.getEntityInformation().getJavaType().isAnnotationPresent(TypeAlias.class) 22 | ? where("_class") 23 | .is(method.getEntityInformation().getJavaType().getAnnotation(TypeAlias.class).value()) 24 | : null; 25 | } 26 | 27 | @Override 28 | protected Query createQuery(ConvertingParameterAccessor accessor) { 29 | Query query = super.createQuery(accessor); 30 | if (inheritanceCriteria != null) { 31 | query.addCriteria(inheritanceCriteria); 32 | } 33 | return query; 34 | } 35 | 36 | @Override 37 | protected Query createCountQuery(ConvertingParameterAccessor accessor) { 38 | Query query = super.createCountQuery(accessor); 39 | if (inheritanceCriteria != null) { 40 | query.addCriteria(inheritanceCriteria); 41 | } 42 | return query; 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/InheritanceAwareSimpleMongoRepository.java: -------------------------------------------------------------------------------- 1 | package com.example.demo; 2 | 3 | import static org.springframework.data.mongodb.core.query.Criteria.where; 4 | 5 | import java.io.Serializable; 6 | import java.util.List; 7 | import org.bson.Document; 8 | import org.springframework.data.annotation.TypeAlias; 9 | import org.springframework.data.mongodb.core.MongoOperations; 10 | import org.springframework.data.mongodb.core.query.Criteria; 11 | import org.springframework.data.mongodb.core.query.Query; 12 | import org.springframework.data.mongodb.repository.query.MongoEntityInformation; 13 | import org.springframework.data.mongodb.repository.support.SimpleMongoRepository; 14 | 15 | public class InheritanceAwareSimpleMongoRepository extends SimpleMongoRepository { 16 | 17 | private final MongoOperations mongoOperations; 18 | private final MongoEntityInformation entityInformation; 19 | private final Document classCriteriaDocument; 20 | private final Criteria classCriteria; 21 | 22 | public InheritanceAwareSimpleMongoRepository(MongoEntityInformation metadata, 23 | MongoOperations mongoOperations) { 24 | super(metadata, mongoOperations); 25 | this.mongoOperations = mongoOperations; 26 | this.entityInformation = metadata; 27 | 28 | if (entityInformation.getJavaType().isAnnotationPresent(TypeAlias.class)) { 29 | classCriteria = where("_class").is(entityInformation.getJavaType().getAnnotation(TypeAlias.class).value()); 30 | classCriteriaDocument = classCriteria.getCriteriaObject(); 31 | } else { 32 | classCriteriaDocument = new Document(); 33 | classCriteria = null; 34 | } 35 | } 36 | 37 | @Override 38 | public long count() { 39 | return classCriteria != null ? mongoOperations.getCollection( 40 | entityInformation.getCollectionName()).count( 41 | classCriteriaDocument) 42 | : super.count(); 43 | } 44 | 45 | @Override 46 | public List findAll() { 47 | return classCriteria != null ? mongoOperations.find(new Query().addCriteria(classCriteria), 48 | entityInformation.getJavaType(), 49 | entityInformation.getCollectionName()) 50 | : super.findAll(); 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/MongoConfigurer.java: -------------------------------------------------------------------------------- 1 | package com.example.demo; 2 | 3 | import org.springframework.context.annotation.Configuration; 4 | import org.springframework.data.mongodb.repository.config.EnableMongoRepositories; 5 | 6 | @Configuration 7 | @EnableMongoRepositories(repositoryBaseClass = InheritanceAwareSimpleMongoRepository.class, 8 | repositoryFactoryBeanClass = InheritanceAwareMongoRepositoryFactoryBean.class) 9 | public class MongoConfigurer { 10 | 11 | } 12 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/domain/Boat.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.domain; 2 | 3 | import org.springframework.data.annotation.TypeAlias; 4 | import org.springframework.data.mongodb.core.mapping.Document; 5 | 6 | @Document(collection = "things") 7 | @TypeAlias("boat") 8 | public class Boat extends Thing { 9 | 10 | private Integer length; 11 | 12 | public Integer getLength() { 13 | return length; 14 | } 15 | 16 | public void setLength(Integer length) { 17 | this.length = length; 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/domain/Car.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.domain; 2 | 3 | import org.springframework.data.annotation.TypeAlias; 4 | import org.springframework.data.mongodb.core.mapping.Document; 5 | 6 | @Document(collection = "things") 7 | @TypeAlias("car") 8 | public class Car extends Thing { 9 | 10 | private String model; 11 | 12 | public String getModel() { 13 | return model; 14 | } 15 | 16 | public void setModel(String model) { 17 | this.model = model; 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/domain/Thing.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.domain; 2 | 3 | import org.springframework.data.annotation.Id; 4 | import org.springframework.data.mongodb.core.mapping.Document; 5 | 6 | @Document(collection = "things") 7 | public abstract class Thing { 8 | 9 | @Id 10 | private String id; 11 | 12 | private String name; 13 | 14 | public String getId() { 15 | return id; 16 | } 17 | 18 | public void setId(String id) { 19 | this.id = id; 20 | } 21 | 22 | public String getName() { 23 | return name; 24 | } 25 | 26 | public void setName(String name) { 27 | this.name = name; 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/repository/BoatRepository.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.repository; 2 | 3 | import com.example.demo.domain.Boat; 4 | import org.springframework.data.repository.CrudRepository; 5 | 6 | public interface BoatRepository extends CrudRepository { 7 | 8 | } 9 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/repository/CarRepository.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.repository; 2 | 3 | import com.example.demo.domain.Car; 4 | import java.util.List; 5 | import org.springframework.data.repository.CrudRepository; 6 | 7 | public interface CarRepository extends CrudRepository { 8 | 9 | List findCarsByIdNotNull(); 10 | 11 | long countCarsByIdNotNull(); 12 | 13 | } 14 | -------------------------------------------------------------------------------- /src/main/java/com/example/demo/repository/ThingRepository.java: -------------------------------------------------------------------------------- 1 | package com.example.demo.repository; 2 | 3 | import com.example.demo.domain.Thing; 4 | import org.springframework.data.repository.CrudRepository; 5 | 6 | public interface ThingRepository extends CrudRepository { 7 | 8 | } 9 | -------------------------------------------------------------------------------- /src/main/resources/application.properties: -------------------------------------------------------------------------------- 1 | spring.data.mongodb.database=test 2 | logging.level.org.springframework.data=TRACE 3 | 4 | -------------------------------------------------------------------------------- /src/test/java/com/example/demo/DemoApplicationTests.java: -------------------------------------------------------------------------------- 1 | package com.example.demo; 2 | 3 | import static org.assertj.core.api.Assertions.assertThat; 4 | 5 | import com.example.demo.domain.Boat; 6 | import com.example.demo.domain.Car; 7 | import com.example.demo.repository.BoatRepository; 8 | import com.example.demo.repository.CarRepository; 9 | import com.example.demo.repository.ThingRepository; 10 | import com.google.common.collect.Lists; 11 | import org.assertj.core.api.Assertions; 12 | import org.junit.Test; 13 | import org.junit.runner.RunWith; 14 | import org.slf4j.Logger; 15 | import org.slf4j.LoggerFactory; 16 | import org.springframework.beans.factory.annotation.Autowired; 17 | import org.springframework.boot.test.context.SpringBootTest; 18 | import org.springframework.test.context.ActiveProfiles; 19 | import org.springframework.test.context.junit4.SpringRunner; 20 | 21 | @RunWith(SpringRunner.class) 22 | @SpringBootTest 23 | @ActiveProfiles("test") 24 | public class DemoApplicationTests { 25 | 26 | @Autowired 27 | private ThingRepository thingRepository; 28 | 29 | @Autowired 30 | private CarRepository carRepository; 31 | 32 | @Autowired 33 | private BoatRepository boatRepository; 34 | 35 | @Test 36 | public void checkInheritanceAwareStuff() { 37 | Car honda = new Car(); 38 | honda.setModel("Honda Civic"); 39 | honda.setName("A Car"); 40 | carRepository.save(honda); 41 | 42 | Boat enterprise = new Boat(); 43 | enterprise.setLength(10); 44 | enterprise.setName("A Boat"); 45 | boatRepository.save(enterprise); 46 | 47 | // We should have 2 things in the collection 48 | assertThat(thingRepository.count()).isEqualTo(2); 49 | 50 | // But only one of each specific types of things 51 | assertThat(carRepository.count()).isEqualTo(1); 52 | assertThat(boatRepository.count()).isEqualTo(1); 53 | 54 | // And the generated queries should work correctly as well 55 | assertThat(carRepository.findCarsByIdNotNull().size()).isEqualTo(1); 56 | assertThat(carRepository.countCarsByIdNotNull()).isEqualTo(1); 57 | } 58 | 59 | } 60 | 61 | -------------------------------------------------------------------------------- /src/test/resources/application-test.properties: -------------------------------------------------------------------------------- 1 | # dummy 2 | --------------------------------------------------------------------------------