カスタム MySQL ASP.NET Identity ストレージプロバイダーの実装

[アーティクル]
07/13/2023

作成者 : Raquel Soares De Almeida、 Suhas Joshi、 Tom FitzMacken

ASP.NET Id は、独自のストレージプロバイダーを作成し、アプリケーションを再作業せずにアプリケーションにプラグインできる拡張可能なシステムです。このトピックでは、ASP.NET ID 用の MySQL ストレージプロバイダーを作成する方法について説明します。カスタムストレージプロバイダーの作成の概要については、「 ASP.NET ID のカスタムストレージプロバイダーの概要」を参照してください。

このチュートリアルを完了するには、Update 2 でVisual Studio 2013が必要です。

このチュートリアルでは、次の操作を行います。

Azure で MySQL データベースインスタンスを作成する方法を示します。

MySQL クライアントツール (MySQL Workbench) を使用してテーブルを作成し、Azure でリモートデータベースを管理する方法について説明します。

既定の ASP.NET Identity ストレージ実装を MVC アプリケーションプロジェクトのカスタム実装に置き換える方法について説明します。

このチュートリアルは、もともとRaquel Soares De AlmeidaとRick Anderson( @RickAndMSFT )によって書かれました。サンプルプロジェクトは、Suhas Joshi によって Identity 2.0 用に更新されました。トピックは、Tom FitzMacken によって Identity 2.0 用に更新されました。

完成したプロジェクトをダウンロードする

このチュートリアルの最後には、Azure でホストされている MySQL データベースを操作する ASP.NET Identity を含む MVC アプリケーションプロジェクトが用意されています。

完成した MySQL ストレージプロバイダーは、AspNet.Identity.MySQL (GitHub) からダウンロードできます。

実行する手順

このチュートリアルでは、次のことについて説明します。

Azure で MySQL データベースを作成する
MySQL で ASP.NET ID テーブルを作成する
MVC アプリケーションを作成し、MySQL プロバイダーを使用するように構成する
アプリを実行する

このトピックでは、ASP.NET ID のアーキテクチャと、顧客ストレージプロバイダーを実装するときに行う必要がある決定については説明しません。詳細については、「 ASP.NET ID のカスタムストレージプロバイダーの概要」を参照してください。

MySQL ストレージプロバイダークラスを確認する

MySQL ストレージプロバイダーを作成する手順に進む前に、ストレージプロバイダーを構成するクラスを見てみましょう。ユーザーとロールを管理するには、アプリケーションから呼び出されるデータベース操作とクラスを管理するクラスが必要です。

ストレージクラス

IdentityUser - ユーザーのプロパティが含まれます。
UserStore - ユーザーを追加、更新、または取得するための操作が含まれます。
IdentityRole - ロールのプロパティが含まれます。
RoleStore - ロールを追加、削除、更新、取得するための操作が含まれます。

データアクセス層クラス

この例では、データアクセス層クラスには、テーブルを操作するための SQL ステートメントが含まれています。ただし、コードでは、Entity Framework や NHibernate などのオブジェクトリレーショナルマッピング (ORM) を使用できます。特に、遅延読み込みとオブジェクトキャッシュを含む ORM がないと、アプリケーションのパフォーマンスが低下する可能性があります。

MySQLDatabase - MySQL データベース接続と、データベース操作を実行するためのメソッドが含まれます。 UserStore と RoleStore はどちらも、このクラスのインスタンスでインスタンス化されます。
RoleTable - ロールを格納するテーブルのデータベース操作が含まれます。
UserClaimsTable - ユーザー要求を格納するテーブルのデータベース操作が含まれます。
UserLoginsTable - ユーザーログイン情報を格納するテーブルのデータベース操作が含まれます。
UserRoleTable - どのロールに割り当てられているユーザーを格納するテーブルのデータベース操作が含まれます。
UserTable - ユーザーを格納するテーブルのデータベース操作が含まれます。

Azure で MySQL データベースインスタンスを作成する

Azure Portal にログインします。
ページの下部にある [ +新規 ] をクリックし、[ ストア] を選択します。
[選択とアドオン] ウィザードで[ClearDB MySQL Database]\(ClearDB MySQL データベース\) を選択し、ダイアログの右下にある次の矢印をクリックします。
既定の Free プランをそのまま使用し、[ 名前] を [IdentityMySQLDatabase] に変更します。最も近いリージョンを選択し、次の矢印をクリックします。
チェックマークをクリックして、データベースの作成を完了します。
データベースが作成されたら、管理ポータルの [アドオン] タブから管理できます。
データベース接続情報を取得するには、ページの下部にある [接続情報 ] をクリックします。
コピーボタンをクリックして接続文字列をコピーし、後で MVC アプリケーションで使用できるように保存します。

mySQL データベースに ASP.NET ID テーブルを作成する

MySQL データベースに接続して管理するための MySQL Workbench ツールをインストールする

