👩‍👩‍👦 👨🏻‍⚖️ 👩🏼‍⚖️ ASP.NET Coreの長いAPIを正しく使用するか、新しいプラットフォームに移行する微妙な点を使用します 🚵 🎈 ⏪

マイクロソフトは、Web開発用の新しいプラットフォームの作成に懸命に取り組みました。新しいASP.NET Coreは、おそらくMVCアーキテクチャ自体が古いASP.NET MVCに似ています。古いプラットフォームの難しさと馴染みのあるものはなくなり、組み込みのDIおよび軽量のビューコンポーネントが登場し、HTTPモジュールとハンドラーがミドルウェアに取って代わりました。クロスプラットフォームと優れたパフォーマンスにより、これらすべてがプラットフォームを非常に魅力的な選択肢にしています。この記事では、インシデント分析の利便性を高めるために、長期リクエストをサードパーティAPIに記録するという特定の問題をどのように解決したかを説明します。

参加する代わりに...

卒業証書や学位論文では、最初のどこかで、問題は通常定式化されるべきです。しかし、以下で説明することはおそらく問題ではありませんが、アプリケーションをより使いやすくし、私たちを取り巻く世界をもう少し美しくしたいという願望はもう少し美しいです。これは、私が自分自身に問いかける私の人生の瞬間の1つです。そしてその後、私はこれを行う方法を見つけようとしています。時々私はそれをします、時々私はそれを改善することは不可能であるか、最終的に意味をなさないほど努力する価値があることを理解します。結局、これ~~は世界をひっくり返したり、地球上の貧困の問題を解決したりするのでは~~なく、時間とエネルギーを浪費する価値のあるもので~~はあり~~ません。しかし、とにかく、私はこれから、将来役に立つと思わざるを得ない経験を得ることができます。この記事では、私がうまくやったと思うことを説明します。

タスクステートメント

そもそも、私が働いている会社は、負荷の高いサイトの開発に携わっています。私が現在取り組んでいるアプリケーションの大部分は、顧客の内部APIにアクセスするための一種の承認ベースのインターフェースです。そこにはあまりロジックがなく、フロントエンドとバックエンドの間でほぼ等しい割合で分散されています。主要なビジネスロジックのほとんどはこれらのAPIにあり、エンドカスタマーに表示されるサイトは顧客です。

サイトに関連するサードパーティAPIが非常に長い時間ユーザーのリクエストに応答することが判明する場合があります。これは一時的な効果である場合もあれば、永続的な場合もあります。本質的にアプリケーションの負荷が高いため、ユーザーリクエストを長時間サスペンド状態のままにすることはできません。そうしないと、オープンソケットの数が増え続け、サーバー上の応答のないリクエストのキューが急速に補充され、多数のクライアントが心配する可能性がありますそして、なぜ彼らのお気に入りのサイトがこんなに長く開いているのか心配していました。 APIでは何もできません。この点に関して、非常に長い時間前から、バランサーはリクエストの期間に5秒に等しい制限を導入しました。これは、アプリケーションアーキテクチャに主に制限を課します。これは、さらに非同期の相互作用を意味し、その結果、上記の問題を解決するためです。サイト自体はすぐに開き、すでに開いているページで読み込みインジケーターが回転し、最終的にユーザーに何らかの結果をもたらします。これはユーザーが期待するものであるか、エラーはもはや大きな役割を果たしません。これはまったく異なるストーリーになります...

まったく異なる物語

注意深い読者は気づくでしょう：しかし、制限がすべてのリクエストにある場合、AJAXリクエストにも適用されます。すべて正しいです。 AJAXリクエストと、すべてのケースで100％動作する通常のページ遷移を区別する方法はまったくわかりません。したがって、長いAJAXリクエストは次の原則に従って実装されます：クライアントからサーバーにリクエストを作成し、サーバーがタスクを作成し、特定のGUIDをそれに関連付けてから、このGUIDをクライアントに返し、クライアントがAPIからサーバーに到着すると、このGUIDの結果を受け取ります。この段階で、私は~~大げさな問題の~~問題のほぼ底辺に~~到達しました~~ 。

デブリーフィングのためにこれらのAPIへのすべてのリクエストと回答を記録および保存する必要があり、ログから、アクション/コントローラー、IP、URI、ユーザーログインなどと呼ばれる有用な情報を最大限に受け取る必要があります。など NLogを初めて使用して、ASP.NET Coreアプリケーションで要求/応答を保護したとき、原則として、ElasticSearchで次のようなものが表示されても驚きませんでした。

2017-09-23 23:15:53.4287|0|AspNetCoreApp.Services.LongRespondingService|TRACE|/| DoJob method is starting (AspNetCoreApp.Services.LongRespondingService.DoJob:0)| url:http:///

同時に、NLog構成ではすべてが非常によく見え、レイアウトとして次のものが設定されました。

${longdate}|${event-properties:item=EventId.Id}|${logger}|${uppercase:${level}}|${aspnet-mvc-controller}/${aspnet-mvc-action}| ${message} (${callsite}:${callsite-linenumber})| url:${aspnet-request-url}

