在编译时强制一个狭窄的隐式强制转换

本文关键字：转换 一个 编译 | 更新日期: 2023-09-27 18:15:25

我试图定义一个结构体，它使用一个有限范围的数字变量，并从int型隐含强制转换。我希望能够强制构建错误，如果任何常数或其他硬编码值与此结构体一起使用。

这是我正在努力完成的一个例子。

    byte a = 123; // Allowed
    byte b = 123123; // Not allowed
    const int x = 123;
    const int y = 123123;
    byte c = x; // Allowed
    byte d = y; // Not allowed

理想情况下，我希望能够，例如，限制一个数字从1到99，这样MyStruct s = 50;工作但MyStruct s = 150;导致编译时错误，就像上面的字节b和d所做的那样。

我在不同的语言中发现了类似的东西，但不是c#。

在编译时强制一个狭窄的隐式强制转换

我认为您可以通过使用自定义属性和roslyn代码分析来做到这一点。我来画一个解。这至少可以解决第一个用字面量初始化的用例。

首先，您需要一个应用于结构体的自定义属性，以允许代码分析能够知道有效范围:

[AttributeUsage(System.AttributeTargets.Struct)]
public class MinMaxSizeAttribute : Attribute
{
    public int MinVal { get; set;}
    public int MaxVal { get; set;}
    public MinMaxSizeAttribute()
    {
    }
}

这里所做的是将最小值和最大值存储在属性中。这样您就可以在稍后的源代码分析中使用它。

现在将此属性应用于结构体声明:

[MinMaxSize(MinVal = 0, MaxVal = 100)]
public struct Foo
{
    //members and implicit conversion operators go here
}

现在结构体Foo的类型信息包含了值范围。接下来你需要的是一个DiagnosticAnalyzer来分析你的代码。

public class MyAnalyzer : DiagnosticAnalyzer
{
    internal static DiagnosticDescriptor Rule = new DiagnosticDescriptor("CS00042", 
        "Value not allowed here",
        @"Type {0} does not allow Values in this range", 
        "type checker", 
        DiagnosticSeverity.Error,
        isEnabledByDefault: true, description: "Value to big");
    public MyAnalyzer()
    {
    }
    #region implemented abstract members of DiagnosticAnalyzer
    public override void Initialize(AnalysisContext context)
    {
        context.RegisterSyntaxNodeAction(AnalyzeSyntaxTree, SyntaxKind.SimpleAssignmentExpression);
    }
    public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(Rule);
    #endregion
    private static void AnalyzeSyntaxTree(SyntaxNodeAnalysisContext context)
    {
    }
}

这是参与代码分析的基本框架。分析器注册来分析分配:

context.RegisterSyntaxNodeAction(AnalyzeSyntaxTree, SyntaxKind.SimpleAssignmentExpression);

对于变量声明，您需要注册不同的SyntaxKind，但为了简单起见，我在这里坚持使用一个。

让我们看一下分析逻辑:

private static void AnalyzeSyntaxTree(SyntaxNodeAnalysisContext context)
        {
            if (context.Node.IsKind(SyntaxKind.SimpleAssignmentExpression))
            {
                var assign = (AssignmentExpressionSyntax)context.Node;
                var leftType = context.SemanticModel.GetTypeInfo(assign.Left).GetType();
                var attr = leftType.GetCustomAttributes(typeof(MinMaxSizeAttribute), false).OfType<MinMaxSizeAttribute>().FirstOrDefault();
                if (attr != null && assign.Right.IsKind(SyntaxKind.NumericLiteralExpression))
                {
                    var numLitteral = (LiteralExpressionSyntax)assign.Right;
                    var t = numLitteral.Token;
                    if (t.Value.GetType().Equals(typeof(int)))
                    {
                        var intVal = (int)t.Value;
                        if (intVal > attr.MaxVal || intVal < attr.MaxVal)
                        {
                            Diagnostic.Create(Rule, assign.GetLocation(), leftType.Name);
                        }
                    }
                }
            }
        }

分析器所做的是检查左侧的类型是否与MinMaxSize相关联，如果是，则检查右侧是否为字面量。当它是一个字面值时，它尝试获取整数值，并将其与与该类型关联的MinVal和MaxVal进行比较。如果该值超过该范围，它将报告诊断错误。

请注意，所有这些代码大多是未经测试的。它编译并通过了一些基本测试。但这只是为了说明一个可能的解决方案。欲了解更多信息，请查看Rsolyn文档

您想要涵盖的第二种情况更复杂，因为您将需要应用数据流分析来获取x的值。

相关文章：