Visual Basic特性（Attributes）定义与应用

Visual Basic 特性（Attributes）概述

在 Visual Basic 编程领域中，特性（Attributes）是一种强大的元数据工具，它允许开发者为代码元素（如类、方法、属性等）附加额外的信息。这些信息并非代码逻辑的一部分，但却能在运行时或编译时被系统利用，以实现各种特定功能，如自定义行为、标记特殊的代码结构、控制序列化过程等。

特性本质上是一种派生自 System.Attribute 类的特殊类。在 Visual Basic 中，特性以方括号 [ ] 的形式应用于代码元素之前。例如：

<Serializable>
Public Class MyClass
    '类的定义
End Class

在上述示例中，Serializable 特性被应用到 MyClass 类上。这个特性向系统表明 MyClass 类的实例可以被序列化，即转换为一种可以存储或传输的格式。

预定义特性

Visual Basic 提供了许多预定义特性，这些特性在各种编程场景中都有广泛应用。

序列化相关特性

1. Serializable 特性 正如前面示例所示，Serializable 特性标记一个类，指示该类的实例可以被序列化。当应用这个特性后，公共语言运行时（CLR）会在必要时（如在网络传输或持久化存储时）将对象转换为字节流。

<Serializable>
Public Class Person
    Public Name As String
    Public Age As Integer
End Class

' 使用示例
Public Sub SerializePerson()
    Dim p As New Person()
    p.Name = "John"
    p.Age = 30

    Dim formatter As New System.Runtime.Serialization.Formatters.Binary.BinaryFormatter()
    Using stream As New System.IO.FileStream("person.bin", System.IO.FileMode.Create)
        formatter.Serialize(stream, p)
    End Using
End Sub

2. NonSerialized 特性 有时候，我们可能不希望类中的某些字段被序列化。这时可以使用 NonSerialized 特性。例如，假设 Person 类中有一个字段用于临时计算，不需要持久化：

<Serializable>
Public Class Person
    Public Name As String
    Public Age As Integer
    <NonSerialized>
    Public TempCalculation As Double
End Class

在上述代码中，TempCalculation 字段不会被序列化，即使 Person 类整体被标记为可序列化。

方法调用相关特性

1. DllImport 特性 当我们需要在 Visual Basic 代码中调用非托管代码（如 Windows API 函数）时，DllImport 特性就派上用场了。它允许我们指定包含要调用函数的动态链接库（DLL）的名称。

Imports System.Runtime.InteropServices

Public Class Win32API
    <DllImport("user32.dll")>
    Public Shared Function MessageBox(ByVal hwnd As IntPtr, ByVal text As String, ByVal caption As String, ByVal type As Integer) As Integer
    End Function
End Class

' 使用示例
Public Sub ShowMessageBox()
    Win32API.MessageBox(IntPtr.Zero, "Hello, World!", "Message", 0)
End Sub

在上述示例中，DllImport 特性应用于 MessageBox 方法，指定该方法来自 user32.dll 动态链接库。这样我们就可以在 Visual Basic 代码中调用 Windows 的 MessageBox 函数。

2. CallerMemberName 特性 CallerMemberName 特性用于获取调用方法的成员名称。这在记录日志、调试等场景中非常有用，因为它可以自动提供调用者的信息，而无需手动传递。

Imports System.Runtime.CompilerServices

Public Class Logger
    Public Shared Sub LogMessage(<CallerMemberName> Optional ByVal memberName As String = "", <CallerFilePath> Optional ByVal sourceFilePath As String = "", <CallerLineNumber> Optional ByVal sourceLineNumber As Integer = 0)
        Console.WriteLine($"Message logged from {memberName} in {sourceFilePath} at line {sourceLineNumber}")
    End Sub
End Class

' 使用示例
Public Class Program
    Public Sub DoSomething()
        Logger.LogMessage()
    End Sub
End Class

在上述代码中，当 DoSomething 方法调用 LogMessage 方法时，CallerMemberName、CallerFilePath 和 CallerLineNumber 特性会自动获取调用者的相关信息并传递给 LogMessage 方法。

反射相关特性

1. Obsolete 特性 Obsolete 特性用于标记一个代码元素（如类、方法、属性等）已经过时，不应该再被使用。当其他代码引用这个标记为过时的元素时，编译器会发出警告。

<Obsolete("This method is no longer supported. Use NewMethod instead.")>
Public Sub OldMethod()
    '方法实现
End Sub

Public Sub NewMethod()
    '新方法实现
End Sub

