如何读取嵌入式资源文本文件

如何使用读取嵌入式资源（文本文件）StreamReader并将其作为字符串返回？我当前的脚本使用Windows窗体和文本框，允许用户在未嵌入的文本文件中查找和替换文本。

private void button1_Click(object sender, EventArgs e)
{
    StringCollection strValuesToSearch = new StringCollection();
    strValuesToSearch.Add("Apple");
    string stringToReplace;
    stringToReplace = textBox1.Text;

    StreamReader FileReader = new StreamReader(@"C:\MyFile.txt");
    string FileContents;
    FileContents = FileReader.ReadToEnd();
    FileReader.Close();
    foreach (string s in strValuesToSearch)
    {
        if (FileContents.Contains(s))
            FileContents = FileContents.Replace(s, stringToReplace);
    }
    StreamWriter FileWriter = new StreamWriter(@"MyFile.txt");
    FileWriter.Write(FileContents);
    FileWriter.Close();
}

您可以使用Assembly.GetManifestResourceStream方法：

1. 添加以下用法

   using System.IO;
   using System.Reflection;

2. 设置相关文件的属性：带值的
   参数Build ActionEmbedded Resource

3. 使用以下代码

var assembly = Assembly.GetExecutingAssembly();
var resourceName = "MyCompany.MyProduct.MyFile.txt";

using (Stream stream = assembly.GetManifestResourceStream(resourceName))
using (StreamReader reader = new StreamReader(stream))
{
    string result = reader.ReadToEnd();
}

resourceName是嵌入在中的资源之一的名称assembly。例如，如果您将一个名为的文本文件嵌入"MyFile.txt"具有默认名称空间的项目的根目录中"MyCompany.MyProduct"，resourceName则为"MyCompany.MyProduct.MyFile.txt"。您可以使用Assembly.GetManifestResourceNamesMethod获得程序集中所有资源的列表。

毫不费吹灰之力地resourceName只从文件名获取（通过传递名称空间的东西）：

string resourceName = assembly.GetManifestResourceNames()
  .Single(str => str.EndsWith("YourFileName.txt"));

一个完整的例子：

public string ReadResource(string name)
{
    // Determine path
    var assembly = Assembly.GetExecutingAssembly();
    string resourcePath = name;
    // Format: "{Namespace}.{Folder}.{filename}.{Extension}"
    if (!name.StartsWith(nameof(SignificantDrawerCompiler)))
    {
        resourcePath = assembly.GetManifestResourceNames()
            .Single(str => str.EndsWith(name));
    }

    using (Stream stream = assembly.GetManifestResourceStream(resourcePath))
    using (StreamReader reader = new StreamReader(stream))
    {
        return reader.ReadToEnd();
    }
}

您可以使用两种单独的方法将文件添加为资源。

访问文件所需的C＃代码不同，这取决于首先添加文件所使用的方法。

方法1：添加现有文件，将属性设置为 Embedded Resource

将文件添加到您的项目，然后将类型设置为Embedded Resource。

注意：如果使用此方法添加文件，则可以GetManifestResourceStream用来访问它（请参阅@dtb中的答案）。

方法2：将文件添加到 Resources.resx

打开Resources.resx文件，使用下拉框添加文件，设置Access Modifier为public。

注意：如果使用此方法添加文件，则可以Properties.Resources用来访问它（请参阅@Night Walker的回答）。

基本上，您用于System.Reflection获取对当前程序集的引用。然后，您使用GetManifestResourceStream()。

例如，在我发布的页面中：

注意：需要添加using System.Reflection;此功能才能正常工作

   Assembly _assembly;
   StreamReader _textStreamReader;

   try
   {
      _assembly = Assembly.GetExecutingAssembly();
      _textStreamReader = new StreamReader(_assembly.GetManifestResourceStream("MyNamespace.MyTextFile.txt"));
   }
   catch
   {
      MessageBox.Show("Error accessing resources!");
   }

