embbed resource

2012-02-26 22:28 by Ecin, 471 阅读, 0 评论, 收藏, 编辑

自己使用

Embedded Resource

.NET中使用外部资源时常用的方式都是使用资源文件，作为程序集的一部分发布。资源文件的读取也比较方便，字符串、图片和任何二进制数据，包括任何类型的文件都可以作为资源的项。

使用资源文件时VS也会自动生成相应的方法来获取资源，用xml编辑器打开后缀.resx的文件，可以看到资源文件是用xml方式存储的。

Embedded Resource亦即嵌入式资源文件，和资源一样，通过一些设置后也可以作为程序集的一部分发布。有时候我们不想用资源文件的时候也可以使用嵌入式资源，例如将文件my.xml作为资源文件嵌入的设置方法：

通过reflector打开程序集可以看到，my.xml文件已经作为程序集的一部分：

其嵌入的资源文件命名规则为：程序集+文件夹名（如果存在）+文件名（含后缀名）。

文件属性中“Copy to OutPut Directory”选定嵌入资源文件的的输出方式。

关于资源文件/嵌入式资源文件的读取

读取资源文件/嵌入式资源文件的一般方式为先加载资源所在的程序集，利用反射获取程序集中的外部文件数据：

• 读取资源文件名使用：string[] Assembly.GetManifestResourceNames(). 返回的是所有程序集资源清单文件
• 资源文件的读取使用System.Resources.ResourceManager类，构造函数签名：public ResourceManager(string baseName, Assembly assembly).
• 嵌入式资源文件的读取使用Assembly.GetManifestResourceStream(string name)

下面是一段参考代码：

[csharp]  view plain  copy

 

1. static void Main(string[] args)  
2. {  
3.    Assembly assembly = Assembly.Load("ResourceSample");  
4.    string content = string.Empty;  
5.   
6.    //GetManifestResourceNames:this method used to find all resource name.  
7.    foreach (string resourcein assembly.GetManifestResourceNames())  
8.    {  
9.        Console.WriteLine("Manifest:{0}", resource);  
10.        if (resource.IndexOf(".Resource1") > 0)  
11.        {  
12.            ResourceManager manager = new ResourceManager("ResourceSample.Resource1", assembly);  
13.            //read specified string   
14.            Console.WriteLine("resource key:mytest,value:{0}",manager.GetString("mytest"));  
15.        }  
16.        else  
17.        {  
18.            //read Embedded  resource  
19.            using (Stream stream = assembly.GetManifestResourceStream(resource))  
20.            {  
21.                using (StreamReader reader = new StreamReader(stream))  
22.                {  
23.                    Console.WriteLine(reader.ReadToEnd());  
24.                }  
25.            }  
26.        }  
27.    }  
28.       
29.    Console.ReadKey();  
30. }  

VS.NET中有两种使用嵌入资源，一种是使用.resx文件，一种是把文件的Build Type属性设为Emebbed Resource。关于resx文件的使用，大家都比较熟悉了，下面介绍一下第二种的使用方法。

　　一、使用第二种方法的好处：
　　１．不需要在你的运用程序中部署嵌入的资源文件，因为它将做为程序集的一部分；
　　２．不需要设置系统文件和文件夹“读”的权利；
　　３．不会暴露嵌入资源文件的内容，特别是当把一个配置信息以XML文件保存的时候。

　　二、如何把一个文件设为嵌入资源？
　　１．右键单击要设为嵌入资源的文件，点击“Properties”按钮；
　　２．在属性窗口中设置“Build Action”属性值为：Emebbed Resource。

　　三、关于嵌入资源文件的文件名
　　嵌入资源文件的文件名由三个部分组成 ：默认名称空间[.文件夹名].文件名。
　　假设在一个项目中把a.xml设为嵌入资源，且项目的默认名称空间（右键当击解决方案，点击属性，可以查看默认名称空间）为DefaultNameSpace：
　　１．若a.xml不在项目的子文件夹下，那么其文件名为DefaultNameSpace.a.xml；
　　２．若 a.xml在子文件夹FolderName下，那么其文件名为DefaultNameSpace.FolderName.a.xml。

　　四、如何访问嵌入资源文件？
　　C#代码：

// WordProcessingML是项目的名称空间
string  str  =   " WordProcessingML.emptyDoc.xml " ;
// 可以使用System.Reflection.Assembly.GetExecutingAssembly().GetName().Name获得默认名称空间
// string str = System.Reflection.Assembly.GetExecutingAssembly().GetName().Name + ".emptyDoc.xml";
System.IO.Stream stream  =  System.Reflection.Assembly.GetExecutingAssembly().GetManifestResourceStream(str);
string  strXml  =   string .Empty;
using  (System.IO.StreamReader sr  =   new  System.IO.StreamReader(stream))
{
    strXml = sr.ReadToEnd();
}
    m_xmlDocument.LoadXml(strXml);