在上述示例中，如果有代码调用 OldMethod，编译器会显示警告信息，提示开发者使用 NewMethod 替代。

2. Browsable 特性 在使用反射来检查对象的属性时，Browsable 特性可以控制某个属性是否在可视化设计器（如 Windows 窗体设计器）中显示。例如，在自定义控件开发中：

Public Class MyControl
    <Browsable(False)>
    Public Property HiddenProperty As String
        Get
            Return "This is a hidden property"
        End Get
        Set(ByVal value As String)
            '设置逻辑
        End Set
    End Property

    Public Property VisibleProperty As String
        Get
            Return "This is a visible property"
        End Get
        Set(ByVal value As String)
            '设置逻辑
        End Set
    End Property
End Class

在上述代码中，HiddenProperty 被标记为 Browsable(False)，在可视化设计器中不会显示，而 VisibleProperty 会正常显示。

创建自定义特性

除了使用预定义特性外，开发者还可以根据自己的需求创建自定义特性。创建自定义特性需要以下几个步骤：

1. 定义特性类 自定义特性类必须直接或间接从 System.Attribute 类派生。例如，我们创建一个用于标记重要方法的自定义特性：

Public Class ImportantMethodAttribute
    Inherits System.Attribute
    Public ImportanceLevel As Integer

    Public Sub New(ByVal level As Integer)
        ImportanceLevel = level
    End Sub
End Class

在上述代码中，ImportantMethodAttribute 类继承自 System.Attribute，并且有一个公共属性 ImportanceLevel，构造函数接受一个 Integer 类型的参数来初始化这个属性。

2. 应用自定义特性 定义好自定义特性后，就可以将其应用到代码元素上。例如：

Public Class BusinessLogic
    <ImportantMethod(10)>
    Public Sub CriticalCalculation()
        '重要计算逻辑
    End Sub
End Class

在上述示例中，CriticalCalculation 方法被标记为 ImportantMethod 特性，并且指定了重要性级别为 10。

3. 使用反射读取自定义特性 为了使自定义特性发挥作用，通常需要在运行时使用反射来读取这些特性信息。例如：

Imports System.Reflection

Public Class Program
    Public Shared Sub Main()
        Dim type As Type = GetType(BusinessLogic)
        Dim method As MethodInfo = type.GetMethod("CriticalCalculation")
        Dim attributes() As Attribute = method.GetCustomAttributes(GetType(ImportantMethodAttribute), False)

        If attributes.Length > 0 Then
            Dim importantAttr As ImportantMethodAttribute = CType(attributes(0), ImportantMethodAttribute)
            Console.WriteLine($"Method {method.Name} is important with level {importantAttr.ImportanceLevel}")
        End If
    End Sub
End Class

在上述代码中，通过反射获取 BusinessLogic 类的 CriticalCalculation 方法，并读取该方法上应用的 ImportantMethodAttribute 特性信息。

特性的继承与覆盖

1. 特性的继承 当一个类继承自另一个类时，父类上应用的特性通常会被子类继承。例如：

<Serializable>
Public Class BaseClass
    '基类定义
End Class

Public Class DerivedClass
    Inherits BaseClass
    '派生类定义
End Class

在上述代码中，DerivedClass 虽然没有显式标记 Serializable 特性，但由于继承自 BaseClass，也具备可序列化的特性。

2. 特性的覆盖 在某些情况下，我们可能希望在子类中覆盖父类的特性设置。然而，并非所有特性都支持覆盖。对于支持覆盖的特性，我们可以在子类上重新应用特性并设置不同的值。例如：

<Obsolete("Base method is obsolete.")>
Public Class BaseClass
    Public Sub BaseMethod()
        '方法实现
    End Sub
End Class

Public Class DerivedClass
    Inherits BaseClass
    <Obsolete("Derived method is obsolete in a different way.")>
    Public Overrides Sub BaseMethod()
        '方法实现
    End Sub
End Class

在上述示例中，BaseMethod 在基类和派生类中都被标记为 Obsolete，但派生类通过重新应用特性并设置不同的提示信息，覆盖了基类的 Obsolete 特性设置。

特性在不同代码元素上的应用规则

1. 类上的特性应用 类上可以应用多种特性，如前面提到的 Serializable、Obsolete 等。这些特性会影响类的整体行为或标记类的特定状态。例如，ComVisible 特性用于指示类是否对 COM 组件可见：

<ComVisible(True)>
Public Class MyComVisibleClass
    '类定义
End Class