在Visual Studio中，您可以通过Project属性（在本示例中为“ Analytics”）的“资源”选项卡直接嵌入对文件资源的访问。

然后可以通过字节数组访问生成的文件

byte[] jsonSecrets = GoogleAnalyticsExtractor.Properties.Resources.client_secrets_reporter;

如果您需要将其作为流，那么（来自https://stackoverflow.com/a/4736185/432976）

Stream stream = new MemoryStream(jsonSecrets)

将文件添加到资源时，应选择其访问修饰符作为公共属性，而不可以进行如下操作。

byte[] clistAsByteArray = Properties.Resources.CLIST01;

CLIST01是嵌入式文件的名称。

实际上，您可以转到resources.Designer.cs并查看getter的名称。

添加例如Testfile.sql项目菜单->属性->资源->添加现有文件

    string queryFromResourceFile = Properties.Resources.Testfile.ToString();

我知道这是一个旧线程，但这对我有用：

1. 将文本文件添加到项目资源
2. 如上图所示，将访问修饰符设置为public

3. 阅读这样的文字：

   textBox1 = new TextBox();
   textBox1.Text = Properties.Resources.SomeText;

我添加到资源中的文本：“ SomeText.txt”

您还可以使用@dtb答案的简化版本：

public string GetEmbeddedResource(string ns, string res)
{
    using (var reader = new StreamReader(Assembly.GetExecutingAssembly().GetManifestResourceStream(string.Format("{0}.{1}", ns, res))))
    {
        return reader.ReadToEnd();
    }
}

我刚刚了解到的是，您的文件不允许带有“。”。文件名中的（点）。

Templates.plainEmailBodyTemplate-en.txt->有效！！！
Templates.plainEmailBodyTemplate.en.txt->无法通过GetManifestResourceStream（）工作

可能是因为框架对名称空间和文件名感到困惑...

通过您的全部力量，我使用此帮助程序类以通用方式从任何程序集和任何名称空间中读取资源。

public class ResourceReader
{
    public static IEnumerable<string> FindEmbededResources<TAssembly>(Func<string, bool> predicate)
    {
        if (predicate == null) throw new ArgumentNullException(nameof(predicate));

        return
            GetEmbededResourceNames<TAssembly>()
                .Where(predicate)
                .Select(name => ReadEmbededResource(typeof(TAssembly), name))
                .Where(x => !string.IsNullOrEmpty(x));
    }

    public static IEnumerable<string> GetEmbededResourceNames<TAssembly>()
    {
        var assembly = Assembly.GetAssembly(typeof(TAssembly));
        return assembly.GetManifestResourceNames();
    }

    public static string ReadEmbededResource<TAssembly, TNamespace>(string name)
    {
        if (string.IsNullOrEmpty(name)) throw new ArgumentNullException(nameof(name));
        return ReadEmbededResource(typeof(TAssembly), typeof(TNamespace), name);
    }

    public static string ReadEmbededResource(Type assemblyType, Type namespaceType, string name)
    {
        if (assemblyType == null) throw new ArgumentNullException(nameof(assemblyType));
        if (namespaceType == null) throw new ArgumentNullException(nameof(namespaceType));
        if (string.IsNullOrEmpty(name)) throw new ArgumentNullException(nameof(name));

        return ReadEmbededResource(assemblyType, $"{namespaceType.Namespace}.{name}");
    }

    public static string ReadEmbededResource(Type assemblyType, string name)
    {
        if (assemblyType == null) throw new ArgumentNullException(nameof(assemblyType));
        if (string.IsNullOrEmpty(name)) throw new ArgumentNullException(nameof(name));

        var assembly = Assembly.GetAssembly(assemblyType);
        using (var resourceStream = assembly.GetManifestResourceStream(name))
        {
            if (resourceStream == null) return null;
            using (var streamReader = new StreamReader(resourceStream))
            {
                return streamReader.ReadToEnd();
            }
        }
    }
}

