Core 3.1 ベース（.NET Framework ではありません）の ASP.NET MVC アプリで認証に ASP.NET Core Identity を用い、ユーザー情報のストアに MySQL を利用するにはどうするかということを書きます。

Visual Studio 2022 + .NET 6.0 の ASP.NET Core Identity の場合は「.NET 6.0 ASP.NET Identity に MySQL 使用 (CORE)」を見てください。

.NET Framework 版の ASP.NET Identity の場合は「ASP.NET Identity で MySQL 利用 (.NET 版)」を見てください。

ネットの情報ではサードパーティ製の Pomelo.EntityFrameworkCore.MySql を使ったという記事を目にしますが、ここでは NuGet でインストールできる Oracle 製の MySql.Data.EntityFrameworkCore v8.0.20 を使ってみました。

Oracle 製の MySql.Data.EntityFrameworkCore は Core に対応してないので下記ステップ「(6) プロジェクトのビルド」でエラーになったという話を聞きましたが、最新版ではそのあたりは対応されているようです。

ただし、何も問題がなかったわけではなく、最後に Update-Database でデータベース / テーブルを生成するところで "Specified key was too long; max key length is 3072 bytes" というエラーが出ます・・・が、解決は可能でした。詳しくは下のステップ「(8) Update-Database の実行」を見てください。

(1) プロジェクトの作成

Visual Studio 2019 のテンプレートを利用して ASP.NET Core 3.1 MVC アプリを作成します。認証は「認証なし」のままとしておきます。

認証に「個別のユーザーアカウント」を選んでプロジェクト作成時点から ASP.NET Identity を実装しても、それを MySQL を利用するように変更できると思います。しかし、そうすると Login, Register 他の認証関係の機能は Razor Class Library (RCL) として提供され、ソースコードはプロジェクトには含まれません。

認証関係のソースコードを見たい / 修正したいことがあるでしょうから（少なくとも登録、ログインページは書き換えたくなるはず）、まず「認証なし」で作って下のステップ (2) に述べるようにスキャフォールディング機能を利用して ASP.NET Identity を実装するのがよさそうです。（「個別のユーザーアカウント」で作って、特定のページをオーバーライドすることもできるそうですが）

(2) ASP.NET Core Identity の実装

Microsoft のドキュメント Scaffold identity into an MVC project without existing authorization を参考に、スキャフォールディング機能を利用して ASP.NET Identity を実装します。

ドキュメントの通り、ソリューションエクスプローラーでプロジェクトを右クリック⇒［追加(D)］⇒［新しいスキャフォールディングアイテム(F)...］で下の画像のダイアログが開きます。

上のダイアログで［インストール済み］の項目から［ID］を選択し、［追加］をクリックすると以下の画像の「ID の追加」ダイアログが表示されます。

レイアウトページ欄にはステップ (1) で生成したプロジェクトのレイアウトページ ~/Views/Shared/_Layout.cshtml を設定します。

ソースコードが必要なファイルに［オーバーライドするファイルの選択］でチェックを入れます。（上の画像では［すべてのファイルをオーバーライド］にチェックを入れて全てのファイルを選択しています。どれを選んだらよいか分からなかったので）

［データコンテキストクラス(D)］には、+ をクリックすると表示されるデフォルトをそのまま設定しました。必要なら任意の名前に変更できます。デフォルトでは xxxxxContext の xxxxx がプロジェクト名になり、プロジェクトルート下に Areas/Identity/Data というフォルダが作られ、その中にコンテキストクラスを含むファイル xxxxxContext.cs が生成されます。

［ユーザークラス(U)］にも同様に、+ をクリックすると表示されるデフォルトをそのまま設定しました。これも任意の名前に変更できます。デフォルトでは IdentityUser を継承した xxxxxUser クラスが生成され、xxxxx がプロジェクト名になります。

［ユーザークラス(U)］に何も設定せず空白のままにしておくと IdentityUser がそのまま使われます。基本的な機能はそれで問題ないですが、もし、将来プロファイル情報を追加するようなことがあると困ることになりますので、設定しておいた方がよさそうです。

その他、NuGet での Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore の追加、Razor ページを有効にするための Startup.cs へのコードの追加を忘れないようにしてください。詳しくは上に紹介した Microsoft のドキュメントを見てください。

(3) MySql.Data.EntityFrameworkCore

NuGet で MySql.Data.EntityFrameworkCore をインストールします。この記事を書いた時点では v8.0.20 しか見つからなかったのでそれをインストールしました。

2021/11/26 追記: MySql.Data.EntityFrameworkCore はいつの間にか非推奨になってました。 代替えパッケージが MySql.EntityFrameworkCore とのことです。それを使って同様なことができるかは未検証・未確認です。

関連するパッケージの更新・インストールが自動的に行われます。その内容は以下の画像を見てください。

(4) 接続文字列の変更

テンプレートで自動生成された接続文字列は appsetteins.json にありますが、それは LocalDB を利用するように設定されていますので MySQL に接続するように変更します。以下のような感じです。

例えば、上の画像の database=coreidentity というようにデータベース名を指定すると、Entity Framework Code First の機能を使って coreidentity という名前のデータベースを新たに生成し、そこに必要なテーブルを生成してくれます。（データベース名は任意に設定できます。この記事で coreidentity としたのは単なる例です）

(5) IdentityHostingStartup.cs の修正

自動生成されれた Areas/Identity/IdentityHostingStartup.cs ファイルで、サービス登録のコードが SQL Server を使うように設定されていますが、これを MySQL を使うように変更します。以下のような感じです。

なお、IdentityHostingStartup.cs ファイルは、上のステップ (2) のようにスキャフォールディング機能を利用して ASP.NET Identity を実装した場合に生成されるものです。プロジェクト作成の時点で認証を「個別のユーザーアカウント」とした場合は、サービス登録のコードは Startup.cs ファイルに含まれますので注意してください。

(6) プロジェクトのビルド

ここで一旦プロジェクトをビルドしてみました。以下の通り成功します。

参考にさせていただいた記事「ASP.NET CoreでMySQLを利用する」ではここでエラーとなったそうです。

その記事では Core のバージョンは 2.0、MySql.Data.EntityFrameworkCore のバージョンは 8.0.6 だったそうです。この記事では Core は 3.1、MySql.Data.EntityFrameworkCore は 8.0.20 です。その差があるのでしょうか。

(7) Add-Migration の実行

パッケージマネージャーコンソールから Add-Migration CreateIdentitySchema を実行します（CreateIdentitySchema という名前は任意です。また、Core では Enable-Migration は不要になったそうです）。

Migrations フォルダには CreateIdentitySchema.cs ファイルが生成されます。ざっと見たところ内容は正しそうです。（ツールのバージョンが 3.1.2 でランタイムのバージョン 3.1.4 より古いという警告は出ていますが Migration には影響ないようです）

(8) Update-Database の実行

次に Update-Database を実行し、Entity Framework Code First の機能を利用して MySQL にデータベース / テーブルの生成を試みます・・・が、以下の画像の通りダメでした。

メッセージを見ると AspNetUserRoles というテーブルを生成する際に "Specified key was too long; max key length is 3072 bytes" という制約のためエラーになったということのようです。

以下、少々話が長くなりますが、なぜそういうエラーになるかと、その解決方法を書きます。

データベース / テーブルは CreateIdentitySchema.cs ファイルのコードに基づいて生成されるのですが、主キーは全て、

UserId = table.Column<string>(nullable: false)

というというような maxLength が指定されない設定となります。その場合、上の画像にある通り、テーブルを生成する create 句では主キーは varchar(767) に設定されます。

varchar(767) の 767 という数字は MySQL の主キーに許容される最大バイト数で、それゆえ主キーに maxLength が指定されないと varchar(767) になるのだと思われます。

767 バイトという制限は、「InnoDBインデックスの最大キー長について」という記事によると、ある条件で 3,072 バイトまで拡張できるそうで、MySQL 5.7 以降がその条件に当てはまるそうです。この記事では MySQL 8.x を使っているのでエラーメッセージにある通り 3,072 バイトが上限になっているのだと思います。

