使用Roslyn在编译时注入方法参数

时间:2020-08-15 17:26:00

标签: c# roslyn roslyn-code-analysis

我正在尝试确定罗斯林是否支持以下用例:

我使用Guard类进行参数验证

public void Foo(string bar)
{
    Guard.NotNull(bar, nameof(bar));
    // ....
}

没有什么花哨的内容和nameof(...)表达式甚至使其对重构友好。但这仍然是多余的。并没有阻止我做这样的事情

public void Foo(string bar, string baz)
{
    Guard.NotNull(bar, nameof(baz));
    // ...
}

因此,如果有一种方法可以完全避免nameof(...)部分,那就太好了。

因此,我希望Roslyn能够执行与[CallerMemberNameattribute]类似的操作,只是用于参数。

public static class Guard
{
    public static void NotNull(object param, [CallerParameterName]string paramName = "")
    {
        if (param == null)
        {
            throw new ArgumentNullException(paramName);
        }
    }
}

public void Foo(string bar)
{
    Guard.NotNull(bar);
    // ...
}

我不想在编译之前更改代码(就像重构或代码修复一样)。我根本不想在源代码中看到带有CallerParameterNameAttribute注释的自变量的值(就像我看不到CallerMemberNameCallerLineNumber等的自变量一样)。

我希望Roslyn在编译时为我注入参数名称。

Source GeneratorsCode Generators都只能添加源代码(不能更改)并进行编译。常规的Roslyn分析器还会更改源代码afaik。

您是否知道罗斯林的那部分是否可以公开访问以及在哪里可以找到有关如何使用它的信息?


更新:我不想使用PostSharp之类的IL Weaver。只需教罗斯林将我的自定义属性视为System.Runtime.CompilerService属性之一即可。

2 个答案:

答案 0 :(得分:1)

我没有用罗斯林来回答这个问题,但这也许有帮助

您可以使用反射来获取member expression 并使用参数名称抛出异常:

public class Guard
{
    public static void NotNull<T1>(Expression<Func<T1>> expression)
    {
        Func<T1> check = expression.Compile();
        if (check() is null)
        {
            var member = expression.Body;
            if (member is MemberExpression)
            {
                string name = ((MemberExpression)member).Member.Name;
                throw new ArgumentNullException(name);
            }
        }
    }
}

public class Program
{
    public static void Foo(string myParameterName)
    {
        Guard.NotNull(() => myParameterName);
    }

    public static void Main(string[] args)
    {
        Foo(null);
        return;
    }
}

因此,该Expcetion将引发原始参数名称: myPropertyName

exception

我还在发布配置(-c版本)中进行了测试,以检查myParameterName 是否未更改为另一个已编译的名称,但尚未对此进行全面调查。

此代码的缺点是使用lambda表达式,反射(更不用说.Compile调用)来简单检查变量是否为null会对性能产生影响。

答案 1 :(得分:0)

您可以使用Fody:https://github.com/Fody/Fody。 例如。 https://github.com/Fody/NullGuard