我阅读了嵌入式资源文本文件的用法：

    /// <summary>
    /// Converts to generic list a byte array
    /// </summary>
    /// <param name="content">byte array (embedded resource)</param>
    /// <returns>generic list of strings</returns>
    private List<string> GetLines(byte[] content)
    {
        string s = Encoding.Default.GetString(content, 0, content.Length - 1);
        return new List<string>(s.Split(new[] { Environment.NewLine }, StringSplitOptions.None));
    }

样品：

var template = GetLines(Properties.Resources.LasTemplate /* resource name */);

template.ForEach(ln =>
{
    Debug.WriteLine(ln);
});

我知道这很旧，但是我只想指出NETMF（.Net MicroFramework），您可以轻松地做到这一点：

string response = Resources.GetString(Resources.StringResources.MyFileName);

由于NETMF没有GetManifestResourceStream

阅读完所有解决方案后，请点击此处。这是我解决的方法：

// How to embedded a "Text file" inside of a C# project
//   and read it as a resource from c# code:
//
// (1) Add Text File to Project.  example: 'myfile.txt'
//
// (2) Change Text File Properties:
//      Build-action: EmbeddedResource
//      Logical-name: myfile.txt      
//          (note only 1 dot permitted in filename)
//
// (3) from c# get the string for the entire embedded file as follows:
//
//     string myfile = GetEmbeddedResourceFile("myfile.txt");

public static string GetEmbeddedResourceFile(string filename) {
    var a = System.Reflection.Assembly.GetExecutingAssembly();
    using (var s = a.GetManifestResourceStream(filename))
    using (var r = new System.IO.StreamReader(s))
    {
        string result = r.ReadToEnd();
        return result;
    }
    return "";      
}

答案很简单，如果直接从resources.resx添加文件，则只需执行此操作。

string textInResourceFile = fileNameSpace.Properties.Resources.fileName;

使用该行代码，可以直接从文件中读取文件中的文本并将其放入字符串变量中。

我很烦恼，您必须始终在字符串中包含名称空间和文件夹。我想简化对嵌入式资源的访问。这就是为什么我写了这个小班。随时使用和改进！

用法：

using(Stream stream = EmbeddedResources.ExecutingResources.GetStream("filename.txt"))
{
 //...
}

类：

public class EmbeddedResources
{
    private static readonly Lazy<EmbeddedResources> _callingResources = new Lazy<EmbeddedResources>(() => new EmbeddedResources(Assembly.GetCallingAssembly()));

    private static readonly Lazy<EmbeddedResources> _entryResources = new Lazy<EmbeddedResources>(() => new EmbeddedResources(Assembly.GetEntryAssembly()));

    private static readonly Lazy<EmbeddedResources> _executingResources = new Lazy<EmbeddedResources>(() => new EmbeddedResources(Assembly.GetExecutingAssembly()));

    private readonly Assembly _assembly;

    private readonly string[] _resources;

    public EmbeddedResources(Assembly assembly)
    {
        _assembly = assembly;
        _resources = assembly.GetManifestResourceNames();
    }

    public static EmbeddedResources CallingResources => _callingResources.Value;

    public static EmbeddedResources EntryResources => _entryResources.Value;

    public static EmbeddedResources ExecutingResources => _executingResources.Value;

    public Stream GetStream(string resName) => _assembly.GetManifestResourceStream(_resources.Single(s => s.Contains(resName)));

}

某些VS .NET项目类型不会自动生成.NET（.resx）文件。以下步骤将资源文件添加到您的项目：

1. 右键单击项目节点，然后选择“添加/新建项目”，滚动到“资源文件”。在名称框中，选择一个适当的名称，例如资源，然后单击按钮添加。
2. 资源文件Resources.resx已添加到项目中，并且可以在解决方案资源管理器中视为节点。
3. 实际上，创建了两个文件，还有一个自动生成的C＃类Resources.Designer.cs。不要编辑它，它是由VS维护的。该文件包含名为的类Resources。

