Asp.net Core 和类库读取配置文件信息

Asp.net Core 和类库读取配置文件信息

看干货请移步至.net core 读取配置文件公共类

首先开一个脑洞,Asp.net core 被使用这么长时间了,但是关于配置文件(json)的读取,微软官方似乎并没有给出像.net framework读取web.config那样简单且完美。严重怀疑这是微软为了促进.net core 生态繁荣搞的一点小手段。

appsetting.Development.json (appsetting.json的内容和这个差不多,下面会讲到多环境使用)

{
  "SettingPath": {
    "VideoFilePath": "C:\\Users\\89275\\Desktop\\Projects\\mv",
    "FfmpegPath": "C:/Users/89275/Desktop/Projects/mv/ffmpeg.exe",
    "FtpPath": "http://192.168.254.1/videofile",
    "VirtualPath": "/videoplay"
  },
  "RedisPath":"192.168.0.108:6379"
}

看了很多Asp.net core 读取配置文件的博客,感觉都没有很好的解决问题。

  1. 最简单的就是在StartUp中通过Configuration[“SettingPath:VirtualPath”]的形式获取信息;
  2. 接下来就是在Controller中获去配置文件信息,在控制器中读取配置文件有两种方法。
  • 第一种是在controller初始化的时候把IHostingEnvironment,IConfiguration传过来,然后把穿过来的值赋给controller中对应的变量,酒后就可以正常读取配置文件了(由于我是个菜逼,还没看明白系统启动的时候,这两个变量是怎么传给controller的)
     public class HomeController : Controller
    {
        //环境变量
        private readonly IHostingEnvironment hostingEnvironment;
        private IConfiguration Configuration;
        public HomeController(IHostingEnvironment hostingEnvironment, IConfiguration configuration)
        {
            this.hostingEnvironment = hostingEnvironment;
            Configuration = configuration;
        }

        pubilc void GetRedisPath()
        {
            string redisPath = Configuration["RedisPath"];
        }
    }
  • 第二种是通过获取对象的方式读取配置文件,最近很多博客说的都是关于这个的。还是在controller初始化的时候把IOptions传进来(这里我还是没懂怎么传过来的/(ㄒoㄒ)/~~),然后把传过来的值赋值给Model的对象,然后就可以正常使用了。

这种方法需要在StartUp中的ConfigureServices中有添加

            services.AddOptions();
            //SettingPath极为Model
            services.Configure<SettingPath>(Configuration.GetSection("SettingPath"));
    public class HomeController
    {

        public SettingPath settingPath;
        private ILog log = LogManager.GetLogger(Startup.repository.Name, typeof(VideosController));
        public HomeController(IOptions<SettingPath> option)
        {
            settingPath = option.Value;
        }

        public void GetVideoPath()
        {
            string path=SettingPath.VideoFilePath
        }
    }

这里因为我不了解,IOptions是怎么传进来的,所以不知道如果有需要只用两个或以上Model的情况该怎么处理。

.net core 读取配置文件公共类

前面几种方法之前都有用过,但是个人感觉用起来都不是很顺手。而且如果想要在一个类库中读取配置文件的话简直痛苦到不想理媳妇。

所以自己动手写了一个工具类

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Options;
using System;

namespace Common
{
    public class ConfigurationHelper
    {
        public IConfiguration config { get; set; }
        public ConfigurationHelper()
        {
            IHostingEnvironment env = MyServiceProvider.ServiceProvider.GetRequiredService<IHostingEnvironment>();
            config = new ConfigurationBuilder()
                .SetBasePath(env.ContentRootPath)
                .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
                .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
                .AddEnvironmentVariables()
                .Build();
        }
        public T GetAppSettings<T>(string key) where T : class, new()
        {
            var appconfig = new ServiceCollection()
                .AddOptions()
                .Configure<T>(config.GetSection(key))
                .BuildServiceProvider()
                .GetService<IOptions<T>>()
                .Value;
            return appconfig;
        }
    }
    //我比较喜欢单独放这个类,但是这样放更明显
    public class MyServiceProvider
    {
        public static IServiceProvider ServiceProvider { get; set; }
    }
}

使用这个类的话需要在StartUp的Configure中添加

 MyServiceProvider.ServiceProvider = app.ApplicationServices;

然后就可以在任何地方使用此类读取配置文件信息了,而且由于ConfigurationHelper初始化时已经默认加载环境变量,所以同时具备多环境功能。

    string path = new ConfigurationHelper().config["RedisPath"];
            SettingPath pathss = new ConfigurationHelper().GetAppSettings<SettingPath>("SettingPath");

参考

https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/configuration/?view=aspnetcore-2.1
https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/environments?view=aspnetcore-2.1
https://www.cnblogs.com/CreateMyself/p/6859076.html