GitHub-Spring
/
spring-data-mongodb
mirror of https://github.com/spring-projects/spring-data-mongodb.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Polishing. 

Consistently use entity.isIdProperty(…) to determine whether a property is the identifier.

Original pull request: #4878
See #4877
pull/4888/head
Mark Paluch 11 months ago
parent
0beff08000
commit
e403985c16
No known key found for this signature in database
GPG Key ID: 55BC6374BAA9D973
7 changed files with 44 additions and 42 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 2
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MappingMongoJsonSchemaCreator.java
  2. 10
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/MappingMongoConverter.java
  3. 10
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/QueryMapper.java
  4. 2
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/BasicMongoPersistentProperty.java
  5. 12
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/support/SpringDataMongodbSerializer.java
  6. 20
      spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/mapping/BasicMongoPersistentPropertyUnitTests.java
  7. 30
      spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/support/SpringDataMongodbSerializerUnitTests.java

2
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MappingMongoJsonSchemaCreator.java
Unescape View File

@ -348,7 +348,7 @@ class MappingMongoJsonSchemaCreator implements MongoJsonSchemaCreator {
return property.getType(); return property.getType();
} }
if (!mongoProperty.isIdProperty()) { if (!property.getOwner().isIdProperty(property)) {
return mongoProperty.getFieldType(); return mongoProperty.getFieldType();
} }

10
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/MappingMongoConverter.java
Unescape View File