ここでの問題は、クライアントが要求を完了した後にAPIからの応答が来ることです（GUIDのみを返します）。そして、私はこの問題の可能な解決策について考え始めました...

問題の可能な解決策

もちろん、問題はいくつかの方法で修正できます。また、得点することも、無視してはならないトリックの1つです。しかし、実際のソリューションとその結果について話しましょう。

タスクIDをAPI呼び出しメソッドに渡す

これはおそらく頭に浮かぶことができる最初のことです。 GUIDを生成し、アクションを終了する前にこのGUIDをログに記録し、APIサービスに渡します。

このアプローチの問題は明らかです。このIDを、サードパーティAPIにアクセスするすべてのメソッドに絶対に渡す必要があります。同時に、このような機能を必要としない他の場所でこの部分を再利用したい場合、これは私たちを大きく妨害します。

クライアントにデータを提供する前に何らかの方法でそれらを処理、単純化、または集約する場合、状況は悪化します。これはビジネスロジックに当てはまり、別の部分で取り出す必要があります。可能な限り独立したままにする必要のあるこの部分は、この識別子でも機能することがわかりました！したがって、物事は完了していないので、他の方法を検討してください。

CallContextにタスクIDを保存する

フレームワークがこれらの目的のために提供するツールについて考える場合、最初に覚えておくべきことは、LogicalSetData / LogicalGetDataを持つCallContextです。これらのメソッドを使用すると、CallContext'eにタスクIDを保存できます。.NET（つまり.NET 4.5）は、新しいスレッドが自動的に同じデータにアクセスするように注意します。フレームワーク内では、これはMementoに似たパターンを使用して実装され、新しいスレッド/タスクを開始するためのすべてのメソッドで使用する必要があります。

 //     snapshot   var ec = ExecutionContext.Capture(); ... //   snapshot    ExecutionContext.Run(ec, obj => { // snapshot     ,       }, state);

IDを保存してタスクに取得する方法がわかったので、ログに記録された各メッセージにこの識別子を含めることができます。これを行うには、ロギングメソッドを呼び出します。または、データアクセス層を詰まらせないために、ロガーの機能を使用できます。たとえば、NLogにはLayout Renderersがあります。

また、最後の手段として、独自のロガーを作成できます。 ASP.NET Coreでは、すべてのロギングは、Microsoft.Extensions.Logging名前空間にある特別なインターフェイスを使用して行われます。これは、DIを介してクラスに実装されます。したがって、ILoggerとILoggerProviderの2つのインターフェイスを実装するだけで十分です。このオプションは、ロガーが拡張機能をサポートしていない場合に役立つと思います。

そして、すべてが正常に機能するように、 Stephen Clearyの記事を読むことをお勧めします。 .NET Coreへのバインドはありません（2013年には、まだ存在していませんでした）が、そこに役立つ何かを明確に強調できます。

このアプローチの欠点は、識別子を持つメッセージがログに記録されるため、全体像を把握するには、同じIDを持つHTTPリクエストを探す必要があることです。パフォーマンスについては何も言いません。なぜなら、何らかのドローダウンがあっても、他のものと比較すると、これは不釣り合いに小さな値に見えるからです。

しかし、なぜこれが機能しないのかを考えたらどうでしょうか？

すでに述べたように、次のようなメッセージがあります。

2017-09-23 23:15:53.4287|0|AspNetCoreApp.Services.LongRespondingService|TRACE|/| DoJob method is starting (AspNetCoreApp.Services.LongRespondingService.DoJob:0)| url:http:///

すなわち IHttpContextに関連するものはすべて単純に無効化されます。理解できるようです：クエリが終了したため、NLogはデータを受信できません。 HttpContextへのリンクはなくなりました。

最後に、NLogが実際にコントローラー外部のHttpContextへのリンクを取得する方法を確認することにしました。 .NET CoreのSynchronizationContextとHttpContext.Current が終わったので（はい、これもStephen Clearyです）、これを行う他の方法が必要です。

NLogソースコードを掘り下げてみると、特定のIHttpContextAccessorが見つかりました。ここで何が起こっているのかを理解するのが渇いたので、GitHubに再び登り、1つのプロパティを持つこの魔法のようなものが何であるかを確認しました。これは、本質的にLogicalCallContextの新しいバージョン（LogicalSetData / LogicalGetDataのメソッド）であるAsyncLocalの単なる抽象化であることが判明しました。ちなみに、これは.NET Frameworkの場合は常にそうではありませんでした。

その後、私は自分自身に質問をしました：なぜ、実際に機能しないのですか？タスクを標準的な方法で実行します。ここにはアンマネージコードはありません...ロギングメソッドが呼び出されたときにHttpContextで何が起こるかを確認するためにデバッガーを実行します。HttpContextはありますが、Request.Schemeを除くすべてのプロパティは現在リセットされています呼び出しは「http」です。そのため、ログには奇妙な「 http:///

」がurlの代わりにあります。

そのため、パフォーマンスを向上させるために、ASP.NET Core自体がHttpContextをリセットして再利用することがわかりました。どうやら、このような微妙な点が結びつき、古いASP.NET MVCに比べて大きな利点を達成できるようになっています。

