如何创建仅适用于特定目标的自定义特性？类似Java @Target注解

嘿，这个需求在C#里其实很好实现，咱们分两步来搞定——先搞定限定特性的应用位置（对应Java里的@Target），再进一步把范围缩小到特定类型的字段上。

C#里专门有个AttributeUsage特性，就是用来干Java @Target的活儿的。它能指定你的自定义特性只能放在哪些元素上（比如字段、属性、方法等等）。

比如你想让特性仅能放在字段上方，代码可以这么写：

// 指定特性只能应用在字段上
[AttributeUsage(AttributeTargets.Field)]
public class MyCustomAttribute : Attribute
{
    // 这里可以加特性的构造函数或属性
    public string Description { get; set; }
}

AttributeTargets是个枚举，常用的取值有Field、Property、Method、Class等，和Java的ElementType一一对应。如果想让特性支持多个位置，用按位或就行：AttributeTargets.Field | AttributeTargets.Property。

AttributeUsage只能限定位置，没法管字段的类型或修饰符（比如public、bool）。这时候要实现更细的限制，有两种方案：

方案一：编译时检查（推荐） #

用Roslyn代码分析器，在编译阶段就检查特性的使用是否符合要求，不符合直接报编译错误，和Java的编译时注解检查体验一致。

核心思路是：

• 注册分析器监听字段声明节点
• 检查字段是否带有你的自定义特性
• 验证字段是否是public修饰的bool类型
• 不符合就抛出诊断错误

给你一段核心的分析器代码示例：

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Diagnostics;
using System.Collections.Immutable;

[DiagnosticAnalyzer(LanguageNames.CSharp)]
public class MyCustomAttributeAnalyzer : DiagnosticAnalyzer
{
    public const string DiagnosticId = "MY001";

    private static readonly LocalizableString Title = "Invalid MyCustomAttribute usage";
    private static readonly LocalizableString MessageFormat = "MyCustomAttribute can only be applied to public Boolean fields";
    private static readonly LocalizableString Description = "Ensure MyCustomAttribute is only used on public bool fields.";
    private const string Category = "Usage";

    private static readonly DiagnosticDescriptor Rule = new DiagnosticDescriptor(
        DiagnosticId, Title, MessageFormat, Category, 
        DiagnosticSeverity.Error, isEnabledByDefault: true, description: Description);

    public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(Rule);

    public override void Initialize(AnalysisContext context)
    {
        context.EnableConcurrentExecution();
        context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
        // 监听字段声明节点
        context.RegisterSyntaxNodeAction(AnalyzeFieldDeclaration, SyntaxKind.FieldDeclaration);
    }

    private void AnalyzeFieldDeclaration(SyntaxNodeAnalysisContext context)
    {
        var fieldDecl = (FieldDeclarationSyntax)context.Node;
        foreach (var variable in fieldDecl.Declaration.Variables)
        {
            // 获取字段的语义符号
            var fieldSymbol = context.SemanticModel.GetDeclaredSymbol(variable) as IFieldSymbol;
            if (fieldSymbol == null) continue;

            // 检查字段是否带有MyCustomAttribute
            var hasTargetAttr = fieldSymbol.GetAttributes()
                .Any(attr => attr.AttributeClass?.Name == nameof(MyCustomAttribute));
            
            if (!hasTargetAttr) continue;

            // 检查是否是public修饰符
            var isPublic = fieldSymbol.DeclaredAccessibility == Accessibility.Public;
            // 检查是否是bool类型
            var isBoolean = fieldSymbol.Type.SpecialType == SpecialType.System_Boolean;

            if (!isPublic || !isBoolean)
            {
                // 报告错误
                context.ReportDiagnostic(Diagnostic.Create(Rule, variable.GetLocation()));
            }
        }
    }
}

把这个分析器打包成NuGet包，或者直接加到项目里，别人用你的特性时只要不符合要求，编译时就会报错，体验拉满。

方案二：运行时检查（备选） #

如果不想搞分析器，也可以在运行时通过反射检查。但这种方式要等到程序跑起来才会发现问题，不如编译时检查友好。

示例代码：

// 假设你要检查某个类里的字段
var targetType = typeof(MyClass);
foreach (var field in targetType.GetFields())
{
    var customAttr = field.GetCustomAttribute<MyCustomAttribute>();
    if (customAttr != null)
    {
        // 验证字段是否符合要求
        if (!field.IsPublic || field.FieldType != typeof(bool))
        {
            throw new InvalidOperationException(
                $"Field '{field.Name}' is invalid for MyCustomAttribute: must be public Boolean.");
        }
        // 符合要求的话，执行你的逻辑
        Console.WriteLine($"Processing valid field: {field.Name}");
    }
}

先通过AttributeUsage限定特性的应用位置，再用Roslyn分析器实现编译时的类型/修饰符检查，就能完美实现类似Java @Target+自定义约束的功能啦。

内容的提问来源于stack exchange，提问作者aQuu