开源实体映射框架EmitMapper介绍

 

• 综述

      EmitMapper是一个开源实体映射框架，地址：http://emitmapper.codeplex.com/。

      EmitMapper映射效率比较高，接近硬编码。EmitMapper采用emit方式在运行时动态生成IL，而其他映射框架多是采用反射机制。此外EmitMapper最大限度地减少了拆箱装箱操作和映射过程中的额外的调用。

      EmitMapper支持.net的所有平台：Framework 3.5、Microsoft Silverlight 3、Mono。

 

      EmitMapper的使用非常简单，不需要指定任何的映射策略。系统会采用默认的映射配置器DefaultMapConfig完成映射操作。

 

    public class Sourse
    {
        public int A;
        public decimal? B;
        public string C;
        public Inner D;
        public string E;
    }

    public class Dest
    {
        public int? A;
        public decimal B;
        public DateTime C;
        public Inner D;
        public string F;
    }

    public class Inner
    {
        public long D1;
        public Guid D2;
    }

    Sourse src = new Sourse
    {
        A = 1,
        B = 0M,
        C = "2011/9/21 0:00:00",
        D = new Inner
        {
            D2 = Guid.NewGuid()
        },
        E = "test"
    };

    ObjectsMapper<Sourse, Dest> mapper = 
        ObjectMapperManager.DefaultInstance.GetMapper<Sourse, Dest>();
Dest dst = mapper.Map(src);

    Assert.AreEqual<string>(dst.B.ToString(), src.B);
    Assert.AreEqual<long>(dst.C.C1, 0L);
    Assert.AreEqual<Guid>(dst.C.C2, src.C.C2);
    Assert.IsNull(dst.E);

 

 

• 默认映射配置器

      默认的映射配置器能自动转换以下几种类型：

任何类型到string类型使用ToString()方法；

可以使用System.Convert类转换的原始类型；

可空类型、枚举类型、各种集合类型、结构与类；

复杂的嵌套类型采用递归方式转换；

 

      如果默认的转换满足不了需求，默认的映射配置器还允许指定命名约定，自定义构造函数，自定义转换器，忽略成员等。

     

支持的方法	描述
ConvertUsing	为指定的成员提供自定义的转换逻辑
ConvertGeneric	为指定的泛型类型成员提供自定义的转换逻辑
ConstructBy	为目标对象使用指定的构造函数替代默认构造函数
NullSubstitution	当源对象中指定的成员在为null时，给目标对象的成员赋值
IgnoreMembers	忽略指定成员的映射
PostProcess	在映射完成后执行指定的方法
ShallowMap	指定的成员采用浅拷贝方式映射
DeepMap	指定的成员采用深拷贝方式映射
MatchMembers	如果成员名称的映射不采用精确匹配，可以指定具体的映射逻辑

 

      选择几个方法简单示例如下：

 

    public class Sourse
    {
        public int A;
        public decimal? B;
        public string C;
        public Inner D;
        public string E;
    }

    public class Dest
    {
        public int? A;
        public decimal B;
        public DateTime C;
        public Inner2 D;
        public string F;
    }

    public class Inner
    {
        public long D1;
        public Guid D2;
    }

    public class Inner2
    {
        public long D12;
        public Guid D22;
    }

    ObjectsMapper<Sourse, Dest> mapper1 = 
        new ObjectMapperManager().GetMapper<Sourse, Dest>(
            new DefaultMapConfig()
            .IgnoreMembers<Sourse, Dest>(new string[] { "A" })
            .NullSubstitution<decimal?, decimal>((value) => -1M)
            .ConvertUsing<Inner, Inner2>(value => new Inner2 { D12 = value.D1, D22 = value.D2 })
            .PostProcess<Dest>((value, state) => { value.F = "nothing"; return value; })
            );
    Dest dst = mapper1.Map(src);

    Assert.IsNull(dst.A);
    Assert.AreEqual<decimal>(dst.B, -1M);
    Assert.AreEqual<Guid>(dst.D.D22, src.D.D2);
    Assert.AreEqual<string>(dst.F, "nothing");

  

 

• 自定义映射配置器

      当然EmitMapper是个非常灵活的框架，也可以自定义映射配置器，实现定制的映射操作。

      自定义的映射配置器可以继承自DefaultMapConfig或CustomMapConfig，利用基类的一些功能实现定制的映射，也可以继承自接口ImappingConfigurator，完全从头实现。

 

      比如可以实现从HTTP中通过Post方式提交的Form数据到具体业务实体类的映射，下面通过继承ImappingConfigurator来实现。

 

    public class FormCollectionMapConfig : IMappingConfigurator
    {        
        public static TPostData GetPostData<TPostData>() where TPostData : class , new()
        {
            ObjectsMapper<NameValueCollection, TPostData> mapper
                = new ObjectMapperManager().GetMapper<NameValueCollection, TPostData>(new FormCollectionMapConfig());

            return mapper.Map(HttpContext.Current.Request.Form);
        }

        public IMappingOperation[] GetMappingOperations(Type from, Type to)
        {
            var members = ReflectionUtils.GetPublicFieldsAndProperties(to);
            return members
                .Select(m => new DestWriteOperation()
                            {
                                Destination = new MemberDescriptor(m),
                                Getter =
                                    (ValueGetter<object>)
                                    (
                                        (form, status) =>
                                        {
                                            FormCollection forms = new FormCollection((NameValueCollection)form);
                                            IValueProvider valueProvider = forms.ToValueProvider();
                                            ValueProviderResult res = valueProvider.GetValue(m.Name);
                                            if (res != null)
                                            {
                                                return ValueToWrite<object>.ReturnValue(res.ConvertTo(ReflectionUtils.GetMemberType(m)));
                                            }
                                            else
                                            {
                                                return ValueToWrite<object>.Skip();
                                            }
                                        }
                                    )
                            }
                )
                .ToArray();
        }

        public string GetConfigurationName()
        {
            return null;
        }

        public IRootMappingOperation GetRootMappingOperation(Type from, Type to)
        {
            return null;
        }

        public StaticConvertersManager GetStaticConvertersManager()
        {
            return null;
        }
    }