何故 nvarchar ではなくて varchar になるのか不思議でしたが、MySQL のドキュメント 10.3.7 The National Character Set によると、"MySQL uses utf8 as this predefined character set" なのでどちらでも同じなのだそうです。ちなみに create 句で nvarchar と指定しても、生成されるのは varchar になるそうです。

この記事で使用している MySQL 8.0.19 で使用されている文字コードを確認してみましたが、以下のようになっていました。

utf8mb4 というのは、10.1.10.7 utf8mb4 文字セット (4 バイトの UTF-8 Unicode エンコーディング) によると、"utf8 という名前の文字セットは、文字あたり最大 3 バイトを使用し、BMP 文字だけを含みます。utf8mb4 文字セットは、文字ごとに最大 4 バイトを使用し、補助文字をサポートします" ということだそうです。

utf8mb4 を使用していますので、主キーに設定された varchar(767) は 767 x 4 = 3,068 バイトになります。制限の 3,072 より小さいので単独の主キーなら varchar(767) で問題ないはずです。

しかし、ASP.NET Core Identity が使うテーブルには連結主キーが設定されるものがあり、それが最大 3,072 バイトの制約を超えるため "Specified key was too long; max key length is 3072 bytes" というエラーになったということのようです。

連結主キーが設定されるテーブルは AspNetUserRoles と AspNetUserTokens です。

それらのテーブルの主キーが varchar(767) とならないよう、CreateIdentitySchema.cs ファイルの当該コードに制限 maxLength: 128 を設定してやります。以下の画像の赤枠部分を見てください。

Id フィールドには d85de5ae-a926-45cd-831a-4835034f6b79 というように書式指定された Guid の文字列が設定されますので、varchar(128) で十分なはずです（少なくとも現時点では）。

上の画像のように maxLength: 128 を設定後 Update-Database を実行すれば MySQL に ASP.NET Core Identity に必要なデータベースとテーブルが生成されます。

その後で Visual Studio から MVC アプリを動かしてユーザー登録できます。登録したユーザーはデーターベースに反映されます。もちろん登録した ID とパスワードでアプリにログインできるようになります。

.NET Framework 版（Core 版ではありません）の ASP.NET Identity でユーザー情報のストアに MySQL を利用するにはどうするかということを書きます。（Core 3.1 版は別の記事「ASP.NET Identity で MySQL 利用 (CORE 版)」を見てください。Visual Studio 2022 + .NET 6.0 の場合は「.NET 6.0 ASP.NET Identity に MySQL 使用 (CORE)」を見てください）

参考にさせていただいたのは「ASP.NET MVC + MySQL で開発環境構築」という記事です（以下、参考記事と書きます）

(1) MVC プロジェクトの作成

Visual Studio 2019 のテンプレートを利用して .NET Framework 版の ASP.NET MVC5 アプリのプロジェクトを自動生成します。

認証に「個別のユーザーアカウント」を選ぶと ASP.NET Identity を使ったクッキーベースの認証システムが実装され、Entity Framework Code First の機能を使って LocalDB (SQL Server) にユーザー情報を保持するためのデーターベースを作るコードが生成されます。

それを LocalDB (SQL Server) ではなくて MySQL にユーザー情報を保持するためのデーターベースを作り、それを利用するように変更します。

(2) 参照設定

ソリューションエクスプローラーで参照を右クリックして MySql.Data と MySql.Data.EntityFramework を参照に追加します。下の画像を見てください。

先の記事「MySQL をインストールしました（その 3）」で書きましたように MySQL 8.0.19 をインストールしており、その時同時にインストールした Connector/NET 8.0.19 に含まれる MySql.Data, MySql.Data.EntityFramework を使うことにしました。

参考記事では NuGet で MySql.Data.Entity をインストールしたと書いてありましたが、NuGet にあるのは今でもバージョンが古いようです。

(3) 接続文字列の変更

テンプレートで自動生成された web.config の接続文字列は LocalDB を利用するように設定されていますので、それを MySQL に接続するように変更します。

以下のような感じです。例えば、database=identity というようにデータベース名を指定すると、Entity Framework Code First の機能を使って identity という名前のデータベースを新たに生成し、そこに必要なテーブルを生成してくれます。(データベース名は任意で、この記事で identity としたのは単なる例です)

