有没有办法告诉AutoMapper忽略除显式映射的那些属性以外的所有属性?
我有可能从外部更改的外部DTO类,并且我想避免指定要显式忽略的每个属性,因为添加新属性会在尝试将它们映射到我自己的对象时破坏功能(导致异常)。
.ForAllOtherMembers(opts => opts.Ignore())
AssertConfigurationIsValid()
呼叫的测试)因此,我将“忽略其余部分”视为反模式。
有没有办法告诉AutoMapper忽略除显式映射的那些属性以外的所有属性?
我有可能从外部更改的外部DTO类,并且我想避免指定要显式忽略的每个属性,因为添加新属性会在尝试将它们映射到我自己的对象时破坏功能(导致异常)。
.ForAllOtherMembers(opts => opts.Ignore())
AssertConfigurationIsValid()
呼叫的测试)因此,我将“忽略其余部分”视为反模式。
Answers:
这是我写的扩展方法,它忽略了目标上所有不存在的属性。不知道它是否仍然有用,因为这个问题已有两年多了,但是我遇到了同样的问题,必须添加大量手动忽略调用。
public static IMappingExpression<TSource, TDestination> IgnoreAllNonExisting<TSource, TDestination>
(this IMappingExpression<TSource, TDestination> expression)
{
var flags = BindingFlags.Public | BindingFlags.Instance;
var sourceType = typeof (TSource);
var destinationProperties = typeof (TDestination).GetProperties(flags);
foreach (var property in destinationProperties)
{
if (sourceType.GetProperty(property.Name, flags) == null)
{
expression.ForMember(property.Name, opt => opt.Ignore());
}
}
return expression;
}
用法:
Mapper.CreateMap<SourceType, DestinationType>()
.IgnoreAllNonExisting();
更新:显然,如果您有自定义映射,这将无法正常工作,因为它会覆盖它们。我想如果先调用IgnoreAllNonExisting然后再调用自定义映射,它仍然可以工作。
schdr有一个解决方案(作为对此问题的解答),该解决方案Mapper.GetAllTypeMaps()
用于找出未映射的属性并自动忽略它们。对我来说似乎是一个更强大的解决方案。
据我了解,问题是目标上的字段在源中没有映射的字段,这就是为什么您正在寻找忽略那些非映射的目标字段的原因。
除了实现和使用这些扩展方法,您可以简单地使用
Mapper.CreateMap<sourceModel, destinationModel>(MemberList.Source);
现在,自动映射器知道仅需要验证所有源字段都已映射,而无需验证其他方式。
您还可以使用:
Mapper.CreateMap<sourceModel, destinationModel>(MemberList.Destination);
MemberList.Destination
也解决了操作问题。
我更新了Can Gencer的扩展程序,以不覆盖任何现有地图。
public static IMappingExpression<TSource, TDestination>
IgnoreAllNonExisting<TSource, TDestination>(this IMappingExpression<TSource, TDestination> expression)
{
var sourceType = typeof (TSource);
var destinationType = typeof (TDestination);
var existingMaps = Mapper.GetAllTypeMaps().First(x => x.SourceType.Equals(sourceType) && x.DestinationType.Equals(destinationType));
foreach (var property in existingMaps.GetUnmappedPropertyNames())
{
expression.ForMember(property, opt => opt.Ignore());
}
return expression;
}
用法:
Mapper.CreateMap<SourceType, DestinationType>()
.ForMember(prop => x.Property, opt => opt.MapFrom(src => src.OtherProperty))
.IgnoreAllNonExisting();
Mapper.GetAllTypeMaps()
已弃用)
Mapper.GetAllTypeMaps()
为即可Mapper.Configuration.GetAllTypeMaps()
。这是参考github.com/AutoMapper/AutoMapper/issues/1252
我已经可以通过以下方式做到这一点:
Mapper.CreateMap<SourceType, DestinationType>().ForAllMembers(opt => opt.Ignore());
Mapper.CreateMap<SourceType, DestinationType>().ForMember(/*Do explicit mapping 1 here*/);
Mapper.CreateMap<SourceType, DestinationType>().ForMember(/*Do explicit mapping 2 here*/);
...
注意:我正在使用AutoMapper v.2.0。
AutoMapper的5.0.0-beta-1版本引入了ForAllOtherMembers
扩展方法,因此您现在可以执行以下操作:
CreateMap<Source, Destination>()
.ForMember(d => d.Text, o => o.MapFrom(s => s.Name))
.ForMember(d => d.Value, o => o.MapFrom(s => s.Id))
.ForAllOtherMembers(opts => opts.Ignore());
请注意,显式映射每个属性有一个优势,因为您永远不会遇到忘记映射属性时出现的无提示映射失败问题。
也许在您的情况下,明智的做法是忽略所有其他成员,并添加一个,TODO
以便在此类更改的频率确定下来之后使它们明确显示。
ForAllOtherSourceMembers
什么?
从AutoMapper 5.0开始,该.TypeMap
属性IMappingExpression
消失了,这意味着4.2解决方案不再起作用。我创建了一个使用原始功能但使用不同语法的解决方案:
var config = new MapperConfiguration(cfg =>
{
cfg.CreateMap<Src, Dest>();
cfg.IgnoreUnmapped(); // Ignores unmapped properties on all maps
cfg.IgnoreUnmapped<Src, Dest>(); // Ignores unmapped properties on specific map
});
// or add inside a profile
public class MyProfile : Profile
{
this.IgnoreUnmapped();
CreateMap<MyType1, MyType2>();
}
实现方式:
public static class MapperExtensions
{
private static void IgnoreUnmappedProperties(TypeMap map, IMappingExpression expr)
{
foreach (string propName in map.GetUnmappedPropertyNames())
{
if (map.SourceType.GetProperty(propName) != null)
{
expr.ForSourceMember(propName, opt => opt.Ignore());
}
if (map.DestinationType.GetProperty(propName) != null)
{
expr.ForMember(propName, opt => opt.Ignore());
}
}
}
public static void IgnoreUnmapped(this IProfileExpression profile)
{
profile.ForAllMaps(IgnoreUnmappedProperties);
}
public static void IgnoreUnmapped(this IProfileExpression profile, Func<TypeMap, bool> filter)
{
profile.ForAllMaps((map, expr) =>
{
if (filter(map))
{
IgnoreUnmappedProperties(map, expr);
}
});
}
public static void IgnoreUnmapped(this IProfileExpression profile, Type src, Type dest)
{
profile.IgnoreUnmapped((TypeMap map) => map.SourceType == src && map.DestinationType == dest);
}
public static void IgnoreUnmapped<TSrc, TDest>(this IProfileExpression profile)
{
profile.IgnoreUnmapped(typeof(TSrc), typeof(TDest));
}
}
CreateMap<TSource,TDest>()
表达式中使用它Profile
?
自问这个问题以来已有好几年了,但是使用当前版本的AutoMapper(3.2.1),这种扩展方法对我来说似乎更干净:
public static IMappingExpression<TSource, TDestination> IgnoreUnmappedProperties<TSource, TDestination>(this IMappingExpression<TSource, TDestination> expression)
{
var typeMap = Mapper.FindTypeMapFor<TSource, TDestination>();
if (typeMap != null)
{
foreach (var unmappedPropertyName in typeMap.GetUnmappedPropertyNames())
{
expression.ForMember(unmappedPropertyName, opt => opt.Ignore());
}
}
return expression;
}
对于那些谁正在使用的非静态API在4.2.0及以上版本,下面的扩展方法(发现这里的AutoMapperExtensions
类)可用于:
// from http://stackoverflow.com/questions/954480/automapper-ignore-the-rest/6474397#6474397
public static IMappingExpression IgnoreAllNonExisting(this IMappingExpression expression)
{
foreach(var property in expression.TypeMap.GetUnmappedPropertyNames())
{
expression.ForMember(property, opt => opt.Ignore());
}
return expression;
}
这里重要的是,一旦删除了静态API,诸如之类的代码Mapper.FindTypeMapFor
将不再起作用,因此将使用该expression.TypeMap
字段。
expression.TypeMap
不再可用。这是我针对5.0
public static IMappingExpression<TSource, TDestination> IgnoreAllNonExisting<TSource, TDestination>(this IMappingExpression<TSource, TDestination> expression)
解决类型问题。
对于Automapper 5.0,为了跳过所有未映射的属性,您只需要放入
.ForAllOtherMembers(x => x.Ignore());
在您的个人资料末尾。
例如:
internal class AccountInfoEntityToAccountDtoProfile : Profile
{
public AccountInfoEntityToAccountDtoProfile()
{
CreateMap<AccountInfoEntity, AccountDto>()
.ForMember(d => d.Id, e => e.MapFrom(s => s.BankAcctInfo.BankAcctFrom.AcctId))
.ForAllOtherMembers(x=>x.Ignore());
}
}
在这种情况下,只会解析输出对象的Id字段,其他所有字段都将被跳过。像魅力一样工作,似乎我们不再需要任何棘手的扩展!
我已经更新了Robert Schroeder对于AutoMapper 4.2的答案。对于非静态映射器配置,我们不能使用Mapper.GetAllTypeMaps()
,但是expression
具有对必填项的引用TypeMap
:
public static IMappingExpression<TSource, TDestination>
IgnoreAllNonExisting<TSource, TDestination>(this IMappingExpression<TSource, TDestination> expression)
{
foreach (var property in expression.TypeMap.GetUnmappedPropertyNames())
{
expression.ForMember(property, opt => opt.Ignore());
}
return expression;
}
您希望如何指定某些成员被忽略?是否要使用约定,基类或属性?一旦您从事显式指定所有映射的业务,就不确定从AutoMapper获得什么价值。
关于忽略许多成员的唯一信息是此线程-http: //groups.google.com/group/automapper-users/browse_thread/thread/9928ce9f2ffa641f。我认为您可以使用ProvideCommonBaseClassConfiguration中使用的技巧来忽略相似类的公共属性。
并且没有有关“忽略其余”功能的信息。我之前已经看过代码,对我来说添加这样的功能似乎非常困难。您也可以尝试使用某些属性并为其标记被忽略的属性,并添加一些通用/通用代码以忽略所有已标记的属性。
您可以使用ForAllMembers,而不是像这样覆盖只需要
public static IMappingExpression<TSource, TDest> IgnoreAll<TSource, TDest>(this IMappingExpression<TSource, TDest> expression)
{
expression.ForAllMembers(opt => opt.Ignore());
return expression;
}
请注意,它将忽略所有内容,如果您不添加自定义映射,则它们已被忽略并且将无法使用
另外,我想说的是,如果您对AutoMapper进行单元测试。并且您测试了所有属性正确映射的模型,您不应该使用这种扩展方法
你应该显式地写ignore
在3.3.1版本中,您可以简单地使用IgnoreAllPropertiesWithAnInaccessibleSetter()
或IgnoreAllSourcePropertiesWithAnInaccessibleSetter()
方法。