c# - .NET 可以加载和解析与 Java Properties 类等效的属性文件吗？

Question

在 C# 中是否有一种简单的方法来读取属性文件，该文件在单独的行中包含每个属性，后跟等号和值，如下所示：

ServerName=prod-srv1
Port=8888
CustomProperty=Any value

在 Java 中，Properties 类很容易处理这种解析：

Properties myProperties=new Properties();
FileInputStream fis = new FileInputStream (new File("CustomProps.properties"));
myProperties.load(fis);
System.out.println(myProperties.getProperty("ServerName"));
System.out.println(myProperties.getProperty("CustomProperty"));

我可以轻松地在 C# 中加载文件并解析每一行，但是是否有一种内置方法可以轻松获取属性，而无需自己解析键名和等号？我发现的 C# 信息似乎总是偏爱 XML，但这是一个我无法控制的现有文件，我更愿意将其保留为现有格式，因为它需要更多时间让另一个团队将其更改为 XML而不是解析现有文件。

score 49 · Accepted Answer

不，没有对此的内置支持。

您必须制作自己的“INIFileReader”。也许是这样的？

var data = new Dictionary<string, string>();
foreach (var row in File.ReadAllLines(PATH_TO_FILE))
  data.Add(row.Split('=')[0], string.Join("=",row.Split('=').Skip(1).ToArray()));

Console.WriteLine(data["ServerName"]);

编辑：更新以反映保罗的评论。

score 18 · Accepted Answer

大多数Java“.properties”文件可以通过假设“=”是分隔符来分割——但格式比这要复杂得多，并且允许在属性名称或值中嵌入空格、等号、换行符和任何Unicode字符。

我需要为 C# 应用程序加载一些 Java 属性，因此我实现了 JavaProperties.cs 以使用与 Java 版本相同的方法正确读取和写入“.properties”格式的文件 - 您可以在http://www.kajabity找到它.com/index.php/2009/06/loading-java-properties-files-in-csharp/。

在那里，您会找到一个 zip 文件，其中包含该类的 C# 源代码和一些我测试过的示例属性文件。

享受！

score 17 · Accepted Answer

最后一堂课。谢谢@eXXL。

public class Properties
{
    private Dictionary<String, String> list;
    private String filename;

    public Properties(String file)
    {
        reload(file);
    }

    public String get(String field, String defValue)
    {
        return (get(field) == null) ? (defValue) : (get(field));
    }
    public String get(String field)
    {
        return (list.ContainsKey(field))?(list[field]):(null);
    }

    public void set(String field, Object value)
    {
        if (!list.ContainsKey(field))
            list.Add(field, value.ToString());
        else
            list[field] = value.ToString();
    }

    public void Save()
    {
        Save(this.filename);
    }

    public void Save(String filename)
    {
        this.filename = filename;

        if (!System.IO.File.Exists(filename))
            System.IO.File.Create(filename);

        System.IO.StreamWriter file = new System.IO.StreamWriter(filename);

        foreach(String prop in list.Keys.ToArray())
            if (!String.IsNullOrWhiteSpace(list[prop]))
                file.WriteLine(prop + "=" + list[prop]);

        file.Close();
    }

    public void reload()
    {
        reload(this.filename);
    }

    public void reload(String filename)
    {
        this.filename = filename;
        list = new Dictionary<String, String>();

        if (System.IO.File.Exists(filename))
            loadFromFile(filename);
        else
            System.IO.File.Create(filename);
    }

    private void loadFromFile(String file)
    {
        foreach (String line in System.IO.File.ReadAllLines(file))
        {
            if ((!String.IsNullOrEmpty(line)) &&
                (!line.StartsWith(";")) &&
                (!line.StartsWith("#")) &&
                (!line.StartsWith("'")) &&
                (line.Contains('=')))
            {
                int index = line.IndexOf('=');
                String key = line.Substring(0, index).Trim();
                String value = line.Substring(index + 1).Trim();

                if ((value.StartsWith("\"") && value.EndsWith("\"")) ||
                    (value.StartsWith("'") && value.EndsWith("'")))
                {
                    value = value.Substring(1, value.Length - 2);
                }

                try
                {
                    //ignore dublicates
                    list.Add(key, value);
                }
                catch { }
            }
        }
    }


}

样品用途：

//load
Properties config = new Properties(fileConfig);
//get value whith default value
com_port.Text = config.get("com_port", "1");
//set value
config.set("com_port", com_port.Text);
//save
config.Save()

score 9 · Accepted Answer

旧问题（2009 年 1 月）的另一个答案（2018 年 1 月）。

Java 属性文件的规范在java.util.Properties.load(java.io.Reader). 一个问题是规范比我们可能的第一印象有点复杂。另一个问题是这里的一些答案任意添加了额外的规范 - 例如，;被'视为注释行的开始，但它们不应该是。属性值周围的双引号/单引号被删除，但它们不应该被删除。

