Fix bind TypeConverter delegation with collections
Update `BindConverter` so that delegation to `SimpleTypeConverter` also works with Collections and Arrays. Prior to this commit, conversion that relied on a `PropertyEditor` would only work for simple types. For example, "String -> Class<?>" would use the `ClassEditor` but "String -> List<Class<?>>" would fail. The `BindConverter` now uses a minimal `ConversionService` as an adapter to the `SimpleTypeConverter`. This allows us to use the same delimited string conversion logic as the `ApplicationConverter`. Fixes gh-12166pull/12202/head
Phillip Webb
7 years ago
parent
4b9c3c137e
commit
3dea6fc645
@ -0,0 +1,295 @@
|
||||
/*
|
||||
* Copyright 2012-2018 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
|
||||
*
|
||||
* http://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.boot.context.properties.bind;
|
||||
|
||||
import java.beans.PropertyEditorSupport;
|
||||
import java.util.List;
|
||||
import java.util.function.Consumer;
|
||||
|
||||
import org.junit.Before;
|
||||
import org.junit.Rule;
|
||||
import org.junit.Test;
|
||||
import org.junit.rules.ExpectedException;
|
||||
import org.mockito.Mock;
|
||||
import org.mockito.MockitoAnnotations;
|
||||
|
||||
import org.springframework.beans.PropertyEditorRegistry;
|
||||
import org.springframework.boot.convert.ApplicationConversionService;
|
||||
import org.springframework.core.ResolvableType;
|
||||
import org.springframework.core.convert.ConversionService;
|
||||
import org.springframework.core.convert.ConverterNotFoundException;
|
||||
import org.springframework.core.convert.TypeDescriptor;
|
||||
import org.springframework.core.convert.converter.Converter;
|
||||
import org.springframework.core.convert.support.GenericConversionService;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.mockito.ArgumentMatchers.any;
|
||||
import static org.mockito.Mockito.verify;
|
||||
|
||||
/**
|
||||
* Tests for {@link BindConverter}.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
public class BindConverterTests {
|
||||
|
||||
@Rule
|
||||
public ExpectedException thrown = ExpectedException.none();
|
||||
|
||||
@Mock
|
||||
private Consumer<PropertyEditorRegistry> propertyEditorInitializer;
|
||||
|
||||
@Before
|
||||
public void setup() {
|
||||
MockitoAnnotations.initMocks(this);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void createWhenConversionServiceIsNullShouldThrowException() {
|
||||
this.thrown.expect(IllegalArgumentException.class);
|
||||
this.thrown.expectMessage("ConversionService must not be null");
|
||||
new BindConverter(null, null);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void createWhenPropertyEditorInitializerIsNullShouldCreate() {
|
||||
BindConverter bindConverter = new BindConverter(
|
||||
ApplicationConversionService.getSharedInstance(), null);
|
||||
assertThat(bindConverter).isNotNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void createWhenPropertyEditorInitializerIsNotNullShouldUseToInitialize() {
|
||||
new BindConverter(ApplicationConversionService.getSharedInstance(),
|
||||
this.propertyEditorInitializer);
|
||||
verify(this.propertyEditorInitializer).accept(any(PropertyEditorRegistry.class));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void canConvertWhenHasDefaultEditorShouldReturnTrue() {
|
||||
BindConverter bindConverter = getPropertyEditorOnlyBindConverter(null);
|
||||
assertThat(bindConverter.canConvert("java.lang.RuntimeException",
|
||||
ResolvableType.forClass(Class.class))).isTrue();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void canConvertWhenHasCustomEditorShouldReturnTrue() {
|
||||
BindConverter bindConverter = getPropertyEditorOnlyBindConverter(
|
||||
this::registerSampleTypeEditor);
|
||||
assertThat(bindConverter.canConvert("test",
|
||||
ResolvableType.forClass(SampleType.class))).isTrue();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void canConvertWhenHasEditorByConventionShouldReturnTrue() {
|
||||
BindConverter bindConverter = getPropertyEditorOnlyBindConverter(null);
|
||||
assertThat(bindConverter.canConvert("test",
|
||||
ResolvableType.forClass(ConventionType.class))).isTrue();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void canConvertWhenHasEditorForCollectionElementShouldReturnTrue() {
|
||||
BindConverter bindConverter = getPropertyEditorOnlyBindConverter(
|
||||
this::registerSampleTypeEditor);
|
||||
assertThat(bindConverter.canConvert("test",
|
||||
ResolvableType.forClassWithGenerics(List.class, SampleType.class)))
|
||||
.isTrue();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void canConvertWhenHasEditorForArrayElementShouldReturnTrue() {
|
||||
BindConverter bindConverter = getPropertyEditorOnlyBindConverter(
|
||||
this::registerSampleTypeEditor);
|
||||
assertThat(bindConverter.canConvert("test",
|
||||
ResolvableType.forClass(SampleType[].class))).isTrue();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void canConvertWhenConversionServiceCanConvertShouldReturnTrue() {
|
||||
BindConverter bindConverter = getBindConverter(new SampleTypeConverter());
|
||||
assertThat(bindConverter.canConvert("test",
|
||||
ResolvableType.forClass(SampleType.class))).isTrue();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void canConvertWhenNotPropertyEditorAndConversionServiceCannotConvertShouldReturnFalse() {
|
||||
BindConverter bindConverter = new BindConverter(
|
||||
ApplicationConversionService.getSharedInstance(), null);
|
||||
assertThat(bindConverter.canConvert("test",
|
||||
ResolvableType.forClass(SampleType.class))).isFalse();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void convertWhenHasDefaultEditorShouldConvert() {
|
||||
BindConverter bindConverter = getPropertyEditorOnlyBindConverter(null);
|
||||
Class<?> converted = bindConverter.convert("java.lang.RuntimeException",
|
||||
ResolvableType.forClass(Class.class));
|
||||
assertThat(converted).isEqualTo(RuntimeException.class);
|
||||
|
||||
}
|
||||
|
||||
@Test
|
||||
public void convertWhenHasCustomEditorShouldConvert() {
|
||||
BindConverter bindConverter = getPropertyEditorOnlyBindConverter(
|
||||
this::registerSampleTypeEditor);
|
||||
SampleType converted = bindConverter.convert("test",
|
||||
ResolvableType.forClass(SampleType.class));
|
||||
assertThat(converted.getText()).isEqualTo("test");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void convertWhenHasEditorByConventionShouldConvert() {
|
||||
BindConverter bindConverter = getPropertyEditorOnlyBindConverter(null);
|
||||
ConventionType converted = bindConverter.convert("test",
|
||||
ResolvableType.forClass(ConventionType.class));
|
||||
assertThat(converted.getText()).isEqualTo("test");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void convertWhenHasEditorForCollectionElementShouldConvert() {
|
||||
BindConverter bindConverter = getPropertyEditorOnlyBindConverter(
|
||||
this::registerSampleTypeEditor);
|
||||
List<SampleType> converted = bindConverter.convert("test",
|
||||
ResolvableType.forClassWithGenerics(List.class, SampleType.class));
|
||||
assertThat(converted).isNotEmpty();
|
||||
assertThat(converted.get(0).getText()).isEqualTo("test");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void convertWhenHasEditorForArrayElementShouldConvert() {
|
||||
BindConverter bindConverter = getPropertyEditorOnlyBindConverter(
|
||||
this::registerSampleTypeEditor);
|
||||
SampleType[] converted = bindConverter.convert("test",
|
||||
ResolvableType.forClass(SampleType[].class));
|
||||
assertThat(converted).isNotEmpty();
|
||||
assertThat(converted[0].getText()).isEqualTo("test");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void convertWhenConversionServiceCanConvertShouldConvert() {
|
||||
BindConverter bindConverter = getBindConverter(new SampleTypeConverter());
|
||||
SampleType converted = bindConverter.convert("test",
|
||||
ResolvableType.forClass(SampleType.class));
|
||||
assertThat(converted.getText()).isEqualTo("test");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void convertWhenNotPropertyEditorAndConversionServiceCannotConvertShouldThrowException() {
|
||||
BindConverter bindConverter = new BindConverter(
|
||||
ApplicationConversionService.getSharedInstance(), null);
|
||||
this.thrown.expect(ConverterNotFoundException.class);
|
||||
bindConverter.convert("test", ResolvableType.forClass(SampleType.class));
|
||||
}
|
||||
|
||||
private BindConverter getPropertyEditorOnlyBindConverter(
|
||||
Consumer<PropertyEditorRegistry> propertyEditorInitializer) {
|
||||
return new BindConverter(new ThrowingConversionService(),
|
||||
propertyEditorInitializer);
|
||||
}
|
||||
|
||||
private BindConverter getBindConverter(Converter<?, ?> converter) {
|
||||
GenericConversionService conversionService = new GenericConversionService();
|
||||
conversionService.addConverter(converter);
|
||||
return new BindConverter(conversionService, null);
|
||||
}
|
||||
|
||||
private void registerSampleTypeEditor(PropertyEditorRegistry registry) {
|
||||
registry.registerCustomEditor(SampleType.class, new SampleTypePropertyEditor());
|
||||
}
|
||||
|
||||
static class SampleType {
|
||||
|
||||
private String text;
|
||||
|
||||
public String getText() {
|
||||
return this.text;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
static class SampleTypePropertyEditor extends PropertyEditorSupport {
|
||||
|
||||
@Override
|
||||
public void setAsText(String text) throws IllegalArgumentException {
|
||||
SampleType value = new SampleType();
|
||||
value.text = text;
|
||||
setValue(value);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
static class SampleTypeConverter implements Converter<String, SampleType> {
|
||||
|
||||
@Override
|
||||
public SampleType convert(String source) {
|
||||
SampleType result = new SampleType();
|
||||
result.text = source;
|
||||
return result;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
static class ConventionType {
|
||||
|
||||
private String text;
|
||||
|
||||
public String getText() {
|
||||
return this.text;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
static class ConventionTypeEditor extends PropertyEditorSupport {
|
||||
|
||||
@Override
|
||||
public void setAsText(String text) throws IllegalArgumentException {
|
||||
ConventionType value = new ConventionType();
|
||||
value.text = text;
|
||||
setValue(value);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link ConversionService} that always throws an {@link AssertionError}.
|
||||
*/
|
||||
private static class ThrowingConversionService implements ConversionService {
|
||||
|
||||
@Override
|
||||
public boolean canConvert(Class<?> sourceType, Class<?> targetType) {
|
||||
throw new AssertionError("Should not call conversion service");
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean canConvert(TypeDescriptor sourceType, TypeDescriptor targetType) {
|
||||
throw new AssertionError("Should not call conversion service");
|
||||
}
|
||||
|
||||
@Override
|
||||
public <T> T convert(Object source, Class<T> targetType) {
|
||||
throw new AssertionError("Should not call conversion service");
|
||||
}
|
||||
|
||||
@Override
|
||||
public Object convert(Object source, TypeDescriptor sourceType,
|
||||
TypeDescriptor targetType) {
|
||||
throw new AssertionError("Should not call conversion service");
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue