<h2 id="%E7%92%B0%E5%A2%83" data-line="0" class="code-line">
<a class="header-anchor-link" href="#%E7%92%B0%E5%A2%83" aria-hidden="true"></a> 環境</h2>
<p data-line="2" class="code-line">.NET AspireとEntity Frameworkでマイグレーション(ドキュメント的には移行)を実現するためのプロジェクト構成・コマンド例については公式ドキュメントがすでに存在する。</p>
<p data-line="4" class="code-line"><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__9ba2ed1f33f7" src="https://embed.zenn.studio/card#zenn-embedded__9ba2ed1f33f7" data-content="https%3A%2F%2Flearn.microsoft.com%2Fja-jp%2Fdotnet%2Faspire%2Fdatabase%2Fef-core-migrations" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://learn.microsoft.com/ja-jp/dotnet/aspire/database/ef-core-migrations" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://learn.microsoft.com/ja-jp/dotnet/aspire/database/ef-core-migrations</a></p>
<p data-line="6" class="code-line">上記のドキュメントとほぼ同じように、ソリューションに.NET 9をランタイムとして設定した以下のプロジェクトがいる環境で実行する。</p>
<ul data-line="7" class="code-line">
<li data-line="7" class="code-line">.NET Aspireのプロジェクト (AppHost)</li>
<li data-line="8" class="code-line">ASP.NET Coreのプロジェクト (以下、<code>Web.Server</code>)</li>
<li data-line="9" class="code-line">クラスライブラリのプロジェクト(DbContextとCode Firstのモデルが入っている。Migrationも入れたい。以下、<code>Web.Data</code>)</li>
</ul>
<p data-line="11" class="code-line">ただし公式ドキュメントと違う点は、利用するコネクタが<br>
<code>Aspire.Pomelo.EntityFrameworkCore.MySql</code><br>
と<br>
<code>Pomelo.EntityFrameworkCore.MySql 9.0.0-preview.2.efcore.9.0.0</code><br>
という点。<br>
※Previewを使うのはまだEF9対応版が出ていないため。</p>
<h2 id="%E5%95%8F%E9%A1%8C" data-line="18" class="code-line">
<a class="header-anchor-link" href="#%E5%95%8F%E9%A1%8C" aria-hidden="true"></a> 問題</h2>
<p data-line="20" class="code-line">環境に記述した通り、すでに構成例となるドキュメントはすでに整備されている。<br>
なので基本はこれをもとにプロジェクトを作成していけば、実行手前の段階までは持っていくことができる。<br>
このドキュメントで詰まるのが<a href="https://learn.microsoft.com/ja-jp/dotnet/aspire/database/ef-core-migrations#create-migrations" target="_blank" rel="nofollow noopener noreferrer">「マイグレーションの作成」</a>というところ。</p>
<p data-line="24" class="code-line">ここで行うのが、一番最初のマイグレーションを作る作業。<br>
そこでマイグレーションを作成すれば以後の<code>MigrationService</code>が動作できるようになるのだが、次のエラーが出て作成することができない。</p>
<div class="code-block-container"><pre><code class="code-line" data-line="27">PS C:\…\Web\Web.Server&gt; dotnet ef migrations add InitialCreate --project ..\..\Web.Data\Web.Data.csproj
Build started...
Build succeeded.
info: MySqlConnector.MySqlConnection[0]
      Session 0.1 connect timeout expired connecting to IP address 172.21.48.1 for host name
      System.Net.Sockets.SocketException (10038): ソケット以外のものに対して操作を実行しようとしました。 172.21.48.1:3306
         at System.Net.Sockets.Socket.DoConnect(EndPoint endPointSnapshot, SocketAddress socketAddress)
         at System.Net.Sockets.Socket.Connect(EndPoint remoteEP)
         at System.Net.Sockets.TcpClient.Connect(IPEndPoint remoteEP)
         at MySqlConnector.Core.ServerSession.OpenTcpSocketAsync(ConnectionSettings cs, ILoadBalancer loadBalancer, Activity activity, IOBehavior ioBehavior, CancellationToken cancellationToken) in /_/src/MySqlConnector/Core/ServerSession.cs:line 1247
warn: Polly[3]
      Execution attempt. Source: 'Microsoft.Extensions.Hosting.AspireEFMySqlExtensions.ServerVersion/(null)/Retry', Operation Key: '', Result: 'Connect Timeout expired.', Handled: 'True', Attempt: '0', Execution Time: 15031.7774ms
      MySqlConnector.MySqlException (0x80004005): Connect Timeout expired.
       ---&gt; MySqlConnector.MySqlException (0x80004005): Connect Timeout expired.
         at MySqlConnector.Core.ServerSession.OpenTcpSocketAsync(ConnectionSettings cs, ILoadBalancer loadBalancer, Activity activity, IOBehavior ioBehavior, CancellationToken cancellationToken) in /_/src/MySqlConnector/Core/ServerSession.cs:line 1266
         at MySqlConnector.Core.ServerSession.ConnectAsync(ConnectionSettings cs, MySqlConnection connection, Int64 startingTimestamp, ILoadBalancer loadBalancer, Activity activity, IOBehavior ioBehavior, CancellationToken cancellationToken) in /_/src/MySqlConnector/Core/ServerSession.cs:line 427
         at MySqlConnector.Core.ServerSession.ConnectAndRedirectAsync(ILogger connectionLogger, ILogger poolLogger, IConnectionPoolMetadata pool, ConnectionSettings cs, ILoadBalancer loadBalancer, MySqlConnection connection, Action`4 logMessage, Int64 startingTimestamp, Activity activity, IOBehavior ioBehavior, CancellationToken cancellationToken) in /_/src/MySqlConnector/Core/ServerSession.cs:line 697
         at MySqlConnector.Core.ServerSession.ConnectAndRedirectAsync(ILogger connectionLogger, ILogger poolLogger, IConnectionPoolMetadata pool, ConnectionSettings cs, ILoadBalancer loadBalancer, MySqlConnection connection, Action`4 logMessage, Int64 startingTimestamp, Activity activity, IOBehavior ioBehavior, CancellationToken cancellationToken) in /_/src/MySqlConnector/Core/ServerSession.cs:line 702
         at MySqlConnector.MySqlConnection.CreateSessionAsync(ConnectionPool pool, Int64 startingTimestamp, Activity activity, Nullable`1 ioBehavior, CancellationToken cancellationToken) in /_/src/MySqlConnector/MySqlConnection.cs:line 1099
         at MySqlConnector.MySqlConnection.CreateSessionAsync(ConnectionPool pool, Int64 startingTimestamp, Activity activity, Nullable`1 ioBehavior, CancellationToken cancellationToken) in /_/src/MySqlConnector/MySqlConnection.cs:line 1114
         at MySqlConnector.MySqlConnection.OpenAsync(Nullable`1 ioBehavior, CancellationToken cancellationToken) in /_/src/MySqlConnector/MySqlConnection.cs:line 567
         at MySqlConnector.MySqlConnection.Open() in /_/src/MySqlConnector/MySqlConnection.cs:line 522
         at Microsoft.EntityFrameworkCore.ServerVersion.AutoDetect(String connectionString)
         at Microsoft.Extensions.Hosting.AspireEFMySqlExtensions.&lt;&gt;c__2`1.&lt;AddMySqlDbContext&gt;b__2_5(String cs) in /_/src/Components/Aspire.Pomelo.EntityFrameworkCore.MySql/AspireEFMySqlExtensions.cs:line 108
         at Polly.ResiliencePipeline.&lt;&gt;c__36`2.&lt;Execute&gt;b__36_0(ResilienceContext _, ValueTuple`2 state)
</code></pre></div><p data-line="55" class="code-line">または</p>
<div class="code-block-container"><pre><code class="code-line" data-line="57">PS C:\…\Web\Web.Server&gt; dotnet ef migrations add InitialCreate --project ..\..\Web.Data\Web.Data.csproj
Build started...
Build succeeded.
The exception 'The string argument 'connectionString' cannot be empty.' was thrown while attempting to find 'DbContext' types. For the different patterns supported at design time, see https://go.microsoft.com/fwlink/?linkid=851728

</code></pre></div><p data-line="65" class="code-line">が表示されてマイグレーションが作成することができない。</p>
<h2 id="%E6%8E%A5%E7%B6%9A%E3%82%BF%E3%82%A4%E3%83%A0%E3%82%A2%E3%82%A6%E3%83%88%E3%81%AE%E5%AF%BE%E5%87%A6" data-line="68" class="code-line">
<a class="header-anchor-link" href="#%E6%8E%A5%E7%B6%9A%E3%82%BF%E3%82%A4%E3%83%A0%E3%82%A2%E3%82%A6%E3%83%88%E3%81%AE%E5%AF%BE%E5%87%A6" aria-hidden="true"></a> 接続タイムアウトの対処</h2>
<p data-line="70" class="code-line"><code>Pomelo.EntityFrameworkCore.MySql</code>で用意されている機能として、接続先のサーバーバージョンによって発行するSQLを切り替えて互換性を維持する機能がある。<br>
そのサーバーバージョンを決めるのに、手動設定で行うか自動設定で行うか選ぶことができる。</p>
<p data-line="73" class="code-line"><code>Aspire.Pomelo.EntityFrameworkCore.MySql</code>を使うと、指定しない場合は自動設定(ServerVersion.AutoDetect)になるのだが、この自動設定というのはいったんMySQL/MariaDBに接続してバージョン情報を取得するというもの。<br>
<code>dotnet ef migrations add</code>コマンドで実行されている場合、.NET Aspireを介しているわけではないので当然データベースは動作しておらず、接続できない。</p>
<p data-line="76" class="code-line">そのため自動設定のための接続をしないために、手動でバージョン情報を渡してあげる必要がある。</p>
<p data-line="79" class="code-line">ハードコーディングで回避するには、<code>Web.Server</code>(ASP.NET Coreが動くプロジェクト、コマンドでカレントディレクトリにするもの)の<code>Program.cs</code>を以下のように変更する。</p>
<div class="code-block-container"><pre><code class="code-line" data-line="80">builder.AddMySqlDbContext&lt;ApplicationDbContext&gt;(
    connectionName: "mariadb",
    settings =&gt;
    {
        settings.ServerVersion = "8.0.41";
    });
