ASP.NET Identity DbContext путаница

196

Приложение MVC 5 по умолчанию поставляется с этим фрагментом кода в IdentityModels.cs - этот фрагмент кода предназначен для всех операций идентификации ASP.NET для шаблонов по умолчанию:

public class ApplicationDbContext : IdentityDbContext<ApplicationUser>
{
    public ApplicationDbContext()
        : base("DefaultConnection")
    {
    }
}

Если я создаю новый контроллер, используя представления с Entity Framework, и создаю «Новый контекст данных ...» в диалоговом окне, я получаю следующее:

using System;
using System.Collections.Generic;
using System.Data.Entity;
using System.Linq;
using System.Web;

namespace WebApplication1.Models
{
    public class AllTheOtherStuffDbContext : DbContext
    {
        // You can add custom code to this file. Changes will not be overwritten.
        // 
        // If you want Entity Framework to drop and regenerate your database
        // automatically whenever you change your model schema, please use data migrations.
        // For more information refer to the documentation:
        // http://msdn.microsoft.com/en-us/data/jj591621.aspx

        public AllTheOtherStuffDbContext() : base("name=AllTheOtherStuffDbContext")
        {
        }

        public System.Data.Entity.DbSet<WebApplication1.Models.Movie> Movies { get; set; }

    }
} 

Если я создам другой контроллер + представление с использованием EF, например, для модели Animal, эта новая строка будет автоматически сгенерирована public System.Data.Entity.DbSet<WebApplication1.Models.Movie> Movies { get; set; }- как здесь:

using System;
using System.Collections.Generic;
using System.Data.Entity;
using System.Linq;
using System.Web;

namespace WebApplication1.Models
{
    public class AllTheOtherStuffDbContext : DbContext
    {
        // You can add custom code to this file. Changes will not be overwritten.
        // 
        // If you want Entity Framework to drop and regenerate your database
        // automatically whenever you change your model schema, please use data migrations.
        // For more information refer to the documentation:
        // http://msdn.microsoft.com/en-us/data/jj591621.aspx

        public AllTheOtherStuffDbContext() : base("name=AllTheOtherStuffDbContext")
        {
        }

        public System.Data.Entity.DbSet<WebApplication1.Models.Movie> Movies { get; set; }
        public System.Data.Entity.DbSet<WebApplication1.Models.Animal> Animals { get; set; }

    }
} 

ApplicationDbContext(для всех вещей ASP.NET Identity) наследуется от IdentityDbContextкоторого в свою очередь наследуется от DbContext. AllOtherStuffDbContext(для моих собственных вещей) наследует от DbContext.

Итак, мой вопрос:

Какой из этих двух ( ApplicationDbContextи AllOtherStuffDbContext) я должен использовать для всех моих других собственных моделей? Или я должен просто использовать автоматически сгенерированный по умолчанию, ApplicationDbContextтак как это не должно быть проблемой с его использованием, так как это происходит из базового класса DbContext, или будут некоторые издержки? Вы должны использовать только один DbContextобъект в своем приложении для всех ваших моделей (я где-то читал это), поэтому я не должен даже рассматривать возможность использования обоих ApplicationDbContextи AllOtherStuffDbContextв одном приложении? Или что является лучшей практикой в ​​MVC 5 с ASP.NET Identity?

Кот в сапогах
источник
1
Кстати; это сверхурочно и не нужно для моих глаз при сканировании документа: public System.Data.Entity.DbSet <WebApplication1.Models.Movie> Movies {get; устанавливать; } - часть System.Data.Entity и WebApplication1.Models. Разве его нельзя удалить из объявления и вместо этого добавить пространства имен в разделе операторов using?
PussInBoots
Кот - да на ваш комментарий. Это должно работать просто отлично.
SB2055
Это хороший и рабочий пример (MVC 6) и библиотека реализации с платформой ASP.NET 5 Identity (> = v3) без Entity Framework для MongoDB.Driver (> = v2.1.0) github.com/saan800/SaanSoft. AspNet.Identity3.MongoDB
Станислав Прусак,

