😖 🚬 🉐 ASP.Netアプリケーションのデバッグ時にコンソールを使用する 🕕 ✌🏾 💚

新しいプロジェクトを開始し、基本的なことを書く段階に徐々に近づいていきます。 ASP.Netプラットフォームでのソフトウェア開発のいくつかの側面に関する知識を収集して整理し、1年以上の商用開発で獲得することにしました。結果はそのような記事です。それは根本的に新しいもののふりをするものではありません。誰もがこれを長い間知っていました。ある意味では、それは一種のベストプラクティスです。以下に書かれていることはすべて、初心者には役立つと思われますが、経験豊富な開発者は、自分にとって興味深いことを学ぶことができます。

私たちは、高度な開発ツール、マルチスレッドアプリケーションのデバッグをサポートするデバッガー、およびその他の非常に有用な多くの時代に生きています。しかし、他の現象と同様に、このような進歩には欠点があります-最速のマシンではなく、段階的なデバッグのプロセスは開発者の悪夢に変わります。すべてがハングし、デバッガーは車をアップグレードする時間になることを示唆します。あなたの頭の子のコードを30分旅した後、もう一度F10を押して恐怖で飛びますが、例外はコードの深さのどこかに、非常に高いレベルまで、慎重にキャッチされたキャッチまで。例外メッセージは、引数がメソッドに来たことを知らせますが、どこから来たのか、どのように来たのかは完全に不明です。歯を食いしばって忍耐を身につけて、再び厄介なバグを探し始めます...

私の背後には、オリンピックのプログラミングのクラスが数年あり、さまざまな条件でTurbo PascalからVisual Studio 2008までのさまざまなツールでコードを記述していました。誰が知らないか、オリンピアードは通常、さまざまな大学で開催されます。学生によって殺されたコンピューターが完全に不可能な場合があり、コンピューター上のウイルスの数が合理的な制限を超えました。ただし、このような状況では、コンテストのすべての参加者が滞在するため、文句を言う時間はありません。タスクを解決する必要があります。そのため、長年にわたって非常に重要なことを学びました。おそらく最良のデバッガーはコンソールです。はい、はい、これは同じ、普通の黒いもので、灰色の文字が忍び寄っています。ただし、色はユーザーの想像力に依存します。

高速なマシンでも、コンソールは長い反復計算または再帰計算をデバッグするのに便利です-中間結果とともに、従来のデバッガよりもはるかに高速に情報を提供し、Console.WriteLine、printf、system.out.printlnまたはそのアナログを入力するだけですアプリケーションを作成する言語で。コンソールは同じログですが、表示するためにファイルに移動する必要はありません。コンソール上にあり、関心のあるすべてのものを一度に見ることができます。最終的に、多くの開発者が、デバッグのために少なくとも一度はそれを使用したと思います。

今日は、ASP.Net MVCアプリケーションの例と、コンソールを使用してデバッグとログを記録する方法を紹介します。それでは始めましょう。

まず、コンソール自体を初期化する必要があります。これを行うために、kernel32.dllからAllocConsoleをインポートする小さな静的クラスConsoleManagerを記述します。また、コンソールを初期化し、出力を設定し、アプリケーションを起動する前にクリーニングするメソッドを追加します。

