ASP.NET Identity DbContextの混乱


196

デフォルトのMVC 5アプリには、IdentityModels.csに次のコードが含まれています。このコードは、デフォルトテンプレートのすべてのASP.NET Identity操作用です。

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を使用して別のコントローラーとビューを足場すると、たとえば、動物モデルの場合、この新しい行は次のように直下に自動生成され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ます。

だから私の質問は:

これら2つ(ApplicationDbContextおよびAllOtherStuffDbContext)のどちらを、他のすべての独自のモデルに使用する必要がありますか?またはApplicationDbContext、基本クラスから派生しているので、デフォルトの自動生成を使用しても問題ありません。デフォルトでは自動生成DbContextされますか、それともオーバーヘッドが発生しますか?DbContextすべてのモデルのアプリで1つのオブジェクトのみを使用する必要があります(これはどこかで読みました)ので、両方ApplicationDbContextAllOtherStuffDbContext1つのアプリでの使用を検討する必要はありませんか?または、ASP.NET Identityを使用したMVC 5のベストプラクティスは何ですか?


1
ところで; これは見事であり、ドキュメントをスキャンしている間は私の目では不要です。public System.Data.Entity.DbSet <WebApplication1.Models.Movie> Movies {get; セットする; }-System.Data.EntityおよびWebApplication1.Modelsパーツ。宣言から削除して、代わりにusingステートメントセクションに名前空間を追加することはできませんか?
PussInBoots 2013

猫-はい、あなたのコメントに。それはうまくいくはずです。
SB2055 2014年

これは、MongoDB.Driver(> = v2.1.0)github.com/saan800/SaanSoftの
Stanislav

回答:


178

IdentityDbContextを継承する単一のContextクラスを使用します。このようにして、クラスとIdentityUserおよびIdentityDbContextのロールとの関係をコンテキストに認識させることができます。IdentityDbContextのオーバーヘッドはほとんどありません。基本的に、2つのDbSetを持つ通常のDbContextです。1つはユーザー用、もう1つはロール用です。


52
これは単一のMVC5プロジェクト用ですが、派生したDbContextが複数のプロジェクト間で共有される場合は望ましくありません。MVC5ではなく、Identityのサポートを必要としないプロジェクトもあります。
Dave、

容易な保守性と優れたリレーショナル整合性のために、同じデータベースに投票しました。ユーザーエンティティとロールエンティティが他のアプリケーションオブジェクトに簡単に関連付けられるためです。
IBMer 2014年

6
@Dave-2つの異なるコンテキストを使用して、ユーザーデータのパーティション分割を複雑にします。MVCアプリパーティションデータをユーザーごとに実行しますが、他のアプリは実行しません。同じデータレイヤーを共有することは一般的ですが、一部のプロジェクトではユーザーごとに分割されたデータが必要であり、そうでないプロジェクトもあると思います。
RickAndMSFT 2015

1
MVCプロジェクトからApplicationDBContextを抽出し、それを既存のEFデータレイヤーに含める方法を知っている人はいますか?上記のように2つをマージすることは適切なアプローチのようですが、私は時間に制約のあるプロジェクトに取り組んでいます。私は最初からそれを正しくやりたいと思っていますが、私の前にあるすべての落とし穴に目を光らせたいと思います...
Mike Devenney

7
約1時間探した後、この答えは私を正しい方向に導きました-しかし、それを実装する方法がわかりませんでした(非常に文字通りの人にとって)。したがって、他の誰かを助ける場合、IdentityModels.csを開き、新しいDbSetをApplicationDbContextクラスに追加するのが最も簡単な方法であることがわかりました。
SeanOB 2015

45

そこについての多くの混乱であるIdentityDbContext、stackoverflowのクイック検索では、あなたはこれらの質問を見つけることができます:
なぜAsp.NetアイデンティティIdentityDbContextはブラックボックス?
のVisual Studio 2013 ASPNETアイデンティティを使用するとき、どのように私はテーブル名を変更できますか?
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とマージする場合、2つのオプションがあります。

最初のオプション:
IdentityDbContextから継承し、クラスにアクセスできるDbContextを作成します。

   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 Extensible Project Templateを使用してすべてのクラスを拡張できます。

2番目のオプション:(非推奨)
実際にすべてのコードを記述する場合、実際にはIdentityDbContextから継承する必要はありません。
したがって、基本的には、DbContextを継承して、IdentityDbContextソースコードから「OnModelCreating(ModelBuilder builder)」のカスタマイズバージョンを実装するだけです。


2
@ mike-devenneyここに、2つのコンテキストレイヤーのマージに関する回答があります。
Arvand 2016年

1
Arvandに感謝します。私はこれを逃しました。奇妙なことに、1.5年後、このトピックをもう一度調べている間、偶然にもそれを偶然見つけました。:)
Mike Devenney 2016年

9

これは人々のための遅いエントリですが、以下は私の実装です。また、KEYのデフォルトのタイプを変更する機能がスタブアウトされていることにも気づくでしょう。詳細については、以下の記事を参照してください。

注:キーに
は使用できないことに注意し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と同じように見えることがわかります。最も簡単な方法はOlavの答えですが、作成されるものをより詳細に制御し、Identityパッケージへの依存を少し少なくしたい場合は、ここで私の質問と回答を確認してください。リンクをクリックするとコード例がありますが、要約すると、必要なDbSetを独自のDbContextサブクラスに追加するだけです。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.