ASP.NET で web.config に アプリケーション設定 を 追加 する方法

カスタム設定まではいきませんが、単純なキーバリュー設定を web.config に追加、 および、追加した値をコード上で読み取る方法をまとめます。

目次

• 設定の追加
• 設定の読み取り

設定の追加

web.config に 独自に追加したい設定を記述します。 記述する場所は /configuration/appSettings/add 要素です。 add 要素 には、 key と value 属性を設定します。 key に指定した値をキーに、 value に指定した値を取得するようになります。

web.config

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <appSettings>
    <add key="SampleMessage" value="Hello, World !" />
    <add key="SampleFlag" value="true" />
  </appSettings>
</configuration>

設定の読み取り

設定の読み取り (基本)

単純に web.config に設定した値を取得するサンプルコードを掲載します。 web.config の key に指定した値をキーとして、当該要素の value の値を取得します。 取得される値は必ず string なので、必要であれば型変換を行います。 型変換に関してはこの後に記載しています。

TestController.cs

using System.Configuration;
using System.Web.Http;

public class TestController : ApiController
{
    public string Get()
    {
        // web.config から 設定 を 取得する
        // /configuration/appSettings/add[@key='SampleMessage'] の value 属性（"Hello, World !"）が取得される
        var value = ConfigurationManager.AppSettings["SampleMessage"];

        return value;
    }
}

設定の読み取り (型変換)

AppSettings で得られる値は必ず string になるので、string 以外 （bool や double） には Parse する必要があります。 以下では、型変換 (パース) するコードサンプルを記載します。

TestController.cs

using System.Configuration;
using System.Web.Http;

public class TestController : ApiController
{
    public void Get()
    {
        bool flag = false;
        bool.TryParse(ConfigurationManager.AppSettings["SampleFlag"], out flag);
    }
}

関連記事

• ASP.NET で web.config に カスタム設定 を追加する 方法
• ASP.NET で web.config に 高度な カスタム設定 を 定義する方法
• ASP.NET で web.config の カスタム設定 を 検証 する 方法
• ASP.NET で web.config の カスタム設定 を 独自検証 する 方法

参考記事

• MSDN - 方法 : Web.config ファイルからアプリケーション設定を読み取る

最後に… このブログに興味を持っていただけた方は、 ぜひ 「Facebookページ に いいね！」または 「Twitter の フォロー」 お願いします！！

• Facebook ページ
• twitter