Ответы:

178

Я бы использовал один класс Context, унаследованный от IdentityDbContext. Таким образом, вы можете иметь контекст, чтобы быть в курсе любых отношений между вашими классами и IdentityUser и ролями IdentityDbContext. В IdentityDbContext очень мало служебных данных, это обычный DbContext с двумя наборами DbSet. Один для пользователей и один для ролей.

Олав Нибё
источник
52
Это для отдельного проекта MVC5, но не желательно, когда производный DbContext используется несколькими проектами, некоторые не MVC5, где некоторые не нуждаются в поддержке Identity.
Дейв
Голосовали за ту же базу данных для удобства сопровождения и лучшей целостности отношений. Поскольку сущность пользователя и сущность роли будут легко связаны с другими объектами приложения.
anIBMer
6
@Dave - усложняет разбиение пользовательских данных, используя два разных контекста. Делает ли ваше MVC приложение разделение данных пользователем, а другие приложения нет. Распространение одного и того же слоя данных является обычным явлением, но я не думаю, что это обычное явление, когда некоторым проектам нужны данные, распределенные пользователем, а другим нет.
RickAndMSFT
1
Кто-нибудь знает о том, как извлечь ApplicationDBContext из проекта MVC и включить его в существующий уровень данных EF? Объединение двух, как описано выше, кажется правильным, но я работаю над ограниченным во времени проектом. Я хочу сделать это правильно с первого раза, но хотел бы получить хедз-ап на все ошибки, которые находятся передо мной ...
Майк Девенни
7
Пройдя примерно час поиска, этот ответ указал мне верное направление - но я не был уверен, как его реализовать (для меня очень буквального человека). Поэтому, если это кому-то поможет, я обнаружил, что самый простой способ - открыть IdentityModels.cs и добавить свой новый DbSet в класс ApplicationDbContext.
SeanOB
45

IdentityDbContext , быстрый поиск в Stackoverflow, вызывает много недоразумений , и вы найдете следующие вопросы:
« Почему Asp.Net Identity IdentityDbContext является черным ящиком?
Как изменить имена таблиц при использовании AspNet Identity в Visual Studio 2013?
Объединить MyDbContext с IdentityDbContext "

Чтобы ответить на все эти вопросы, нам нужно понять, что IdentityDbContext - это просто класс, унаследованный от DbContext.
Давайте посмотрим на источник IdentityDbContext :

