appsetting.jsonに値を更新するには？

Question

私はIOptionsパターンをin the official documentationのように使用しています。

appsetting.jsonから値を読み取っても正しく動作しますが、値を更新して変更を保存するにはどうすればappsetting.jsonに戻るのですか？

私の場合、ユーザーインターフェイス（アプリケーションの管理ユーザー）から編集できるフィールドがいくつかあります。したがって、これらの値をオプションアクセサで更新する理想的なアプローチを探しています。

Answer 1

Microsoft.Extensions.Optionsパッケージで提供されるコンポーネントがこの回答を書いている時点で、構成値をappsettings.jsonに書き戻す機能を持つように見えました。

は私 ASP.NET Coreプロジェクトの一つで、私はいくつかのアプリケーションの設定を変更するには、ユーザーを有効にしたかった - と、それらの設定値が存在する場合の構成に追加されるオプションの appsettings.custom.jsonファイルによりprecisly、 appsettings.jsonに格納する必要があります。このよう

...

public Startup(IHostingEnvironment env) 
{ 
    IConfigurationBuilder builder = new ConfigurationBuilder() 
     .SetBasePath(env.ContentRootPath) 
     .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true) 
     .AddJsonFile("appsettings.custom.json", optional: true, reloadOnChange: true) 
     .AddEnvironmentVariables(); 

    this.Configuration = builder.Build(); 
} 

私はIOptions<T>を拡張IWritableOptions<T>インタフェースを宣言しました。ですから、私は設定を読み書きしたいときはいつもをIWritableOptions<T>に置き換えることができます。

public interface IWritableOptions<out T> : IOptions<T> where T : class, new() 
{ 
    void Update(Action<T> applyChanges); 
} 

また、Iは設定部を更新するためにIWritableOptions<T>によって使用されることを意図しているコンポーネントである、IOptionsWriter思い付きました。ライターは、ファイル構造について認識していないので、これは私がJObjectオブジェクトとしてセクションを処理することを決定し、...

class OptionsWriter : IOptionsWriter 
{ 
    private readonly IHostingEnvironment environment; 
    private readonly IConfigurationRoot configuration; 
    private readonly string file; 

    public OptionsWriter(
     IHostingEnvironment environment, 
     IConfigurationRoot configuration, 
     string file) 
    { 
     this.environment = environment; 
     this.configuration = configuration; 
     this.file = file; 
    } 

    public void UpdateOptions(Action<JObject> callback, bool reload = true) 
    { 
     IFileProvider fileProvider = this.environment.ContentRootFileProvider; 
     IFileInfo fi = fileProvider.GetFileInfo(this.file); 
     JObject config = fileProvider.ReadJsonFileAsObject(fi); 
     callback(config); 
     using (var stream = File.OpenWrite(fi.PhysicalPath)) 
     { 
      stream.SetLength(0); 
      config.WriteTo(stream); 
     } 

     this.configuration.Reload(); 
    } 
} 

beforementionedインタフェースのための私の実装です。アクセサは要求されたセクションを見つけようとしてTのインスタンスに逆シリアル化し、現在の値（見つからない場合）を使用します。現在の値がnullの場合はTの新しいインスタンスを作成します。このホルダーオブジェクトは、発信者に渡され、発信者に変更が適用されます。変更されたオブジェクトは、バック部分を置き換えるために起こっているJTokenインスタンスに変換されるよりも、...

class WritableOptions<T> : IWritableOptions<T> where T : class, new() 
{ 
    private readonly string sectionName; 
    private readonly IOptionsWriter writer; 
    private readonly IOptionsMonitor<T> options; 

    public WritableOptions(
     string sectionName, 
     IOptionsWriter writer, 
     IOptionsMonitor<T> options) 
    { 
     this.sectionName = sectionName; 
     this.writer = writer; 
     this.options = options; 
    } 

    public T Value => this.options.CurrentValue; 

    public void Update(Action<T> applyChanges) 
    { 
     this.writer.UpdateOptions(opt => 
     { 
      JToken section; 
      T sectionObject = opt.TryGetValue(this.sectionName, out section) ? 
       JsonConvert.DeserializeObject<T>(section.ToString()) : 
       this.options.CurrentValue ?? new T(); 

      applyChanges(sectionObject); 

      string json = JsonConvert.SerializeObject(sectionObject); 
      opt[this.sectionName] = JObject.Parse(json); 
     }); 
    } 
} 

