root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity

YamlPropertiesFactoryBean incorrect flatten nested map to properties when map key contains escaped brackets. 

Close gh-27020.

Signed-off-by: Mengqi Xu <2663479778@qq.com>
This commit is contained in:
Mengqi Xu 2025-01-19 17:55:25 +08:00
parent 1ab3d89f10
commit 491f89831a
2 changed files with 41 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
spring-beans/src/main/java/org/springframework/beans/factory/config/YamlProcessor.java
View File

@ -56,6 +56,7 @@ import org.springframework.util.StringUtils;
* @author Juergen Hoeller
* @author Sam Brannen
* @author Brian Clozel
* @author Mengqi Xu
* @since 4.1
*/
public abstract class YamlProcessor {
@ -305,17 +306,20 @@ public abstract class YamlProcessor {
*/
protected final Map<String, Object> getFlattenedMap(Map<String, Object> source) {
Map<String, Object> result = new LinkedHashMap<>();
buildFlattenedMap(result, source, null);
buildFlattenedMap(result, source, null, false);
return result;
}
@SuppressWarnings({"rawtypes", "unchecked"})
private void buildFlattenedMap(Map<String, Object> result, Map<String, Object> source, @Nullable String path) {
private void buildFlattenedMap(Map<String, Object> result, Map<String, Object> source, @Nullable String path, boolean isIndexedKey) {
source.forEach((key, value) -> {
if (StringUtils.hasText(path)) {
if (key.startsWith("[")) {
if (isIndexedKey) {
key = path + key;
}
else if (key.startsWith("[") || key.endsWith("]")) {
key = path + '[' + key + ']';
}
else {
key = path + '.' + key;
}
@ -325,7 +329,7 @@ public abstract class YamlProcessor {
}
else if (value instanceof Map map) {
// Need a compound key
buildFlattenedMap(result, map, key);
buildFlattenedMap(result, map, key, false);
}
else if (value instanceof Collection collection) {
// Need a compound key
@ -336,7 +340,7 @@ public abstract class YamlProcessor {
int count = 0;
for (Object object : collection) {
buildFlattenedMap(result, Collections.singletonMap(
"[" + (count++) + "]", object), key);
"[" + (count++) + "]", object), key, true);
}
}
}

32
spring-beans/src/test/java/org/springframework/beans/factory/config/YamlPropertiesFactoryBeanTests.java
View File

@ -165,6 +165,38 @@ class YamlPropertiesFactoryBeanTests {
assertThat(properties.getProperty("one")).isEqualTo("two");
}
@Test // gh-27020
void loadResourceWithEscapedKey() {
String yaml = "root:\n" +
" webservices:\n" +
" \"[domain.test:8080]\":\n" +
" - username: foo\n" +
" password: bar\n";
YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();
factory.setResources(
new ByteArrayResource(yaml.getBytes()),
new ByteArrayResource("indexed:\n \"[0]\": foo\n \"[1]\": bar".getBytes()),
new ByteArrayResource("indexed:\n - \"[a]\": foo\n \"[b]\": bar".getBytes()),
new ByteArrayResource("only-left-bracket:\n \"[/key1/\": foo".getBytes()),
new ByteArrayResource("only-right-bracket:\n \"/key1/]\": foo".getBytes()),
new ByteArrayResource("special-bracket:\n \"][/key1/][\": foo".getBytes()));
Properties properties = factory.getObject();
assertThat(properties.getProperty("root.webservices[[domain.test:8080]][0].username")).isEqualTo("foo");
assertThat(properties.getProperty("root.webservices[[domain.test:8080]][0].password")).isEqualTo("bar");
assertThat(properties.getProperty("indexed[[0]]")).isEqualTo("foo");
assertThat(properties.getProperty("indexed[[1]]")).isEqualTo("bar");
assertThat(properties.getProperty("indexed[0][[a]]")).isEqualTo("foo");
assertThat(properties.getProperty("indexed[0][[b]]")).isEqualTo("bar");
assertThat(properties.getProperty("only-left-bracket[[/key1/]")).isEqualTo("foo");
assertThat(properties.getProperty("only-right-bracket[/key1/]]")).isEqualTo("foo");
assertThat(properties.getProperty("special-bracket.][/key1/][")).isEqualTo("foo");
}
@Test
void loadNonExistentResource() {
YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();