C# 8将为断言和自动化测试带来Caller Expression Attribute

最新推荐文章于 2025-02-19 19:30:00 发布

原创最新推荐文章于 2025-02-19 19:30:00 发布 · 56 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#c#

C#即将引入CallerExpressionAttribute特性，允许编译器自动捕获表达式的字符串表示，用于断言等场景，增强代码可读性和调试能力。然而，这一特性也带来了一些潜在的安全和兼容性问题。

C#和其他的.NET编程语言有一个叫作Caller Information Attribute的概念。在参数上应用这些属性时，开发人员就可以不负责提供匹配参数，把这些事情留给了编译器。目前，C#支持文件名或路径、行号以及调用方法或属性名的Caller Information Attribute。根据“Caller Expression Attribute”提案，表达式也将支持Caller Information Attribute。

考虑以下这对断言：

Assert.IsTrue(x - 7 \u0026gt; 0);Assert.IsTrue(y - 3 \u0026gt; 0);

如果测试失败，很难确定是哪个断言被触发。你可以为每个断言提供一条消息，但这样做很枯燥乏味，而且很容易就过时，如果表达本身可以被捕获就好了。

public static void IsTrue(bool condition, [CallerArgumentExpression(\u0026quot;condition\u0026quot;)] string message = null);

在这个示例中，如果开发人员未明确提供消息，那么编译器会将会使用condition参数对应的代码。本质上，编译器将代码转换为如下所示的形式：

Assert.IsTrue(x - 7 \u0026gt; 0, \u0026quot;x - 7 \u0026gt; 0\u0026quot;);Assert.IsTrue(y - 3 \u0026gt; 0, \u0026quot;y - 3 \u0026gt; 0\u0026quot;);

根据提案的设计，这种捕获机制甚至可以被用在扩展方法上。

潜在的问题

这个设计存在三个问题。

如果提供的参数是null或者不是参数名的字符串，那么编译器将传入一个空字符串。

知道如何使用反编译器的人将能够通过反编译看到标有这个属性的方法的一些源代码。对于闭源软件来说，这可能是难以接受的。

虽然这不是功能本身的缺陷，但问题是现在存在一个只接受bool的Debug.Assert API。即使重载方法的第二个参数使用了这个属性，并且是可选的，编译器仍然会选择非消息的那个参数。因此，非消息重载会被移除，这将造成二进制（尽管不是源代码）的突破性变更。

状态

目前，Caller Expression Attribute被列在C# 8路线图中，状态为“Prototype”。

查看英文原文：https://www.infoq.com/news/2019/01/Caller-Expression-Attribute