は最後に、私は

...私は簡単に書き込み可能なオプションのアクセサを設定することができ IServicesCollectionために拡張メソッドを実装しました私 Controller CLで

static class ServicesCollectionExtensions 
{ 
    public static void ConfigureWritable<T>(
     this IServiceCollection services, 
     IConfigurationRoot configuration, 
     string sectionName, 
     string file) where T : class, new() 
    { 
     services.Configure<T>(configuration.GetSection(sectionName)); 

     services.AddTransient<IWritableOptions<T>>(provider => 
     { 
      var environment = provider.GetService<IHostingEnvironment>(); 
      var options = provider.GetService<IOptionsMonitor<T>>(); 
      IOptionsWriter writer = new OptionsWriter(environment, configuration, file); 
      return new WritableOptions<T>(sectionName, writer, options); 
     }); 
    } 
} 

ConfigureServicesなどに使用することができます

...

services.ConfigureWritable<CustomizableOptions>(this.Configuration, 
    "MySection", "appsettings.custom.json"); 

私はちょうどIWritableOptions<CustomizableOptions>インスタンスを要求することができます。これはIOptions<T>と同じ特性を持ちますが、設定値を変更して保存することもできます。

private IWritableOptions<CustomizableOptions> options; 

... 

this.options.Update((opt) => { 
    opt.SampleOption = "..."; 
}); 

Answer 2

Matzeの答えの簡体字版：

public interface IWritableOptions<out T> : IOptionsSnapshot<T> where T : class, new() 
{ 
    void Update(Action<T> applyChanges); 
} 

public class WritableOptions<T> : IWritableOptions<T> where T : class, new() 
{ 
    private readonly IHostingEnvironment _environment; 
    private readonly IOptionsMonitor<T> _options; 
    private readonly string _section; 
    private readonly string _file; 

    public WritableOptions(
     IHostingEnvironment environment, 
     IOptionsMonitor<T> options, 
     string section, 
     string file) 
    { 
     _environment = environment; 
     _options = options; 
     _section = section; 
     _file = file; 
    } 

    public T Value => _options.CurrentValue; 
    public T Get(string name) => _options.Get(name); 

    public void Update(Action<T> applyChanges) 
    { 
     var fileProvider = _environment.ContentRootFileProvider; 
     var fileInfo = fileProvider.GetFileInfo(_file); 
     var physicalPath = fileInfo.PhysicalPath; 

     var jObject = JsonConvert.DeserializeObject<JObject>(File.ReadAllText(physicalPath)); 
     var sectionObject = jObject.TryGetValue(_section, out JToken section) ? 
      JsonConvert.DeserializeObject<T>(section.ToString()) : (Value ?? new T()); 

     applyChanges(sectionObject); 

     jObject[_section] = JObject.Parse(JsonConvert.SerializeObject(sectionObject)); 
     File.WriteAllText(physicalPath, JsonConvert.SerializeObject(jObject, Formatting.Indented)); 
    } 
} 

public static class ServiceCollectionExtensions 
{ 
    public static void ConfigureWritable<T>(
     this IServiceCollection services, 
     IConfigurationSection section, 
     string file = "appsettings.json") where T : class, new() 
    { 
     services.Configure<T>(section); 
     services.AddTransient<IWritableOptions<T>>(provider => 
     { 
      var environment = provider.GetService<IHostingEnvironment>(); 
      var options = provider.GetService<IOptionsMonitor<T>>(); 
      return new WritableOptions<T>(environment, options, section.Key, file); 
     }); 
    } 
} 

使用方法：次に

services.ConfigureWritable<MyOptions>(Configuration.GetSection("MySection")); 

：

0：

private readonly IWritableOptions<MyOptions> _options; 

public MyClass(IWritableOptions<MyOptions> options) 
{ 
    _options = options; 
} 

は、ファイルに変更を保存するには

_options.Update(opt => { 
    opt.Field1 = "value1"; 
    opt.Field2 = "value2"; 
}); 

そして、あなたは、オプションのパラメータとしてカスタムJSONファイルを渡すことができます（これはデフォルトでappsettings.json使用します）：

services.ConfigureWritable<MyOptions>(Configuration.GetSection("MySection"), "appsettings.custom.json");