<add name="DefaultConnection"
    connectionString="server=localhost;user id=root;password=*****;
    database=identity"
    providerName="MySql.Data.MySqlClient" />

(4) Enable-Migrations

上記 (3) の設定の後、Enable-Migrations を実行すると以下のエラーになると思います��

"ADO.NET プロバイダーに、不変名が 'MySql.Data.MySqlClient' の Entity Framework プロバイダーがありません。アプリケーションの構成ファイルの "entityFramework" セクションにプロバイダーが登録されていることを確認してください"

それを解決するためには、エラーメッセージに応じて、自動生成された web.config の entityFramework/providers セクションに以下のコードを追加します。

<provider 
  invariantName="MySql.Data.MySqlClient" 
  type="MySql.Data.MySqlClient.MySqlProviderServices, 
        MySql.Data.EntityFramework,Version=8.0.19.0, Culture=neutral, 
        PublicKeyToken=c5687fc88969c44d" />

NuGet で MySql.Data.Entity をインストールした場合は web.config への上記の provider の追加は NuGet が面倒を見てくれるようです。

上のコードを web.config に追加した後 Enable-Migrations を実行すると Migrations フォルダに Configuration.cs ファイルが生成されているはずです。

(5) Add-Migration

Add-Migration Initial を実行します（Initial という名前は任意です）。そうすると、参考記事と同様に以下のエラーになると思います。

"プロバイダー 'MySql.Data.MySqlClient' で MigrationSqlGenerator が見つかりませんでした。対象の移行構成クラスで SetSqlGenerator メソッドを使用して、追加の SQL ジェネレーターを登録してください"

エラーメッセージに従って Configuration.cs に手を加えます。以下のコードのコメントで「追加」としている部分がそれです。

namespace Mvc5AppIdentityMySql.Migrations
{
  using System;
  using System.Data.Entity;
  using System.Data.Entity.Migrations;
  using System.Linq;

  // 追加
  using MySql.Data.EntityFramework;

  internal sealed class Configuration : 
    DbMigrationsConfiguration<Mvc5AppIdentityMySql.Models.ApplicationDbContext>
  {
    public Configuration()
    {
      AutomaticMigrationsEnabled = false;

      // 追加
      SetSqlGenerator("MySql.Data.MySqlClient", 
                      new MySqlMigrationSqlGenerator());
    }

    protected override void Seed(
      Mvc5AppIdentityMySql.Models.ApplicationDbContext context)
    {
    }
  }
}

エラーメッセージの SetSqlGenerator メソッドというのは DbMigrationsConfiguration クラスの SetSqlGenerator(String, MigrationSqlGenerator) メソッド です。これをコンストラクタに追加します。

SetSqlGenerator メソッドの第 1 引数には MySQL のプロバイダ名 "MySql.Data.MySqlClient" を与え、第 2 引数には MySqlMigrationSqlGenerator クラスを初期化して与えます。

MySqlMigrationSqlGenerator クラスが属する名前空間は Connector/NET 8.0 になって変わったようで MySql.Data.EntityFramework となっていますので注意してください。（v6.x の時代は MySql.Data.Entity だったはずです）

参考記事に書いてあったコードは上記と違いますが、参考記事の通りとしても問題なく Add-Migration Initial, Update-Database できることは確認できました。しかし、参考記事のコードがエラーメッセージの「追加の SQL ジェネレーターを登録」をどう解決しているのか分からなかったので、エラーメッセージ通りにコーディングしました。

(6) Update-Database

Update-Database で MySQL に必要なデータベースとテーブルを生成します。成功すると、上のステップ「(5) Add-Migration」で生成された Configuration.cs ファイルの内容に従って ASP.NET Identity 用のテー���ルが生成されます。下の画像を見てください。

データーベース / テーブルが生成できましたので、Visual Studio から MVC アプリを動かしてユーザー登録できます。登録したユーザーはデーターベースに反映されています。もちろん登録した ID とパスワードでアプリにログインできるようになります。

参考記事では Update-Database で "Specified key was too long; max key length is 767 bytes" というエラーとなったそうです。なぜ参考記事でその問題が起こったのか、この記事では問題なかったかは以下のようなことだと思います。

テーブル AspNetUserRoles は UserId と RoleId がそれぞれ nvarchar(128) で連結主キーの設定になるのですが、charset が utf8 で一文字 3 バイトですと 128 x 2 x 3 = 768 となって制限の 767 バイトを超えます。それが参考記事の問題のようです。

一方、この記事では MySQL 8.x を使っているので上限が 3,072 バイトになっています。（MySQL 5.7 以降では _large_prefix が ON となっており、767 バイトの制限が 3,072 バイトに拡張されているとのこと）。文字コードは utf8mb4 なので一文字 4 バイトになり、128 x 2 x 4 = 1024 < 3072 なので問題ないということのようです。

旧来のフォーム認証の場合、ASP.NET の認証・承認システムとデータベースの間にプロバイダを配置して、プロバイダを入れ替えることによりいろいろなデータベースに対応していました。例えば SQL Server の場合は専用の SqlMembershipProvider が提供されています。

異なるデーターベースを使う場合はプロバイダを入れ替えて対応します。例えば MySQL の場合は Oracle が提供している MySQLMembershipProvider を利用できます。ただし、プロバイダが提供されていなければ自力でコードを書いてプロバイダを作成しなければなりません。

ASP.NET Identity では上に書いたように参照設定の追加、web.config の設定、追加の SQL ジェネレーター登録（これはすべてのケースで必要かは分かりませんが）で可能なようです。個人的には以前より分かりにくくなった感じがしますが・・・

先の記事「デスクトップ PC を買いました」の PC に MySQL 8.0.19 をインストールしました。8.0.19 はこの記事を書いた時点での最新版です。

手順は「MySQL をインストールしました（その 2）」で書いた MySQL Community Server 5.7.17 のものとほぼ同じです。

前回 5.7.17 の時と同様に、今回も MySQL のダウンロードサイト MySQL Community Downloads からインストーラー mysql-installer-web-community-8.0.19.0.msi を入手し、上の画像の製品一式をインストールしました。

前回の手順と大きく異なる点のみ以下に備忘録として書いておきます。下の (7) とか (8) は先の記事「MySQL をインストールしました（その 2）」に書いたステップの番号です。

(7) タイプとネットワーク

ここまでは前回 5.7.17 の時とほぼ同じですが、この画面で［Next >］をクリックすると、前回は出なかった Authentication Method というダイアログが出ます。以下の画像を見てください。

Use Legacy Authentication Method (Retain MySQL 5.x Compatibility) を選んで［Next >］をクリックします。

(9) MySQL サーバーへのアカウント登録

前回 5.7.17 の時は「(8) MySQL ユーザー詳細情報」がこのステップより先でしたが、今回はこちらが先になります。［MySQL Root Password］欄に任意のパスワードを入力し、［Add User] ボタンをクリックすると「(8) MySQL ユーザー詳細情報」のダイアログが出ます。設定したパスワードは忘れないように覚えておいてください。

(8) MySQL ユーザー詳細情報

この画面で User Name に root を設定すると既に使用されているというエラーになります。どうも root とは別のユーザーを設定するらしく、ここでは別の任意のユーザー名とパスワードを設定します。設定したユーザー名とパスワードは忘れないように覚えておいてください。

（ちなみに、前回の 5.7.17 の時はこの画面で User Name に root を設定、Password を入力して「(9) MySQL サーバーへのアカウント登録」に進むと、そこで［MySQL User Account］には (9) で設定したユーザー root が表示されました）

(13) 設定の完了

内容が前回と異なりますが気にせず続行します。

その後、MySQL Router Configuration というダイアログが出ますが、InnoDB cluster と関係あるものらしく、自分は利用しないのでチェックは入れずスキップして完了しました。

MySQL for Visual Studio の MySql.Data.dll 8.0.18 と Connector/NET の MySql.Data.dll 8.0.19 のバージョン不一致により Visual Studio の TableAdapter 構成ウィザードで不具合が出るという問題は依然としてあります。それについては別途記事を書く予定です。