/// <summary>
/// Base class for the Entity Framework database context used for identity.
/// </summary>
/// <typeparam name="TUser">The type of user objects.</typeparam>
/// <typeparam name="TRole">The type of role objects.</typeparam>
/// <typeparam name="TKey">The type of the primary key for users and roles.</typeparam>
/// <typeparam name="TUserClaim">The type of the user claim object.</typeparam>
/// <typeparam name="TUserRole">The type of the user role object.</typeparam>
/// <typeparam name="TUserLogin">The type of the user login object.</typeparam>
/// <typeparam name="TRoleClaim">The type of the role claim object.</typeparam>
/// <typeparam name="TUserToken">The type of the user token object.</typeparam>
public abstract class IdentityDbContext<TUser, TRole, TKey, TUserClaim, TUserRole, TUserLogin, TRoleClaim, TUserToken> : DbContext
    where TUser : IdentityUser<TKey, TUserClaim, TUserRole, TUserLogin>
    where TRole : IdentityRole<TKey, TUserRole, TRoleClaim>
    where TKey : IEquatable<TKey>
    where TUserClaim : IdentityUserClaim<TKey>
    where TUserRole : IdentityUserRole<TKey>
    where TUserLogin : IdentityUserLogin<TKey>
    where TRoleClaim : IdentityRoleClaim<TKey>
    where TUserToken : IdentityUserToken<TKey>
{
    /// <summary>
    /// Initializes a new instance of <see cref="IdentityDbContext"/>.
    /// </summary>
    /// <param name="options">The options to be used by a <see cref="DbContext"/>.</param>
    public IdentityDbContext(DbContextOptions options) : base(options)
    { }

    /// <summary>
    /// Initializes a new instance of the <see cref="IdentityDbContext" /> class.
    /// </summary>
    protected IdentityDbContext()
    { }

    /// <summary>
    /// Gets or sets the <see cref="DbSet{TEntity}"/> of Users.
    /// </summary>
    public DbSet<TUser> Users { get; set; }

    /// <summary>
    /// Gets or sets the <see cref="DbSet{TEntity}"/> of User claims.
    /// </summary>
    public DbSet<TUserClaim> UserClaims { get; set; }

    /// <summary>
    /// Gets or sets the <see cref="DbSet{TEntity}"/> of User logins.
    /// </summary>
    public DbSet<TUserLogin> UserLogins { get; set; }

    /// <summary>
    /// Gets or sets the <see cref="DbSet{TEntity}"/> of User roles.
    /// </summary>
    public DbSet<TUserRole> UserRoles { get; set; }

    /// <summary>
    /// Gets or sets the <see cref="DbSet{TEntity}"/> of User tokens.
    /// </summary>
    public DbSet<TUserToken> UserTokens { get; set; }

    /// <summary>
    /// Gets or sets the <see cref="DbSet{TEntity}"/> of roles.
    /// </summary>
    public DbSet<TRole> Roles { get; set; }

    /// <summary>
    /// Gets or sets the <see cref="DbSet{TEntity}"/> of role claims.
    /// </summary>
    public DbSet<TRoleClaim> RoleClaims { get; set; }

    /// <summary>
    /// Configures the schema needed for the identity framework.
    /// </summary>
    /// <param name="builder">
    /// The builder being used to construct the model for this context.
    /// </param>
    protected override void OnModelCreating(ModelBuilder builder)
    {
        builder.Entity<TUser>(b =>
        {
            b.HasKey(u => u.Id);
            b.HasIndex(u => u.NormalizedUserName).HasName("UserNameIndex").IsUnique();
            b.HasIndex(u => u.NormalizedEmail).HasName("EmailIndex");
            b.ToTable("AspNetUsers");
            b.Property(u => u.ConcurrencyStamp).IsConcurrencyToken();

            b.Property(u => u.UserName).HasMaxLength(256);
            b.Property(u => u.NormalizedUserName).HasMaxLength(256);
            b.Property(u => u.Email).HasMaxLength(256);
            b.Property(u => u.NormalizedEmail).HasMaxLength(256);
            b.HasMany(u => u.Claims).WithOne().HasForeignKey(uc => uc.UserId).IsRequired();
            b.HasMany(u => u.Logins).WithOne().HasForeignKey(ul => ul.UserId).IsRequired();
            b.HasMany(u => u.Roles).WithOne().HasForeignKey(ur => ur.UserId).IsRequired();
        });

        builder.Entity<TRole>(b =>
        {
            b.HasKey(r => r.Id);
            b.HasIndex(r => r.NormalizedName).HasName("RoleNameIndex");
            b.ToTable("AspNetRoles");
            b.Property(r => r.ConcurrencyStamp).IsConcurrencyToken();

            b.Property(u => u.Name).HasMaxLength(256);
            b.Property(u => u.NormalizedName).HasMaxLength(256);

            b.HasMany(r => r.Users).WithOne().HasForeignKey(ur => ur.RoleId).IsRequired();
            b.HasMany(r => r.Claims).WithOne().HasForeignKey(rc => rc.RoleId).IsRequired();
        });

        builder.Entity<TUserClaim>(b => 
        {
            b.HasKey(uc => uc.Id);
            b.ToTable("AspNetUserClaims");
        });

        builder.Entity<TRoleClaim>(b => 
        {
            b.HasKey(rc => rc.Id);
            b.ToTable("AspNetRoleClaims");
        });

        builder.Entity<TUserRole>(b => 
        {
            b.HasKey(r => new { r.UserId, r.RoleId });
            b.ToTable("AspNetUserRoles");
        });

        builder.Entity<TUserLogin>(b =>
        {
            b.HasKey(l => new { l.LoginProvider, l.ProviderKey });
            b.ToTable("AspNetUserLogins");
        });

        builder.Entity<TUserToken>(b => 
        {
            b.HasKey(l => new { l.UserId, l.LoginProvider, l.Name });
            b.ToTable("AspNetUserTokens");
        });
    }
}


