.net core中编辑json配置文件的方法
引言
最近在具体项目开发应用中,项目采用的json格式配置文件,配置文件的加载采用的IConfiguration接口对象进行的管理,这是.net standard时代,微软所提供的现代化的配置管理工具。
项目设计中,需要在运行过程中,将远程服务端发送过来的配置信息回写到配置文件中。然而,必应也好,百度也罢,翻遍网络,这套现代化的配置管理模型中,却找不到一个可以改变配置回写的方法。
无奈之下,只好自己动手,手动造轮子了。
.NET Standard时代的配置模型
随着.NET Standard时代的来临,System.Configuration在.net core中已经不存在了,那么取而代之的是Microsoft.Extensions.Configuration系列配置管理类库:
Microsoft.Extensions.Configuration.Abstractions:基础接口
Microsoft.Extensions.Configuration:实现上面的基础接口
Microsoft.Extensions.Configuration.FileProviderExtensions:提供重载配置扩展
Microsoft.Extensions.Configuration.Binder:提供转换到实体功能
Microsoft.Extensions.Configuration.FileExtensions:提供配置文件根路径扩展
相关文章资源
关于以上类库的使用,网上有大量相关文章,如知名博主大内老A的文章中,有着系统、详细阐述,各位可自行查阅。
链接在此:https://www.cnblogs.com/artech/p/config-for-net-core.html
配置类的建议用法
出于编程上的便利,我们通常不会直接利用ConfigurationBuilder创建的Configuration对象读取某个单一配置项的值,而是倾向于将一组相关的配置绑定为一个对象。
例如笔者某个项目消息主题配置参数类如下:
public class TopicConfig { public string Project { get; set; } ="ibms"; public string Device { get; set; } = "gateway"; public string City { get; set; } = "wuhan"; public string Area { get; set; } = "poly"; }
我们可以为配置类指定默认参数。
在需要使用配置参数的对象中,我们可以将配置类设置为属性字段
private TopicConfig topicConfig = new TopicConfig();
当对象类被实例化时,配置类将自动被构造并拥有默认配置参数
我们在需要使用配置的对象类中,写一个加载配置类的方法和保存配置类的方法,当对象类构造时,调用并执行加载配置文件。
当配置文件存在时,判断对应的配置段是否存在,如果存在,则绑定到对应的配置类,从而实现配置参数的加载(对象类中,相关需要使用配置参数的地方,直接从配置类的获取参数);
当配置文件不存在时,加载配置方法调用保存配置方法,将默认配置回写到配置文件中。
当配置参数动态更新后需要保存时,也通过调用保存配置方法,将配置参数更新到配置文件中。
示例json配置文件
{ "topic": { "Project": "ibms", "Device": "gateway", "City": "wuhan", "Area": "poly" } }
加载配置方法
笔者采用程序目录下的"appsettings.json"文件作为配置文件
private void LoadConfig() { var path = Directory.GetCurrentDirectory(); var config_file = "appsettings.json"; var full_path = Path.Combine(path, config_file); if (File.Exists(full_path)) { var builder = new ConfigurationBuilder() .SetBasePath(path) .AddJsonFile("appsettings.json"); IConfiguration Configuration = builder.Build(); if (Configuration.GetSection(Topic).Exists())//Topic为字符串常量,对应配置段属性名称 Configuration.GetSection(Topic).Bind(topicConfig);//绑定配置数据到配置类 } else { SaveConfig(); } }
在dotnet core由于采用了更为模块化的设计方式,使用配置类需要引用相应的程序包,我们在程序中使用json配置,需要安装Microsoft.Extensions.Configuration.Json程序包。
Bind方法为扩展方法,需要项目中先安装Microsoft.Extensions.Configuration.Binder程序包。
程序包可通过Nuget包管理器进行安装。
保存配置方法
private void SaveConfig(string path = "") { if (path == "") path = Directory.GetCurrentDirectory(); Dictionary<string, object> sectionsInfo = new Dictionary<string, object>(); sectionsInfo.Add(Topic, topicConfig); //Topic为字符串常量,对应配置段属性名称 JsonConfigHelper.SaveJson(sectionsInfo, path); }
调用json配置保存类,将配置保存到指定的位置。
通用Json配置保存类
笔者针对需要改写配置文件的应用的需要,自行实现了一个保存json格式配置文件的通用类,支持同时保存多个配置类。
支持对现有配置文件节点的改写和追加配置节点。
using System; using System.Collections.Generic; using System.IO; using Newtonsoft.Json; using Newtonsoft.Json.Linq; namespace flyfire.Common { public class JsonConfigHelper { public static bool SaveJson(Dictionary<string,object> sectionInfo, string configFilePath, string configFileName = "appsettings.json") { if (sectionInfo.Count==0) return false; try { var filePath = Path.Combine(configFilePath, configFileName); JObject jsonObject; if (File.Exists(filePath)) { using (StreamReader file = new StreamReader(filePath)) { using (JsonTextReader reader = new JsonTextReader(file)) { jsonObject = (JObject)JToken.ReadFrom(reader); } } } else { jsonObject = new JObject(); } foreach (var key in sectionInfo.Keys) { jsonObject[key] = JObject.FromObject(sectionInfo[key]); } using (var writer = new StreamWriter(filePath)) using (JsonTextWriter jsonwriter = new JsonTextWriter(writer) { Formatting = Formatting.Indented,//格式化缩进 Indentation = 4, //缩进四个字符 IndentChar = ' ' //缩进的字符是空格 }) { jsonObject.WriteTo(jsonwriter); return true; } } catch (Exception) { return false; } } } }
至此,我们完成了Json格式配置文件的加载、绑定与保存。
以上就是.net core中编辑json配置文件的详细内容,更多关于.net core json配置文件的资料请关注猪先飞其它相关文章!
相关文章
- 这篇文章主要为大家详细介绍了ASP.NET购物车的实现过程,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2021-09-22
- 这篇文章主要介绍了gin 获取post请求的json body操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2021-03-15
- 新版 Mysql 中加入了对 JSON Document 的支持,可以创建 JSON 类型的字段,并有一套函数支持对JSON的查询、修改等操作,下面就实际体验一下...2016-08-23
- 这篇文章主要介绍了.NET Core下使用Kafka的方法步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-09-22
- 在开发过程中,使用Visual Studio的断点调试功能可以很方便帮我们调试发现程序存在的错误,同样Visual Studio也支持对SQL Server里面的存储过程进行调试,下面就让我们看看具体的调试方法。...2021-09-22
- JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式。JSON采用完全独立于语言的文本格式,这些特性使JSON成为理想的数据交换语言。易于人阅读和编写,同时也易于机器解析和生成...2021-11-05
C#使用Http Post方式传递Json数据字符串调用Web Service
这篇文章主要为大家详细介绍了C#使用Http Post方式传递Json数据字符串调用Web Service,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2020-06-25- 下面小编就为大家带来一篇js遍历json的key和value的实例。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧...2017-01-26
- 这篇文章主要介绍了Win10 IIS 安装及.net 4.5及Win10安装IIS并配置ASP.NET 4.0的方法,本文给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下...2021-09-22
- 这篇文章主要介绍了详解.NET Core 3.0 里新的JSON API,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-09-22
- 通常php.ini的位置在:复制代码 代码如下:/etc目录下或/usr/local/lib目录下。如果你还是找不到php.ini或者找到了php.ini修改后不生效(其实是没找对),请使用如下办法:1.新建php文件,写入如下代码复制代码 代码如下:<?phpe...2014-05-31
- 这篇文章主要介绍了.net数据库操作框架SqlSugar的简单入门,帮助大家更好的理解和学习使用.net技术,感兴趣的朋友可以了解下...2021-09-22
ASP.NET Core根据环境变量支持多个 appsettings.json配置文件
这篇文章主要介绍了ASP.NET Core根据环境变量支持多个 appsettings.json配置文件,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-09-22基于Vue+Openlayer实现动态加载geojson的方法
本文通过实例代码给大家介绍基于Vue+Openlayer实现动态加载geojson的方法,代码简单易懂,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧...2021-09-01- 这篇文章主要介绍了记一次EFCore类型转换错误及解决方案,帮助大家更好的理解和学习使用asp.net core,感兴趣的朋友可以了解下...2021-09-22
- 引言今天在教别人使用protobuf的时候,无意中发现了一个php cli模式下的诡异问题,费了老半天的找到解决方法了,这里拿出来分享下。问题描述我们这边最先引入了protobuf协议,使用的是allegro/php-protobuf这个扩展安装的。...2015-10-21
- 这篇文章主要介绍了C#中读写INI配置文件的方法,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下...2020-06-25
- 下面就为大家带来一篇jquery对Json的各种遍历方法总结(必看篇)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧...2016-10-02
解决HttpPost+json请求---服务器中文乱码及其他问题
这篇文章主要介绍了解决HttpPost+json请求---服务器中文乱码及其他问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2021-01-22- 本文给大家介绍如何替换json对象中的key,通过实例代码给大家介绍key的替换方法,代码也很简单,需要的朋友参考下吧...2021-06-02