Skip to content

Commit

Permalink
Support for MultiValueMap elements in bean property paths
Browse files Browse the repository at this point in the history 
Closes gh-26297
  • Loading branch information
@jhoeller
jhoeller committed Jul 12, 2023
1 parent 490ff0a commit c1932dd
Show file tree
Hide file tree
Showing 4 changed files with 126 additions and 23 deletions.
29 changes: 13 additions & 16 deletions spring-beans/src/main/java/org/springframework/beans/AbstractNestablePropertyAccessor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -319,14 +319,14 @@ private void processKeyedProperty(PropertyTokenHolder tokens, PropertyValue pv)
}

else if (propValue instanceof List list) {
Class<?> requiredType = ph.getCollectionType(tokens.keys.length);
TypeDescriptor requiredType = ph.getCollectionType(tokens.keys.length);
int index = Integer.parseInt(lastKey);
Object oldValue = null;
if (isExtractOldValueForEditor() && index < list.size()) {
oldValue = list.get(index);
}
Object convertedValue = convertIfNecessary(tokens.canonicalName, oldValue, pv.getValue(),
requiredType, ph.nested(tokens.keys.length));
requiredType.getResolvableType().resolve(), requiredType);
int size = list.size();
if (index >= size && index < this.autoGrowCollectionLimit) {
for (int i = size; i < index; i++) {
Expand Down Expand Up @@ -354,20 +354,20 @@ else if (propValue instanceof List list) {
}

else if (propValue instanceof Map map) {
Class<?> mapKeyType = ph.getMapKeyType(tokens.keys.length);
Class<?> mapValueType = ph.getMapValueType(tokens.keys.length);
TypeDescriptor mapKeyType = ph.getMapKeyType(tokens.keys.length);
TypeDescriptor mapValueType = ph.getMapValueType(tokens.keys.length);
// IMPORTANT: Do not pass full property name in here - property editors
// must not kick in for map keys but rather only for map values.
TypeDescriptor typeDescriptor = TypeDescriptor.valueOf(mapKeyType);
Object convertedMapKey = convertIfNecessary(null, null, lastKey, mapKeyType, typeDescriptor);
Object convertedMapKey = convertIfNecessary(null, null, lastKey,
mapKeyType.getResolvableType().resolve(), mapKeyType);
Object oldValue = null;
if (isExtractOldValueForEditor()) {
oldValue = map.get(convertedMapKey);
}
// Pass full property name and old value in here, since we want full
// conversion ability for map values.
Object convertedMapValue = convertIfNecessary(tokens.canonicalName, oldValue, pv.getValue(),
mapValueType, ph.nested(tokens.keys.length));
mapValueType.getResolvableType().resolve(), mapValueType);
map.put(convertedMapKey, convertedMapValue);
}

Expand Down Expand Up @@ -1041,19 +1041,16 @@ public boolean isWritable() {

public abstract ResolvableType getResolvableType();

@Nullable
public Class<?> getMapKeyType(int nestingLevel) {
return getResolvableType().getNested(nestingLevel).asMap().resolveGeneric(0);
public TypeDescriptor getMapKeyType(int nestingLevel) {
return TypeDescriptor.valueOf(getResolvableType().getNested(nestingLevel).asMap().resolveGeneric(0));
}

@Nullable
public Class<?> getMapValueType(int nestingLevel) {
return getResolvableType().getNested(nestingLevel).asMap().resolveGeneric(1);
public TypeDescriptor getMapValueType(int nestingLevel) {
return TypeDescriptor.valueOf(getResolvableType().getNested(nestingLevel).asMap().resolveGeneric(1));
}

@Nullable
public Class<?> getCollectionType(int nestingLevel) {
return getResolvableType().getNested(nestingLevel).asCollection().resolveGeneric();
public TypeDescriptor getCollectionType(int nestingLevel) {
return TypeDescriptor.valueOf(getResolvableType().getNested(nestingLevel).asCollection().resolveGeneric());
}

@Nullable
Expand Down
25 changes: 21 additions & 4 deletions spring-beans/src/main/java/org/springframework/beans/BeanWrapperImpl.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 the original author or authors.
* Copyright 2002-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.
Expand Down Expand Up @@ -236,19 +236,36 @@ private class BeanPropertyHandler extends PropertyHandler {

private final PropertyDescriptor pd;

private final TypeDescriptor typeDescriptor;

public BeanPropertyHandler(PropertyDescriptor pd) {
super(pd.getPropertyType(), pd.getReadMethod() != null, pd.getWriteMethod() != null);
this.pd = pd;
this.typeDescriptor = new TypeDescriptor(property(pd));
}

@Override
public TypeDescriptor toTypeDescriptor() {
return this.typeDescriptor;
}

@Override
public ResolvableType getResolvableType() {
return ResolvableType.forMethodReturnType(this.pd.getReadMethod());
return this.typeDescriptor.getResolvableType();
}

@Override
public TypeDescriptor toTypeDescriptor() {
return new TypeDescriptor(property(this.pd));
public TypeDescriptor getMapValueType(int nestingLevel) {
return new TypeDescriptor(
this.typeDescriptor.getResolvableType().getNested(nestingLevel).asMap().getGeneric(1),
null, this.typeDescriptor.getAnnotations());
}

@Override
public TypeDescriptor getCollectionType(int nestingLevel) {
return new TypeDescriptor(
this.typeDescriptor.getResolvableType().getNested(nestingLevel).asCollection().getGeneric(),
null, this.typeDescriptor.getAnnotations());
}

@Override
Expand Down
21 changes: 18 additions & 3 deletions spring-beans/src/main/java/org/springframework/beans/DirectFieldAccessor.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2020 the original author or authors.
* Copyright 2002-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.
Expand Down Expand Up @@ -101,19 +101,34 @@ private class FieldPropertyHandler extends PropertyHandler {

private final Field field;

private final ResolvableType resolvableType;

public FieldPropertyHandler(Field field) {
super(field.getType(), true, true);
this.field = field;
this.resolvableType = ResolvableType.forField(this.field);
}

@Override
public TypeDescriptor toTypeDescriptor() {
return new TypeDescriptor(this.field);
return new TypeDescriptor(this.resolvableType, this.field.getType(), this.field.getAnnotations());
}

@Override
public ResolvableType getResolvableType() {
return ResolvableType.forField(this.field);
return this.resolvableType;
}

@Override
public TypeDescriptor getMapValueType(int nestingLevel) {
return new TypeDescriptor(this.resolvableType.getNested(nestingLevel).asMap().getGeneric(1),
null, this.field.getAnnotations());
}

@Override
public TypeDescriptor getCollectionType(int nestingLevel) {
return new TypeDescriptor(this.resolvableType.getNested(nestingLevel).asCollection().getGeneric(),
null, this.field.getAnnotations());
}

@Override
Expand Down
74 changes: 74 additions & 0 deletions spring-beans/src/test/java/org/springframework/beans/BeanWrapperGenericsTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@
import org.springframework.beans.testfixture.beans.GenericSetOfIntegerBean;
import org.springframework.beans.testfixture.beans.TestBean;
import org.springframework.core.io.UrlResource;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
Expand Down Expand Up @@ -429,6 +431,18 @@ void testComplexGenericIndexedMapEntryWithCollectionConversion() {
assertThat(holder.getGenericIndexedMap().values().iterator().next().get(0)).isEqualTo(Long.valueOf(10));
}

@Test
void testComplexGenericIndexedMapEntryWithPlainValue() {
String inputValue = "10";

ComplexMapHolder holder = new ComplexMapHolder();
BeanWrapper bw = new BeanWrapperImpl(holder);
bw.setPropertyValue("genericIndexedMap[1]", inputValue);

assertThat(holder.getGenericIndexedMap().keySet().iterator().next()).isEqualTo(1);
assertThat(holder.getGenericIndexedMap().values().iterator().next().get(0)).isEqualTo(Long.valueOf(10));
}

@Test
void testComplexDerivedIndexedMapEntry() {
List<String> inputValue = new ArrayList<>();
Expand All @@ -455,6 +469,56 @@ void testComplexDerivedIndexedMapEntryWithCollectionConversion() {
assertThat(holder.getDerivedIndexedMap().values().iterator().next().get(0)).isEqualTo(Long.valueOf(10));
}

@Test
void testComplexDerivedIndexedMapEntryWithPlainValue() {
String inputValue = "10";

ComplexMapHolder holder = new ComplexMapHolder();
BeanWrapper bw = new BeanWrapperImpl(holder);
bw.setPropertyValue("derivedIndexedMap[1]", inputValue);

assertThat(holder.getDerivedIndexedMap().keySet().iterator().next()).isEqualTo(1);
assertThat(holder.getDerivedIndexedMap().values().iterator().next().get(0)).isEqualTo(Long.valueOf(10));
}

@Test
void testComplexMultiValueMapEntry() {
List<String> inputValue = new ArrayList<>();
inputValue.add("10");

ComplexMapHolder holder = new ComplexMapHolder();
BeanWrapper bw = new BeanWrapperImpl(holder);
bw.setPropertyValue("multiValueMap[1]", inputValue);

assertThat(holder.getMultiValueMap().keySet().iterator().next()).isEqualTo(1);
assertThat(holder.getMultiValueMap().values().iterator().next().get(0)).isEqualTo(Long.valueOf(10));
}

@Test
void testComplexMultiValueMapEntryWithCollectionConversion() {
Set<String> inputValue = new HashSet<>();
inputValue.add("10");

ComplexMapHolder holder = new ComplexMapHolder();
BeanWrapper bw = new BeanWrapperImpl(holder);
bw.setPropertyValue("multiValueMap[1]", inputValue);

assertThat(holder.getMultiValueMap().keySet().iterator().next()).isEqualTo(1);
assertThat(holder.getMultiValueMap().values().iterator().next().get(0)).isEqualTo(Long.valueOf(10));
}

@Test
void testComplexMultiValueMapEntryWithPlainValue() {
String inputValue = "10";

ComplexMapHolder holder = new ComplexMapHolder();
BeanWrapper bw = new BeanWrapperImpl(holder);
bw.setPropertyValue("multiValueMap[1]", inputValue);

assertThat(holder.getMultiValueMap().keySet().iterator().next()).isEqualTo(1);
assertThat(holder.getMultiValueMap().values().iterator().next().get(0)).isEqualTo(Long.valueOf(10));
}

@Test
void testGenericallyTypedIntegerBean() {
GenericIntegerBean gb = new GenericIntegerBean();
Expand Down Expand Up @@ -585,6 +649,8 @@ private static class ComplexMapHolder {

private DerivedMap derivedIndexedMap = new DerivedMap();

private MultiValueMap<Integer, Long> multiValueMap = new LinkedMultiValueMap<>();

public void setGenericMap(Map<List<Integer>, List<Long>> genericMap) {
this.genericMap = genericMap;
}
Expand All @@ -608,6 +674,14 @@ public void setDerivedIndexedMap(DerivedMap derivedIndexedMap) {
public DerivedMap getDerivedIndexedMap() {
return derivedIndexedMap;
}

public void setMultiValueMap(MultiValueMap<Integer, Long> multiValueMap) {
this.multiValueMap = multiValueMap;
}

public MultiValueMap<Integer, Long> getMultiValueMap() {
return multiValueMap;
}
}


Expand Down

0 comments on commit c1932dd

Please sign in to comment.