</code></pre></div><aside class="msg message"><span class="msg-symbol">!</span><div class="msg-content">
<p data-line="89" class="code-line">もしサーバーがMariaDBだった場合はバージョン表記は<code>11.4.4-mariadb</code>のようになる</p>
</div></aside>
<aside class="msg message"><span class="msg-symbol">!</span><div class="msg-content">
<p data-line="92" class="code-line"><code>connectionName: "mariadb"</code> については、.NET Aspireで設定した名前と合わせる必要があるので注意</p>
</div></aside>
<p data-line="95" class="code-line">または、<code>appsettings.json</code>にバージョン情報を記述してそれを取得するようにすればよい。</p>
<h2 id="%E6%8E%A5%E7%B6%9A%E6%96%87%E5%AD%97%E5%88%97%E3%81%8C%E7%A9%BA%E3%81%AE%E5%AF%BE%E5%87%A6" data-line="100" class="code-line">
<a class="header-anchor-link" href="#%E6%8E%A5%E7%B6%9A%E6%96%87%E5%AD%97%E5%88%97%E3%81%8C%E7%A9%BA%E3%81%AE%E5%AF%BE%E5%87%A6" aria-hidden="true"></a> 接続文字列が空の対処</h2>
<div class="code-block-container"><pre><code class="code-line" data-line="102">The exception 'The string argument 'connectionString' cannot be empty.'
</code></pre></div><p data-line="105" class="code-line">というのは文字通り接続文字列が空だといわれている。</p>
<p data-line="107" class="code-line">.NET Aspireから起動すれば、自動的に接続情報が注入されるため設定が必要ないのだが、<code>dotnet ef migrations add</code>コマンドで実行されている場合、.NET Aspireを介しているわけではないので当然接続情報が注入されることはない。</p>
<p data-line="109" class="code-line">手動で<code>Web.Server</code>(ASP.NET Coreが動くプロジェクト、コマンドでカレントディレクトリにするもの)の<code>appsettings.json</code>に対して、以下のような設定を注入すればこの問題は回避できる。</p>
<div class="code-block-container"><pre><code class="code-line" data-line="110">{
  "ConnectionStrings": {
    "mariadb": "server=localhost;port=3306;database=dummydb;"
  },
～省略～
}
</code></pre></div><aside class="msg message"><span class="msg-symbol">!</span><div class="msg-content">
<p data-line="119" class="code-line"><code>"mariadb"</code> については、.NET Aspireで設定した名前と合わせる必要があるので注意</p>
</div></aside>
<p data-line="122" class="code-line"><strong>あくまで設定が入っていれば良い</strong>のでDB自体には<strong>つながらなくても大丈夫。</strong></p>
<h2 id="%E7%B5%82%E3%82%8F%E3%82%8A%E3%81%AB" data-line="126" class="code-line">
<a class="header-anchor-link" href="#%E7%B5%82%E3%82%8F%E3%82%8A%E3%81%AB" aria-hidden="true"></a> 終わりに</h2>
<p data-line="128" class="code-line">SQL Serverは問題ないのに、MySQLにするとドキュメントに書いてない問題が発生するの、.NET Coreあるあるだよね。</p>
<p data-line="130" class="code-line">Aspireの公式リポジトリでも.NET Aspire+EFの問題は議論されていて<sup class="footnote-ref"><a href="#fn-b355-1" id="fnref-b355-1">[1]</a></sup>、その結果上で使ったドキュメントができてはいるのですが、こうもう一声というか…。</p>
<section class="footnotes">
<span class="footnotes-title">脚注</span>
<ol class="footnotes-list">
<li id="fn-b355-1" class="footnote-item">
<p data-line="132" class="code-line"><a href="https://github.com/dotnet/aspire/issues/398" target="_blank" rel="nofollow noopener noreferrer">https://github.com/dotnet/aspire/issues/398</a> <a href="#fnref-b355-1" class="footnote-backref">↩︎</a></p>
</li>
</ol>
</section>


.NET Aspireに依存したMySQLとEntity FrameworkとASP.NET Coreでマイグレーションを作成する

Discussion