Documentation

Dapper Usage

    Introduction

    Dapper is an object-relational mapper (ORM) for .NET. Abp.Dapper package simply integrates Dapper to ASP.NET Boilerplate. It works as secondary ORM provider with EF 6.x, EF Core or NHibernate.

    Installation

    Before you start, you need to install Abp.Dapper and one of EF Core, EF 6.x and NHibernate ORM nuget packages to project that you want to use it.

    Module Registration

    First you need to add DependsOn attribute for AbpDapperModule on your module where you register it.

    [DependsOn(
         typeof(AbpEntityFrameworkCoreModule),
         typeof(AbpDapperModule)
    )]
    public class MyModule : AbpModule
    {
        public override void Initialize()
        {
            IocManager.RegisterAssemblyByConvention(typeof(SampleApplicationModule).GetAssembly());
        }
    }

    Note that AbpDapperModule dependency should be added later than EF Core dependency.

    Entity to Table Mapping

    You can configure mappings. For example, Person class maps to Persons table in the following example:

    public class PersonMapper : ClassMapper<Person>
    {
        public PersonMapper()
        {
            Table("Persons");
            Map(x => x.Roles).Ignore();
            AutoMap();
        }
    }

    You should set the assemblies contains mapper classes. Excample:

    [DependsOn(
         typeof(AbpEntityFrameworkModule),
         typeof(AbpDapperModule)
    )]
    public class MyModule : AbpModule
    {
        public override void Initialize()
        {
            IocManager.RegisterAssemblyByConvention(typeof(SampleApplicationModule).GetAssembly());
            DapperExtensions.SetMappingAssemblies(new List<Assembly> { typeof(MyModule).GetAssembly() });
        }
    }
    			

    Usage

    After registering AbpDapperModule, you can use Generic IDapperRepository interface (instead of standard IRepository) to inject dapper repositories.

    public class SomeApplicationService : ITransientDependency
    {
        private readonly IDapperRepository<Person> _personDapperRepository;
        private readonly IRepository<Person> _personRepository;
    
        public SomeApplicationService(
            IRepository<Person> personRepository,
            IDapperRepository<Person> personDapperRepository)
        {
            _personRepository = personRepository;
            _personDapperRepository = personDapperRepository;
        }
    
        public void DoSomeStuff()
        {
            var people = _personDapperRepository.Query("select * from Persons");
        }
    }
    

    You can use both EF repositories and Dapper repositories at the same time, in the same transaction.