以下是需要考虑的要点。

线有两种，自然线和逻辑线。
自然行以\n、\r或\r\n流的结尾终止。
通过使用反斜杠字符转义行终止符序列，可以将逻辑行分散到多个相邻的自然行中\。
逻辑行中第二个和后续自然行开头的任何空白都将被丢弃。
空格是空格 ( , \u0020)、制表符 ( \t, \u0009) 和换页 ( \f, \u000C)。
正如规范中明确指出的那样，“仅检查行终止符序列之前的字符来确定行终止符是否被转义是不够的；行终止符必须有奇数个连续的反斜杠才能被转义。由于输入是从左到右处理的，在转义处理后，行终止符（或其他地方）编码 n 个反斜杠之前的非零偶数 2n 个连续反斜杠。”
=用作键和值之间的分隔符。
:也用作键和值之间的分隔符。
键和值之间的分隔符可以省略。
注释行具有#or!作为其第一个非空白字符，这意味着在#or之前的前导空白!是允许的。
注释行不能扩展到下一个自然行，即使它的行终止符前面是\.
正如规范中明确指出的那样，如果用反斜杠转义=，:和空格可以嵌入到键中。
甚至可以使用\r和\n转义序列包含行终止符。
如果省略值，则使用空字符串作为值。
\uxxxx用于表示 Unicode 字符。
无效转义字符之前的反斜杠字符不被视为错误；它被默默地丢弃。

因此，例如，如果test.properties具有以下内容：

# A comment line that starts with '#'.
   # This is a comment line having leading white spaces.
! A comment line that starts with '!'.

key1=value1
  key2 : value2
    key3 value3
key\
  4=value\
    4
\u006B\u0065\u00795=\u0076\u0061\u006c\u0075\u00655
\k\e\y\6=\v\a\lu\e\6

\:\ \= = \\colon\\space\\equal

它应该被解释为以下键值对。

+------+--------------------+
| KEY  | VALUE              |
+------+--------------------+
| key1 | value1             |
| key2 | value2             |
| key3 | value3             |
| key4 | value4             |
| key5 | value5             |
| key6 | value6             |
| : =  | \colon\space\equal |
+------+--------------------+

PropertiesLoaderAuthlete.Authlete NuGet 包中的类可以解释规范的格式。下面的示例代码：

using System;
using System.IO;
using System.Collections.Generic;
using Authlete.Util;

namespace MyApp
{
    class Program
    {
        public static void Main(string[] args)
        {
            string file = "test.properties";
            IDictionary<string, string> properties;

            using (TextReader reader = new StreamReader(file))
            {
                properties = PropertiesLoader.Load(reader);
            }

            foreach (var entry in properties)
            {
                Console.WriteLine($"{entry.Key} = {entry.Value}");
            }
        }
    }
}

将生成此输出：

key1 = value1
key2 = value2
key3 = value3
key4 = value4
key5 = value5
key6 = value6
: = = \colon\space\equal

Java中的一个等效示例如下：

import java.util.*;
import java.io.*;

public class Program
{
    public static void main(String[] args) throws IOException
    {
        String file = "test.properties";
        Properties properties = new Properties();

        try (Reader reader = new FileReader(file))
        {
             properties.load(reader);
        }

        for (Map.Entry<Object, Object> entry : properties.entrySet())
        {
            System.out.format("%s = %s\n", entry.getKey(), entry.getValue());
        }    
    }
}

源代码PropertiesLoader.cs可以在authlete-csharp中找到。xUnit测试PropertiesLoader是用PropertiesLoaderTest.cs.

score 8 · Accepted Answer

我编写了一个方法，允许在文件中使用空行、注释和引用。

例子：

var1="value1"
var2='value2'

'var3=outcommented
;var4=outcommented, too

这是方法：

public static IDictionary ReadDictionaryFile(string fileName)
{
    Dictionary<string, string> dictionary = new Dictionary<string, string>();
    foreach (string line in File.ReadAllLines(fileName))
    {
        if ((!string.IsNullOrEmpty(line)) &&
            (!line.StartsWith(";")) &&
            (!line.StartsWith("#")) &&
            (!line.StartsWith("'")) &&
            (line.Contains('=')))
        {
            int index = line.IndexOf('=');
            string key = line.Substring(0, index).Trim();
            string value = line.Substring(index + 1).Trim();

            if ((value.StartsWith("\"") && value.EndsWith("\"")) ||
                (value.StartsWith("'") && value.EndsWith("'")))
            {
                value = value.Substring(1, value.Length - 2);
            }
            dictionary.Add(key, value);
        }
    }

    return dictionary;
}

score 3 · Accepted Answer

是的，我知道没有内置的类可以做到这一点。