现在，您可以将文本文件添加为资源，例如xml文件：

1. 双击Resources.resx。选择添加资源>添加现有文件，然后滚动到要包含的文件。将默认值“内部”保留为“访问修改”。
2. 图标代表新的资源项目。如果选中，属性窗格将显示其属性。对于xml文件，在“编码”属性下选择“ Unicode（UTF-8）–代码页65001”，而不是默认的本地代码页。对于其他文本文件，请选择此文件的正确编码，例如代码页1252。
3. 对于xml文件之类的文本文件，该类Resources具有一个string以包含的文件命名的类型的属性。如果文件名为例如RibbonManifest.xml，则该属性应具有名称RibbonManifest。您可以在代码文件Resources.Designer.cs中找到确切的名称。
4. 与其他任何字符串属性一样，使用字符串属性，例如：string xml = Resources.RibbonManifest。一般形式为ResourceFileName.IncludedTextFileName。不要使用，ResourceManager.GetString因为string属性的get-function已经做到了。

public class AssemblyTextFileReader
{
    private readonly Assembly _assembly;

    public AssemblyTextFileReader(Assembly assembly)
    {
        _assembly = assembly ?? throw new ArgumentNullException(nameof(assembly));
    }

    public async Task<string> ReadFileAsync(string fileName)
    {
        var resourceName = _assembly.GetManifestResourceName(fileName);

        using (var stream = _assembly.GetManifestResourceStream(resourceName))
        {
            using (var reader = new StreamReader(stream))
            {
                return await reader.ReadToEndAsync();
            }
        }
    }
}

public static class AssemblyExtensions
{
    public static string GetManifestResourceName(this Assembly assembly, string fileName)
    {
        string name = assembly.GetManifestResourceNames().SingleOrDefault(n => n.EndsWith(fileName, StringComparison.InvariantCultureIgnoreCase));

        if (string.IsNullOrEmpty(name))
        {
            throw new FileNotFoundException($"Embedded file '{fileName}' could not be found in assembly '{assembly.FullName}'.", fileName);
        }

        return name;
    }
}

这是一个类，您可能会发现从当前类读取嵌入式资源文件非常方便Assembly：

using System.IO;
using System.Linq;
using System.Text;
using static System.IO.Path;
using static System.Reflection.Assembly;

public static class EmbeddedResourceUtils
{
    public static string ReadFromResourceFile(string endingFileName)
    {
        var assembly = GetExecutingAssembly();
        var manifestResourceNames = assembly.GetManifestResourceNames();

        foreach (var resourceName in manifestResourceNames)
        {
            var fileNameFromResourceName = _GetFileNameFromResourceName(resourceName);
            if (!fileNameFromResourceName.EndsWith(endingFileName))
            {
                continue;
            }

            using (var manifestResourceStream = assembly.GetManifestResourceStream(resourceName))
            {
                if (manifestResourceStream == null)
                {
                    continue;
                }

                using (var streamReader = new StreamReader(manifestResourceStream))
                {
                    return streamReader.ReadToEnd();
                }
            }
        }

        return null;
    }

    // https://stackoverflow.com/a/32176198/3764804
    private static string _GetFileNameFromResourceName(string resourceName)
    {
        var stringBuilder = new StringBuilder();
        var escapeDot = false;
        var haveExtension = false;

        for (var resourceNameIndex = resourceName.Length - 1;
            resourceNameIndex >= 0;
            resourceNameIndex--)
        {
            if (resourceName[resourceNameIndex] == '_')
            {
                escapeDot = true;
                continue;
            }

            if (resourceName[resourceNameIndex] == '.')
            {
                if (!escapeDot)
                {
                    if (haveExtension)
                    {
                        stringBuilder.Append('\\');
                        continue;
                    }

                    haveExtension = true;
                }
            }
            else
            {
                escapeDot = false;
            }

            stringBuilder.Append(resourceName[resourceNameIndex]);
        }

        var fileName = GetDirectoryName(stringBuilder.ToString());
        return fileName == null ? null : new string(fileName.Reverse().ToArray());
    }
}