私はそれについて何ができますか？はい、HttpContextの現在の状態を保存するだけです！ DIコンテナーに登録した唯一のCloneCurrentContextメソッドを使用して単純なサービスを作成しました。

HttpContextPreserver

 public class HttpContextPreserver : IHttpContextPreserver { private readonly IHttpContextAccessor _httpContextAccessor; ILogger _logger; public HttpContextPreserver(IHttpContextAccessor httpContextAccessor, ILogger<HttpContextPreserver> logger) { _httpContextAccessor = httpContextAccessor; _logger = logger; } public void CloneCurrentContext() { var httpContext = _httpContextAccessor.HttpContext; var feature = httpContext.Features.Get<IHttpRequestFeature>(); feature = new HttpRequestFeature() { Scheme = feature.Scheme, Body = feature.Body, Headers = new HeaderDictionary(feature.Headers.ToDictionary(kvp => kvp.Key, kvp => kvp.Value)), Method = feature.Method, Path = feature.Path, PathBase = feature.PathBase, Protocol = feature.Protocol, QueryString = feature.QueryString, RawTarget = feature.RawTarget }; var itemsFeature = httpContext.Features.Get<IItemsFeature>(); itemsFeature = new ItemsFeature() { Items = itemsFeature?.Items.ToDictionary(kvp => kvp.Key, kvp => kvp.Value) }; var routingFeature = httpContext.Features.Get<IRoutingFeature>(); routingFeature = new RoutingFeature() { RouteData = routingFeature.RouteData }; var connectionFeature = httpContext.Features.Get<IHttpConnectionFeature>(); connectionFeature = new HttpConnectionFeature() { ConnectionId = connectionFeature?.ConnectionId, LocalIpAddress = connectionFeature?.LocalIpAddress, RemoteIpAddress = connectionFeature?.RemoteIpAddress, }; var collection = new FeatureCollection(); collection.Set(feature); collection.Set(itemsFeature); collection.Set(connectionFeature); collection.Set(routingFeature); var newContext = new DefaultHttpContext(collection); _httpContextAccessor.HttpContext = newContext; } } public interface IHttpContextPreserver { void CloneCurrentContext(); }

ディープクローンを使用しなかったのは、プロジェクトに大きな反省が加わるからです。そして、私はこれをただ一つの場所で必要とします。したがって、既存のものに基づいて新しいHttpContextを作成し、インシデント（アクション|コントローラー、URL、IPなど）を分析するときにログに表示するのに有用なもののみをコピーします。 すべての情報がコピーされるわけではありません 。

アプリケーションを開始すると、次の幸せな行を見ました。

 2017-10-08 20:29:25.3015|0|AspNetCoreApp.Services.LongRespondingService|TRACE|Home/Test| DoJob method is starting (AspNetCoreApp.Services.LongRespondingService.DoJob:0)| url:http://localhost/Test/1 2017-10-08 20:29:34.3322|0|AspNetCoreApp.Services.LongRespondingService|TRACE|Home/Test| DoJob method is ending (AspNetCoreApp.Services.LongRespondingService+<DoJob>d__3.MoveNext:0)| url:http://localhost/Test/1

そして、これは私にとって小さな勝利を意味しました。誰がこれについて考えていますか？

自分に間違ったことを考えないようにするために、小さな機能負荷テストを作成しました。これは、サービスとともにgithubリポジトリで見つけることができます。 5000の同時タスクを開始すると、テストは成功しました。

ところで、ASP.NET Coreのアーキテクチャのおかげで、このようなテストは簡単かつ自然に作成できます。テスト内でサーバー全体を実行し、実際のソケットを介してアクセスするだけです。

URLによるサーバーの初期化

 protected TestFixture(bool fixHttpContext, string solutionRelativeTargetProjectParentDir) { var startupAssembly = typeof(TStartup).Assembly; var contentRoot = GetProjectPath(solutionRelativeTargetProjectParentDir, startupAssembly); Console.WriteLine($"Content root: {contentRoot}"); var builder = new WebHostBuilder() .UseKestrel() .UseContentRoot(contentRoot) .ConfigureServices(InitializeServices) .UseEnvironment(fixHttpContext ? "Good" : "Bad") .UseStartup(typeof(TStartup)) .UseUrls(BaseAddress); _host = builder.Build(); _host.Start(); }

プロジェクトでASP.NET Coreを使用するもう1つの理由。

まとめ

実装のすべての面でASP.NET Coreが本当に好きでした。優れた柔軟性と、プラットフォーム全体の軽さを兼ね備えています。絶対にすべての機能が抽象化されているため、自分自身、チーム、および開発方法に合わせてあらゆることを実行し、プラットフォーム全体をカスタマイズできます。クロスプラットフォームはまだ完成していませんが、Microsoftはこれを目指して努力しており、いつの日か（すぐではないかもしれませんが）成功するはずです。

Githubリンク

ASP.NET Coreの長いAPIを正しく使用するか、新しいプラットフォームに移行する微妙な点を使用します