但这不应该是一个真正的问题吗？它看起来很容易解析，只需将结果存储Stream.ReadToEnd()在字符串中，根据新行拆分，然后拆分=字符上的每个记录。剩下的是一堆键值对，您可以轻松地将它们扔进字典中。

这是一个可能对您有用的示例：

public static Dictionary<string, string> GetProperties(string path)
{
    string fileData = "";
    using (StreamReader sr = new StreamReader(path))
    {
        fileData = sr.ReadToEnd().Replace("\r", "");
    }
    Dictionary<string, string> Properties = new Dictionary<string, string>();
    string[] kvp;
    string[] records = fileData.Split("\n".ToCharArray());
    foreach (string record in records)
    {
        kvp = record.Split("=".ToCharArray());
        Properties.Add(kvp[0], kvp[1]);
    }
    return Properties;
}

以下是如何使用它的示例：

Dictionary<string,string> Properties = GetProperties("data.txt");
Console.WriteLine("Hello: " + Properties["Hello"]);
Console.ReadKey();

score 2 · Accepted Answer

真正的答案是否定的（至少不是本身）。您仍然可以编写自己的代码来执行此操作。

score 1 · Accepted Answer

C# 通常使用基于 xml 的配置文件，而不是像你说的 *.ini 样式的文件，所以没有内置的东西来处理这个问题。然而，谷歌返回了一些有希望的结果。

score 1 · Accepted Answer

我不知道有任何内置方法可以做到这一点。但是，这似乎很容易做到，因为您唯一需要担心的分隔符是换行符和等号。

在给定文件内容的情况下，编写一个返回 NameValueCollection 或 IDictionary 的例程将非常容易。

score 1 · Accepted Answer

您还可以使用具有默认值和限制集的 C# 自动属性语法。这里的优点是您可以在属性“文件”（现在实际上是一个类）中拥有任何类型的数据类型。另一个优点是您可以使用 C# 属性语法来调用属性。但是，您只需要为每个属性写几行（属性声明中的一行，构造函数中的一行）即可完成这项工作。

using System;
namespace ReportTester {
   class TestProperties
   {
        internal String ReportServerUrl { get; private set; }
        internal TestProperties()
        {
            ReportServerUrl = "http://myhost/ReportServer/ReportExecution2005.asmx?wsdl";
        }
   }
}

score 1 · Accepted Answer

为此有几个 NuGet 包，但目前都处于预发布版本。

Capgemini.Cauldron.Core.JavaProperties 2.0.39-beta
Kajabity.Tools.Java 0.2.6638.28124

[更新] 截至 2018 年 6 月，Capgemini.Cauldron.Core.JavaProperties现在处于稳定版本（版本 2.1.0 和 3.0.20）。

score 0 · Accepted Answer

我意识到这并不是您要问的，但以防万一：

当您想要加载一个实际的Java 属性文件时，您需要适应它的编码。 Java 文档表明编码是 ISO 8859-1，其中包含一些您可能无法正确解释的转义序列。例如，查看这个 SO 答案，了解将 UTF-8 转换为 ISO 8859-1 的必要条件（反之亦然）

当我们需要这样做时，我们找到了一个开源的PropertyFile.cs并进行了一些更改以支持转义序列。这个类是读/写场景的好类。您还需要支持的PropertyFileIterator.cs类。

即使您没有加载真正的 Java 属性，请确保您的 prop 文件可以表达您需要保存的所有字符（至少 UTF-8）

score 0 · Accepted Answer

不，没有：但我创建了一个简单的课程来帮助：

public class PropertiesUtility
{
    private static Hashtable ht = new Hashtable();
    public void loadProperties(string path)
    {
        string[] lines = System.IO.File.ReadAllLines(path);
        bool readFlag = false;
        foreach (string line in lines)
        {
            string text = Regex.Replace(line, @"\s+", "");
            readFlag =  checkSyntax(text);
            if (readFlag)
            {
                string[] splitText = text.Split('=');
                ht.Add(splitText[0].ToLower(), splitText[1]);
            }
        }
    }

    private bool checkSyntax(string line)
    {
        if (String.IsNullOrEmpty(line) || line[0].Equals('['))
        {
            return false;
        }

        if (line.Contains("=") && !String.IsNullOrEmpty(line.Split('=')[0]) && !String.IsNullOrEmpty(line.Split('=')[1]))
        {
            return true;
        }
        else
        {
            throw new Exception("Can not Parse Properties file please verify the syntax");
        }
    }

    public string getProperty(string key)
    {
        if (ht.Contains(key))
        {
            return ht[key].ToString();
        }
        else
        {
            throw new Exception("Property:" + key + "Does not exist");
        }

    }
}

希望这可以帮助。

c# - .NET 可以加载和解析与 Java Properties 类等效的属性文件吗？

13 回答 13

Related

Reference