对于所有很快想要Winforms中的硬编码文件文本的人；

1. 在解决方案资源管理器>资源>添加文件中右键单击您的应用程序。
2. 单击它，然后在属性选项卡中将“ FileType”设置为“ Text”。
3. 在程序中只需Resources.<name of resource>.toString();读取文件即可。

我不建议将此作为最佳实践或其他任何方法，但是它可以快速运行并且可以完成所需的工作。

对于使用VB.Net的用户

Imports System.IO
Imports System.Reflection

Dim reader As StreamReader
Dim ass As Assembly = Assembly.GetExecutingAssembly()
Dim sFileName = "MyApplicationName.JavaScript.js" 
Dim reader = New StreamReader(ass.GetManifestResourceStream(sFileName))
Dim sScriptText = reader.ReadToEnd()
reader.Close()

MyApplicationName我的应用程序的名称空间在哪里。它不是程序集名称。此名称在项目的属性（“应用程序”选项卡）中定义。

如果找不到正确的资源名称，则可以使用GetManifestResourceNames()函数

Dim resourceName() As String = ass.GetManifestResourceNames()

要么

Dim sName As String 
    = ass.GetManifestResourceNames()
        .Single(Function(x) x.EndsWith("JavaScript.js"))

要么

Dim sNameList 
    = ass.GetManifestResourceNames()
        .Where(Function(x As String) x.EndsWith(".js"))

阅读表单加载事件中的嵌入式TXT文件。

动态设置变量。

string f1 = "AppName.File1.Ext";
string f2 = "AppName.File2.Ext";
string f3 = "AppName.File3.Ext";

呼叫尝试接球。

try 
{
     IncludeText(f1,f2,f3); 
     /// Pass the Resources Dynamically 
     /// through the call stack.
}

catch (Exception Ex)
{
     MessageBox.Show(Ex.Message);  
     /// Error for if the Stream is Null.
}

为IncludeText（）创建空对象，Visual Studio为您完成此操作。单击灯泡以自动生成代码块。

将以下内容放入生成的代码块中

资源1

var assembly = Assembly.GetExecutingAssembly();
using (Stream stream = assembly.GetManifestResourceStream(file1))
using (StreamReader reader = new StreamReader(stream))
{
string result1 = reader.ReadToEnd();
richTextBox1.AppendText(result1 + Environment.NewLine + Environment.NewLine );
}

资源2

var assembly = Assembly.GetExecutingAssembly();
using (Stream stream = assembly.GetManifestResourceStream(file2))
using (StreamReader reader = new StreamReader(stream))
{
string result2 = reader.ReadToEnd();
richTextBox1.AppendText(
result2 + Environment.NewLine + 
Environment.NewLine );
}

资源3

var assembly = Assembly.GetExecutingAssembly();
using (Stream stream = assembly.GetManifestResourceStream(file3))

using (StreamReader reader = new StreamReader(stream))
{
    string result3 = reader.ReadToEnd();
    richTextBox1.AppendText(result3);
}

如果您希望将返回的变量发送到其他地方，只需调用另一个函数并...

using (StreamReader reader = new StreamReader(stream))
{
    string result3 = reader.ReadToEnd();
    ///richTextBox1.AppendText(result3);
    string extVar = result3;

    /// another try catch here.

   try {

   SendVariableToLocation(extVar)
   {
         //// Put Code Here.
   }

       }

  catch (Exception ex)
  {
    Messagebox.Show(ex.Message);
  }

}

这是通过一种在单个富文本框中组合多个txt文件并读取其嵌入数据的方法实现的。这是我对代码示例的预期效果。