ASP.NET 中的自定义类型应用程序设置

Question

刚才我在 .NET WinForms 中遇到了可以处理复杂类型的 ApplicationSettings。
目前我在我的 ASP.NET WebForms 中使用 AppSettings，它只能处理字符串。
我可以在 Web 表单中使用 ApplicationSettings 吗？如果有怎么办？

Answer 1

基本思路：

1. 在不同的项目中，创建将保存您的自定义设置的类。例如：

   public class EndPoint
   {
       public string HostName { get; set; }
       public int Port { get; set; }
   }
   
   public class EndPointCollection : Collection<EndPoint>
   {
   }
   

2. 构建包含类的项目。

3. 转到项目属性中的设置选项卡。它会说还没有设置文件并询问您是否要创建它。

4. 添加新的设置文件。在类型字段中选择 Browse 并输入完整的类名。例如：ClassLibrary.EndPointCollection。保存并重建项目。

5. 点击设置值的编辑按钮。 （请注意，如果前面步骤中创建的类在同一个项目中，这将不可用。）使用 UI 编辑设置。

6. 如果你打开 web.config / app.config 文件，你会看到如下内容：

   ...
   <applicationSettings>
     <WebApplication1.Properties.Settings>
       <setting name="MyEndPoints"
                serializeAs="Xml">
         <value>
           <ArrayOfEndPoint xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                            xmlns:xsd="http://www.w3.org/2001/XMLSchema">
             <EndPoint>
               <HostName>MyHostName</HostName>
               <Port>12345</Port>
             </EndPoint>
             <EndPoint>
               <HostName>MyHost1</HostName>
               <Port>1212</Port>
             </EndPoint>
           </ArrayOfEndPoint>
         </value>
       </setting>
     </WebApplication1.Properties.Settings>
   </applicationSettings>
   ...
   

7. 最后，要从您的代码中读取这些设置，只需使用

   var endPointCollection = Settings.Default.MyEndPoints;
   

   设计师将在幕后创建强类型对象以允许上述操作。您可以在Settings.Designer.cs 文件中查看完整的详细信息。

底线：您可以进行各种自定义类型设置，只要这些设置具有 XmlSerializable 或具有类型转换器。该技术适用于 Web 应用程序、WinForms、WPF、控制台应用程序等。

Answer 2

这是接受答案的变体，使用以下用户定义的类来表示设置：

namespace MyApplication
{
    public class EndPoint
    {
        public string HostName { get; set; }
        public int Port { get; set; }
    }
}

接受的答案建议使用专门的集合类EndPointCollection 来保存设置。但是，我认为这没有必要；数组类型 (EndPoint[]) 似乎也可以工作。

但是，在类型浏览器中键入数组类型不起作用；您可以直接在 .settings 文件中指定类型（使用文本编辑器）：

<Setting Name="MyEndPoints" Type="MyApplication.EndPoint[]" Scope="User">
    <Value Profile="(Default)" />
</Setting>

此外，如果接受的答案中显示的值编辑器不可用，您可以改为使用 XML 将值直接输入到值字段中：

<ArrayOfEndPoint>
    <EndPoint>
        <HostName>MyHostName</HostName>
        <Port>12345</Port>
    </EndPoint>
    <EndPoint>
        <HostName>MyHost1</HostName>
        <Port>1212</Port>
    </EndPoint>
</ArrayOfEndPoint>

请注意，在 XML 中不需要 Visual Studio 生成的 XML 命名空间声明，如上所示。