@ -28,7 +28,6 @@ import java.util.Map;
import java.util.Optional; import java.util.Optional;
import java.util.Set; import java.util.Set;
import java.util.function.BiPredicate; import java.util.function.BiPredicate;
import java.util.function.Predicate;
import java.util.stream.Collectors; import java.util.stream.Collectors;
import org.apache.commons.logging.Log; import org.apache.commons.logging.Log;
@ -61,7 +60,6 @@ import org.springframework.data.mapping.Association;
import org.springframework.data.mapping.InstanceCreatorMetadata; import org.springframework.data.mapping.InstanceCreatorMetadata;
import org.springframework.data.mapping.MappingException; import org.springframework.data.mapping.MappingException;
import org.springframework.data.mapping.Parameter; import org.springframework.data.mapping.Parameter;
import org.springframework.data.mapping.PersistentEntity;
import org.springframework.data.mapping.PersistentProperty; import org.springframework.data.mapping.PersistentProperty;
import org.springframework.data.mapping.PersistentPropertyAccessor; import org.springframework.data.mapping.PersistentPropertyAccessor;
import org.springframework.data.mapping.callback.EntityCallbacks; import org.springframework.data.mapping.callback.EntityCallbacks;
@ -1929,14 +1927,6 @@ public class MappingMongoConverter extends AbstractMongoConverter
return result.iterator().next(); return result.iterator().next();
} }
static Predicate<MongoPersistentProperty> isIdentifier(PersistentEntity<?, ?> entity) {
return entity::isIdProperty;
}
static Predicate<MongoPersistentProperty> isConstructorArgument(PersistentEntity<?, ?> entity) {
return entity::isCreatorArgument;
}
/** /**
* {@link PropertyValueProvider} to evaluate a SpEL expression if present on the property or simply accesses the field * {@link PropertyValueProvider} to evaluate a SpEL expression if present on the property or simply accesses the field
* of the configured source {@link Document}. * of the configured source {@link Document}.

10
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/QueryMapper.java
Unescape View File

@ -487,7 +487,8 @@ public class QueryMapper {
} }
private boolean isIdField(Field documentField) { private boolean isIdField(Field documentField) {
return documentField.getProperty() != null && documentField.getProperty().isIdProperty(); return documentField.getProperty() != null
&& documentField.getProperty().getOwner().isIdProperty(documentField.getProperty());
} }
private Class<?> getIdTypeForField(Field documentField) { private Class<?> getIdTypeForField(Field documentField) {
@ -635,7 +636,8 @@ public class QueryMapper {
if (source instanceof DBRef ref) { if (source instanceof DBRef ref) {
Object id = convertId(ref.getId(), property.isIdProperty() ? property.getFieldType() : ObjectId.class); Object id = convertId(ref.getId(),
property.getOwner().isIdProperty(property) ? property.getFieldType() : ObjectId.class);
if (StringUtils.hasText(ref.getDatabaseName())) { if (StringUtils.hasText(ref.getDatabaseName())) {
return new DBRef(ref.getDatabaseName(), ref.getCollectionName(), id); return new DBRef(ref.getDatabaseName(), ref.getCollectionName(), id);
@ -1187,7 +1189,7 @@ public class QueryMapper {
public boolean isIdField() { public boolean isIdField() {
if (property != null) { if (property != null) {
return property.isIdProperty(); return property.getOwner().isIdProperty(property);
} }
MongoPersistentProperty idProperty = entity.getIdProperty(); MongoPersistentProperty idProperty = entity.getIdProperty();
@ -1317,7 +1319,7 @@ public class QueryMapper {
continue; continue;
} }
if (associationDetected && !property.isIdProperty()) { if (associationDetected && !property.getOwner().isIdProperty(property)) {
throw new MappingException(String.format(INVALID_ASSOCIATION_REFERENCE, pathExpression)); throw new MappingException(String.format(INVALID_ASSOCIATION_REFERENCE, pathExpression));
} }
} }

2
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/BasicMongoPersistentProperty.java
Unescape View File

@ -117,7 +117,7 @@ public class BasicMongoPersistentProperty extends AnnotationBasedPersistentPrope
Field fieldAnnotation = findAnnotation(Field.class); Field fieldAnnotation = findAnnotation(Field.class);
if (!isIdProperty()) { if (!getOwner().isIdProperty(this)) {
if (fieldAnnotation == null || fieldAnnotation.targetType() == FieldType.IMPLICIT) { if (fieldAnnotation == null || fieldAnnotation.targetType() == FieldType.IMPLICIT) {
return getType(); return getType();

12
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/support/SpringDataMongodbSerializer.java
Unescape View File

@ -135,13 +135,14 @@ class SpringDataMongodbSerializer extends MongodbDocumentSerializer {
MongoPersistentProperty property = getPropertyFor(path); MongoPersistentProperty property = getPropertyFor(path);
return property != null && property.isIdProperty() ? key.replaceAll("." + ID_KEY + "$", "") : key; return property != null && property.getOwner().isIdProperty(property) ? key.replaceAll("." + ID_KEY + "$", "")
: key;
} }
@Override @Override
protected boolean isId(Path<?> arg) { protected boolean isId(Path<?> arg) {
MongoPersistentProperty propertyFor = getPropertyFor(arg); MongoPersistentProperty propertyFor = getPropertyFor(arg);
return propertyFor == null ? super.isId(arg) : propertyFor.isIdProperty(); return propertyFor == null ? super.isId(arg) : propertyFor.getOwner().isIdProperty(propertyFor);
} }
@Override @Override
@ -159,7 +160,7 @@ class SpringDataMongodbSerializer extends MongodbDocumentSerializer {
return super.convert(path, constant); return super.convert(path, constant);
} }
if (property.isIdProperty()) { if (property.getOwner().isIdProperty(property)) {
return mapper.convertId(constant.getConstant(), property.getFieldType()); return mapper.convertId(constant.getConstant(), property.getFieldType());
} }
@ -177,7 +178,7 @@ class SpringDataMongodbSerializer extends MongodbDocumentSerializer {
return converter.toDocumentPointer(constant.getConstant(), property).getPointer(); return converter.toDocumentPointer(constant.getConstant(), property).getPointer();
} }
if (property.isIdProperty()) { if (property.getOwner().isIdProperty(property)) {
MongoPersistentProperty propertyForPotentialDbRef = getPropertyForPotentialDbRef(path); MongoPersistentProperty propertyForPotentialDbRef = getPropertyForPotentialDbRef(path);
if (propertyForPotentialDbRef != null && propertyForPotentialDbRef.isDocumentReference()) { if (propertyForPotentialDbRef != null && propertyForPotentialDbRef.isDocumentReference()) {
@ -221,7 +222,8 @@ class SpringDataMongodbSerializer extends MongodbDocumentSerializer {
MongoPersistentProperty property = getPropertyFor(path); MongoPersistentProperty property = getPropertyFor(path);
PathMetadata metadata = path.getMetadata(); PathMetadata metadata = path.getMetadata();
if (property != null && property.isIdProperty() && metadata != null && metadata.getParent() != null) { if (property != null && property.getOwner().isIdProperty(property) && metadata != null
&& metadata.getParent() != null) {
return getPropertyFor(metadata.getParent()); return getPropertyFor(metadata.getParent());
} }

20
spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/mapping/BasicMongoPersistentPropertyUnitTests.java
Unescape View File

@ -263,8 +263,12 @@ public class BasicMongoPersistentPropertyUnitTests {
} }
private static MongoPersistentProperty getPropertyFor(MongoPersistentEntity<?> entity, Field field) { private static MongoPersistentProperty getPropertyFor(MongoPersistentEntity<?> entity, Field field) {
return new BasicMongoPersistentProperty(Property.of(entity.getTypeInformation(), field), entity, BasicMongoPersistentProperty property = new BasicMongoPersistentProperty(
SimpleTypeHolder.DEFAULT, PropertyNameFieldNamingStrategy.INSTANCE); Property.of(entity.getTypeInformation(), field), entity, SimpleTypeHolder.DEFAULT,
PropertyNameFieldNamingStrategy.INSTANCE);
entity.addPersistentProperty(property);
return property;
} }
class Person { class Person {
@ -335,12 +339,14 @@ public class BasicMongoPersistentPropertyUnitTests {
static class DocumentWithExplicitlyRenamedIdPropertyHavingIdAnnotation { static class DocumentWithExplicitlyRenamedIdPropertyHavingIdAnnotation {
@Id @org.springframework.data.mongodb.core.mapping.Field("id") String id; @Id
@org.springframework.data.mongodb.core.mapping.Field("id") String id;
} }
static class DocumentWithComposedAnnotations { static class DocumentWithComposedAnnotations {
@ComposedIdAnnotation @ComposedFieldAnnotation String myId; @ComposedIdAnnotation
@ComposedFieldAnnotation String myId;
@ComposedFieldAnnotation(name = "myField") String myField; @ComposedFieldAnnotation(name = "myField") String myField;
} }
@ -356,7 +362,8 @@ public class BasicMongoPersistentPropertyUnitTests {
@Retention(RetentionPolicy.RUNTIME) @Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD) @Target(ElementType.FIELD)
@Id @Id
static @interface ComposedIdAnnotation {} static @interface ComposedIdAnnotation {
}
static class WithStringMongoId { static class WithStringMongoId {
@ -375,7 +382,8 @@ public class BasicMongoPersistentPropertyUnitTests {
static class WithComplexId { static class WithComplexId {
@Id @org.springframework.data.mongodb.core.mapping.Field ComplexId id; @Id
@org.springframework.data.mongodb.core.mapping.Field ComplexId id;
} }
static class WithJMoleculesIdentity { static class WithJMoleculesIdentity {

30
spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/support/SpringDataMongodbSerializerUnitTests.java
Unescape View File

@ -68,11 +68,11 @@ import com.querydsl.core.types.dsl.StringPath;
public class SpringDataMongodbSerializerUnitTests { public class SpringDataMongodbSerializerUnitTests {
@Mock DbRefResolver dbFactory; @Mock DbRefResolver dbFactory;
MongoConverter converter; private MongoConverter converter;
SpringDataMongodbSerializer serializer; private SpringDataMongodbSerializer serializer;
@BeforeEach @BeforeEach
public void setUp() { void setUp() {
MongoMappingContext context = new MongoMappingContext(); MongoMappingContext context = new MongoMappingContext();
@ -81,21 +81,21 @@ public class SpringDataMongodbSerializerUnitTests {
} }
@Test @Test
public void uses_idAsKeyForIdProperty() { void uses_idAsKeyForIdProperty() {
StringPath path = QPerson.person.id; StringPath path = QPerson.person.id;
assertThat(serializer.getKeyForPath(path, path.getMetadata())).isEqualTo("_id"); assertThat(serializer.getKeyForPath(path, path.getMetadata())).isEqualTo("_id");
} }
@Test @Test
public void buildsNestedKeyCorrectly() { void buildsNestedKeyCorrectly() {
StringPath path = QPerson.person.address.street; StringPath path = QPerson.person.address.street;
assertThat(serializer.getKeyForPath(path, path.getMetadata())).isEqualTo("street"); assertThat(serializer.getKeyForPath(path, path.getMetadata())).isEqualTo("street");
} }
@Test @Test
public void convertsComplexObjectOnSerializing() { void convertsComplexObjectOnSerializing() {
Address address = new Address(); Address address = new Address();
address.street = "Foo"; address.street = "Foo";
@ -111,14 +111,14 @@ public class SpringDataMongodbSerializerUnitTests {
} }
@Test // DATAMONGO-376 @Test // DATAMONGO-376
public void returnsEmptyStringIfNoPathExpressionIsGiven() { void returnsEmptyStringIfNoPathExpressionIsGiven() {
QAddress address = QPerson.person.shippingAddresses.any(); QAddress address = QPerson.person.shippingAddresses.any();
assertThat(serializer.getKeyForPath(address, address.getMetadata())).isEmpty(); assertThat(serializer.getKeyForPath(address, address.getMetadata())).isEmpty();
} }
@Test // DATAMONGO-467, DATAMONGO-1798 @Test // DATAMONGO-467, DATAMONGO-1798
public void appliesImplicitIdConversion() { void appliesImplicitIdConversion() {
ObjectId id = new ObjectId(); ObjectId id = new ObjectId();
@ -130,7 +130,7 @@ public class SpringDataMongodbSerializerUnitTests {
} }
@Test // DATAMONGO-761 @Test // DATAMONGO-761
public void looksUpKeyForNonPropertyPath() { void looksUpKeyForNonPropertyPath() {
PathBuilder<Address> builder = new PathBuilder<Address>(Address.class, "address"); PathBuilder<Address> builder = new PathBuilder<Address>(Address.class, "address");
SimplePath<Object> firstElementPath = builder.getArray("foo", String[].class).get(0); SimplePath<Object> firstElementPath = builder.getArray("foo", String[].class).get(0);
@ -140,7 +140,7 @@ public class SpringDataMongodbSerializerUnitTests {
} }
@Test // DATAMONGO-1485 @Test // DATAMONGO-1485
public void takesCustomConversionForEnumsIntoAccount() { void takesCustomConversionForEnumsIntoAccount() {
MongoMappingContext context = new MongoMappingContext(); MongoMappingContext context = new MongoMappingContext();
@ -158,7 +158,7 @@ public class SpringDataMongodbSerializerUnitTests {
} }
@Test // DATAMONGO-1848, DATAMONGO-1943 @Test // DATAMONGO-1848, DATAMONGO-1943
public void shouldRemarshallListsAndDocuments() { void shouldRemarshallListsAndDocuments() {
BooleanExpression criteria = QPerson.person.lastname.isNotEmpty() BooleanExpression criteria = QPerson.person.lastname.isNotEmpty()
.and(QPerson.person.firstname.containsIgnoreCase("foo")).not(); .and(QPerson.person.firstname.containsIgnoreCase("foo")).not();
@ -168,7 +168,7 @@ public class SpringDataMongodbSerializerUnitTests {
} }
@Test // DATAMONGO-2228 @Test // DATAMONGO-2228
public void retainsOpsInAndExpression() { void retainsOpsInAndExpression() {
PredicateOperation testExpression = predicate(Ops.AND, PredicateOperation testExpression = predicate(Ops.AND,
predicate(Ops.OR, predicate(Ops.EQ, path(Object.class, "firstname"), constant("John")), predicate(Ops.OR, predicate(Ops.EQ, path(Object.class, "firstname"), constant("John")),
@ -181,7 +181,7 @@ public class SpringDataMongodbSerializerUnitTests {
} }
@Test // DATAMONGO-2475 @Test // DATAMONGO-2475
public void chainedOrsInSameDocument() { void chainedOrsInSameDocument() {
Predicate predicate = QPerson.person.firstname.eq("firstname_value") Predicate predicate = QPerson.person.firstname.eq("firstname_value")
.or(QPerson.person.lastname.eq("lastname_value")).or(QPerson.person.age.goe(30)).or(QPerson.person.age.loe(20)) .or(QPerson.person.lastname.eq("lastname_value")).or(QPerson.person.age.goe(30)).or(QPerson.person.age.loe(20))
@ -192,7 +192,7 @@ public class SpringDataMongodbSerializerUnitTests {
} }
@Test // DATAMONGO-2475 @Test // DATAMONGO-2475
public void chainedNestedOrsInSameDocument() { void chainedNestedOrsInSameDocument() {
Predicate predicate = QPerson.person.firstname.eq("firstname_value") Predicate predicate = QPerson.person.firstname.eq("firstname_value")
.or(QPerson.person.lastname.eq("lastname_value")).or(QPerson.person.address.street.eq("spring")); .or(QPerson.person.lastname.eq("lastname_value")).or(QPerson.person.address.street.eq("spring"));
@ -202,7 +202,7 @@ public class SpringDataMongodbSerializerUnitTests {
} }
@Test // DATAMONGO-2475 @Test // DATAMONGO-2475
public void chainedAndsInSameDocument() { void chainedAndsInSameDocument() {
Predicate predicate = QPerson.person.firstname.eq("firstname_value") Predicate predicate = QPerson.person.firstname.eq("firstname_value")
.and(QPerson.person.lastname.eq("lastname_value")).and(QPerson.person.age.goe(30)) .and(QPerson.person.lastname.eq("lastname_value")).and(QPerson.person.age.goe(30))

Write Preview
Loading…
Cancel
Save