Browse Source
This commit introduces support for mapping (read/write) fields that contain dots in their name, preserving the name as is instead of considering the dot being a separator within a path of nested objects. Query and Update functionality remains unaffected which means no automatic rewrite for field names containing paths will NOT take place. It's in the users responsibility to pick the appropriate query/update operator (eg. $expr) to interact with the field. Closes #4464 Original pull request: #4512pull/4525/head
Christoph Strobl
2 years ago
committed by
Mark Paluch
19 changed files with 946 additions and 82 deletions
@ -0,0 +1,118 @@
@@ -0,0 +1,118 @@
|
||||
/* |
||||
* Copyright 2023 the original author or 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. |
||||
*/ |
||||
package org.springframework.data.mongodb.core.mapping; |
||||
|
||||
import org.springframework.util.ObjectUtils; |
||||
|
||||
/** |
||||
* Value Object representing a field name that should be used to read/write fields within the MongoDB document. |
||||
* {@link FieldName Field names} field names may contain special characters (such as {@literal .} (dot)) but may be |
||||
* treated differently depending ob their {@link Type type}. |
||||
* |
||||
* @author Christoph Strobl |
||||
* @since 4.2 |
||||
*/ |
||||
public record FieldName(String name, Type type) { |
||||
|
||||
/** |
||||
* Create a new {@link FieldName} that treats the given {@literal value} as is. |
||||
* |
||||
* @param value must not be {@literal null}. |
||||
* @return new instance of {@link FieldName}. |
||||
*/ |
||||
public static FieldName name(String value) { |
||||
return new FieldName(value, Type.KEY); |
||||
} |
||||
|
||||
/** |
||||
* Create a new {@link FieldName} that treats the given {@literal value} as a path. If the {@literal value} contains |
||||
* {@literal .} (dot) characters, they are considered deliminators in a path. |
||||
* |
||||
* @param value must not be {@literal null}. |
||||
* @return new instance of {@link FieldName}. |
||||
*/ |
||||
public static FieldName path(String value) { |
||||
return new FieldName(value, Type.PATH); |
||||
} |
||||
|
||||
/** |
||||
* Get the parts the field name consists of. If the {@link FieldName} is a {@link Type#KEY} or a {@link Type#PATH} |
||||
* that does not contain {@literal .} (dot) characters an array containing a single element is returned. Otherwise the |
||||
* {@link #name()} is split into segments using {@literal .} (dot) as a deliminator. |
||||
* |
||||
* @return never {@literal null}. |
||||
*/ |
||||
public String[] parts() { |
||||
|
||||
if (isOfType(Type.KEY)) { |
||||
return new String[] { name }; |
||||
} |
||||
|
||||
return name.split("\\."); |
||||
} |
||||
|
||||
/** |
||||
* @param type return true if the given {@link Type} is equal to {@link #type()}. |
||||
* @return {@literal true} if values are equal. |
||||
*/ |
||||
public boolean isOfType(Type type) { |
||||
return ObjectUtils.nullSafeEquals(type(), type); |
||||
} |
||||
|
||||
@Override |
||||
public String toString() { |
||||
return "FieldName{%s=%s}".formatted(isOfType(Type.KEY) ? "key" : "path", name); |
||||
} |
||||
|
||||
@Override |
||||
public boolean equals(Object o) { |
||||
|
||||
if (o == this) { |
||||
return true; |
||||
} |
||||
if (o == null || getClass() != o.getClass()) { |
||||
return false; |
||||
} |
||||
FieldName fieldName = (FieldName) o; |
||||
return ObjectUtils.nullSafeEquals(name, fieldName.name) && type == fieldName.type; |
||||
} |
||||
|
||||
@Override |
||||
public int hashCode() { |
||||
|
||||
int hashCode = ObjectUtils.nullSafeHashCode(name); |
||||
return 31 * hashCode + ObjectUtils.nullSafeHashCode(type); |
||||
} |
||||
|
||||
/** |
||||
* The {@link FieldName.Type type} defines how to treat a {@link FieldName} that contains special characters. |
||||
* |
||||
* @author Christoph Strobl |
||||
* @since 4.2 |
||||
*/ |
||||
public enum Type { |
||||
|
||||
/** |
||||
* {@literal .} (dot) characters are treated as deliminators in a path. |
||||
*/ |
||||
PATH, |
||||
|
||||
/** |
||||
* Values are used as is. |
||||
*/ |
||||
KEY |
||||
} |
||||
} |
||||
@ -0,0 +1,130 @@
@@ -0,0 +1,130 @@
|
||||
/* |
||||
* Copyright 2023 the original author or 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. |
||||
*/ |
||||
package org.springframework.data.mongodb.core.mapping; |
||||
|
||||
import org.springframework.data.mongodb.core.mapping.FieldName.Type; |
||||
|
||||
/** |
||||
* Value Object for representing a field to read/write within a MongoDB {@link org.bson.Document}. |
||||
* |
||||
* @author Christoph Strobl |
||||
* @since 4.2 |
||||
*/ |
||||
public class MongoField { |
||||
|
||||
private final FieldName fieldName; |
||||
private final FieldType fieldType; |
||||
private final int fieldOrder; |
||||
|
||||
/** |
||||
* Create a new {@link MongoField} with given {@literal name}. |
||||
* |
||||
* @param name the name to be used as is (with all its potentially special characters). |
||||
* @return new instance of {@link MongoField}. |
||||
*/ |
||||
public static MongoField just(String name) { |
||||
return builder().fieldName(name).build(); |
||||
} |
||||
|
||||
/** |
||||
* @return new instance of {@link MongoFieldBuilder}. |
||||
*/ |
||||
public static MongoFieldBuilder builder() { |
||||
return new MongoFieldBuilder(); |
||||
} |
||||
|
||||
protected MongoField(FieldName fieldName, Class<?> targetFieldType, int fieldOrder) { |
||||
this(fieldName, FieldType.valueOf(targetFieldType.getSimpleName()), fieldOrder); |
||||
} |
||||
|
||||
protected MongoField(FieldName fieldName, FieldType fieldType, int fieldOrder) { |
||||
|
||||
this.fieldName = fieldName; |
||||
this.fieldType = fieldType; |
||||
this.fieldOrder = fieldOrder; |
||||
} |
||||
|
||||
/** |
||||
* @return never {@literal null}. |
||||
*/ |
||||
public FieldName getFieldName() { |
||||
return fieldName; |
||||
} |
||||
|
||||
/** |
||||
* Get the position of the field within the target document. |
||||
* |
||||
* @return {@link Integer#MAX_VALUE} if undefined. |
||||
*/ |
||||
public int getFieldOrder() { |
||||
return fieldOrder; |
||||
} |
||||
|
||||
/** |
||||
* @param prefix a prefix to the current name. |
||||
* @return new instance of {@link MongoField} with prefix appended to current field name. |
||||
*/ |
||||
MongoField withPrefix(String prefix) { |
||||
return new MongoField(new FieldName(prefix + fieldName.name(), fieldName.type()), fieldType, fieldOrder); |
||||
} |
||||
|
||||
/** |
||||
* Get the fields target type if defined. |
||||
* |
||||
* @return never {@literal null}. |
||||
*/ |
||||
public FieldType getFieldType() { |
||||
return fieldType; |
||||
} |
||||
|
||||
public static class MongoFieldBuilder { |
||||
|
||||
private String fieldName; |
||||
private FieldType fieldType = FieldType.IMPLICIT; |
||||
private int orderNumber = Integer.MAX_VALUE; |
||||
private Type type = Type.PATH; |
||||
|
||||
public MongoFieldBuilder fieldType(FieldType fieldType) { |
||||
|
||||
this.fieldType = fieldType; |
||||
return this; |
||||
} |
||||
|
||||
public MongoFieldBuilder fieldName(String fieldName) { |
||||
|
||||
this.fieldName = fieldName; |
||||
this.type = Type.KEY; |
||||
return this; |
||||
} |
||||
|
||||
public MongoFieldBuilder fieldOrderNumber(int orderNumber) { |
||||
|
||||
this.orderNumber = orderNumber; |
||||
return this; |
||||
} |
||||
|
||||
public MongoFieldBuilder fieldPath(String path) { |
||||
|
||||
this.fieldName = path; |
||||
this.type = Type.PATH; |
||||
return this; |
||||
} |
||||
|
||||
public MongoField build() { |
||||
return new MongoField(new FieldName(fieldName, type), fieldType, orderNumber); |
||||
} |
||||
} |
||||
} |
||||
Loading…
Reference in new issue