可选参数以及参数数组

Question

我有一个日志接口，我使用一些有用的扩展方法对其进行了扩展，以便我可以传递格式和参数列表，以避免每次调用该方法时都必须使用字符串格式。 （它也帮助我遵守 FXCops 文化信息规则）

所以我可以打电话：

logger.Debug("Created {0} with id {1}",typeof(MyObject).Name ,myObject.Id);

代替：

logger.Debug(string.Format("Created {0} with id {1}", typeof(MyObject).Name, myObject.Id));

我现在发现自己陷入了一个棘手的境地，因为在日志中获取一些关于日志写入位置的信息（例如文件、方法和行号）将非常有帮助。这可以通过简洁的[CallerMemberName]、[CallerFilePath] 和[CallerLineNumber] 属性来实现。

logger.Debug("Created {0} with id {1}", typeof(MyObject).Name, myObject.Id);

然后会给我一个日志条目，例如：

“MyObjectProvider.cs, Provide, line:50 | Created MyObject with id 1564”

这里的问题是方法签名看起来像这样：

public static void Debug(this ILogger logger, string format [CallerMemberName] string callerMemberName = "", [CallerFilePath] string callerFilePath = "", [CallerLineNumber] int callerLineNumber = 0, params object[] args)

这是不可能的，因为 [Caller*] 属性使参数成为可选参数，而这不适用于 args 参数。

我还尝试使用固定数量的字符串作为参数进行多种实现，如下所示：

public static void Debug(this ILogger logger, string format [CallerMemberName] string callerMemberName = "",string arg, string arg2 , ...etc... , [CallerFilePath] string callerFilePath = "", [CallerLineNumber] int callerLineNumber = 0)

然后我收到编译器错误，提示 “以下方法或属性之间的调用不明确”

我现在几乎已经放弃了这个问题，但我心想，“也许 SO 可以为我找到解决方案”。所以这里是... 是否可以同时使用params object[] args 和[CallerFilePath] 或者是否有其他方法可以获得预期的结果？

Answer 1

将所有默认参数向右移动。

Answer 2

您不能将两者结合在方法签名中。您可以做的只是其中之一并将null 传递到您需要可选参数的地方，这对您有用吗？

Foo(s, null);
public void Foo(string s, params string[] sArray)
{

}

Foo(new string[] {""});
private static void Foo(string[] sArray,  string s = "")
{
}

或

为什么不使用一个类来处理您的格式并将其设为可选？

public class LogArgs
{
  private string _formatString;
  private string[] _args;
  public LogArgs(string formatString, params string[] args)
  {
    _formatString = formatString;
    _args = args;
  }
  public override string ToString()
  {
    return string.Format(_formatString, _args);
  }
}

public void Foo(string mandatory, LogArgs optionalParam = null)
{
  //Do Stuff
}

Foo("", new LogArgs("{0} is formatted", ""));

Answer 3

我找到了另一种使用 StackTrace 获取所需信息的方法。它在优化代码中有点不安全，而且速度很慢，但出于调试目的，只要可以在发布版本中关闭它，它就可以很好地工作。

StackTrace stackTrace = new StackTrace();
var callerMember = stackTrace.GetFrame(1).GetMethod();
var callerMemberName = callerMember.Name;
var callerType = callerMember.ReflectedType.Name;

Answer 4

我遇到了同样的问题，但解决方法有所不同。这不是最优雅的解决方案，但它可以工作并且相对干净：

public class SrcLoc
{
    public string sourceFile { get; set; }
    public int lineNumber { get; set; }
    public SrcLoc([CallerFilePath] string sourceFile = "",
                  [CallerLineNumber] int lineNumber = 0)
    {
      this.sourceFile = sourceFile;
      this.lineNumber = lineNumber;
    }
}
public class Logger
{
   public void Log(SrcLoc location,
                int level = 1,
                string formatString = "",
                params object[] parameters)
  {
     string message = String.Format(formatString, parameters);
  }
}
public MainTest
{
    public static void Main()
    {
        string file="filename";
        logger.Log(new SrcLoc(), (int)LogLevel.Debug, "My File: {0}", file);
    }
}

Answer 5

我发现的最优雅的方式（或最不优雅的方式）是创建一个提取属性信息并返回Action 委托的所需名称的方法。然后，您使用您实际要调用的签名设置此委托。

所以，从

public static void Debug(this ILogger logger, string format, [CallerMemberName] string callerMemberName = "", [CallerFilePath] string callerFilePath = "", [CallerLineNumber] int callerLineNumber = 0, params object[] args)

创建一个委托

public delegate void LogDelegate(string format, params object[] args);

从您的方法调用返回：

public static void Debug(this ILogger logger, [CallerMemberName] string callerMemberName = "", [CallerFilePath] string callerFilePath = "", [CallerLineNumber] int callerLineNumber = 0)
{
  return (format, args)
  {
    LogWithCallerSiteInfo(format, args, callerMemberName, callerFilePath, callerLineNumber, logAction);
  }
}

并使用捕获的数据调用辅助方法：

private static void LogWithCallerSiteInfo(string format, object[] args, string callerMemberName, string callerFilePath, int callerLineNumber, Action<string, object[]> logRequest)
    {
        if (args == null)
        {
            args = new object[0];
        }
        var args2 = new object[args.Length + 3];
        args.CopyTo(args2, 0);
        args2[args.Length] = sourceFile;
        args2[args.Length + 1] = memberName;
        args2[args.Length + 2] = lineNumber;

        logRequest(format + " [{callerFilePath:l}.{callerMemberName:l}-{callerLineNumber}]", args2);
    }

然后拨打电话，因此：

logger.Debug()("Created {0} with id {1}",typeof(MyObject).Name ,myObject.Id);

因此，就用法而言，您插入了一组额外的()，它捕获了呼叫站点信息，并且该集合集合在委托上进行呼叫。这和我设法做到的一样整洁。

我已经重新创建了params 数组，添加了捕获的数据，否则（至少使用SeriLog，结果是不可预测的。