third_codes/mapstruct
1
0
Fork 0
mirror of https://github.com/mapstruct/mapstruct.git synced 2025-07-12 00:00:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

#157 introduction of conversionY( methodX ( parameter ) )

Browse Source
This commit is contained in:
sjaakd 2014-03-23 00:30:21 +01:00
parent 23f3d4a3c1
commit 01e918b3e0
7 changed files with 353 additions and 299 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
processor/src/main/java/org/mapstruct/ap/model/TypeConversion.java
View File

@ -38,6 +38,12 @@ public class TypeConversion extends ModelElement {
private final String sourceReference;
private final String openExpression;
private final String closeExpression;
/**
* A reference to mapping method in case this is a two-step mapping, e.g. from
* {@code JAXBElement<Bar>} to {@code Foo} to for which a nested method call will be generated:
* {@code setFoo(barToFoo( jaxbElemToValue( bar) ) )}
*/
private MethodReference methodRefChild;
public TypeConversion( Set<Type> importTypes,
List<Type> exceptionTypes,
@ -72,4 +78,12 @@ public class TypeConversion extends ModelElement {
public String getCloseExpression() {
return closeExpression;
}
public void setMethodRefChild( MethodReference methodRefChild ) {
this.methodRefChild = methodRefChild;
}
public MethodReference getMethodRefChild() {
return methodRefChild;
}
}

316
processor/src/main/java/org/mapstruct/ap/processor/creation/MappingResolver.java
View File

@ -121,70 +121,107 @@ public class MappingResolver {
String dateFormat,
String sourceReference ) {
MethodReference mappingMethodReference = resolveViaMethod(
mappingMethod,
ResolvingAttempt attempt = new ResolvingAttempt( mappingMethod,
mappedElement,
mapperReferences,
methods,
sourceType,
targetType,
targetPropertyName,
dateFormat
);
TargetAssignment assignment = null;
if (mappingMethodReference != null ) {
assignment = new TargetAssignment(mappingMethodReference );
}
else if (sourceType.isAssignableTo( targetType ) ) {
assignment = new TargetAssignment();
}
else {
TypeConversion conversion = resolveViaConversion( sourceType, targetType, dateFormat, sourceReference );
if ( conversion != null ) {
assignment = new TargetAssignment(conversion );
}
else {
mappingMethodReference = resolveViaMethodAndMethod(
mappingMethod,
mappedElement,
mapperReferences,
methods,
sourceType,
targetType,
targetPropertyName,
dateFormat
);
if ( mappingMethodReference != null ) {
assignment = new TargetAssignment( mappingMethodReference );
}
else {
mappingMethodReference = resolveViaConversionAndMethod(
mappingMethod,
mappedElement,
mapperReferences,
methods,
sourceType,
targetType,
targetPropertyName,
dateFormat,
sourceReference );
sourceReference,
this
);
return attempt.getTargetAssignment( sourceType, targetType );
}
if ( mappingMethodReference != null ) {
assignment = new TargetAssignment( mappingMethodReference );
}
}
}
return assignment;
public Set<VirtualMappingMethod> getVirtualMethodsToGenerate() {
return virtualMethods;
}
private TypeConversion resolveViaConversion( Type sourceType,
Type targetType,
private static class ResolvingAttempt {
private final SourceMethod mappingMethod;
private final String mappedElement;
private final List<MapperReference> mapperReferences;
private final List<SourceMethod> methods;
private final String targetPropertyName;
private final String dateFormat;
private final String sourceReference;
private final MappingResolver context;
// resolving via 2 steps creates the possibillity of wrong matches, first builtin method matches,
// second doesn't. In that case, the first builtin method should not lead to a virtual method
// so this set must be cleared.
private final Set<VirtualMappingMethod> virtualMethodCandidates;
private ResolvingAttempt( SourceMethod mappingMethod,
String mappedElement,
List<MapperReference> mapperReferences,
List<SourceMethod> methods,
String targetPropertyName,
String dateFormat,
String sourceReference ) {
ConversionProvider conversionProvider = conversions.getConversion( sourceType, targetType );
String sourceReference,
MappingResolver context ) {
this.mappingMethod = mappingMethod;
this.mappedElement = mappedElement;
this.mapperReferences = mapperReferences;
this.methods = methods;
this.targetPropertyName = targetPropertyName;
this.dateFormat = dateFormat;
this.sourceReference = sourceReference;
this.context = context;
this.virtualMethodCandidates = new HashSet<VirtualMappingMethod>();
}
private TargetAssignment getTargetAssignment( Type sourceType, Type targetType ) {
// first simpele mapping method
MethodReference mappingMethodReference = resolveViaMethod( sourceType, targetType );
if ( mappingMethodReference != null ) {
context.virtualMethods.addAll( virtualMethodCandidates );
return new TargetAssignment( mappingMethodReference );
}
// then direct assignable
if ( sourceType.isAssignableTo( targetType ) ) {
return new TargetAssignment();
}
// then type conversion
TypeConversion conversion = resolveViaConversion( sourceType, targetType );
if ( conversion != null ) {
return new TargetAssignment( conversion );
}
// 2 step method, first: method(method(souurce))
mappingMethodReference = resolveViaMethodAndMethod( sourceType, targetType );
if ( mappingMethodReference != null ) {
context.virtualMethods.addAll( virtualMethodCandidates );
return new TargetAssignment( mappingMethodReference );
}
// 2 step method, then: method(conversion(souurce))
mappingMethodReference = resolveViaConversionAndMethod( sourceType, targetType );
if ( mappingMethodReference != null ) {
context.virtualMethods.addAll( virtualMethodCandidates );
return new TargetAssignment( mappingMethodReference );
}
// 2 step method, finally: conversion(method(souurce))
conversion = resolveViaMethodAndConversion( sourceType, targetType );
if ( conversion != null ) {
context.virtualMethods.addAll( virtualMethodCandidates );
return new TargetAssignment( conversion );
}
// if nothing works, alas, the result is null
return null;
}
private TypeConversion resolveViaConversion( Type sourceType, Type targetType ) {
ConversionProvider conversionProvider = context.conversions.getConversion( sourceType, targetType );
if ( conversionProvider == null ) {
return null;
@ -192,49 +229,35 @@ public class MappingResolver {
return conversionProvider.to(
sourceReference,
new DefaultConversionContext( typeFactory, targetType, dateFormat )
new DefaultConversionContext( context.typeFactory, targetType, dateFormat )
);
}
/**
* Returns a reference to a method mapping the given source type to the given target type, if such a method exists.
* Returns a reference to a method mapping the given source type to the given target type, if such a method
* exists.
*
*/
private MethodReference resolveViaMethod( SourceMethod mappingMethod,
String mappedElement,
List<MapperReference> mapperReferences,
List<SourceMethod> methods,
Type sourceType,
Type targetType,
String targetPropertyName,
String dateFormat ) {
private MethodReference resolveViaMethod( Type sourceType, Type targetType ) {
// first try to find a matching source method
SourceMethod matchingSourceMethod = getBestMatch(
mappingMethod,
mappedElement,
methods,
sourceType,
targetType,
targetPropertyName
);
SourceMethod matchingSourceMethod = getBestMatch( methods, sourceType, targetType );
if ( matchingSourceMethod != null ) {
return getMappingMethodReference( matchingSourceMethod, mapperReferences, targetType );
}
// then a matching built-in method
BuiltInMethod matchingBuiltInMethod = getBestMatch(
mappingMethod,
mappedElement,
builtInMethods.getBuiltInMethods(),
sourceType,
targetType,
targetPropertyName
);
BuiltInMethod matchingBuiltInMethod =
getBestMatch( context.builtInMethods.getBuiltInMethods(), sourceType, targetType );
return matchingBuiltInMethod != null ?
getMappingMethodReference( matchingBuiltInMethod, targetType, dateFormat ) : null;
if ( matchingBuiltInMethod != null ) {
virtualMethodCandidates.add( new VirtualMappingMethod( matchingBuiltInMethod ) );
ConversionContext ctx = new DefaultConversionContext( context.typeFactory, targetType, dateFormat );
return new MethodReference( matchingBuiltInMethod, ctx );
}
return null;
}
/**
@ -247,49 +270,27 @@ public class MappingResolver {
* </ul>
* then this method tries to resolve this combination and make a mapping methodY( methodX ( parameter ) )
*/
private MethodReference resolveViaMethodAndMethod( SourceMethod mappingMethod,
String mappedElement,
List<MapperReference> mapperReferences,
List<SourceMethod> methods,
Type sourceType,
Type targetType,
String targetPropertyName,
String dateFormat ) {
private MethodReference resolveViaMethodAndMethod( Type sourceType, Type targetType ) {
List<Method> methodYCandidates = new ArrayList<Method>( methods );
methodYCandidates.addAll( builtInMethods.getBuiltInMethods() );
methodYCandidates.addAll( context.builtInMethods.getBuiltInMethods() );
MethodReference methodRefY = null;
// Iterate over all source methods. Check if the return type matches with the parameter that we need.
// so assume we need a method from A to C we look for a methodX from A to B (all methods in the
// list form such a candidate).
// For each of the candidates, we need to look if there's a methodY, either
// sourceMethod or builtIn that fits the signature B to C. Only then there is a match. If we have a match
// a nested method call can be called. so C = methodY( methodX (A) )
for ( Method methodYCandidate : methodYCandidates ) {
if ( methodYCandidate.getSourceParameters().size() == 1 ) {
methodRefY = resolveViaMethod(
mappingMethod,
mappedElement,
mapperReferences,
methods,
methodYCandidate.getSourceParameters().get( 0 ).getType(),
targetType,
targetPropertyName,
dateFormat
);
methodRefY = resolveViaMethod( methodYCandidate.getSourceParameters().get( 0 ).getType(),
targetType );
if ( methodRefY != null ) {
MethodReference methodRefX = resolveViaMethod(
mappingMethod,
mappedElement,
mapperReferences,
methods,
sourceType,
methodYCandidate.getSourceParameters().get( 0 ).getType(),
targetPropertyName,
dateFormat
methodYCandidate.getSourceParameters().get( 0 ).getType()
);
if ( methodRefX != null ) {
methodRefY.setMethodRefChild( methodRefX );
@ -297,6 +298,7 @@ public class MappingResolver {
}
else {
// both should match;
virtualMethodCandidates.clear();
methodRefY = null;
}
}
@ -313,46 +315,31 @@ public class MappingResolver {
* </ul>
* then this method tries to resolve this combination and make a mapping methodY( conversionX ( parameter ) )
*/
private MethodReference resolveViaConversionAndMethod( SourceMethod mappingMethod,
String mappedElement,
List<MapperReference> mapperReferences,
List<SourceMethod> methods,
Type sourceType,
Type targetType,
String targetPropertyName,
String dateFormat,
String sourceReference ) {
private MethodReference resolveViaConversionAndMethod( Type sourceType, Type targetType ) {
List<Method> methodYCandidates = new ArrayList<Method>( methods );
methodYCandidates.addAll( builtInMethods.getBuiltInMethods() );
methodYCandidates.addAll( context.builtInMethods.getBuiltInMethods() );
MethodReference methodRefY = null;
for ( Method methodYCandidate : methodYCandidates ) {
if ( methodYCandidate.getSourceParameters().size() == 1 ) {
methodRefY = resolveViaMethod(
mappingMethod,
mappedElement,
mapperReferences,
methods,
methodYCandidate.getSourceParameters().get( 0 ).getType(),
targetType,
targetPropertyName,
dateFormat
targetType
);
if ( methodRefY != null ) {
TypeConversion conversionXRef = resolveViaConversion(
sourceType,
methodYCandidate.getSourceParameters().get( 0 ).getType(),
dateFormat,
sourceReference
methodYCandidate.getSourceParameters().get( 0 ).getType()
);
if ( conversionXRef != null ) {
methodRefY.setTypeConversionChild( conversionXRef );
break;
}
else {
// both should match;
// both should match
virtualMethodCandidates.clear();
methodRefY = null;
}
}
@ -361,15 +348,51 @@ public class MappingResolver {
return methodRefY;
}
/**
* Suppose mapping required from A to C and:
* <ul>
* <li>there is a conversion from A to B, conversionX</li>
* <li>there is a method from B to C, methodY</li>
* </ul>
* then this method tries to resolve this combination and make a mapping methodY( conversionX ( parameter ) )
*/
private TypeConversion resolveViaMethodAndConversion( Type sourceType, Type targetType ) {
private <T extends Method> T getBestMatch( SourceMethod mappingMethod,
String mappedElement,
List<T> methods,
Type sourceType,
Type returnType,
String targetPropertyName ) {
List<Method> methodXCandidates = new ArrayList<Method>( methods );
methodXCandidates.addAll( context.builtInMethods.getBuiltInMethods() );
List<T> candidates = methodSelectors.getMatchingMethods(
TypeConversion conversionYRef = null;
// search the other way arround
for ( Method methodXCandidate : methodXCandidates ) {
if ( methodXCandidate.getSourceParameters().size() == 1 ) {
MethodReference methodRefX = resolveViaMethod(
sourceType,
methodXCandidate.getReturnType()
);
if ( methodRefX != null ) {
conversionYRef = resolveViaConversion(
methodXCandidate.getReturnType(),
targetType
);
if ( conversionYRef != null ) {
conversionYRef.setMethodRefChild( methodRefX );
break;
}
else {
// both should match;
virtualMethodCandidates.clear();
conversionYRef = null;
}
}
}
}
return conversionYRef;
}
private <T extends Method> T getBestMatch( List<T> methods, Type sourceType, Type returnType ) {
List<T> candidates = context.methodSelectors.getMatchingMethods(
mappingMethod,
methods,
sourceType,
@ -377,10 +400,11 @@ public class MappingResolver {
targetPropertyName
);
// raise an error if more than one mapping method is suitable to map the given source type into the target type
// raise an error if more than one mapping method is suitable to map the given source type
// into the target type
if ( candidates.size() > 1 ) {
messager.printMessage(
context.messager.printMessage(
Kind.ERROR,
String.format(
"Ambiguous mapping methods found for mapping " + mappedElement + " from %s to %s: %s.",
@ -399,11 +423,6 @@ public class MappingResolver {
return null;
}
public Set<VirtualMappingMethod> getVirtualMethodsToGenerate() {
return virtualMethods;
}
private MethodReference getMappingMethodReference( SourceMethod method,
List<MapperReference> mapperReferences,
Type targetType ) {
@ -416,7 +435,7 @@ public class MappingResolver {
);
}
private MapperReference findMapperReference(List<MapperReference> mapperReferences, SourceMethod method) {
private MapperReference findMapperReference( List<MapperReference> mapperReferences, SourceMethod method ) {
for ( MapperReference ref : mapperReferences ) {
if ( ref.getType().equals( method.getDeclaringMapper() ) ) {
return ref;
@ -424,12 +443,5 @@ public class MappingResolver {
}
return null;
}
private MethodReference getMappingMethodReference(BuiltInMethod method, Type returnType, String dateFormat) {
virtualMethods.add( new VirtualMappingMethod( method ) );
ConversionContext ctx = new DefaultConversionContext( typeFactory, returnType, dateFormat );
return new MethodReference( method, ctx );
}
}

2
processor/src/main/resources/org.mapstruct.ap.model.MethodReference.ftl
View File

@ -32,7 +32,7 @@
<@includeModel object=methodRefChild source=ext.source targetType=singleSourceParameterType.name/>
<#elseif typeConversion??>
<#-- the nested case: a type conversion -->
<@includeModel object=typeConversion/>
<@includeModel object=typeConversion source=ext.source targetType=singleSourceParameterType.name/>
<#else>
<#-- the non nested case -->
${ext.source}

2
processor/src/main/resources/org.mapstruct.ap.model.TargetAssignment.ftl
View File

@ -52,7 +52,7 @@
<#compress>
<#switch assignmentType>
<#case "TYPE_CONVERSION">
<@includeModel object=typeConversion/>
<@includeModel object=typeConversion source="${ext.source}" targetType=ext.targetType/>
<#break>
<#case "METHOD_REFERENCE">
<@includeModel object=methodReference source="${ext.source}" targetType=ext.targetType raw=ext.raw/>

8
processor/src/main/resources/org.mapstruct.ap.model.TypeConversion.ftl
View File

@ -18,4 +18,10 @@
limitations under the License.
-->
${openExpression}${sourceReference}${closeExpression}
<#if methodRefChild??>
<#-- the nested case: mapping method -->
${openExpression}<@includeModel object=methodRefChild source=ext.source targetType=ext.targetType/>${closeExpression}
<#else>
<#-- the non nested case: a type conversion -->
${openExpression}${sourceReference}${closeExpression}
</#if>

22
processor/src/test/java/org/mapstruct/ap/test/nestedmethodcall/NestedMappingMethodInvocationTest.java
View File

@ -83,6 +83,22 @@ public class NestedMappingMethodInvocationTest {
assertThat( target.getOrderDetails().getDescription() ).containsExactly( "elem1", "elem2" );
}
@Test
@WithClasses( {
SourceTypeTargetDtoMapper.class,
SourceType.class,
ObjectFactory.class,
TargetDto.class
} )
public void shouldMapViaMethodAndConversion() throws DatatypeConfigurationException {
SourceTypeTargetDtoMapper instance = SourceTypeTargetDtoMapper.INSTANCE;
TargetDto target = instance.sourceToTarget( createSource() );
assertThat( target ).isNotNull();
assertThat( target.getDate() ).isEqualTo( new GregorianCalendar( 2013, 6, 6 ).getTime() );
}
@Test
@WithClasses( {
SourceTypeTargetDtoMapper.class,
@ -143,6 +159,12 @@ public class NestedMappingMethodInvocationTest {
.newXMLGregorianCalendarDate( year, month, day, DatatypeConstants.FIELD_UNDEFINED );
}
private SourceType createSource() {
SourceType source = new SourceType();
source.setDate( new JAXBElement<String>( QNAME, String.class, "06.07.2013" ) );
return source;
}
private TargetDto createTarget() {
TargetDto target = new TargetDto();
target.setDate( new GregorianCalendar( 2013, 6, 6 ).getTime() );

2
processor/src/test/java/org/mapstruct/ap/test/nestedmethodcall/SourceTypeTargetDtoMapper.java
View File

@ -32,7 +32,7 @@ public interface SourceTypeTargetDtoMapper {
SourceTypeTargetDtoMapper INSTANCE = Mappers.getMapper( SourceTypeTargetDtoMapper.class );
@Mapping(source = "date", target = "date", dateFormat = "dd.MM.yyyy")
TargetDto sourceToTarget(SourceType source);
SourceType targetToSource( TargetDto source );
// TargetDto sourceToTarget(SourceType source);
}