在Asp.net (core)中使用AutoMapper(1)why & how

1. why

考虑以下类:

namespace AutoMapperTest
{
    public class Author
    {
        public string Name { get; set; }
    }
    public class Book
    {
        public string Title { get; set; }
        public Author Author { get; set; }
    }
    public class BookViewModel
    {
        public string Title { get; set; }
        public string Author { get; set; }
    }
}

如果想得到一个理想中的BookViewModel, 不借助任何类的帮助,我们可能会这样写:

BookViewModel model = new BookViewModel
{
    Title = book.Title,
    Author = book.Author.Name
}

嗯,看起来还好...
但如果BookViewModel类有20个字段呢?40个?写这样的代码可以直接写吐。不能忍。这时候有请AutoMapper上场。

2. how

  • 安装
    从NuGet添加Automapper包

    或者install-package automapper
  • 基本使用
Mapper.Initialize(cfg => cfg.CreateMap<Book, BookViewModel>());
//或者
//var config = new MapperConfiguration(cfg => cfg.CreateMap<Book, BookViewModel>());
//config.CreateMapper();

然后就可以使用Mapper了:

Book book = new Book { Author = new Author { Name = "Angeladaddy" }, Title = "Java两周从入门到放弃" };
var model = Mapper.Map<BookViewModel>(book);

此时运行程序不会报错,但是mapper结果不正确:


image.png

原因大家都能看到,mapper并不能自动识别不符合concention约定的字段定义,Author属性是个对象,我们必须告诉mapper该怎么样映射这个对象。

//修改map定义,将Book.Author.Name 映射到 BookViewModel的Author
 Mapper.Initialize(
                cfg => cfg.CreateMap<Book, BookViewModel>()
                    .ForMember(dest => dest.Author, 
                    opts => opts.MapFrom(src => src.Author.Name))
                );
image.png

that's all, 有关automapper知道这么多就基本能用了。需要注意的一点是,mapper定义必须越早越好。

2.1 在asp.net 中使用Automapper

其实我们使用automapper最常见的场景应该是在web开发中,由于前端模型定义和后端往往不一致,为了建立两者间的映射,我们不得不手动映射。有了automapper,这一切都方便了很多。
建立一个asp.net core 的api项目作为演示:


红框为添加或改动的内容
  • Models中,我们定义最常见的用户模型,方便起见,我们不引入数据库。
    public class User
    {
        [Key]
        public int Id { get; set; }
        public string Name { get; set; }
        public string Email { get; set; }
        public string Password { get; set; }
        public DateTime CreatedOn { get; set; } = DateTime.UtcNow;
    }

    public class UserViewModel
    {
        [Required]
        public string Name { get; set; }
        [Required, DataType(DataType.EmailAddress)]
        public string Email { get; set; }
        [Required, DataType(DataType.Password)]
        public string Password { get; set; }
        [Required, DataType(DataType.Password), Compare("Password")]
        public string ConfirmPassword { get; set; }
        [Required]
        public bool AgreedToTerms { get; set; }
    }

前端传进来的模型中多了ConfirmPassword 字段和AgreedToTerms 字段,这些字段我们不希望存入数据库,所以我们要建立UserViewModel→User(数据库类)的映射。
用Automapper我们的映射应该是这个样子:

var config = new AutoMapper.MapperConfiguration(cfg =>
{
    cfg.CreateMap<UserViewModel, User>();
});
var mapper = config.CreateMapper();

但是这段代码我们应该放在那里呢?这是一个web应用,我们的映射定义应该放在尽可能早的地方。那放在Startup.cs文件中的ConfigureServices方法中最合适不过:

 public void ConfigureServices(IServiceCollection services)
{
            var config = new AutoMapper.MapperConfiguration(cfg =>
            {
                cfg.CreateMap<UserViewModel, User>();
            });
            var mapper = config.CreateMapper();
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
}

但如果我们的映射类较多,这里就会显得很臃肿。而且这个map我想在所有地方可用,那最好是定一个service进行注入。
比较好的做法是建立一个profile,统一放置。新建AutoMapperProfileConfiguration.cs文件,在其中定义所有映射:

    public class AutoMapperProfileConfiguration : Profile
    {
         public AutoMapperProfileConfiguration() : this("MyProfile") { }

        protected AutoMapperProfileConfiguration(string profileName):base(profileName)
        {
            CreateMap<UserViewModel, User>();
        }
    }

然后在Startup中进行实例化并注册单例:

        public void ConfigureServices(IServiceCollection services)
        {
            var config = new AutoMapper.MapperConfiguration(cfg => {
                cfg.AddProfile(new AutoMapperProfileConfiguration());
            });
            var mapper = config.CreateMapper();
            services.AddSingleton(mapper);
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
        }

一切就绪,我们新建UsersController测试:

    [Route("api/[controller]")]
    [ApiController]
    public class UsersController : ControllerBase
    {
        private readonly IMapper _mapper;
        public UsersController(IMapper mapper)
        {
            _mapper = mapper;
        }
        [HttpPost]
        public JsonResult Index(UserViewModel uservm)
        {
            var user = _mapper.Map<User>(uservm);
            return new JsonResult(user) ;
        }

    }
automapper正确进行了映射,去除了多余字段
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343

推荐阅读更多精彩内容