Основываясь на исходном коде, если мы хотим объединить IdentityDbContext с нашим DbContext, у нас есть два варианта:

Первый вариант:
Создать DbContext, который наследуется от IdentityDbContext и имеет доступ к классам.

   public class ApplicationDbContext 
    : IdentityDbContext
{
    public ApplicationDbContext()
        : base("DefaultConnection")
    {
    }

    static ApplicationDbContext()
    {
        Database.SetInitializer<ApplicationDbContext>(new ApplicationDbInitializer());
    }

    public static ApplicationDbContext Create()
    {
        return new ApplicationDbContext();
    }

    // Add additional items here as needed
}


Дополнительные заметки:

1) Мы также можем изменить имена таблиц по умолчанию asp.net Identity следующим решением:

    public class ApplicationDbContext : IdentityDbContext
    {    
        public ApplicationDbContext(): base("DefaultConnection")
        {
        }

        protected override void OnModelCreating(System.Data.Entity.DbModelBuilder modelBuilder)
        {
            base.OnModelCreating(modelBuilder);
            modelBuilder.Entity<IdentityUser>().ToTable("user");
            modelBuilder.Entity<ApplicationUser>().ToTable("user");

            modelBuilder.Entity<IdentityRole>().ToTable("role");
            modelBuilder.Entity<IdentityUserRole>().ToTable("userrole");
            modelBuilder.Entity<IdentityUserClaim>().ToTable("userclaim");
            modelBuilder.Entity<IdentityUserLogin>().ToTable("userlogin");
        }
    }

2) Кроме того, мы можем расширить каждый класс и добавить любое свойство к таким классам, как «IdentityUser», «IdentityRole», ...

    public class ApplicationRole : IdentityRole<string, ApplicationUserRole>
{
    public ApplicationRole() 
    {
        this.Id = Guid.NewGuid().ToString();
    }

    public ApplicationRole(string name)
        : this()
    {
        this.Name = name;
    }

    // Add any custom Role properties/code here
}


// Must be expressed in terms of our custom types:
public class ApplicationDbContext 
    : IdentityDbContext<ApplicationUser, ApplicationRole, 
    string, ApplicationUserLogin, ApplicationUserRole, ApplicationUserClaim>
{
    public ApplicationDbContext()
        : base("DefaultConnection")
    {
    }

    static ApplicationDbContext()
    {
        Database.SetInitializer<ApplicationDbContext>(new ApplicationDbInitializer());
    }

    public static ApplicationDbContext Create()
    {
        return new ApplicationDbContext();
    }

    // Add additional items here as needed
}

Чтобы сэкономить время, мы можем использовать расширяемый шаблон проекта AspNet Identity 2.0 для расширения всех классов.

Второй вариант:(Не рекомендуется) На
самом деле нам не нужно наследовать от IdentityDbContext, если мы сами пишем весь код.
Таким образом, в основном мы можем просто наследовать от DbContext и реализовать нашу настроенную версию «OnModelCreating (ModelBuilder builder)» из исходного кода IdentityDbContext

Арванд
источник
2
@ mike-devenney Вот ваш ответ о слиянии двух слоев контекста, надеюсь, это поможет.
Арванд
1
Благодаря Арванду, я пропустил это и, как ни странно, наткнулся на это 1,5 года спустя, снова изучая тему. :)
Майк Devenney
9