MySQL のダウンロードページから MySQL Workbench ツールをインストールする
アプリを起動し、 MySQLConnections + ボタンをクリックして新しい接続を追加します。このチュートリアルで前に作成した Azure MySQL データベースからコピーした接続文字列データを使用します。
接続を確立したら、新しい [クエリ ] タブを開きます。 MySQLIdentity.sql のコマンドをクエリに貼り付け、データベーステーブルを作成するために実行します。
次に示すように、Azure でホストされている MySQL データベースに作成されたすべての ASP.NET ID 必要なテーブルが作成されました。

テンプレートから MVC アプリケーションプロジェクトを作成し、MySQL プロバイダーを使用するように構成する

必要に応じて、Visual Studio Express 2013 for Web または Update 2 でVisual Studio 2013をインストールします。

ASP.NET をダウンロードします。GitHub の Identity.MySQL プロジェクト

AspNet.Identity.MySQL (GitHub) のリポジトリ URL を参照します。
ソースコードをダウンロードします。
.zip ファイルをローカルフォルダーに抽出します。
AspNet.Identity.MySQL ソリューションを開き、ビルドします。

テンプレートから新しい MVC アプリケーションプロジェクトを作成する

AspNet.Identity.MySQL ソリューションを右クリックし、追加、新しいプロジェクト
[ 新しいプロジェクトの追加 ] ダイアログで、左側の [Visual C# ] を選択し、[ Web ] を選択し、[ Web アプリケーション ASP.NET 選択します。プロジェクトに IdentityMySQLDemo という名前を付けます。[OK] をクリックします。
[ 新しい ASP.NET プロジェクト ] ダイアログで、既定のオプション (認証方法として 個々のユーザーアカウント を含む) を含む MVC テンプレートを選択し、[OK] をクリック します。
ソリューションエクスプローラーで、IdentityMySQLDemo プロジェクトを右クリックし、[NuGet パッケージの管理] を選択します。検索テキストボックスダイアログで、「 Identity.EntityFramework」と入力します。結果の一覧でこのパッケージを選択し、[ アンインストール] をクリックします。依存関係パッケージ EntityFramework をアンインストールするように求められます。 [はい] をクリックします。このアプリケーションではこのパッケージは使用されなくなります。
IdentityMySQLDemo プロジェクトを右クリックし、[ 追加]、[参照]、[ ソリューション]、[プロジェクト ] の順に選択し、AspNet.Identity.MySQL プロジェクトを選択し、[ OK] をクリックします。
IdentityMySQLDemo プロジェクトで、すべての参照をに置き換えます。
using Microsoft.AspNet.Identity.EntityFramework;
代入
using AspNet.Identity.MySQL;

IdentityModels.cs で、 ApplicationDbContext を MySqlDatabase から派生するように設定し、接続名を持つ 1 つのパラメーターを受け取るコンストラクターを含めます。

public class ApplicationDbContext : MySQLDatabase
{
    public ApplicationDbContext(string connectionName)
        : base(connectionName)
    {
    }

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

IdentityConfig.cs ファイルを開きます。 ApplicationUserManager.Create メソッドで、インスタンス化する UserManager を次のコードに置き換えます。
```
var manager = new ApplicationUserManager(
    new UserStore<ApplicationUser>(
    context.Get<ApplicationDbContext>() as MySQLDatabase));
```
web.config ファイルを開き、DefaultConnection 文字列をこのエントリに置き換えます。強調表示された値は、前の手順で作成した MySQL データベースの接続文字列に置き換えます。
```
<add name="DefaultConnection" connectionString="Database=IdentityMySQLDatabase;
Data Source=<DataSource>;User Id=<UserID>;Password=<Password>"
providerName="MySql.Data.MySqlClient" />
```

アプリを実行して MySQL DB に接続する

IdentityMySQLDemo プロジェクトを右クリックし、[スタートアッププロジェクトとして設定] を選択します
Ctrl キーを押しながら F5 キーを押して、アプリをビルドして実行します。
ページの上部にある [ 登録 ] タブをクリックします。
新しいユーザー名とパスワードを入力し、[ 登録] をクリックします。
これで、新しいユーザーが登録され、ログインします。
MySQL Workbench ツールに戻るし、IdentityMySQLDatabase テーブルの内容を調べます。新しいユーザーを登録するときに、users テーブルでエントリを調べます。

次の手順

このアプリで他の認証方法を有効にする方法の詳細については、「 Facebook と Google OAuth2 と OpenID サインオンを使用して ASP.NET MVC 5 アプリを作成する」を参照してください。

DB を OAuth と統合する方法と、ユーザーがアプリへのアクセスを制限するようにロールを設定する方法については、「Membership、OAuth、および SQL Database を使用してセキュリティで保護された ASP.NET MVC 5 アプリを Azure にデプロイする」を参照してください。

カスタム MySQL ASP.NET Identity ストレージプロバイダーの実装

完成したプロジェクトをダウンロードする

実行する手順