Question

我正在寻找一种为所有现有TraceSource添加和删除TraceListener的方法。

（我不确定我的方法是否正确，我可以使用其他方法吗？基本上我想将所有跟踪输出记录到一个文件中，该文件使用当前项目名称作为文件名。每当用户创建或重新打开项目时，我都希望将日志附加到正确的文件。一次只能打开一个项目。）

代码示例：

我在我的应用程序中创建了几个TraceSources，每个类都有一个

public class Class1
{
    private static readonly System.Diagnostics.TraceSource trace = 
            new System.Diagnostics.TraceSource("Class1");
}

public class Class2
{
    private static readonly System.Diagnostics.TraceSource trace = 
            new System.Diagnostics.TraceSource("Class2");
}

我现在想在运行时向我的所有traceSources添加或删除traceListener，如下所示：

private System.Diagnostics.TextWriterTraceListener myListener;

private onProjectOpen()
{
    // user created a new project or opened an existing one
    myListener = new System.Diagnostics.TextWriterTraceListener("log-"+projectname+".log");
    ALL_TRACESOURCES.Add ( myListener) ; // <-- how to do this?
}

private onProjectClose()
{
    // user closed a project
    ALL_TRACESOURCES.Remove( myListener) ; // <-- how to do this?
    myListener.Flush();
    myListener.Close();
    myListener.Dispose(); // <-- not sure if all this is neccessary
}

到目前为止，我没有办法在不将所有traceSources公开（看起来像个坏主意）的情况下执行此操作，然后列出我的所有类：

Class1.Trace.Add( myListener );
Class2.Trace.Add( myListener );
...

这似乎是几个层面上糟糕的设计选择。

或者

将我的所有TraceSources添加到每个类的构造函数中的自定义全局集合中（容易忘记/搞乱;全局变量很糟糕）

有更好的方法吗？基本上我正在寻找一种方法来设置另一个默认监听器

Answer 1

基于this StackOverflow answer和this answer

这是一种方法：

    private static void AttachToAllTraceSources(TraceListener yourListener)
    {
        TraceSource ts = new TraceSource("foo");
        List<WeakReference> list = (List<WeakReference>)GetInstanceField(typeof(TraceSource), ts, "tracesources");
        foreach(var weakReference in list)
        {
            if(weakReference.IsAlive)
            {
                TraceSource source = (weakReference.Target as TraceSource);
                if(source != null && source.Name != "foo")
                {
                    source.Listeners.Add(yourListener);
                }
            }
        }
    }

Answer 2

在.NET 4及更高版本中，您可以在配置侦听器后使用Lazy<>延迟加载TraceSources。请参阅以下工作示例程序：

public static class TraceSources
{
    public static TraceSource Create(string sourceName)
    {
        var source = new TraceSource(sourceName);
        source.Listeners.AddRange(Trace.Listeners);
        source.Switch.Level = SourceLevels.All;
        return source;
    }
}

public class Class1
{
    private static readonly Lazy<TraceSource> trace = new 
            Lazy<TraceSource>(() => TraceSources.Create("Class1"));

    public void DoSomething()
    {
        trace.Value.TraceEvent(TraceEventType.Information, 1, "Class1 speaking up");
    }
}

public class Class2
{
    private static readonly Lazy<TraceSource> trace = new
            Lazy<TraceSource>(() => TraceSources.Create("Class2"));

    public void DoSomethingElse()
    {
        trace.Value.TraceEvent(TraceEventType.Information, 2, "Class2 speaking out");
    }
}

public class Program
{
    static void Main(string[] args)
    {
        try
        {
            var listener = new TextWriterTraceListener(@"C:\trace.txt");
            Trace.Listeners.Add(listener);

            var classOne = new Class1();
            var classTwo = new Class2();
            classOne.DoSomething();
            classTwo.DoSomethingElse();
        }
        finally
        {
            Trace.Close();
        }
    }
}

Answer 3

好吧，我参加这个聚会的时间太晚了——很难相信七年后，仍然有人在努力完成在系统中获取所有跟踪源的任务（并且在任何地方都找不到好的答案）。

>

这是查找所有跟踪源的反射方法：

    /// <summary>
    /// Get all trace sources instantiated by the current process.
    /// </summary>
    /// <remarks>
    /// This is  reaching into a part of the .Net code that Microsoft haven't given public access to, that's not part of their API.
    /// Found from inspection of the .Net (4.8) reference source that the TraceSource class holds a static cache of all trace sources, and the names of the corresponding members.
    /// </remarks>
    /// <returns>List of all current trace sources</returns>
    public static List<TraceSource> GetAll()
    {
        var result = new List<TraceSource>(); 
        var privateStaticMethods = typeof(TraceSource).GetMethods(BindingFlags.Static | BindingFlags.NonPublic);
        var pruneMethod = privateStaticMethods.FirstOrDefault(m => m.Name == "_pruneCachedTraceSources");
        var privateStaticFields = typeof(TraceSource).GetFields(BindingFlags.Static | BindingFlags.NonPublic);
        var tracesourcesField = privateStaticFields.FirstOrDefault(f => f.Name == "tracesources");
        if (tracesourcesField != null)
        {
            var tracesourceValue = tracesourcesField.GetValue(null);
            var tracesources = tracesourceValue as List<WeakReference>;
            if (tracesources != null)
            {
                lock (tracesources)
                {
                    if (pruneMethod != null)
                    {
                        pruneMethod.Invoke(null, new object[] { });
                    }
                    for (int i = 0; i < tracesources.Count; i++)
                    {
                        var target = tracesources[i].Target;
                        TraceSource tracesource = target as TraceSource;
                        if (tracesource != null)
                        {
                            result.Add(tracesource);
                        }
                    }
                }
            }
        }
        return result;
    }

目前使用 .Net Framework 4.8，它可以工作；我没有用 5 试过这个。也许需要注意的是，如果您管理自己的所有跟踪源列表，那么您就加倍了。

使用它来获取所有跟踪源。也许过滤你想要的。然后将您的跟踪侦听器添加到所有这些。

Answer 4

我自己也遇到过这个问题。在我的情况下，我也在每个类中创建了跟踪源。 app.config中的监听器被添加到所有源代码没有问题，但是我需要在运行时添加一个特定的监听器。这当然只适用于添加侦听器的跟踪源。我看到两个选项 - 创建一个跟踪源并将其传递给应用程序的其余部分（yuck），或者在其他所有引用的辅助类中有一个静态跟踪源。所以我有：

public class LogHelper { /// /// The trace source logger for the application. /// public static readonly TraceSource Logger = new TraceSource("FruityBlergs", SourceLevels.All); }

LogHelper类还设置了在运行时配置的侦听器和各种其他过滤器。到目前为止，这对我来说效果很好。如果由于某种原因某个特定类需要不同的行为，您仍然可以在该类中创建跟踪源。

将TraceListener添加/删除到所有TraceSources

4 个答案: