友元程序集(C# 和 Visual Basic)

“友元程序集”是一种能够访问其他程序集的 Friend (Visual Basic) 或 internal (C#) 类型和成员的程序集。如果将程序集指定为友元程序集,则不再需要将类型和成员标记为公共,以使其他程序集可以访问它们。在以下情况下,使用友元程序集尤其方便:

  • 在单元测试中,测试代码在另一个程序集中运行,但需要访问正在测试的标记为 Friend (Visual Basic) 或 internal (C#) 的程序集中的成员。

  • 您正在开发类库,库的附加部分包含在单独的程序集中,但需要访问标记为 Friend (Visual Basic) 或 internal (C#) 的现有程序集中的成员。

备注

使用 InternalsVisibleToAttribute 特性可以为给定程序集指定一个或多个友元程序集。下面的示例使用程序集 A 中的 InternalsVisibleToAttribute 特性,并将程序集 AssemblyB 指定为友元程序集。这样,程序集 AssemblyB 将能够访问程序集 A 中标记为 Friend (Visual Basic) 或 internal (C#) 的所有类型和成员。

说明说明

在对将要访问另一个程序集(程序集 A)的内部类型或内部成员的程序集(程序集 AssemblyB)进行编译时,必须用 /out 编译器选项显式指定输出文件的名称(.exe 或 .dll)。这是必需的,因为当编译器将生成的程序集绑定到外部引用时,尚未为该程序集生成名称。有关更多信息,请参见 /out (C#)/out (Visual Basic)

Imports System.Runtime.CompilerServices
Imports System
<Assembly: InternalsVisibleTo("AssemblyB")> 

' Friend class.
Friend Class FriendClass
    Public Sub Test()
        Console.WriteLine("Sample Class")
    End Sub
End Class

' Public class with a Friend method.
Public Class ClassWithFriendMethod
    Friend Sub Test()
        Console.WriteLine("Sample Method")
    End Sub
End Class
using System.Runtime.CompilerServices;
using System;

[assembly: InternalsVisibleTo("AssemblyB")]

// The class is internal by default.
class FriendClass
{
    public void Test()
    {
        Console.WriteLine("Sample Class");
    }
}

// Public class that has an internal method.
public class ClassWithFriendMethod
{
    internal void Test()
    {
        Console.WriteLine("Sample Method");
    }

}

只有显式指定为友元的程序集才能访问 Friend (Visual Basic) 或 internal (C#) 类型和成员。例如,如果程序集 B 是程序集 A 的友元,且程序集 C 引用了程序集 B,则 C 不能访问 A 中的 Friend (Visual Basic) 或 internal (C#) 类型。

编译器对传递给 InternalsVisibleToAttribute 特性的友元程序集名称执行一些基本验证。如果程序集 A 将 B 声明为友元程序集,则验证规则如下:

  • 如果程序集 A 具有强名称,则程序集 B 也必须具有强名称。传递给特性的友元程序集名称必须包括程序集名称,以及用于签发程序集 B 的强名称密钥的公钥。

    传递给 InternalsVisibleToAttribute 特性的友元程序集名称不能是程序集 B 的强名称:不包含程序集版本、区域性、结构或公钥标记。

  • 如果程序集 A 不具有强名称,则友元程序集名称应仅包含该程序集名称。有关更多信息,请参见如何:创建未签名友元程序集(C# 和 Visual Basic)

  • 如果程序集 B 具有强名称,则必须使用项目设置或命令行 /keyfile 编译器选项,为程序集 B 指定强名称密钥。有关更多信息,请参见如何:创建签名的友元程序集(C# 和 Visual Basic)

StrongNameIdentityPermission 类还提供共享类型的功能,其与友元程序集的区别如下:

  • StrongNameIdentityPermission 应用于单个类型,而友元程序集应用于整个程序集。

  • 如果程序集 A 中有您希望与程序集 B 共享的数百个类型,则必须将 StrongNameIdentityPermission 添加到所有这些类型。如果使用友元程序集,则只需声明友元关系一次。

  • 如果使用 StrongNameIdentityPermission,则必须将希望共享的类型声明为公共类型。如果使用友元程序集,则将共享的类型声明为 Friend (Visual Basic) 或 internal (C#)。

有关如何从模块文件(具有 .netmodule 扩展名的文件)访问程序集的 Friend (Visual Basic) 或 internal (C#) 类型和方法的信息,请参见 /moduleassemblyname (Visual Basic)/moduleassemblyname (C#)

请参见

任务

如何:创建未签名友元程序集(C# 和 Visual Basic)

如何:创建签名的友元程序集(C# 和 Visual Basic)

参考

InternalsVisibleToAttribute

StrongNameIdentityPermission

概念

程序集和全局程序集缓存(C# 和 Visual Basic)

C# 编程指南

其他资源

Visual Basic 编程指南