Spring/spring-data-commons
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add property path tests & update reference documentation.

Browse Source 
See: #1851
Original Pull Request: #2940
This commit is contained in:
Christoph Strobl
2023-11-08 10:52:59 +01:00
parent e0b2f1ef4d
commit 786c2e537d
2 changed files with 51 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
src/main/antora/modules/ROOT/pages/repositories/query-methods-details.adoc
View File

@@ -119,7 +119,34 @@ So our method name would be as follows:
List<Person> findByAddress_ZipCode(ZipCode zipCode);
----
Because we treat the underscore character as a reserved character, we strongly advise following standard Java naming conventions (that is, not using underscores in property names but using camel case instead).
[NOTE]
====
Because we treat underscores (`_`) as a reserved character, we strongly advise to follow standard Java naming conventions (that is, not using underscores in property names but applying camel case instead).
====
[CAUTION]
====
.Field Names starting with underscore:
Field names may start with underscores like `String \_name`.
Make sure to preserve the `_` as in `\_name` and use double `_` to split nested paths like `user__name`.
.Upper Case Field Names:
Field names that are all uppercase can be used as such.
Nested paths if applicable require splitting via `_` as in `USER_name`.
.Field Names with 2nd uppercase letter:
Field names that consist of a starting lower case letter followed by an uppercase one like `String qCode` can be resolved by starting with two upper case letters as in `QCode`.
Please be aware of potential path ambiguities.
.Path Ambiguities:
In the following sample the arrangement of properties `qCode` and `q`, with `q` containing a property called `code`, creates an ambiguity for the path `QCode`.
```java
record Container(String qCode, Code q) {}
record Code(String code) {}
```
Since a direct match on a property is considered first, any potential nested paths will not be considered and the algorithm picks the `qCode` field.
In order to select the `code` field in `q` the underscore notation `Q_Code` is required.
====
[[repositories.collections-and-iterables]]
== Repository Methods Returning Collections or Iterables

23
src/test/java/org/springframework/data/mapping/PropertyPathUnitTests.java
View File

@@ -309,6 +309,19 @@ class PropertyPathUnitTests {
assertThat(PropertyPath.from("QCode", Foo.class).toDotPath()).isEqualTo("qCode");
assertThat(PropertyPath.from("zIndex", MyRecord.class).toDotPath()).isEqualTo("zIndex");
assertThat(PropertyPath.from("ZIndex", MyRecord.class).toDotPath()).isEqualTo("zIndex");
assertThat(PropertyPath.from("_foo.QCode", Sample2.class).toDotPath()).isEqualTo("_foo.qCode");
assertThat(PropertyPath.from("_fooQCode", Sample2.class).toDotPath()).isEqualTo("_foo.qCode");
}
@Test // GH-1851
void favoursPropertyHitOverNestedPath() {
assertThat(PropertyPath.from("qCode", NameAmbiguities.class).toDotPath()).isEqualTo("qCode");
assertThat(PropertyPath.from("QCode", NameAmbiguities.class).toDotPath()).isEqualTo("qCode");
assertThat(PropertyPath.from("Q_Code", NameAmbiguities.class).toDotPath()).isEqualTo("q.code");
assertThat(PropertyPath.from("q.code", NameAmbiguities.class).toDotPath()).isEqualTo("q.code");
assertThat(PropertyPath.from("Q.Code", NameAmbiguities.class).toDotPath()).isEqualTo("q.code");
assertThat(PropertyPath.from("q_code", NameAmbiguities.class).toDotPath()).isEqualTo("q.code");
}
@Test // DATACMNS-257
@@ -458,6 +471,16 @@ class PropertyPathUnitTests {
}
}
private static class NameAmbiguities {
String qCode;
Code q;
}
private static class Code {
String code;
}
private class Bar {
private FooBar user;