Это поздняя запись для людей, но ниже моя реализация. Вы также заметите, что я не смог изменить тип KEYs по умолчанию: подробности о нем можно найти в следующих статьях:

ПРИМЕЧАНИЯ.
Следует отметить, что вы не можете использовать Guid'sсвои ключи. Это потому, что под капотом они есть Struct, и, как таковые, не имеют распаковки, которая позволила бы их преобразование из общего <TKey>параметра.

Классы выглядят так:

public class ApplicationDbContext : IdentityDbContext<ApplicationUser, CustomRole, string, CustomUserLogin, CustomUserRole, CustomUserClaim>
{
    #region <Constructors>

    public ApplicationDbContext() : base(Settings.ConnectionString.Database.AdministrativeAccess)
    {
    }

    #endregion

    #region <Properties>

    //public DbSet<Case> Case { get; set; }

    #endregion

    #region <Methods>

    #region

    protected override void OnModelCreating(DbModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);

        //modelBuilder.Configurations.Add(new ResourceConfiguration());
        //modelBuilder.Configurations.Add(new OperationsToRolesConfiguration());
    }

    #endregion

    #region

    public static ApplicationDbContext Create()
    {
        return new ApplicationDbContext();
    }

    #endregion

    #endregion
}

    public class ApplicationUser : IdentityUser<string, CustomUserLogin, CustomUserRole, CustomUserClaim>
    {
        #region <Constructors>

        public ApplicationUser()
        {
            Init();
        }

        #endregion

        #region <Properties>

        [Required]
        [StringLength(250)]
        public string FirstName { get; set; }

        [Required]
        [StringLength(250)]
        public string LastName { get; set; }

        #endregion

        #region <Methods>

        #region private

        private void Init()
        {
            Id = Guid.Empty.ToString();
        }

        #endregion

        #region public

        public async Task<ClaimsIdentity> GenerateUserIdentityAsync(UserManager<ApplicationUser, string> manager)
        {
            // Note the authenticationType must match the one defined in CookieAuthenticationOptions.AuthenticationType
            var userIdentity = await manager.CreateIdentityAsync(this, DefaultAuthenticationTypes.ApplicationCookie);

            // Add custom user claims here

            return userIdentity;
        }

        #endregion

        #endregion
    }

    public class CustomUserStore : UserStore<ApplicationUser, CustomRole, string, CustomUserLogin, CustomUserRole, CustomUserClaim>
    {
        #region <Constructors>

        public CustomUserStore(ApplicationDbContext context) : base(context)
        {
        }

        #endregion
    }

    public class CustomUserRole : IdentityUserRole<string>
    {
    }

    public class CustomUserLogin : IdentityUserLogin<string>
    {
    }

    public class CustomUserClaim : IdentityUserClaim<string> 
    { 
    }

    public class CustomRoleStore : RoleStore<CustomRole, string, CustomUserRole>
    {
        #region <Constructors>

        public CustomRoleStore(ApplicationDbContext context) : base(context)
        {
        } 

        #endregion
    }

    public class CustomRole : IdentityRole<string, CustomUserRole>
    {
        #region <Constructors>

        public CustomRole() { }
        public CustomRole(string name) 
        { 
            Name = name; 
        }

        #endregion
    }
Узник ноль
источник
8

Если вы детализируете абстракции IdentityDbContext, вы обнаружите, что он выглядит точно так же, как ваш производный DbContext. Самый простой путь - это ответ Олава, но если вам нужен больший контроль над тем, что создается, и чуть меньше зависимости от пакетов Identity , посмотрите мой вопрос и ответ здесь . Есть пример кода, если вы переходите по ссылке, но в итоге вы просто добавляете необходимые DbSets в свой собственный подкласс DbContext.

joelmdev
источник