2. 方法上的特性应用 方法上可以应用特性来控制方法的调用方式、标记方法的特殊用途等。除了前面提到的 DllImport、CallerMemberName 等特性外，WebMethod 特性在 ASP.NET Web 服务开发中用于标记一个方法可以通过 HTTP 调用：

Imports System.Web.Services

Public Class MyWebService
    <WebMethod>
    Public Function GetData() As String
        Return "Some data"
    End Function
End Class

3. 属性上的特性应用 属性上应用特性可以控制属性的行为，如序列化行为、数据验证等。例如，DisplayName 特性用于在数据绑定场景中为属性指定一个更友好的显示名称：

Public Class Employee
    <DisplayName("Full Name")>
    Public Property Name As String
        Get
            Return m_name
        End Get
        Set(ByVal value As String)
            m_name = value
        End Set
    End Property
    Private m_name As String
End Class

4. 字段上的特性应用 字段上的特性应用与属性类似，如 NonSerialized 特性用于控制字段的序列化行为。此外，DefaultValue 特性可以为字段指定一个默认值：

Public Class Settings
    <DefaultValue(10)>
    Public MaximumValue As Integer
End Class

在上述代码中，MaximumValue 字段被指定了默认值 10。

特性与编译时和运行时的交互

1. 编译时特性的作用 有些特性主要在编译时起作用，如 Obsolete 特性。当编译器检测到代码中引用了标记为 Obsolete 的元素时，会根据特性的设置发出警告或错误。这有助于开发者在开发阶段及时发现并修正代码中使用过时元素的问题，避免在运行时出现潜在的兼容性问题。
2. 运行时特性的作用 更多的特性是在运行时起作用的。例如，Serializable 特性在运行时被公共语言运行时（CLR）识别，用于执行对象的序列化和反序列化操作。通过反射获取特性信息也是在运行时进行的，这使得开发者可以根据特性动态地改变代码的行为。例如，我们可以根据自定义特性来动态加载不同的插件模块：

Imports System.Reflection

Public Class PluginLoader
    Public Shared Sub LoadPlugins()
        Dim assemblies() As Assembly = AppDomain.CurrentDomain.GetAssemblies()
        For Each assembly As Assembly In assemblies
            Dim types() As Type = assembly.GetTypes()
            For Each type As Type In types
                Dim attributes() As Attribute = type.GetCustomAttributes(GetType(PluginAttribute), False)
                If attributes.Length > 0 Then
                    Dim instance As Object = Activator.CreateInstance(type)
                    '执行插件相关操作
                End If
            Next
        Next
    End Sub
End Class

Public Class PluginAttribute
    Inherits System.Attribute
End Class

在上述代码中，PluginAttribute 是一个自定义特性，用于标记插件类。在运行时，PluginLoader 类通过反射查找所有标记为 PluginAttribute 的类，并创建实例，实现插件的动态加载。

特性的局限性与注意事项

1. 性能影响 虽然特性提供了强大的功能，但过度使用特性可能会对性能产生一定影响。特别是在运行时使用反射来读取特性信息时，由于反射本身是一种较为昂贵的操作，频繁地通过反射获取特性可能导致性能下降。因此，在设计中应谨慎考虑特性的使用场景，尽量避免在性能敏感的代码段中过多依赖特性。
2. 兼容性问题 在不同的运行时环境或框架版本中，特性的行为可能会有所不同。例如，某些预定义特性在旧版本的.NET Framework 中可能不被支持，或者支持的方式略有差异。开发者在跨平台或跨版本开发时，需要仔细测试特性的兼容性，确保代码在各种目标环境中都能正常工作。
3. 滥用特性导致代码可读性下降 如果不合理地使用特性，将过多的业务逻辑或复杂的配置信息嵌入到特性中，可能会导致代码的可读性和维护性下降。特性应该用于提供与代码逻辑分离的元数据，而不是作为一种隐藏业务逻辑的手段。例如，将复杂的算法逻辑通过特性参数传递，可能会使代码的意图变得模糊，给后续开发者带来理解和维护的困难。

总之，Visual Basic 的特性（Attributes）是一种非常强大的编程工具，它为开发者提供了丰富的元数据控制能力。通过合理地使用预定义特性和创建自定义特性，我们可以实现代码的功能增强、行为定制以及与各种运行时环境的良好交互。但在使用过程中，我们也需要充分了解特性的原理、应用规则以及可能带来的问题，以确保代码的质量和性能。无论是在企业级应用开发、系统底层编程还是插件式架构设计中，特性都有着广泛的应用前景，开发者应熟练掌握并运用这一强大的功能。