CA1303:不要將常值當作已當地語系化的參數傳遞

文章
02/15/2024

屬性	值
規則識別碼	CA1303
標題	不要將常值當作已當地語系化的參數傳遞
類別	全球化
修正程式是中斷或非中斷	不中斷
預設在 .NET 8 中啟用	No

原因

方法會將字串常值當做參數傳遞至 .NET 建構函式或方法，而且該字串應可當地語系化。

當常值字串當做值傳遞至參數或屬性，且下列一或多個情況成立時，就會引發這個警告：

參數 LocalizableAttribute 或屬性的屬性設定為 true。
常值字串會傳遞至 string value 或方法多載的 Console.Write 或 string formatConsole.WriteLine 參數。
規則 CA1303 設定為使用命名啟發學習法，而參數或屬性名稱包含片語 Text、 Message或 Caption。

根據預設，此規則會分析整個程式代碼基底，但這是可設定的。

檔案描述

內嵌在原始程式碼中的字串常值難以當地語系化。

如何修正違規

若要修正此規則的違規，請將字串常值取代為透過類別實例擷取的 ResourceManager 字串。

對於不需要本地化字串的方法，您可以透過下列方式消除不必要的 CA1303 警告：

如果已啟用命名啟發學習法選項，請重新命名參數或屬性。
LocalizableAttribute拿掉參數或屬性上的屬性，或將它設定為 false （[Localizable(false)]）。

隱藏警告的時機

如果適用下列任一語句，則隱藏此規則的警告是安全的：

程式代碼連結庫不會當地語系化。
字串不會公開給使用者或使用程式代碼連結庫的開發人員。

隱藏警告

如果您只想要隱藏單一違規，請將預處理器指示詞新增至原始程式檔以停用，然後重新啟用規則。

#pragma warning disable CA1303
// The code that's violating the rule is on this line.
#pragma warning restore CA1303

若要停用檔案、資料夾或項目的規則，請在組態檔中將其嚴重性設定為。none

[*.{cs,vb}]
dotnet_diagnostic.CA1303.severity = none

如需詳細資訊，請參閱如何隱藏程式代碼分析警告。

設定程式代碼以分析

使用下列選項來設定程式代碼基底要執行此規則的部分。

排除特定符號
排除特定類型及其衍生類型
使用命名啟發學習法

您可以只針對此規則、它套用的所有規則，或針對套用至此類別的所有規則（全球化）設定這些選項。如需詳細資訊，請參閱程式代碼品質規則組態選項。

排除特定符號

您可以從分析中排除特定符號，例如類型和方法。例如，若要指定規則不應該在名為 MyType的任何程式代碼上執行，請將下列機碼/值組新增至 專案中的 .editorconfig 檔案：

dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType

選項值中允許的符號名稱格式（以 |分隔）：

只包含符號名稱（包含名稱的所有符號，不論包含類型或命名空間為何）。
符號檔案識別碼格式的完整名稱。每個符號名稱都需要符號種類前置詞，例如 M: 方法、 T: 類型和 N: 命名空間。
.ctor 用於建構函式和 .cctor 靜態建構函式。

範例：

選項值	摘要
`dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType`	符合所有名為 `MyType`的符號。
`dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType1\|MyType2`	比對名為 `MyType1` 或 `MyType2`的所有符號。
`dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS.MyType.MyMethod(ParamType)`	比對特定方法 `MyMethod` 與指定的完整簽章。
`dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS1.MyType1.MyMethod1(ParamType)\|M:NS2.MyType2.MyMethod2(ParamType)`	比對特定方法和`MyMethod1MyMethod2`個別的完整簽章。

排除特定類型及其衍生類型

您可以從分析中排除特定類型及其衍生類型。例如，若要指定規則不應該在具名 MyType 類型及其衍生型別內的任何方法上執行，請將下列機碼/值組新增至 專案中的 .editorconfig 檔案：

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType

選項值中允許的符號名稱格式（以 |分隔）：

僅限類型名稱（包含名稱的所有類型，不論包含類型或命名空間為何）。
符號文件識別碼格式的完整名稱，具有選擇性 T: 前置詞。

範例：

選項值	摘要
`dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType`	比對所有具名 `MyType` 的類型及其所有衍生型別。
`dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType1\|MyType2`	比對所有名為 `MyType1` 或 `MyType2` 的型別，以及其所有衍生型別。
`dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = M:NS.MyType`	比對具有指定完整名稱的特定型 `MyType` 別及其所有衍生型別。
`dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = M:NS1.MyType1\|M:NS2.MyType2`	比對特定類型和`MyType1MyType2`個別的完整名稱，以及其所有衍生型別。

使用命名啟發學習法

您可以設定參數或包含 Text、 Message或 Caption 的屬性名稱是否會觸發此規則。

dotnet_code_quality.CA1303.use_naming_heuristic = true

範例

下列範例顯示當兩個自變數中任一個自變數超出範圍時，寫入主控台的方法。針對自 hour 變數檢查，常值字串會傳遞至 Console.WriteLine，這違反了此規則。針對自 minute 變數檢查，透過 ResourceManager 擷取的字串會傳遞至 Console.WriteLine，以符合規則。

<Assembly: System.Resources.NeutralResourcesLanguageAttribute("en-US")>
Namespace GlobalizationLibrary

    Public Class DoNotPassLiterals

        Dim stringManager As System.Resources.ResourceManager

        Sub New()
            stringManager = New System.Resources.ResourceManager(
                "en-US", System.Reflection.Assembly.GetExecutingAssembly())
        End Sub

        Sub TimeMethod(hour As Integer, minute As Integer)

            If (hour < 0 Or hour > 23) Then
                'CA1303 fires because a literal string
                'is passed as the 'value' parameter.
                Console.WriteLine("The valid range is 0 - 23.")
            End If

            If (minute < 0 Or minute > 59) Then
                Console.WriteLine(
                    stringManager.GetString("minuteOutOfRangeMessage",
                        System.Globalization.CultureInfo.CurrentUICulture))
            End If

        End Sub

    End Class

End Namespace

public class DoNotPassLiterals
{
    ResourceManager stringManager;
    public DoNotPassLiterals()
    {
        stringManager = new ResourceManager("en-US", Assembly.GetExecutingAssembly());
    }

    public void TimeMethod(int hour, int minute)
    {
        if (hour < 0 || hour > 23)
        {
            // CA1303 fires because a literal string
            // is passed as the 'value' parameter.
            Console.WriteLine("The valid range is 0 - 23.");
        }

        if (minute < 0 || minute > 59)
        {
            Console.WriteLine(stringManager.GetString(
            "minuteOutOfRangeMessage", CultureInfo.CurrentUICulture));
        }
    }
}

分享方式：