public static class ConsoleManager { [DllImport( "kernel32.dll" , EntryPoint = "AllocConsole" , CharSet = CharSet.Unicode)] private static extern bool AllocConsole(); public static void InitializeConsoleManager() { #if CONSOLE try { AllocConsole(); Console .SetOut( new TextWriter( new StreamWriter( Console .OpenStandardOutput(), Encoding .Default, 100))); Console .Clear(); } catch (Exception) { } #endif } } * This source code was highlighted with Source Code Highlighter .

サーバー上のアプリケーションの通常の操作中にコンソールを表示したくないため、それを初期化するコードを条件付きコンパイルディレクティブに初期化し、もちろん、デバッグプロジェクト構成でCONSOLEシンボルを定義することを忘れませんでした。次に、Global.asaxに進み、アプリケーションの開始時にコンソールを初期化します。

protected void Application_Start() { ConsoleManager.InitializeConsoleManager(); // ... } * This source code was highlighted with Source Code Highlighter .

Hooray、アプリケーションが起動すると、黒いアプリケーションウィンドウが表示されます！素晴らしいですが、作業はここでは終わりません。今から少し装飾します。ログは、ほとんどのWebアプリケーションに不可欠な属性です。多くの場合、ログは実行中のサーバーでエラーを追跡できる唯一の証拠であるためです。コンソールでロガーメッセージを複製しないのは罪です。デバッグ中の時間を大幅に節約できます。ファイルとコンソールの両方に書き込むメッセージと、コンソールのみに書き込むメッセージを区別するために、列挙について説明します。

public enum Severity { None, Event, Error, Debug, } * This source code was highlighted with Source Code Highlighter .

すべてがシンプルです：

なし-重要でない情報、ファイルに書き込まない、注意をそらさないためにコンソールに濃い灰色で表示されます。使用例-HTTPリクエストロギング;
イベント-サイトの存続期間中のイベント-ファイルに書き込まれ、コンソールに緑色で表示されます。例-ユーザーがログインしています。
エラー-どこかでトラブルが発生しました-ファイル、コンソールに明るい赤で書き込まれます。使用例-未処理の例外。
デバッグ-なしとほぼ同じですが、より重要-コンソールに青色でのみ表示されます。使用例は、検証が必要な長い計算の中間結果です。

特定のタイプのメッセージに対応する色を決定するために、単純な拡張メソッドを作成します。

public static ConsoleColor GetLogEntryColor( this Severity severity) { switch (severity) { case Severity.None: return ConsoleColor.DarkGray; case Severity.Event: return ConsoleColor.Green; case Severity.Error: return ConsoleColor.Red; case Severity.Debug: return ConsoleColor.Cyan; default : throw new ArgumentException( string .Format( "Unknown severity: '{0}'" , severity)); } } * This source code was highlighted with Source Code Highlighter .

宣言的なアプローチの方がはるかにきれいであることに注意してください：

public enum Severity { [SeverityColor(ConsoleColor.DarkGray)] None, [SeverityColor(ConsoleColor.Green)] Event, [SeverityColor(ConsoleColor.Red)] Error, [SeverityColor(ConsoleColor.Cyan)] Debug, } * This source code was highlighted with Source Code Highlighter .

しかし、パフォーマンス上の理由から、私はそれを拒否しました。この問題は議論の余地があり、多分将来的には戻ってくるでしょう。 ASP.Netアプリケーションがマルチスレッドであることを忘れずに、ロガーを説明するだけです。

public static class Logger { [ThreadStatic] private static Severity m_CurrentSeverity; /// <summary> /// Writes debug message to log /// </summary> public static void WriteToLog( string message) { WriteToLog(message, Severity.Debug); } public static void WriteToLog( string message, Severity severity) { lock ( typeof (Logger)) { m_CurrentSeverity = severity; WriteLineStart(); WriteLine(message); } } private static void WriteLine( string message) { Write(message + Environment.NewLine); } private static void Write( string message, params object [] parameters) { Write( string .Format(message, parameters)); } private static void Write( string message) { Console .ForegroundColor = m_CurrentSeverity.GetLogEntryColor(); Console .Write(message); if (m_CurrentSeverity == Severity.Error || m_CurrentSeverity == Severity.Event) { // file logging } } private static void WriteLineStart() { Write( "{0} -> " , DateTime .Now); } } * This source code was highlighted with Source Code Highlighter .

理解を深めるために、すべてが意図的に簡素化されています。デバッグ中のコンソールは次のようになります。

私自身の経験から言えば、このようなコンソールを使用すると、開発者の生活がはるかに楽になります。

ありがとう

UPD。 ここで、ほぼ同じ機能を実装する代替ツール- デバッグビュープログラムがあることを求められました。

ASP.Netアプリケーションのデバッグ時にコンソールを使用する

More articles: