Sisk

手動(高度)設定

このページは英語から自動翻訳されています。 原文を読む

手動セットアップは、サーバーの構成要素を自分で組み立てる必要がある場合に使用します。たとえば、1 つのプロセスが複数のホスト、ポート、ルーター、またはカスタムサーバー構成を公開しなければならない場合です。ほとんどのアプリケーションでは、ビルダー API の方が短く、優先すべきです。手動セットアップは、Router、1 つ以上の ListeningHost オブジェクト、HttpServerConfiguration、最終的な HttpServer の 4 つのコア要素を直接制御したいときに便利です。

まず、リクエスト/レスポンスの概念を理解する必要があります。これは非常にシンプルです。すべてのリクエストに対してレスポンスが必要です。Sisk もこの原則に従っています。ステータスコードとヘッダーを指定した、HTML の「Hello, World!」メッセージで応答するメソッドを作成しましょう。

C#
// Program.cs
using Sisk.Core.Http;
using Sisk.Core.Routing;

static HttpResponse IndexPage(HttpRequest request)
{
    HttpResponse indexResponse = new HttpResponse
    {
        Status = System.Net.HttpStatusCode.OK,
        Content = new HtmlContent(@"
            <html>
                <body>
                    <h1>Hello, world!</h1>
                </body>
            </html>
        ")
    };

    return indexResponse;
}

次のステップは、このメソッドを HTTP ルートに関連付けることです。

ルーター #

ルーターはリクエストルートの抽象化であり、サービスのリクエストとレスポンスの橋渡しを行います。ルーターはサービスのルート、関数、エラーを管理します。

ルーターは複数のルートを持つことができ、各ルートは関数の実行、ページの提供、サーバーからのリソース提供など、パスに対して異なる操作を実行できます。

最初のルーターを作成し、IndexPage メソッドをインデックスパスに関連付けてみましょう。

C#
Router mainRouter = new Router();

mainRouter.MapGet("/", IndexPage);

これでルーターはリクエストを受け取り、レスポンスを送信できるようになりました。ただし、mainRouter はホストやサーバーに結び付けられていないため、単体では機能しません。次のステップは ListeningHost を作成することです。

リスニングホストとポート #

ListeningHost はルーターと同じルーター用の複数のリスニングポートをホストできます。ListeningPort は HTTP サーバーがリッスンするプレフィックスです。

ここでは、ルーターに対して 2 つのエンドポイントを指す ListeningHost を作成します。

C#
ListeningHost myHost = new ListeningHost
{
    Router = mainRouter,
    Ports = new ListeningPort[]
    {
        new ListeningPort("http://localhost:5000/")
    }
};

これで HTTP サーバーは指定されたエンドポイントでリッスンし、リクエストをルーターに転送します。

サーバー構成 #

サーバー構成は HTTP サーバー自体の動作の大部分を担当します。この構成では、ListeningHosts をサーバーに関連付けることができます。

C#
HttpServerConfiguration config = new HttpServerConfiguration();
config.ListeningHosts.Add(myHost); // Add our ListeningHost to this server configuration

一般的なサーバー構成オプション:

プロパティデフォルト使用シーン備考
RemoteRequestsActionRequestListenAction.Acceptサービスは、信頼できるリバースプロキシ経由でない限り、ローカル以外のリクエストを拒否すべきです。Drop に設定するのは、デプロイトポロジーが明確な場合のみです。
IncludeRequestIdHeaderfalseクライアントまたはプロキシが X-Request-Id 応答ヘッダーに Sisk のリクエスト ID を必要とする場合。HttpRequest.RequestId を含むログと組み合わせて使用してください。
IdleConnectionTimeout120 秒アイデル状態の Keep-Alive 接続は、いずれかの時点で閉じるべきです。これは HTTP エンジンによって適用されます。
NormalizeHeadersEncodingsfalseエンコーディングが一致しないヘッダーを受信した場合。処理コストがかかります。必要なければ無効のままにしてください。
SendSiskHeadertrueX-Powered-By Sisk ヘッダーを隠すか表示したい場合。本番環境でヘッダー方針を厳格にする場合は無効にしてください。
OptionsLogModeLogOutput.Both自動 OPTIONS 処理で生成されるログを削減またはリダイレクトしたい場合。ルートと同じログモードの値を使用します。
AsyncRequestProcessingtrue診断のために決定的な単一リクエスト処理が必要な場合。無効にするとスループットが制限されます。
DisposeDisposableContextValuestrueIDisposable を実装するリクエストバッグの値は自動的に破棄すべきです。所有権が他で管理されていない限り有効にしておいてください。
ConvertIAsyncEnumerableIntoEnumerabletrue値ハンドラは非同期列挙可能オブジェクトをブロッキング列挙可能値として受け取るべきです。独自の非同期ストリーム処理を実装する場合は無効にしてください。
KeepAlivetrueレスポンス後も接続を再利用可能にすべきです。永続接続を適切に処理できないクライアントや中間サーバーの場合は無効にしてください。
ForceTrailingSlashfalseGET ルートは末尾スラッシュ付き URL にリダイレクトすべきです。正規表現以外のルートにのみ適用されます。
MaximumContentLength100 MBリクエストボディや WebSocket メッセージに別のサイズ上限が必要な場合。Sisk 1.7 以前のデフォルトは 0(無制限)でした。上限を解除するには 0 に設定してください。
EnableAutomaticResponseCompressionfalseクライアントがサポートしている場合、レスポンスを自動的に圧縮すべきです。既存の CompressedContent 応答は再度圧縮されません。

次に、HTTP サーバーを作成します。

C#
HttpServer server = new HttpServer(config);
server.Start();    // Starts the server
Console.ReadKey(); // Prevents the application from exiting

これで実行ファイルをビルドし、次のコマンドで HTTP サーバーを起動できます。

Bash
dotnet watch

実行時にブラウザを開きサーバーパスへアクセスすると、以下のように表示されます。

ドキュメントと API リファレンスを検索するには入力してください。