Add support for @Delimiter binding
Add a new `@Delimiter` annotation that can be used to change how a String value is bound to a Collection. Fixes gh-11883pull/11886/head
Phillip Webb
7 years ago
parent
f24c92c658
commit
d6ae4e48d8
@ -0,0 +1,98 @@
|
||||
/*
|
||||
* 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.convert;
|
||||
|
||||
import java.util.Arrays;
|
||||
import java.util.Collection;
|
||||
import java.util.Collections;
|
||||
import java.util.Set;
|
||||
import java.util.stream.Stream;
|
||||
|
||||
import org.springframework.core.CollectionFactory;
|
||||
import org.springframework.core.convert.ConversionService;
|
||||
import org.springframework.core.convert.TypeDescriptor;
|
||||
import org.springframework.core.convert.converter.ConditionalGenericConverter;
|
||||
import org.springframework.lang.Nullable;
|
||||
import org.springframework.util.Assert;
|
||||
import org.springframework.util.StringUtils;
|
||||
|
||||
/**
|
||||
* Converts a {@link Delimiter delimited} String to a Collection.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
class DelimitedStringToCollectionConverter implements ConditionalGenericConverter {
|
||||
|
||||
private final ConversionService conversionService;
|
||||
|
||||
DelimitedStringToCollectionConverter(ConversionService conversionService) {
|
||||
Assert.notNull(conversionService, "ConversionService must not be null");
|
||||
this.conversionService = conversionService;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Set<ConvertiblePair> getConvertibleTypes() {
|
||||
return Collections.singleton(new ConvertiblePair(String.class, Collection.class));
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean matches(TypeDescriptor sourceType, TypeDescriptor targetType) {
|
||||
return targetType.hasAnnotation(Delimiter.class)
|
||||
&& (targetType.getElementTypeDescriptor() == null
|
||||
|| this.conversionService.canConvert(sourceType,
|
||||
targetType.getElementTypeDescriptor()));
|
||||
}
|
||||
|
||||
@Override
|
||||
@Nullable
|
||||
public Object convert(@Nullable Object source, TypeDescriptor sourceType,
|
||||
TypeDescriptor targetType) {
|
||||
if (source == null) {
|
||||
return null;
|
||||
}
|
||||
return convert((String) source, sourceType, targetType);
|
||||
}
|
||||
|
||||
private Object convert(String source, TypeDescriptor sourceType,
|
||||
TypeDescriptor targetType) {
|
||||
Delimiter delimiter = targetType.getAnnotation(Delimiter.class);
|
||||
Assert.state(delimiter != null, "Missing @DelimitedStringFormat annotation");
|
||||
String[] elements = getElements(source, delimiter.value());
|
||||
TypeDescriptor elementDescriptor = targetType.getElementTypeDescriptor();
|
||||
Collection<Object> target = createCollection(targetType, elementDescriptor,
|
||||
elements.length);
|
||||
Stream<Object> stream = Arrays.stream(elements).map(String::trim);
|
||||
if (elementDescriptor != null) {
|
||||
stream = stream.map((element) -> this.conversionService.convert(element,
|
||||
sourceType, elementDescriptor));
|
||||
}
|
||||
stream.forEach(target::add);
|
||||
return target;
|
||||
}
|
||||
|
||||
private Collection<Object> createCollection(TypeDescriptor targetType,
|
||||
TypeDescriptor elementDescriptor, int length) {
|
||||
return CollectionFactory.createCollection(targetType.getType(),
|
||||
(elementDescriptor != null ? elementDescriptor.getType() : null), length);
|
||||
}
|
||||
|
||||
private String[] getElements(String source, String delimiter) {
|
||||
return StringUtils.delimitedListToStringArray(source,
|
||||
Delimiter.NONE.equals(delimiter) ? null : delimiter);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,51 @@
|
||||
/*
|
||||
* 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.convert;
|
||||
|
||||
import java.lang.annotation.Documented;
|
||||
import java.lang.annotation.ElementType;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
/**
|
||||
* Declares a field or method parameter should be converted to collection using the
|
||||
* specified delimiter.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
* @since 2.0.0
|
||||
*/
|
||||
@Documented
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@Target({ ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER,
|
||||
ElementType.ANNOTATION_TYPE })
|
||||
public @interface Delimiter {
|
||||
|
||||
/**
|
||||
* A delimiter value used to indicate that no delimiter is required and the result
|
||||
* should be a single element containing the entire string.
|
||||
*/
|
||||
String NONE = "";
|
||||
|
||||
/**
|
||||
* The delimiter to use or {@code NONE} if the entire contents should be treated as a
|
||||
* single element.
|
||||
* @return the delimiter
|
||||
*/
|
||||
String value();
|
||||
|
||||
}
|
||||
@ -0,0 +1,178 @@
|
||||
/*
|
||||
* 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.convert;
|
||||
|
||||
import java.util.Collection;
|
||||
import java.util.LinkedList;
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
|
||||
import org.junit.Before;
|
||||
import org.junit.Rule;
|
||||
import org.junit.Test;
|
||||
import org.junit.rules.ExpectedException;
|
||||
|
||||
import org.springframework.core.convert.TypeDescriptor;
|
||||
import org.springframework.core.convert.converter.GenericConverter.ConvertiblePair;
|
||||
import org.springframework.format.support.DefaultFormattingConversionService;
|
||||
import org.springframework.util.ReflectionUtils;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* Tests for {@link DelimitedStringToCollectionConverter}.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
public class DelimitedStringToCollectionConverterTests {
|
||||
|
||||
private DefaultFormattingConversionService service;
|
||||
|
||||
private DelimitedStringToCollectionConverter converter;
|
||||
|
||||
@Rule
|
||||
public ExpectedException thrown = ExpectedException.none();
|
||||
|
||||
@Before
|
||||
public void setup() {
|
||||
this.service = new DefaultFormattingConversionService(null, false);
|
||||
this.converter = new DelimitedStringToCollectionConverter(this.service);
|
||||
this.service.addConverter(this.converter);
|
||||
DefaultFormattingConversionService.addDefaultFormatters(this.service);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void createWhenConversionServiceIsNullShouldThrowException() {
|
||||
this.thrown.expect(IllegalArgumentException.class);
|
||||
this.thrown.expectMessage("ConversionService must not be null");
|
||||
new DelimitedStringToCollectionConverter(null);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getConvertiblePairShouldReturnStringCollectionPair() {
|
||||
Set<ConvertiblePair> types = this.converter.getConvertibleTypes();
|
||||
assertThat(types).hasSize(1);
|
||||
ConvertiblePair pair = types.iterator().next();
|
||||
assertThat(pair.getSourceType()).isEqualTo(String.class);
|
||||
assertThat(pair.getTargetType()).isEqualTo(Collection.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void matchesWhenTargetIsNotAnnotatedShouldReturnFalse() {
|
||||
TypeDescriptor sourceType = TypeDescriptor.valueOf(String.class);
|
||||
TypeDescriptor targetType = TypeDescriptor
|
||||
.nested(ReflectionUtils.findField(Values.class, "noAnnotation"), 0);
|
||||
assertThat(this.converter.matches(sourceType, targetType)).isFalse();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void matchesWhenHasAnnotationAndNoElementTypeShouldReturnTrue() {
|
||||
TypeDescriptor sourceType = TypeDescriptor.valueOf(String.class);
|
||||
TypeDescriptor targetType = TypeDescriptor
|
||||
.nested(ReflectionUtils.findField(Values.class, "noElementType"), 0);
|
||||
assertThat(this.converter.matches(sourceType, targetType)).isTrue();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void matchesWhenHasAnnotationAndConvertibleElementTypeShouldReturnTrue() {
|
||||
TypeDescriptor sourceType = TypeDescriptor.valueOf(String.class);
|
||||
TypeDescriptor targetType = TypeDescriptor.nested(
|
||||
ReflectionUtils.findField(Values.class, "convertibleElementType"), 0);
|
||||
assertThat(this.converter.matches(sourceType, targetType)).isTrue();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void matchesWhenHasAnnotationAndNonConvertibleElementTypeShouldReturnFalse() {
|
||||
TypeDescriptor sourceType = TypeDescriptor.valueOf(String.class);
|
||||
TypeDescriptor targetType = TypeDescriptor.nested(
|
||||
ReflectionUtils.findField(Values.class, "nonConvertibleElementType"), 0);
|
||||
assertThat(this.converter.matches(sourceType, targetType)).isFalse();
|
||||
}
|
||||
|
||||
@Test
|
||||
@SuppressWarnings("unchecked")
|
||||
public void convertWhenHasNoElementTypeShouldReturnTrimmedString() {
|
||||
TypeDescriptor sourceType = TypeDescriptor.valueOf(String.class);
|
||||
TypeDescriptor targetType = TypeDescriptor
|
||||
.nested(ReflectionUtils.findField(Values.class, "noElementType"), 0);
|
||||
List<String> converted = (List<String>) this.converter.convert(" a | b| c ",
|
||||
sourceType, targetType);
|
||||
assertThat(converted).containsExactly("a", "b", "c");
|
||||
}
|
||||
|
||||
@Test
|
||||
@SuppressWarnings("unchecked")
|
||||
public void convertWhenHasConvertibleElementTypeShouldReturnConvertedType() {
|
||||
TypeDescriptor sourceType = TypeDescriptor.valueOf(String.class);
|
||||
TypeDescriptor targetType = TypeDescriptor.nested(
|
||||
ReflectionUtils.findField(Values.class, "convertibleElementType"), 0);
|
||||
List<Integer> converted = (List<Integer>) this.converter.convert(" 1 | 2| 3 ",
|
||||
sourceType, targetType);
|
||||
assertThat(converted).containsExactly(1, 2, 3);
|
||||
}
|
||||
|
||||
@Test
|
||||
@SuppressWarnings("unchecked")
|
||||
public void convertWhenHasDelimiterOfNoneShouldReturnTrimmedStringElement() {
|
||||
TypeDescriptor sourceType = TypeDescriptor.valueOf(String.class);
|
||||
TypeDescriptor targetType = TypeDescriptor
|
||||
.nested(ReflectionUtils.findField(Values.class, "delimiterNone"), 0);
|
||||
List<String> converted = (List<String>) this.converter.convert("a,b,c",
|
||||
sourceType, targetType);
|
||||
assertThat(converted).containsExactly("a,b,c");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void convertWhenHasCollectionObjectTypeShouldUseCollectionObjectType() {
|
||||
TypeDescriptor sourceType = TypeDescriptor.valueOf(String.class);
|
||||
TypeDescriptor targetType = TypeDescriptor
|
||||
.nested(ReflectionUtils.findField(Values.class, "specificType"), 0);
|
||||
Object converted = this.converter.convert("a*b", sourceType, targetType);
|
||||
assertThat(converted).isInstanceOf(MyCustomList.class);
|
||||
}
|
||||
|
||||
static class Values {
|
||||
|
||||
List<String> noAnnotation;
|
||||
|
||||
@SuppressWarnings("rawtypes")
|
||||
@Delimiter("|")
|
||||
List noElementType;
|
||||
|
||||
@Delimiter("|")
|
||||
List<Integer> convertibleElementType;
|
||||
|
||||
@Delimiter("|")
|
||||
List<NonConvertible> nonConvertibleElementType;
|
||||
|
||||
@Delimiter(Delimiter.NONE)
|
||||
List<String> delimiterNone;
|
||||
|
||||
@Delimiter("*")
|
||||
MyCustomList<String> specificType;
|
||||
|
||||
}
|
||||
|
||||
static class NonConvertible {
|
||||
|
||||
}
|
||||
|
||||
static class MyCustomList<E> extends LinkedList<E> {
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue