added conversion service performance optimizations; added mapping cyclical ref handling; removed ConverterInfo in favor of specifying S and T at registration time if necessary

This commit is contained in:
Keith Donald 2009-10-07 16:54:36 +00:00
parent c9f0e68c82
commit acf574c3e3
17 changed files with 248 additions and 99 deletions

View File

@ -17,6 +17,7 @@ package org.springframework.mapping.support;
import org.springframework.beans.BeanUtils; import org.springframework.beans.BeanUtils;
import org.springframework.core.convert.TypeDescriptor; import org.springframework.core.convert.TypeDescriptor;
import org.springframework.util.ClassUtils;
/** /**
* Creates a mapping target by calling its default constructor. * Creates a mapping target by calling its default constructor.
@ -25,7 +26,11 @@ import org.springframework.core.convert.TypeDescriptor;
*/ */
class DefaultMapperTargetFactory implements MapperTargetFactory { class DefaultMapperTargetFactory implements MapperTargetFactory {
public Object createTarget(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) { public boolean supports(TypeDescriptor targetType) {
return ClassUtils.hasConstructor(targetType.getType(), null);
}
public Object createTarget(TypeDescriptor targetType) {
return BeanUtils.instantiate(targetType.getType()); return BeanUtils.instantiate(targetType.getType());
} }

View File

@ -15,6 +15,8 @@
*/ */
package org.springframework.mapping.support; package org.springframework.mapping.support;
import org.springframework.beans.BeanUtils;
import org.springframework.core.convert.ConversionFailedException;
import org.springframework.core.convert.TypeDescriptor; import org.springframework.core.convert.TypeDescriptor;
import org.springframework.core.convert.support.GenericConverter; import org.springframework.core.convert.support.GenericConverter;
import org.springframework.mapping.Mapper; import org.springframework.mapping.Mapper;
@ -44,9 +46,33 @@ public class MapperConverter implements GenericConverter {
if (source == null) { if (source == null) {
return null; return null;
} }
// TODO - could detect cyclical reference here if had a mapping context? (source should not equal currently mapped object) if (SpelMappingContextHolder.contains(source)) {
Object target = this.mappingTargetFactory.createTarget(source, sourceType, targetType); return source;
return this.mapper.map(source, target); }
if (sourceType.isAssignableTo(targetType) && isCopyByReference(sourceType, targetType)) {
return source;
}
return createAndMap(targetType, source, sourceType);
} }
private boolean isCopyByReference(TypeDescriptor sourceType, TypeDescriptor targetType) {
if (BeanUtils.isSimpleValueType(targetType.getType()) || Enum.class.isAssignableFrom(targetType.getType())) {
return true;
} else {
return false;
}
}
private Object createAndMap(TypeDescriptor targetType, Object source, TypeDescriptor sourceType) {
if (this.mappingTargetFactory.supports(targetType)) {
Object target = this.mappingTargetFactory.createTarget(targetType);
return this.mapper.map(source, target);
} else {
IllegalStateException cause = new IllegalStateException("["
+ this.mappingTargetFactory.getClass().getName() + "] does not support target type ["
+ targetType.getName() + "]");
throw new ConversionFailedException(sourceType, targetType, source, cause);
}
}
} }

View File

@ -27,6 +27,13 @@ import org.springframework.mapping.Mapper;
*/ */
public interface MapperTargetFactory { public interface MapperTargetFactory {
/**
* Does this factory support creating mapping targets of the specified type
* @param targetType the targe type
* @return true if so, false otherwise
*/
public boolean supports(TypeDescriptor targetType);
/** /**
* Create the target object to be mapped to. * Create the target object to be mapped to.
* @param source the source object to map from * @param source the source object to map from
@ -34,5 +41,6 @@ public interface MapperTargetFactory {
* @param targetType the target object type descriptor * @param targetType the target object type descriptor
* @return the target * @return the target
*/ */
public Object createTarget(Object source, TypeDescriptor sourceType, TypeDescriptor targetType); public Object createTarget(TypeDescriptor targetType);
} }

View File

@ -22,6 +22,8 @@ import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Set; import java.util.Set;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.core.convert.TypeDescriptor; import org.springframework.core.convert.TypeDescriptor;
import org.springframework.core.convert.converter.ConverterRegistry; import org.springframework.core.convert.converter.ConverterRegistry;
import org.springframework.core.convert.support.DefaultConversionService; import org.springframework.core.convert.support.DefaultConversionService;
@ -45,6 +47,8 @@ import org.springframework.mapping.MappingFailure;
*/ */
public class SpelMapper implements Mapper<Object, Object> { public class SpelMapper implements Mapper<Object, Object> {
private static final Log logger = LogFactory.getLog(SpelMapper.class);
private static final MappableTypeFactory mappableTypeFactory = new MappableTypeFactory(); private static final MappableTypeFactory mappableTypeFactory = new MappableTypeFactory();
private static final SpelExpressionParser sourceExpressionParser = new SpelExpressionParser(); private static final SpelExpressionParser sourceExpressionParser = new SpelExpressionParser();
@ -92,26 +96,39 @@ public class SpelMapper implements Mapper<Object, Object> {
} }
public Object map(Object source, Object target) { public Object map(Object source, Object target) {
EvaluationContext sourceContext = getMappingContext(source); try {
EvaluationContext targetContext = getMappingContext(target); SpelMappingContextHolder.push(source);
List<MappingFailure> failures = new LinkedList<MappingFailure>(); EvaluationContext sourceContext = getEvaluationContext(source);
for (SpelMapping mapping : this.mappings) { EvaluationContext targetContext = getEvaluationContext(target);
mapping.map(sourceContext, targetContext, failures); List<MappingFailure> failures = new LinkedList<MappingFailure>();
for (SpelMapping mapping : this.mappings) {
doMap(mapping, sourceContext, targetContext, failures);
}
Set<SpelMapping> autoMappings = getAutoMappings(sourceContext, targetContext);
for (SpelMapping mapping : autoMappings) {
doMap(mapping, sourceContext, targetContext, failures);
}
if (!failures.isEmpty()) {
throw new MappingException(failures);
}
return target;
} finally {
SpelMappingContextHolder.pop();
} }
Set<SpelMapping> autoMappings = getAutoMappings(sourceContext, targetContext);
for (SpelMapping mapping : autoMappings) {
mapping.map(sourceContext, targetContext, failures);
}
if (!failures.isEmpty()) {
throw new MappingException(failures);
}
return target;
} }
private EvaluationContext getMappingContext(Object object) { private EvaluationContext getEvaluationContext(Object object) {
return mappableTypeFactory.getMappableType(object).getEvaluationContext(object, this.conversionService); return mappableTypeFactory.getMappableType(object).getEvaluationContext(object, this.conversionService);
} }
private void doMap(SpelMapping mapping, EvaluationContext sourceContext, EvaluationContext targetContext,
List<MappingFailure> failures) {
if (logger.isDebugEnabled()) {
logger.debug(SpelMappingContextHolder.getLevel() + mapping);
}
mapping.map(sourceContext, targetContext, failures);
}
private Set<SpelMapping> getAutoMappings(EvaluationContext sourceContext, EvaluationContext targetContext) { private Set<SpelMapping> getAutoMappings(EvaluationContext sourceContext, EvaluationContext targetContext) {
if (this.autoMappingEnabled) { if (this.autoMappingEnabled) {
Set<SpelMapping> autoMappings = new LinkedHashSet<SpelMapping>(); Set<SpelMapping> autoMappings = new LinkedHashSet<SpelMapping>();

View File

@ -0,0 +1,49 @@
package org.springframework.mapping.support;
import java.util.Stack;
import org.springframework.core.NamedThreadLocal;
class SpelMappingContextHolder {
private static final ThreadLocal<Stack<Object>> mappingContextHolder = new NamedThreadLocal<Stack<Object>>(
"Mapping context");
public static void push(Object source) {
Stack<Object> context = getContext();
if (context == null) {
context = new Stack<Object>();
mappingContextHolder.set(context);
}
context.add(source);
}
public static boolean contains(Object source) {
return getContext().contains(source);
}
public static void pop() {
Stack<Object> context = getContext();
if (context != null) {
context.pop();
if (context.isEmpty()) {
mappingContextHolder.set(null);
}
}
}
public static String getLevel() {
int size = getContext().size();
StringBuilder builder = new StringBuilder();
for (int i = 0; i < size; i++) {
builder.append("*");
}
builder.append(" ");
return builder.toString();
}
private static Stack<Object> getContext() {
return mappingContextHolder.get();
}
}

View File

@ -2,13 +2,14 @@ package org.springframework.mapping.support;
import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull; import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import java.math.BigDecimal;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.HashMap; import java.util.HashMap;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import org.junit.Ignore;
import org.junit.Test; import org.junit.Test;
import org.springframework.core.convert.converter.Converter; import org.springframework.core.convert.converter.Converter;
import org.springframework.mapping.MappingException; import org.springframework.mapping.MappingException;
@ -239,7 +240,6 @@ public class SpelMapperTests {
} }
@Test @Test
@Ignore
public void mapCyclic() { public void mapCyclic() {
Person source = new Person(); Person source = new Person();
source.setName("Keith"); source.setName("Keith");
@ -254,6 +254,72 @@ public class SpelMapperTests {
assertEquals(source.cyclic, target.cyclic); assertEquals(source.cyclic, target.cyclic);
} }
@Test
public void mapCyclicTypicalHibernateDomainModel() {
Order source = new Order();
source.setNumber(1);
LineItem item = new LineItem();
item.setAmount(new BigDecimal("30.00"));
item.setOrder(source);
source.setLineItem(item);
Order target = new Order();
mapper.map(source, target);
assertEquals(1, target.getNumber());
assertTrue(item != target.getLineItem());
assertEquals(new BigDecimal("30.00"), target.getLineItem().getAmount());
assertEquals(source, target.getLineItem().getOrder());
}
public static class Order {
private int number;
private LineItem lineItem;
public int getNumber() {
return number;
}
public void setNumber(int number) {
this.number = number;
}
public LineItem getLineItem() {
return lineItem;
}
public void setLineItem(LineItem lineItem) {
this.lineItem = lineItem;
}
}
public static class LineItem {
private BigDecimal amount;
private Order order;
public BigDecimal getAmount() {
return amount;
}
public void setAmount(BigDecimal amount) {
this.amount = amount;
}
public Order getOrder() {
return order;
}
public void setOrder(Order order) {
this.order = order;
}
}
public static class PersonDto { public static class PersonDto {
private String fullName; private String fullName;

View File

@ -11,11 +11,7 @@
</layout> </layout>
</appender> </appender>
<logger name="org.springframework.beans"> <logger name="org.springframework.mapping">
<level value="warn" />
</logger>
<logger name="org.springframework.binding">
<level value="debug" /> <level value="debug" />
</logger> </logger>

View File

@ -1,41 +0,0 @@
/*
* Copyright 2002-2009 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.core.convert.converter;
/**
* A meta interface a Converter may implement to describe what types he can convert between.
*
* Implementing this interface is required when registering converters that do not declare their
* parameterized types S and T with a {@link org.springframework.core.convert.ConversionService}.
*
* @author Keith Donald
* @since 3.0
* @see Converter
*/
public interface ConverterInfo {
/**
* The source type the converter converts from.
*/
Class<?> getSourceType();
/**
* The target type the converter converts to.
*/
Class<?> getTargetType();
}

View File

@ -16,6 +16,7 @@
package org.springframework.core.convert.support; package org.springframework.core.convert.support;
import java.util.Locale;
/** /**
* Default implementation of a conversion service. Will automatically register <i>from string</i> * Default implementation of a conversion service. Will automatically register <i>from string</i>
@ -31,15 +32,15 @@ public class DefaultConversionService extends GenericConversionService {
* Create a new default conversion service, installing the default converters. * Create a new default conversion service, installing the default converters.
*/ */
public DefaultConversionService() { public DefaultConversionService() {
addConverter(new StringToBooleanConverter()); addConverter(String.class, Boolean.class, new StringToBooleanConverter());
addConverter(new StringToCharacterConverter()); addConverter(String.class, Character.class, new StringToCharacterConverter());
addConverter(new StringToLocaleConverter()); addConverter(String.class, Locale.class, new StringToLocaleConverter());
addConverter(new NumberToCharacterConverter()); addConverter(Number.class, Character.class, new NumberToCharacterConverter());
addConverter(new ObjectToStringConverter()); addConverter(Object.class, String.class, new ObjectToStringConverter());
addConverterFactory(new StringToNumberConverterFactory()); addConverterFactory(String.class, Number.class, new StringToNumberConverterFactory());
addConverterFactory(new StringToEnumConverterFactory()); addConverterFactory(String.class, Enum.class, new StringToEnumConverterFactory());
addConverterFactory(new NumberToNumberConverterFactory()); addConverterFactory(Number.class, Number.class, new NumberToNumberConverterFactory());
addConverterFactory(new CharacterToNumberFactory()); addConverterFactory(Character.class, Number.class, new CharacterToNumberFactory());
} }
} }

View File

@ -33,7 +33,6 @@ import org.springframework.core.convert.ConverterNotFoundException;
import org.springframework.core.convert.TypeDescriptor; import org.springframework.core.convert.TypeDescriptor;
import org.springframework.core.convert.converter.Converter; import org.springframework.core.convert.converter.Converter;
import org.springframework.core.convert.converter.ConverterFactory; import org.springframework.core.convert.converter.ConverterFactory;
import org.springframework.core.convert.converter.ConverterInfo;
import org.springframework.core.convert.converter.ConverterRegistry; import org.springframework.core.convert.converter.ConverterRegistry;
import org.springframework.util.Assert; import org.springframework.util.Assert;
import org.springframework.util.ClassUtils; import org.springframework.util.ClassUtils;
@ -54,7 +53,7 @@ public class GenericConversionService implements ConversionService, ConverterReg
} }
}; };
private final Map<Class, Map<Class, GenericConverter>> sourceTypeConverters = new HashMap<Class, Map<Class, GenericConverter>>(); private final Map<Class, Map<Class, GenericConverter>> sourceTypeConverters = new HashMap<Class, Map<Class, GenericConverter>>(36);
private ConversionService parent; private ConversionService parent;
@ -132,7 +131,7 @@ public class GenericConversionService implements ConversionService, ConverterReg
} }
Class sourceType = typeInfo[0]; Class sourceType = typeInfo[0];
Class targetType = typeInfo[1]; Class targetType = typeInfo[1];
getSourceMap(sourceType).put(targetType, new ConverterAdapter(converter)); addConverter(sourceType, targetType, converter);
} }
public void addConverterFactory(ConverterFactory<?, ?> converterFactory) { public void addConverterFactory(ConverterFactory<?, ?> converterFactory) {
@ -143,7 +142,7 @@ public class GenericConversionService implements ConversionService, ConverterReg
} }
Class sourceType = typeInfo[0]; Class sourceType = typeInfo[0];
Class targetType = typeInfo[1]; Class targetType = typeInfo[1];
getSourceMap(sourceType).put(targetType, new ConverterFactoryAdapter(converterFactory)); addConverterFactory(sourceType, targetType, converterFactory);
} }
public void removeConvertible(Class<?> sourceType, Class<?> targetType) { public void removeConvertible(Class<?> sourceType, Class<?> targetType) {
@ -196,6 +195,28 @@ public class GenericConversionService implements ConversionService, ConverterReg
getSourceMap(sourceType).put(targetType, converter); getSourceMap(sourceType).put(targetType, converter);
} }
/**
* Registers a Converter with the sourceType and targetType to index on specified explicitly.
* This method performs better than {@link #addConverter(Converter)} because there parameterized types S and T don't have to be discovered.
* @param sourceType the source type to convert from
* @param targetType the target type to convert to
* @param converter the converter.
*/
protected void addConverter(Class<?> sourceType, Class<?> targetType, Converter<?, ?> converter) {
addGenericConverter(sourceType, targetType, new ConverterAdapter(converter));
}
/**
* Registers a ConverterFactory with the sourceType and targetType to index on specified explicitly.
* This method performs better than {@link #addConverter(ConverterFactory)} because there parameterized types S and T don't have to be discovered.
* @param sourceType the source type to convert from
* @param targetType the target type to convert to
* @param converter the converter.factory
*/
protected void addConverterFactory(Class<?> sourceType, Class<?> targetType, ConverterFactory<?, ?> converterFactory) {
addGenericConverter(sourceType, targetType, new ConverterFactoryAdapter(converterFactory));
}
/** /**
* Hook method to convert a null source. * Hook method to convert a null source.
* Default implementation returns <code>null</code>. * Default implementation returns <code>null</code>.
@ -259,15 +280,7 @@ public class GenericConversionService implements ConversionService, ConverterReg
} }
private Class[] getRequiredTypeInfo(Object converter, Class genericIfc) { private Class[] getRequiredTypeInfo(Object converter, Class genericIfc) {
Class[] typeInfo = new Class[2]; return GenericTypeResolver.resolveTypeArguments(converter.getClass(), genericIfc);
if (converter instanceof ConverterInfo) {
ConverterInfo info = (ConverterInfo) converter;
typeInfo[0] = info.getSourceType();
typeInfo[1] = info.getTargetType();
return typeInfo;
} else {
return GenericTypeResolver.resolveTypeArguments(converter.getClass(), genericIfc);
}
} }
private GenericConverter findConverterByClassPair(Class sourceType, Class targetType) { private GenericConverter findConverterByClassPair(Class sourceType, Class targetType) {

View File

@ -37,7 +37,7 @@ public interface GenericConverter {
/** /**
* Convert the source to the targetType described by the TypeDescriptor. * Convert the source to the targetType described by the TypeDescriptor.
* @param source the source object to convert (never <code>null</code>) * @param source the source object to convert (may be null)
* @param sourceType context about the source type to convert from * @param sourceType context about the source type to convert from
* @param targetType context about the target type to convert to * @param targetType context about the target type to convert to
* @return the converted object * @return the converted object

View File

@ -28,6 +28,14 @@ import org.springframework.core.convert.converter.Converter;
*/ */
final class ObjectToStringConverter implements Converter<Object, String> { final class ObjectToStringConverter implements Converter<Object, String> {
public Class<?> getSourceType() {
return Object.class;
}
public Class<?> getTargetType() {
return String.class;
}
public String convert(Object source) { public String convert(Object source) {
return source.toString(); return source.toString();
} }

View File

@ -49,7 +49,6 @@ final class StringToBooleanConverter implements Converter<String, Boolean> {
falseValues.add("0"); falseValues.add("0");
} }
public Boolean convert(String source) { public Boolean convert(String source) {
String value = (source != null ? source.trim() : null); String value = (source != null ? source.trim() : null);
if (!StringUtils.hasLength(value)) { if (!StringUtils.hasLength(value)) {

View File

@ -31,7 +31,9 @@ final class StringToCharacterConverter implements Converter<String, Character> {
return null; return null;
} }
if (source.length() > 1) { if (source.length() > 1) {
throw new IllegalArgumentException("Can only convert a [String] with length of 1 to a [Character]; string value '" + source + "' has length of " + source.length()); throw new IllegalArgumentException(
"Can only convert a [String] with length of 1 to a [Character]; string value '" + source
+ "' has length of " + source.length());
} }
return source.charAt(0); return source.charAt(0);
} }