Prism使用Options选项

坐不住喜单溜

Options是微软提供的选项模块，该模块依赖于容器使用。除了微软的IServiceCollection，当然也可以使用其它的依赖注入容器。本文演示如何在prism中使用Options。
创建应用项目

创建一个Avalonia应用（或其它类型应用），然后使用NuGet包管理器添加Prism.DryIoc.Avalonia包。创建Views和ViewModels文件夹，将MainWindow移动到Views文件夹中（注意修改namespace），在ViewModels文件夹中创建MainWindowViewModel，以便Prism自动绑定ViewModel。

1. public partial class App : PrismApplication
2. {
3.     public override void Initialize()
4.     {
5.         AvaloniaXamlLoader.Load(this);
6.         base.Initialize();
7.     }
9.     protected override AvaloniaObject CreateShell()
10.     {
11.         return Container.Resolve<MainWindow>();
12.     }
14.     protected override void RegisterTypes(IContainerRegistry containerRegistry)
15.     {
16.         containerRegistry.Register<MainWindow>();
17.     }
18. }

复制代码

添加Options功能

• 首先使用NuGet添加Microsoft.Extentions.Options和Microsoft.Extensions.Options.ConfigurationExtensions。使用json配置文件进行测试，因此再添加上Microsoft.Extensions.Configuration.Json及Microsoft.Extensions.Configuration.Binder。
  
• 添加Options静态类，提供DefaultName：
  

1. public static class Options
2. {
3.     public static readonly string DefaultName = string.Empty;
4.     internal const DynamicallyAccessedMemberTypes DynamicallyAccessedMembers =
5.         DynamicallyAccessedMemberTypes.PublicParameterlessConstructor;
6. }

复制代码

• 由于UnnamedOptionsManager为内部类，无法直接使用，因此添加一个UnnamedOptionsManager类，实现IOptions接口，直接拷贝源码即可：
  

1. public class UnnamedOptionsManager<[DynamicallyAccessedMembers(Options.DynamicallyAccessedMembers)] TOptions> :
2.     IOptions<TOptions>
3.     where TOptions : class
4. {
5.     private readonly IOptionsFactory<TOptions> _factory;
6.     private volatile object _syncObj;
7.     private volatile TOptions _value;
9.     public UnnamedOptionsManager(IOptionsFactory<TOptions> factory) => _factory = factory;
11.     public TOptions Value
12.     {
13.         get
14.         {
15.             if (_value is TOptions value)
16.                 return value;
18.             lock (_syncObj ?? Interlocked.CompareExchange(ref _syncObj, new object(), null) ?? _syncObj)
19.             {
20.                 return _value ??= _factory.Create(Options.DefaultName);
21.             }
22.         }
23.     }
24. }

复制代码

• 添加OptionsPrismExtensions扩展类，添加AddOptions扩展方法，将选项泛型接口、工厂、缓存注册到容器中。工厂注册为瞬时，其它注册为单例。客户端不需要添加IOptionsSnapshot，只添加IOptions和IOptionsMonitor即可，前者获取选项不会监听修改，后者可以监听选项修改：
  

1. public static class OptionsPrismExtensions
2. {
3.     public static IContainerExtension AddOptions(this IContainerExtension container)
4.     {
5.         ArgumentNullException.ThrowIfNull(container, nameof(container));
7.         container.RegisterSingleton(typeof(IOptions<>), typeof(UnnamedOptionsManager<>));
8.         container.RegisterSingleton(typeof(IOptionsMonitor<>), typeof(OptionsMonitor<>));
9.         container.Register(typeof(IOptionsFactory<>), typeof(OptionsFactory<>));
10.         container.RegisterSingleton(typeof(IOptionsMonitorCache<>), typeof(OptionsCache<>));
11.         return container;
12.     }
13. }

复制代码

• 添加OptionsConfigurationPrismExtensions扩展类，提供Configuration相关的扩展方法，可以直接将选项和配置Section进行绑定：
  

1. public static class OptionsConfigurationPrismExtensions
2. {
3.     public static IContainerExtension Configure<[DynamicallyAccessedMembers(
4.         DynamicallyAccessedMemberTypes.All)] TOptions>(this IContainerExtension container,
5.         IConfiguration config) where TOptions : class
6.         => container.Configure<TOptions>(Options.DefaultName, config, _ => { });
8.     public static IContainerExtension Configure<[DynamicallyAccessedMembers(
9.         DynamicallyAccessedMemberTypes.All)] TOptions>(this IContainerExtension container,
10.         string name, IConfiguration config, Action<BinderOptions> configureBinder)
11.         where TOptions : class
12.     {
13.         ArgumentNullException.ThrowIfNull(container, nameof(container));
14.         ArgumentNullException.ThrowIfNull(config, nameof(config));
15.    
16.         container.AddOptions();
17.         container.RegisterInstance<IOptionsChangeTokenSource<TOptions>>(
18.             new ConfigurationChangeTokenSource<TOptions>(name, config));
19.         container.RegisterInstance<IConfigureOptions<TOptions>>(
20.             new NamedConfigureFromConfigurationOptions<TOptions>(name, config, configureBinder));
21.    
22.         return container;
23.     }
24. }

复制代码

使用

• 添加一个settings.json配置文件，设置属性复制到输出目录：如果较新则复制：
  

1. {
2.   "Test": {
3.     "Name": "louzi",
4.     "Age": 18,
5.     "Sex": "Male"
6.   }
7. }

复制代码

• 添加Test对应的Option实体：
  

1. public class TestOption
2. {
3.     public string Name { get; set; }
5.     public int Age { get; set; }
7.     public Gender Sex { get; set; }
8. }
10. public enum Gender
11. {
12.     Male,
13.     Female
14. }

复制代码

• 创建IConfiguration并绑定到选项：
  

1. // App
2. protected override IContainerExtension CreateContainerExtension()
3. {
4.     var container =  base.CreateContainerExtension();
6.     IConfiguration config = new ConfigurationBuilder().SetBasePath(Directory.GetCurrentDirectory())
7.         .AddJsonFile("settings.json", optional: true, reloadOnChange: true).Build();
8.     container.AddOptions().Configure<TestOption>(config.GetSection("Test"));
10.     return container;
11. }

复制代码

• ViewModel中通过依赖注入获取选项：
  

1. public class MainWindowViewModel : BindableBase
2. {
3.     private string _name;
4.     private int _age;
5.     private Gender _sex;
7.     public MainWindowViewModel(IOptions<TestOption> options)
8.     {
9.         var testOption = options.Value;
10.         _name = testOption.Name;
11.         _age = testOption.Age;
12.         _sex = testOption.Sex;
13.     }
15.     public string Name { get => _name; set => SetProperty(ref _name, value); }
17.     public int Age { get => _age; set => SetProperty(ref _age, value); }
19.     public Gender Sex { get => _sex; set => SetProperty(ref _sex, value); }
20. }

复制代码

• View中显示
  

1. <Grid RowDefinitions="1*,1*,1*" ColumnDefinitions="1*,1*">
2.         <TextBlock Text="Name: " TextAlignment="Right"/>
3.         <TextBlock Text="{Binding Name}" Grid.Column="1"/>
4.         <TextBlock Text="Age: " Grid.Row="1" TextAlignment="Right"/>
5.         <TextBlock Text="{Binding Age}" Grid.Row="1" Grid.Column="1"/>
6.         <TextBlock Text="Sex: " Grid.Row="2" TextAlignment="Right"/>
7.         <TextBlock Text="{Binding Sex}" Grid.Row="2" Grid.Column="1"/>
8. </Grid>

复制代码

项目结构及运行效果如下图：

来源:https://www.cnblogs.com/louzixl/archive/2023/12/05/17877961.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！