Roslyn是编译时表达式检查的正确工具吗?

时间:2012-03-19 10:05:44

标签: c# .net roslyn

我有一个工具包,有很多方法经常以Expression<Func<T,TProperty>>为参数。有些可以只是单级(o=>o.Name),有些可以是多级(o=>o.EmployeeData.Address.Street)。

我想开发一些东西(MSBuild Task?Visual Studio Plugin?希望是第一个)读取所有用户的.cs文件,并在给定参数不是属性表达式时给出构建错误(但是像{{1}或者,如果给出了一个只允许单级的多级表达式。

我首先尝试查看已编译的IL代码,但由于表达式树是C#编译器“技巧”,所以我在IL中看到的是创建表达式实例等等,而我可以检查每个只创建了MemberExpressions(以及它们的正确数量),它不是那么好。

然后我想起了罗斯林。 可以用Roslyn写这样的东西吗?

2 个答案:

答案 0 :(得分:10)

是的,我认为Roslyn及其代码问题正是这个问题的正确工具。使用它们,您可以在键入时分析代码并创建在Visual Studio中显示为其他错误的错误(或警告)。

我试图创建这样的代码问题:

[ExportSyntaxNodeCodeIssueProvider("PropertyExpressionCodeIssue", LanguageNames.CSharp, typeof(InvocationExpressionSyntax))]
class PropertyExpressionCodeIssueProvider : ICodeIssueProvider
{
    [ImportingConstructor]
    public PropertyExpressionCodeIssueProvider()
    {}

    public IEnumerable<CodeIssue> GetIssues(IDocument document, CommonSyntaxNode node, CancellationToken cancellationToken)
    {
        var invocation = (InvocationExpressionSyntax)node;

        var semanticModel = document.GetSemanticModel(cancellationToken);

        var semanticInfo = semanticModel.GetSemanticInfo(invocation, cancellationToken);

        var methodSymbol = (MethodSymbol)semanticInfo.Symbol;

        if (methodSymbol == null)
            yield break;

        var attributes = methodSymbol.GetAttributes();

        if (!attributes.Any(a => a.AttributeClass.Name == "PropertyExpressionAttribute"))
            yield break;

        var arguments = invocation.ArgumentList.Arguments;
        foreach (var argument in arguments)
        {
            var lambdaExpression = argument.Expression as SimpleLambdaExpressionSyntax;
            if (lambdaExpression == null)
                continue;

            var parameter = lambdaExpression.Parameter;
            var memberAccess = lambdaExpression.Body as MemberAccessExpressionSyntax;
            if (memberAccess != null)
            {
                var objectIdentifierSyntax = memberAccess.Expression as IdentifierNameSyntax;

                if (objectIdentifierSyntax != null
                    && objectIdentifierSyntax.PlainName == parameter.Identifier.ValueText
                    && semanticModel.GetSemanticInfo(memberAccess, cancellationToken).Symbol is PropertySymbol)
                    continue;
            }

            yield return
                new CodeIssue(
                    CodeIssue.Severity.Error, argument.Span,
                    string.Format("Has to be simple property access of '{0}'", parameter.Identifier.ValueText));
        }
    }

    #region Unimplemented ICodeIssueProvider members

    public IEnumerable<CodeIssue> GetIssues(IDocument document, CommonSyntaxToken token, CancellationToken cancellationToken)
    {
        throw new NotImplementedException();
    }

    public IEnumerable<CodeIssue> GetIssues(IDocument document, CommonSyntaxTrivia trivia, CancellationToken cancellationToken)
    {
        throw new NotImplementedException();
    }

    #endregion
}

用法如下:

[AttributeUsage(AttributeTargets.Method)]
class PropertyExpressionAttribute : Attribute
{ }

…

[PropertyExpression]
static void Foo<T>(Expression<Func<SomeType, T>> expr)
{ }

…

Foo(x => x.P);   // OK
Foo(x => x.M()); // error
Foo(x => 42);    // error

上面的代码有几个问题:

  1. 完全没有优化。
  2. 可能需要更多错误检查。
  3. 它不起作用。至少在当前的CTP中。接近结尾的表达式semanticModel.GetSemanticInfo(memberAccess, cancellationToken).Symbol始终返回null。这是因为表达式树的语义在the currently unimplemented features之间。

答案 1 :(得分:5)

是的,这完全有可能。问题是Roslyn还没有支持所有语言结构,所以你可能遇到一些不受支持的东西。表达式树不受支持,因为Roslyn无法编译生成表达式的代码,但是你应该能够做得足够远以使某些东西工作。

在较高级别,如果您希望将其作为MSBuild任务实施,则可以在构建任务中调用Roslyn.Services.Workspace.LoadSolutionRoslyn.Services.Workspace.LoadStandaloneProject。然后,您将遍历语法树,寻找各种方法的提及,然后绑定它们以确保它实际上是您认为正在调用的方法。从那里,您可以找到lambda语法节点,并从那里执行您想要的任何语法/语义分析。

CTP中有一些您可能会觉得有用的示例项目,例如RFxCopConsoleCS项目,该项目在Roslyn中实现了一个简单的FxCop样式规则。

我还应该提一下,Roslyn的解析器是完整的,所以没有语义信息就能做得越多越好。