メンバーシップとユーザープロファイルのユニバーサルプロバイダーデータを ASP.NET Identity に移行する (C#)

[アーティクル]
06/09/2024

執筆者: Pranav Rastogi、Rick Anderson、Robert McMurray、Suhas Joshi

このチュートリアルでは、既存のアプリケーションのユニバーサルプロバイダーを使用して作成されたユーザーとロールのデータとユーザープロファイルデータを ASP.NET Identity モデルに移行するために必要な手順について説明します。ユーザープロファイルデータを移行するためにここで説明するアプローチは、SQL メンバーシップを持つアプリケーションでも使用できます。

Visual Studio 2013 のリリースでは、ASP.NET チームが新しい ASP.NET Identity システムを導入しました。このリリースの詳細については、こちらをご覧ください。 Web アプリケーションを SQL メンバーシップから新しい ID システムに移行する記事に引き続き、この記事では、ユーザーとロールの管理のためにプロバイダーモデルに従う既存のアプリケーションを新しい ID モデルに移行する手順について説明します。このチュートリアルでは主に、ユーザープロファイルデータを移行して、新しいシステムにシームレスにフックすることに重点を置きます。ユーザーとロールの情報の移行は、SQL メンバーシップと似ています。プロファイルデータを移行するために従ったアプローチは、SQL メンバーシップを持つアプリケーションでも使用できます。

例として、プロバイダーモデルを使用する Visual Studio 2012 を使用して作成された Web アプリから始めます。次に、プロファイル管理用のコードを追加し、ユーザーを登録し、ユーザーのプロファイルデータを追加し、データベーススキーマを移行し、ユーザーとロールの管理に ID システムを使用するようにアプリケーションを変更します。移行のテストとして、ユニバーサルプロバイダーを使用して作成されたユーザーがログインでき、新しいユーザーが登録できるようになります。

Note

完全なサンプルについては、https://github.com/suhasj/UniversalProviders-Identity-Migrations を参照してください。

プロファイルデータの移行の概要

移行を開始する前に、プロバイダーモデルにプロファイルデータを保存するエクスペリエンスを見てみましょう。アプリケーションユーザーのプロファイルデータは複数の方法で保存できます。その中で最も一般的なのは、ユニバーサルプロバイダーと共に出荷された組み込みのプロファイルプロバイダーを使用する方法です。手順には、次が含まれます

プロファイルデータの保存に使用するプロパティを持つクラスを追加します。
'ProfileBase' を拡張し、上記のユーザーのプロファイルデータを取得するメソッドを実装するクラスを追加します。
web.config ファイルで既定のプロファイルプロバイダーの使用を有効にし、プロファイル情報へのアクセスに使用する、手順 2 で宣言されるクラスを定義します。

プロファイル情報は、シリアル化された xml とバイナリデータとしてデータベースの 'Profiles' テーブルに格納されます。

新しい ASP.NET Identity システムを使用するようにアプリケーションを移行した後、プロファイル情報が逆シリアル化され、ユーザークラスにプロパティとして保存されます。その後、各プロパティをユーザーテーブルの列にマップできます。ここでの利点は、データ情報にアクセスするたびにシリアル化/逆シリアル化する必要がないだけでなく、ユーザークラスを使用してプロパティを直接操作できることです。

はじめに

Visual Studio 2012 で新しい ASP.NET 4.5 Web Forms アプリケーションを作成します。現在のサンプルでは Web Forms テンプレートを使用していますが、MVC アプリケーションを使用することもできます。
プロファイル情報を格納する新しいフォルダー 'Models' を作成します

例として、ユーザーの生年月日、市区町村、身長、体重をプロファイルに保存してみましょう。身長と体重は、'PersonalStats' と呼ばれるカスタムクラスとして格納されます。プロファイルを取得して保存するには、'ProfileBase' を拡張するクラスが必要です。プロファイル情報を取得して保存する新しいクラス 'AppProfile' を作成してみましょう。

public class ProfileInfo
{
    public ProfileInfo()
    {
        UserStats = new PersonalStats();
    }
    public DateTime? DateOfBirth { get; set; }
    public PersonalStats UserStats { get; set; }
    public string City { get; set; }
}

public class PersonalStats
{
    public int? Weight { get; set; }
    public int? Height { get; set; }
}

public class AppProfile : ProfileBase
{
    public ProfileInfo ProfileInfo
    {
        get { return (ProfileInfo)GetPropertyValue("ProfileInfo"); }
    }
    public static AppProfile GetProfile()
    {
        return (AppProfile)HttpContext.Current.Profile;
    }
    public static AppProfile GetProfile(string userName)
    {
        return (AppProfile)Create(userName);
    }
}

web.config ファイルでプロファイルを有効にします。手順 3 で作成したユーザー情報の取得/保存に使用するクラス名を入力します。

<profile defaultProvider="DefaultProfileProvider" enabled="true"
    inherits="UniversalProviders_ProfileMigrations.Models.AppProfile">
  <providers>
    .....
  </providers>
</profile>

'Account' フォルダーに Web Forms ページを追加して、ユーザーからプロファイルデータを取得して保存します。プロジェクトを右クリックし、[新しい項目の追加] を選択します。マスターページ 'AddProfileData.aspx' を持つ新しい Web Forms ページを追加します。 'MainContent' セクションで次のコードをコピーします。

<h2> Add Profile Data for <%# User.Identity.Name %></h2>
<asp:Label Text="" ID="Result" runat="server" />
<div>
    Date of Birth:
    <asp:TextBox runat="server" ID="DateOfBirth"/>
</div>
<div>
    Weight:
    <asp:TextBox runat="server" ID="Weight"/>
</div>
<div>
    Height:
    <asp:TextBox runat="server" ID="Height"/>
</div>
<div>
    City:
    <asp:TextBox runat="server" ID="City"/>
</div>
<div>
    <asp:Button Text="Add Profile" ID="Add" OnClick="Add_Click" runat="server" />
</div>

分離コードに次のコードを追加します。

protected void Add_Click(object sender, EventArgs e)
{
    AppProfile profile = AppProfile.GetProfile(User.Identity.Name);
    profile.ProfileInfo.DateOfBirth = DateTime.Parse(DateOfBirth.Text);
    profile.ProfileInfo.UserStats.Weight = Int32.Parse(Weight.Text);
    profile.ProfileInfo.UserStats.Height = Int32.Parse(Height.Text);
    profile.ProfileInfo.City = City.Text;
    profile.Save();
}

コンパイルエラーを削除するために、AppProfile クラスが定義されている名前空間を追加します。

アプリを実行し、ユーザー名 'olduser' を持つ新しいユーザーを作成します。'AddProfileData' ページに移動し、ユーザーのプロファイル情報を追加します。

[サーバーエクスプローラー] ウィンドウを使用して、データがシリアル化された xml として 'Profiles' テーブルに保存されていることを確認できます。 Visual Studio の [表示] メニューから、[サーバーエクスプローラー] を選択します。 web.config ファイルで定義されているデータベースのデータ接続があります。データ接続をクリックすると、さまざまなサブカテゴリが表示されます。 'Tables' を展開してデータベース内のさまざまなテーブルを表示し、[プロファイル] を右クリックし、[テーブルデータの表示] を選択して、'Profiles' テーブルに保存されているプロファイルデータを表示します。

Screenshot of the Server Explorer window that shows the data stored in the 'Profiles' table.

Screenshot of the Profiles data table.

データベーススキーマの移行

既存のデータベースを ID システムと連携させるには、元のデータベースに追加したフィールドをサポートするように ID データベースのスキーマを更新する必要があります。これを行うには、SQL スクリプトを使用して新しいテーブルを作成し、既存の情報をコピーします。 [サーバーエクスプローラー] ウィンドウで、'DefaultConnection' を展開してテーブルを表示します。 'Tables' を右クリックし、[新しいクエリ] を選択します

Screenshot of updating the schema in the Identity database by selecting New Query.

https://raw.github.com/suhasj/UniversalProviders-Identity-Migrations/master/Migration.txt から SQL スクリプトを貼り付けて実行します。 'DefaultConnection' が更新されると、新しいテーブルが追加されていることを確認できます。テーブル内のデータをチェックして、情報が移行されたことを確認できます。

Screenshot of the Default Connection refreshed and new tables added.

ASP.NET Identity を使用するためにアプリケーションを移行する

ASP.NET Identity に必要な Nuget パッケージをインストールします。
- Microsoft.AspNet.Identity.EntityFramework
- Microsoft.AspNet.Identity.Owin
- Microsoft.Owin.Host.SystemWeb
- Microsoft.Owin.Security.Facebook
- Microsoft.Owin.Security.Google
- Microsoft.Owin.Security.MicrosoftAccount
- Microsoft.Owin.Security.Twitter
Nuget パッケージの管理の詳細については、こちらを参照してください。

テーブル内の既存のデータを操作するには、テーブルにマップし直すモデルクラスを作成し、これらを ID システムにフックする必要があります。 ID コントラクトの一環として、モデルクラスは Identity.Core dll に定義されているインターフェイスを実装するか、Microsoft.AspNet.Identity.EntityFramework で使用できるこれらのインターフェイスの既存の実装を拡張できます。ロール、ユーザーログイン、ユーザー要求には既存のクラスを使用します。このサンプルでは、カスタムユーザーを使用する必要があります。プロジェクトを右クリックし、新しいフォルダー 'IdentityModels' を作成します。次に示すように、新しい 'User' クラスを追加します。

using Microsoft.AspNet.Identity.EntityFramework;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using UniversalProviders_ProfileMigrations.Models;

namespace UniversalProviders_Identity_Migrations
{
    public class User : IdentityUser
    {
        public User()
        {
            CreateDate = DateTime.UtcNow;
            IsApproved = false;
            LastLoginDate = DateTime.UtcNow;
            LastActivityDate = DateTime.UtcNow;
            LastPasswordChangedDate = DateTime.UtcNow;
            Profile = new ProfileInfo();
        }

        public System.Guid ApplicationId { get; set; }
        public bool IsAnonymous { get; set; }
        public System.DateTime? LastActivityDate { get; set; }
        public string Email { get; set; }
        public string PasswordQuestion { get; set; }
        public string PasswordAnswer { get; set; }
        public bool IsApproved { get; set; }
        public bool IsLockedOut { get; set; }
        public System.DateTime? CreateDate { get; set; }
        public System.DateTime? LastLoginDate { get; set; }
        public System.DateTime? LastPasswordChangedDate { get; set; }
        public System.DateTime? LastLockoutDate { get; set; }
        public int FailedPasswordAttemptCount { get; set; }
        public System.DateTime? FailedPasswordAttemptWindowStart { get; set; }
        public int FailedPasswordAnswerAttemptCount { get; set; }
        public System.DateTime? FailedPasswordAnswerAttemptWindowStart { get; set; }
        public string Comment { get; set; }
        public ProfileInfo Profile { get; set; }
    }
}

'ProfileInfo' がユーザークラスのプロパティになったことに注意してください。このため、このユーザークラスを使用してプロファイルデータを直接操作できます。

ダウンロードソース (https://github.com/suhasj/UniversalProviders-Identity-Migrations/tree/master/UniversalProviders-Identity-Migrations) から IdentityModels フォルダーと IdentityAccount フォルダー内のファイルをコピーします。これらには、ASP.NET Identity API を使用したユーザーとロールの管理に必要な残りのモデルクラスと新しいページがあります。使用される方法は SQL メンバーシップに似ています。詳細な説明については、こちらをご覧ください。

アプリで SQLite を Identity データストアとして使用する場合、一部のコマンドはサポートされません。データベースエンジンの制限により、Alter コマンドは次の例外をスローします。

"System.NotSupportedException: SQLite はこの移行操作をサポートしていません。"

回避策として、データベースで Code First の移行を実行してテーブルを変更します。

プロファイルデータを新しいテーブルにコピーする

前述のように、'Profiles' テーブル内の xml データを逆シリアル化し、'AspNetUsers' テーブルの列に保存する必要があります。前の手順で新しい列はユーザーテーブルに作成されたので、残っている作業は、必要なデータを使用してこれらの列を設定することのみです。これを行うには、新しく作成された列をユーザーテーブルに設定するために 1 回実行されるコンソールアプリケーションを使用します。

既存のソリューションに新しいコンソールアプリケーションを作成します。
Entity Framework パッケージの最新バージョンをインストールします。
上記で作成した Web アプリケーションを参照としてコンソールアプリケーションに追加します。これを行うには、[プロジェクト]、[参照の追加]、[ソリューション]の順にクリックし、プロジェクトをクリックし、[OK] をクリックします。

次のコードを Program.cs クラスにコピーします。このロジックでは、各ユーザーのプロファイルデータを読み取り、それを 'ProfileInfo' オブジェクトとしてシリアル化し、データベースに保存し直します。

public class Program
{
    var dbContext = new ApplicationDbContext();
    foreach (var profile in dbContext.Profiles)
    {
        var stringId = profile.UserId.ToString();
        var user = dbContext.Users.Where(x => x.Id == stringId).FirstOrDefault();
        Console.WriteLine("Adding Profile for user:" + user.UserName);
        var serializer = new XmlSerializer(typeof(ProfileInfo));
        var stringReader = new StringReader(profile.PropertyValueStrings);
        var profileData = serializer.Deserialize(stringReader) as ProfileInfo;
        if (profileData == null)
        {
            Console.WriteLine("Profile data deserialization error for user:" + user.UserName);
        }
        else
        {
            user.Profile = profileData;
        }
    }
    dbContext.SaveChanges();
}

使用されるモデルの一部は、Web アプリケーションプロジェクトの 'IdentityModels' フォルダーに定義されているため、対応する名前空間を含める必要があります。

上記のコードは、前の手順で作成した Web アプリケーションプロジェクトの 'App_Data' フォルダー内のデータベースファイルに対して動作します。これを参照するには、コンソールアプリケーションの app.config ファイル内の接続文字列を、Web アプリケーションの web.config 内の接続文字列で更新します。また、'AttachDbFilename' プロパティに完全な物理パスを指定します。
コマンドプロンプトを開き、上記のコンソールアプリケーションの bin フォルダーに移動します。実行可能ファイルを実行し、次の図に示されるログ出力を確認します。
サーバーエクスプローラーで 'AspNetUsers' テーブルを開き、プロパティが保持されている新しい列のデータを確認します。これらは、対応するプロパティ値で更新されます。

機能を確認する

ASP.NET Identity を使用して実装された、新しく追加されたメンバーシップページを使用して、古いデータベースからのユーザーとしてログインします。このユーザーは、同じ資格情報を使用してログインできます。 OAuth の追加、新しいユーザーの作成、パスワードの変更、ロールの追加、ロールへのユーザーの追加などのその他の機能を試してみてください。

古いユーザーと新しいユーザーのプロファイルデータは、取得されてユーザーテーブルに保存されます。古いテーブルは参照されなくなります。

まとめ

この記事では、メンバーシップ用としてプロバイダーモデルを使用した Web アプリケーションを ASP.NET Identity に移行するプロセスについて説明しました。この記事ではさらに、ユーザーのプロファイルデータを移行して ID システムにフックする方法についても説明しました。アプリを移行するときに発生した質問や問題については、以下にコメントを残してください。

この記事をレビューしてくれた Rick Anderson と Robert McMurray に感謝します。

次の方法で共有

メンバーシップとユーザープロファイルのユニバーサルプロバイダーデータを ASP.NET Identity に移行する (C#)

プロファイルデータの移行の概要

はじめに

データベーススキーマの移行

ASP.NET Identity を使用するためにアプリケーションを移行する

プロファイルデータを新しいテーブルにコピーする

機能を確認する

まとめ

フィードバック

その他のリソース

次の方法で共有

メンバーシップとユーザー プロファイルのユニバーサル プロバイダー データを ASP.NET Identity に移行する (C#)

プロファイル データの移行の概要

はじめに

データベース スキーマの移行

ASP.NET Identity を使用するためにアプリケーションを移行する

プロファイル データを新しいテーブルにコピーする

機能を確認する

まとめ

フィードバック

その他のリソース

メンバーシップとユーザープロファイルのユニバーサルプロバイダーデータを ASP.NET Identity に移行する (C#)

プロファイルデータの移行の概要

データベーススキーマの移行

プロファイルデータを新しいテーブルにコピーする