Вопрос об эффективных лесозаготовках в C#

Question

Я написал простой класс для отладки и я называю метод Debugger.WriteLine (...) в своем коде, как это:

Debugger.WriteLine("[Draw]", "InProgress", 
    "[x,y] = " + x.ToString("0.00") + 
    ", " + y.ToString("0.00") + 
    "; pos = " + lastPosX.ToString() + "x" + 
    lastPosY.ToString() + " -> " + posX.ToString() + 
    "x" + posY.ToString() + "; SS = " + 
    squareSize.ToString() + "; MST = " + 
    startTime.ToString("0.000") + "; Time = " + time.ToString() + 
    phase.ToString(".0000") + "; progress = " + 
    progress.ToString("0.000") + "; step = " + 
    step.ToString() + "; TimeMovementEnd = " + 
    UI.MovementEndTime.ToString() 
); 

Тело процедуры Debugger .WriteLine скомпилируется только в режиме отладки (директивы #if, #endif). Меня беспокоит то, что мне часто требуется ToString() в вызове Debugger.WriteLine, что дорого, потому что он создает все еще новые строки (например, для изменения числа). Как решить эту проблему?

Несколько точек/вопросы отладки/трассировки:

• Я не хочу, чтобы обернуть каждый Debugger.WriteLine в операторе IF или использовать директивы препроцессора для того, чтобы оставить из методов отладки, потому что это неизбежно приведет к не очень читаемому коду и потребует слишком большого набора текста.

• Я не хочу использовать какие-либо рамки для трассировки/отладки. Я хочу попытаться запрограммировать его сам.

• Оставляют ли Trace methods при компиляции в режиме деблокирования? Если это возможно, мои методы будут вести себя одинаково?

• С static String.Format method я могу это сделать:

  выходом = String.Format ("Вы теперь {0} года.", Года);

Что кажется приятным. Является ли это решением для моей проблемы с ToString()?

Answer 1

Используйте StringBuilder, чтобы создать свои выходные строки, а не объединять каждое значение.

И вы можете создать собственный собственный класс отладчика (MyDbg), который содержит элемент WriteLine, содержимое которого вы можете окружать с помощью директив компиляции. Он не будет полностью компилировать код отладки, но превратит ваши вызовы MyDbg.WriteLine в no-ops.

Вот быстрый эскиз класса:

using System; 
using System.Text ; 

public static class MyDbg 
{ 
    public static void WriteLine(string str) // and some other params 
    { 
     #if DEBUG 

     StringBuilder sb = new StringBuilder(); 
     sb.Append(str); 
     // etc. appending other params as you see fit 
     #endif 
    } 
} 

ИЛИ

[Conditional("DEBUG")] 
public static class MyDbg 
{ 
    public static void WriteLine(string str) // and some other params 
    { 
     StringBuilder sb = new StringBuilder(); 
     sb.Append(str); 
     // etc. appending other params as you see fit 
    } 
} 

Вы хотите изменить его в соответствии со своими потребностями, конечно. И вместо создания отдельного класса вы можете создать метод-член, если #if DEBUG/# endif встроенный для отображения своего собственного состояния, когда в отладчике.

Answer 2

1. Вам не нужно обертывать каждую линию. Просто напишите вспомогательный метод, содержащий Debug.WriteLine и включите/выключите его по флагом (обычно bool).

2. Отслеживание будет в вашем коде даже в режиме деблокирования. Вы можете настроить его, см. http://msdn.microsoft.com/en-us/library/system.diagnostics.tracelistener.aspx

3. string.Format вызывает ToString() по внутренним аргументам, поэтому нет никакой пользы.

Answer 3

Для ведения журнала взгляните на такие структуры, как Log4net или корпоративная библиотека. Они позволяют настраивать протоколирование различными способами. Даже если вы хотите войти в систему.

НТН

Answer 4

string.Format() Используя ожидаемый выход на самом деле станет более легко узнаваемы просто глядя на код (ИМХО):

Debug.WriteLine(string.Format(
    "[Draw]InProgress[x,y] = {0:0.00}, {1:0.00}; pos = {2}x{3} -> {4}x{5}; ...", 
    x, y, 
    lastPosX, lastPosY, 
    posX, posY, 
    ...)); 

Answer 5

Использование отражателя я узнал, что Debug.WriteLine объявлен этот путь:

[Conditional("DEBUG")] 
public static void WriteLine(string message) 

Это означает, что в режиме деблокирования все вызовы этого метода исключаются из кода.

Например, этот код:

public static void Test(int a) 
{ 
    string b = Console.ReadLine(); 
    Debug.WriteLine(a + " " + b); 
    Console.WriteLine(a + " " + b); 
} 

компилируется в режиме выпуска для:

public static void Test(int a) 
{ 
    Console.WriteLine(a + " " + Console.ReadLine()); 
} 

Answer 6

Узор я использую, чтобы определить интерфейс протоколирования (ILogger), который получает зависимость впрыскивается во все классы

public class MyClassThatLogs 
{ 
    public MyClassThatLogs(ILogger logger) 
    { 
     try 
     { 
      logger.Write("bla bla bla"); 
     } 
     catch(Exception ex) 
     { 
      logger.Write(ex); //overload of Write() that takes in an Exception 
     } 
    } 
} 

Так что, когда вы новичок, вы можете пройти в «реальном» регистраторе или ложном/поддельном

var mc = new MyClassThatLogs(new FakeLogger()); 

Теперь вы отвлекли необходимость знать в классе MyClassThatLogs, что происходит с протоколированием. Базовый SOLID материал. Таким образом, «верхний» (например, метод main() консоли) должен иметь директиву IF DEBUG, а затем передать правильную реализацию регистратора.