CA1055:URI 返回值不应是字符串

值

规则 ID

CA1055

类别

设计

修复是中断修复还是非中断修复

重大

原因

方法名称包含“uri”、“Uri”、“urn”、“Urn”、“url”或“Url”，且方法返回一个字符串。

默认情况下，此规则仅查看外部可见的方法，但这是可配置的。

规则说明

此规则根据 Pascal 大小写约定将方法名称拆分为标记，并检查每个标记是否等于“uri”、“Uri”、“urn”、“Urn”、“url”或“Url”。 如果存在匹配项，则规则假定该方法返回统一资源标识符 (URI)。 URI 的字符串表示形式容易导致分析和编码错误，并且可造成安全漏洞。 System.Uri 类以一种安全的方式提供这些服务。

如何解决冲突

若要解决与此规则的冲突，请将返回类型更改为 Uri。

何时禁止显示警告

如果返回值不表示 URI，则可以安全地禁止显示此规则发出的警告。

配置代码以进行分析

使用下面的选项来配置代码库的哪些部分要运行此规则。

包含特定的 API 图面

你可以仅为此规则、为所有规则或为此类别中的所有规则配置此选项（设计）。 有关详细信息，请参阅代码质量规则配置选项。

包含特定的 API 图面

你可以根据代码库的可访问性，配置要针对其运行此规则的部分。 例如，若要指定规则应仅针对非公共 API 图面运行，请将以下键值对添加到项目中的 .editorconfig 文件：

dotnet_code_quality.CAXXXX.api_surface = private, internal

示例

下面的示例显示了一个与此规则冲突的 ErrorProne 类型，以及一个符合此规则的 SaferWay 类型。

public class ErrorProne

{

// Violates rule UriPropertiesShouldNotBeStrings.

public string SomeUri { get; set; }

// Violates rule UriParametersShouldNotBeStrings.

public void AddToHistory(string uriString) { }

// Violates rule UriReturnValuesShouldNotBeStrings.

public string GetReferrerUri(string httpHeader)

{

return "http://www.adventure-works.com";

}

}

public class SaferWay

{

// To retrieve a string, call SomeUri.ToString().

// To set using a string, call SomeUri = new Uri(string).

public Uri SomeUri { get; set; }

public void AddToHistory(string uriString)

{

// Check for UriFormatException.

AddToHistory(new Uri(uriString));

}

public void AddToHistory(Uri uriType) { }

public Uri GetReferrerUri(string httpHeader)

{

return new Uri("http://www.adventure-works.com");

}

}

Imports System

Namespace ca1055

Public Class ErrorProne

' Violates rule UriPropertiesShouldNotBeStrings.

Property SomeUri As String

' Violates rule UriParametersShouldNotBeStrings.

Sub AddToHistory(uriString As String)

End Sub

' Violates rule UriReturnValuesShouldNotBeStrings.

Function GetRefererUri(httpHeader As String) As String

Return "http://www.adventure-works.com"

End Function

End Class

Public Class SaferWay

' To retrieve a string, call SomeUri.ToString().

' To set using a string, call SomeUri = New Uri(string).

Property SomeUri As Uri

Sub AddToHistory(uriString As String)

' Check for UriFormatException.

AddToHistory(New Uri(uriString))

End Sub

Sub AddToHistory(uriString As Uri)

End Sub

Function GetRefererUri(httpHeader As String) As Uri

Return New Uri("http://www.adventure-works.com")

End Function

End Class

End Namespace

相关规则

CA1056:URI 属性不应是字符串

CA1054:URI 参数不应为字符串

CA2234:传递 System.Uri 对象，而不传递字符串