将CallerMemberName与params结合使用

时间:2013-01-16 09:56:23

标签: c# string-formatting optional-parameters c#-5.0

现在(C#4.0)我们的日志记录方法看起来像

public void Log(string methodName, string messageFormat, params object[] messageParameters)

其中记录器执行字符串格式化,以便调用者没有放置String.Format来创建一个好的日志消息(如果没有附加logviewer,则允许记录器跳过字符串格式)。

使用c#5.0我想通过使用新的CallerMemberName属性来摆脱methodName参数,但我不知道如何将它与'params'关键字结合起来。有没有办法做到这一点?

3 个答案:

答案 0 :(得分:26)

你可以这样做:

protected static object[] Args(params object[] args)
{
    return args;
}

protected void Log(string message, object[] args = null, [CallerMemberName] string method = "")
{
    // Log
}

要使用日志,请执行以下操作:

Log("My formatted message a1 = {0}, a2 = {2}", Args(10, "Nice"));

答案 1 :(得分:15)

我认为您根本无法合并paramsCallerMemberName所需的可选参数。您可以做的最好的事情是使用实际数组而不是params

答案 2 :(得分:1)

以@guilhermekmelo 的回答为基础,我可能建议使用链式方法:

所以保留您当前的 Log(string,string,object[] 方法:

public void Log(string methodName, string messageFormat, params object[] messageParameters)

并添加这个新的重载 (Log(string,string)):

public LogMessageBuilder Log(string messageFormat, [CallerMemberName] string methodName = null)
{
    // Where `this.Log` is 
    return new LogMessageBuilder( format: messageFormat, logAction: this.Log );
}

public struct LogMessageBuilder
{
    private readonly String format;
    private readonly String callerName;
    private readonly Action<String,String,Object[]> logAction;

    public LogMessageBuilder( String format, String callerName, Action<String,String,Object[]> logAction )
    {
        this.format = format;
        this.callerName = callerName;
        this.logAction = logAction;
    }

    public void Values( params Object[] values )
    {
        this.logAction( this.format, this.callerName, values );
    }
}

像这样使用:

this.Log( "My formatted message a1 = {0}, a2 = {2}" ).Values( 10, "Nice" );

注意 LogMessageBuilder 是一个 struct,所以它是一个值类型,这意味着它不会导致另一个 GC 分配 - 尽管使用 params Object[] 会导致一个数组分配在呼叫站点。 (我希望 C# 和 .NET 支持基于堆栈的可变参数,而不是用堆分配的参数数组来伪造它。


另一种选择是使用 FormattableString - 但请注意,由于 FormattableString 的 C# compiler has built-in special-case magic 您需要小心不要让它被隐式转换为 {{1} } (也很糟糕,你不能直接向 String 添加扩展方法,抱怨):

FormattableString

用法:

public void Log(FormattableString fs, [CallerMemberName] string methodName = null)
{
    
    this.Log( messageFormat: fs.Format, methodName: methodName, messageParameters: fs.GetArguments() );
}