OWIN スタートアップクラス検出

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

このチュートリアルでは、読み込まれる OWIN スタートアップクラスを構成する方法について説明します。 OWIN の詳細については、「プロジェクトカタナの概要」を参照してください。このチュートリアルは、Rick Anderson ( @RickAndMSFT )、Praburaj Thiagarajan、および Howard Dierking ( @howard_dierking ) によって作成されました。

必須コンポーネント

Visual Studio 2017

OWIN スタートアップクラス検出

すべての OWIN アプリケーションには、アプリケーションパイプラインのコンポーネントを指定するスタートアップクラスがあります。選択したホスティングモデル (OwinHost、IIS、IIS-Express) に応じて、スタートアップクラスをランタイムに接続する方法はさまざまです。このチュートリアルで示すスタートアップクラスは、すべてのホスティングアプリケーションで使用できます。次のいずれかの方法を使用して、スタートアップクラスをホスティングランタイムに接続します。

名前付け規則: Katana は、アセンブリ名またはグローバル名前空間に一致する名前空間でという名前 Startup のクラスを検索します。
OwinStartup 属性: これは、ほとんどの開発者がスタートアップクラスを指定するために行うアプローチです。次の属性は、スタートアップクラスを名前空間の TestStartup クラスに StartupDemo 設定します。
```
[assembly: OwinStartup(typeof(StartupDemo.TestStartup))]
```
属性は OwinStartup 、名前付け規則をオーバーライドします。この属性を使用してフレンドリ名を指定することもできますが、フレンドリ名を使用するには、構成ファイルの要素も使用 appSetting する必要があります。

構成ファイルの appSetting 要素: 要素は appSetting 、属性と名前付け規則を OwinStartup オーバーライドします。複数のスタートアップクラス (それぞれ属性を使用) を OwinStartup 持ち、次のようなマークアップを使用して、構成ファイルに読み込むスタートアップクラスを構成できます。

<appSettings>  
  <add key="owin:appStartup" value="StartupDemo.ProductionStartup" />
</appSettings>

スタートアップクラスとアセンブリを明示的に指定する次のキーも使用できます。

<add key="owin:appStartup" value="StartupDemo.ProductionStartup, StartupDemo" />

構成ファイル内の次の XML は、のフレンドリスタートアップクラス名を ProductionConfiguration指定します。

<appSettings>  
  <add key="owin:appStartup" value="ProductionConfiguration" />       
</appSettings>

上記のマークアップは、フレンドリ名を指定し、クラスを実行する次 OwinStartup の ProductionStartup2 属性と共に使用する必要があります。

[assembly: OwinStartup("ProductionConfiguration", typeof(StartupDemo.ProductionStartup2))]

namespace StartupDemo
{
    public class ProductionStartup
    {
        public void Configuration(IAppBuilder app)
        {
            app.Run(context =>
            {
                string t = DateTime.Now.Millisecond.ToString();
                return context.Response.WriteAsync(t + " Production OWIN App");
            });
        }
    }
    public class ProductionStartup2
    {
        public void Configuration(IAppBuilder app)
        {
            app.Run(context =>
            {
                string t = DateTime.Now.Millisecond.ToString();
                return context.Response.WriteAsync(t + " 2nd Production OWIN App");
            });
        }
    }
}

OWIN スタートアップ検出を無効にするには、web.config ファイルにの"false"値を指定してを追加appSetting owin:AutomaticAppStartupします。
```
<add key="owin:AutomaticAppStartup" value="false" />
```

OWIN スタートアップを使用して ASP.NET Web アプリを作成する

空の Asp.Net Web アプリケーションを作成し、 StartupDemo という名前を付けます。 - NuGet パッケージマネージャーを使用してインストール Microsoft.Owin.Host.SystemWeb します。 [ツール] メニューの [NuGet パッケージマネージャー] を選択し、[パッケージマネージャーコンソール] を選択します。次のコマンドを入力します。
```
Install-Package Microsoft.Owin.Host.SystemWeb
```
OWIN スタートアップクラスを追加します。 Visual Studio 2017 でプロジェクトを右クリックし、[クラスの追加] を選択します。- [ 新しい項目の追加 ] ダイアログボックスで、検索フィールドに 「OWIN 」と入力し、名前を Startup.cs に変更して、[ 追加] を選択します。

