使用InternalsVisibleToAttribute控制internal成员的访问
在上一篇文章中,为了解决成员访问级别的问题,我采用了一个object adapter,使得客户程序无法轻易地修改对象的属性。网友评论说,我的这种做法就是绕了一圈,的确,这种方法没办法阻止客户程序刻意地去修改对象的属性,但在一定程度上起到了保护作用:至少降低了误操作的可能性。
今天发现其实可以用System.Runtime.CompilerServices.InternalsVisibleToAttribute这个特性达到同样的效果。以下是操作步骤。
- 假设ExposedSetter.Library这个class library中包含了一个具有internal setter属性的SourcedAggregationRoot类。首先,对ExposedSetter.Library作数字签名。在ExposedSetter.Library项目上点右键选择“Properties”。在“Signing”页下选择“Sign the assembly”选项,然后指定一个强名称密钥文件。SourcedAggregationRoot的代码以及ExposedSetter.Library的签名设置如下
-
public class SourcedAggregationRoot : IVersionControllable
-
{
-
private long version;
-
private long branch;
-
#region IVersionControllable Members
-
public long Version
-
{
-
get { return this.version; }
-
internal set { this.version = value; }
-
}
-
public long Branch
-
{
-
get { return this.branch; }
-
internal set { this.branch = value; }
-
}
-
#endregion
-
-
public override string ToString()
-
{
-
return string.Format("Version = {0}, Branch = {1}",
-
version, branch);
-
}
-
}
- 新建一个class library,以调用ExposedSetter.Library中SourcedAggregationRoot的internal setter属性。为方便描述,我们将这个class library命名为ExposedSetter.Library2。在这个class library上添加对ExposedSetter.Library的引用,同时随便写一个测试的类,在类里直接调用SourcedAggregationRoot的internal setter属性来设置属性值。
-
public class Class1
-
{
-
public SourcedAggregationRoot Test()
-
{
-
SourcedAggregationRoot sar = new SourcedAggregationRoot();
-
sar.Branch = 125;
-
return sar;
-
}
-
}
- 启动Visual Studio的Command Line,使用sn.exe获得ExposedSetter.Library2的公共密钥(public key),注意:是public key,而不是public key token
- 打开ExposedSetter.Library的AssemblyInfo.cs文件,向其添加InternalsVisibleToAttribute:
-
[assembly: InternalsVisibleTo("ExposedSetter.Library2, PublicKey=0024000004800000940000000602000000240" +
-
"000525341310004000001000100bbccb249a2e7a1" +
-
"7cbddf86e24532777568cb13c2ea7643b61cf60367068f2b9ca785dca303c49f015823e4eaa17b" +
-
"50ed60ac47563dc8d8771358f10c3dc41f288530cfa350e6a2a24781dedeb8ec4138f93e76c537" +
-
"bce6c5aa7b25858fa90d6ef5c6ea613b1b49e6e287f9ebb7f990cfa0ce17fbfe1c338e95e88c14" +
-
"81f9598f")]
- 编译解决方案
同样,为ExposedSetter.Library2做数字签名(这一点很重要!)
注意,InternalsVisibleToAttribute的参数指定了允许访问其internal成员的assembly名称和公共密钥数据。在此不能设置assembly的版本等信息,否则编译都过不去。
这种方式有点像C++的友元。与我上文提到的引入object adapter的解决方案相比,这种做法更加professional一些,毕竟可以通过.NET Framework直接支持,而且也更加安全一些,它能够明确指定哪些assembly可以访问,其余的则不能访问。但这种做法也有弊端:假设我今后又有一个assembly希望使用ExposedSetter.Library中的internal成员,我需要去修改ExposedSetter.Library中的代码,以添加一个InteralsVisibleToAttribute特性。