次回 Owin Startup クラスを追加する場合は、[ 追加] メニューから使用できるようになります。

または、プロジェクトを右クリックして [ 追加] を選択し、[ 新しい項目] を選択して、 Owin Startup クラスを選択することもできます。

$[Select the Owin Startup class]$Owin スタートアップクラスの選択$ のスクリーンショット。$

Startup.cs ファイルで生成されたコードを次のように置き換えます。
```
using System;
using System.Threading.Tasks;
using Microsoft.Owin;
using Owin;
using System.IO;

//[assembly: OwinStartup(typeof(StartupDemo.Startup))]

namespace StartupDemo
{
   public class Startup
   {
      public void Configuration(IAppBuilder app)
      {
         app.Use((context, next) =>
         {
            TextWriter output = context.Get<TextWriter>("host.TraceOutput");
            return next().ContinueWith(result =>
            {
               output.WriteLine("Scheme {0} : Method {1} : Path {2} : MS {3}",
               context.Request.Scheme, context.Request.Method, context.Request.Path, getTime());
            });
         });

         app.Run(async context =>
         {
            await context.Response.WriteAsync(getTime() + " My First OWIN App");
         });
      }

      string getTime()
      {
         return DateTime.Now.Millisecond.ToString();
      }
   }
}
```
app.Useラムダ式は、指定したミドルウェアコンポーネントを OWIN パイプラインに登録するために使用されます。この場合、受信要求に応答する前に、受信要求のログ記録を設定します。パラメーターは next 、パイプライン内の次のコンポーネントへのデリゲート ( Func<Task> ) です。ラムダ式は app.Run 、パイプラインを受信要求にフックし、応答メカニズムを提供します。

Note

上記のコードでは、属性を OwinStartup コメントアウトし、という名前 Startup のクラスを実行する規則に依存しています。- F5 キーを押してアプリケーションを実行します。数回の更新をヒットします。

注: このチュートリアルの画像に表示される番号は、表示される数値と一致しません。ミリ秒の文字列は、ページを更新するときに新しい応答を表示するために使用されます。トレース情報は [出力 ]ウィンドウで確認できます。

その他のスタートアップクラスを追加する

このセクションでは、別の Startup クラスを追加します。複数の OWIN スタートアップクラスをアプリケーションに追加できます。たとえば、開発、テスト、運用のためのスタートアップクラスを作成できます。

新しい OWIN スタートアップクラスを作成し、という名前を付けます ProductionStartup。

生成されたコードを次のコードに置き換えます。

using System;
using System.Threading.Tasks;
using Microsoft.Owin;
using Owin;

[assembly: OwinStartup(typeof(StartupDemo.ProductionStartup))]

namespace StartupDemo
{
    public class ProductionStartup
    {
        public void Configuration(IAppBuilder app)
        {
            app.Run(context =>
            {
                string t = DateTime.Now.Millisecond.ToString();
                return context.Response.WriteAsync(t + " Production OWIN App");
            });
        }
    }
}

Ctrl F5 キーを押してアプリを実行します。属性は OwinStartup 、運用スタートアップクラスが実行されていることを指定します。
別の OWIN スタートアップクラスを作成し、という名前を付けます TestStartup。

生成されたコードを次のコードに置き換えます。

using System;
using System.Threading.Tasks;
using Microsoft.Owin;
using Owin;

[assembly: OwinStartup("TestingConfiguration", typeof(StartupDemo.TestStartup))]

namespace StartupDemo
{
    public class TestStartup
    {
        public void Configuration(IAppBuilder app)
        {
            app.Run(context =>
            {
                string t = DateTime.Now.Millisecond.ToString();
                return context.Response.WriteAsync(t + " Test OWIN App");
            });
        }
    }
}

上記の属性オーバーロードは OwinStartup 、 TestingConfiguration Startup クラスの フレンドリ 名としてを指定します。

web.config ファイルを開き、スタートアップクラスのフレンドリ名を指定する OWIN アプリスタートアップキーを追加します。

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <appSettings>
    <add key="owin:appStartup" value="TestingConfiguration" />
  </appSettings>
  <system.web>
    <compilation debug="true" targetFramework="4.5" />
    <httpRuntime targetFramework="4.5" />
  </system.web>
</configuration>

Ctrl F5 キーを押してアプリを実行します。アプリ設定要素が優先され、テスト構成が実行されます。
クラスの属性からOwinStartupフレンドリ名をTestStartup削除します。
```
[assembly: OwinStartup(typeof(StartupDemo.TestStartup))]
```
web.config ファイルの OWIN アプリスタートアップキーを次のように置き換えます。
```
<add key="owin:appStartup" value="StartupDemo.TestStartup" />
```

各クラスの属性を OwinStartup 、Visual Studio によって生成された既定の属性コードに戻します。

[assembly: OwinStartup(typeof(StartupDemo.Startup))]
[assembly: OwinStartup(typeof(StartupDemo.ProductionStartup))]
[assembly: OwinStartup(typeof(StartupDemo.TestStartup))]

以下の OWIN アプリのスタートアップキーごとに、運用クラスが実行されます。

<add key="owin:appStartup" value="StartupDemo.ProductionStartup" />
<add key="owin:appStartup" value="StartupDemo.ProductionStartup, StartupDemo" />
<add key="owin:appStartup" value="StartupDemo.ProductionStartup.Configuration, StartupDemo" />

最後のスタートアップキーは、スタートアップ構成方法を指定します。次の OWIN アプリスタートアップキーを使用すると、構成クラスの名前をに MyConfiguration 変更できます。

<add key="owin:appStartup" value="StartupDemo.ProductionStartup2.MyConfiguration" />

Owinhost.exeの使用

Web.config ファイルを次のマークアップに置き換えます。

<?xml version="1.0" encoding="utf-8"?>
<configuration>
   <appSettings>
      <add key="owin:appStartup" value="StartupDemo.Startup" />
      <add key="owin:appStartup" value="StartupDemo.TestStartup" />
   </appSettings>
  <system.web>
    <compilation debug="true" targetFramework="4.5" />
    <httpRuntime targetFramework="4.5" />
  </system.web>
</configuration>

最後のキーが優先されるため、この場合 TestStartup はを指定します。

PMC から Owinhost をインストールします。
```
Install-Package OwinHost
```
アプリケーションフォルダー ( Web.config ファイルを含むフォルダー) に移動し、コマンドプロンプトで次のように入力します。
```
..\packages\Owinhost<Version>\tools\Owinhost.exe
```
コマンドウィンドウに次の情報が表示されます。
```
C:\StartupDemo\StartupDemo>..\packages\OwinHost.2.0.0\tools\Owin
Host.exe
Starting with the default port: 5000 (http://localhost:5000/)
Started successfully
Press Enter to exit
```
URL http://localhost:5000/を使用してブラウザーを起動します。

OwinHost は、上記のスタートアップ規則に従いました。
コマンドウィンドウで Enter キーを押して OwinHost を終了します。
クラスに ProductionStartup 、 ProductionConfiguration のフレンドリ名を指定する次の OwinStartup 属性を追加します。
```
[assembly: OwinStartup("ProductionConfiguration", 
           typeof(StartupDemo.ProductionStartup))]
```
コマンドプロンプトで、次のように入力します。
```
..\packages\OwinHost.2.0.0\tools\OwinHost.exe ProductionConfiguration
```
運用スタートアップクラスが読み込まれます。

アプリケーションには複数のスタートアップクラスがあり、この例では、ランタイムまで読み込むスタートアップクラスを延期しています。

次のランタイムスタートアップオプションをテストします。

..\packages\OwinHost.2.0.0-rc1\tools\OwinHost.exe StartupDemo.TestStartup
..\packages\OwinHost.2.0.0-rc1\tools\OwinHost.exe "StartupDemo.TestStartup,StartupDemo"
..\packages\OwinHost.2.0.0-rc1\tools\OwinHost.exe StartupDemo.TestStartup.Configuration
..\packages\OwinHost.2.0.0-rc1\tools\OwinHost.exe "StartupDemo.TestStartup.Configuration,StartupDemo"

OWIN スタートアップクラス検出

必須コンポーネント