1 Star 1 Fork 0

徐昌龙 / tinyDBConfigProvider

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-2.0

TinyDBConfigProvider

介绍

微型数据库配置中心

https://www.nuget.org/packages/xu.TinyDBConfigProvider

为什么要用数据库配置中心

在开发、实施中,需要保存第三方接口appKey、jwt、redis、项目自定义的配置等配置信息。在项目实施时为了保证应用的可用性,同一个应用需要部署多台Web服务器实例。配置信息都保存到本地配置文件,管理较为麻烦,如果有一个配置项要修改的话,就要修改多个地方,且容易出现修改不一致、遗漏等问题,因此需要引入集中配置中心服务,各个应用统一从配置中心服务读取配置。

目前,有 ctrip apollo 、Nacos、spring-cloud-config 、disconf 等开源的配置中心可供使用,功能非常强大,需要单独部署维护配置中心服务器。但是我的应用并没有复杂到那种程度,为了避免增加太多运维的成本,尽量减少应用使用的服务的数量及运维人员操作难度。

此外,阿里云、腾讯云等云服务商也有对应的配置中心服务可以用,不用自己去部署维护,但是我所服务的行业多数情况是不允许连接公网,也不想让应用依赖于某个特定云服务商。

因此把配置信息保存到数据库中,用数据库来做配置中心服务,最符合要求。

项目特点

为方便各个项目读取配置及管理,开发了自定义的ConfigurationProvider,名字叫 xu.TinyDBConfigProvider。

  • 配置保存到数据库表中,管理简单;

  • 支持Sqlserver、mysql、sqlite等关系数据库,理论上只要.NET能连上的数据库都支持;

  • 支持配置的版本化管理;

  • 支持符合.NET配置命名规则的多级配置的覆盖;

  • 配置项的值类型丰富,支持简单的字符串、数字等类型,也支持json格式;

  • 采用.Net Standard2.0开发,支持.NET Framework、.NET Core;

软件架构

为项目安装Nuget包:

  • Microsoft.Extensions.DependencyInjection:依赖注入框架
  • Microsoft.Extensions.Configuration:配置框架
  • Microsoft.Extensions.Configuration.Json:配置框架Json扩展
  • Microsoft.Extensions.Options:选项扩展
  • Microsoft.Extensions.Configuration.Binder:选项绑定

使用说明

  1. 在数据库中创建一张表,默认的表名 "TinyDBConfig",支持自定义表名。表必须有Id、KeyName、KeyValue三个列,Id定义为整数、自动增长列,KeyName和KeyValue都定义为字符串类型列,长度根据系统配置数据的长度合理的分配,KeyName列配置项的名字,KeyValue列配置项的值。

    允许具有相同KeyName的多行数据,其中Id值最大的一条的值生效。

    KeyName的值遵循 .NET 中配置的 “多层级数据的扁平化”(微软文档 https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/?view=aspnetcore-5.0)。

    以下都是合法的KeyName列的值:

    api:Jwt:Audience

    age

    api:0

    api:1

    KeyValue列的值用来保存KeyName类对应的配置的值。KeyValue的值可以是普通的值,也可以是json对象、json数组。比如下面都是合法的KeyValue值:

    ["a","b","c1"]

    {"logFilePath":"D:/wwwroot/logs","minLevel":"INFO","source":1,"appID":"2007","sign":"96B03FD39E284C1E8FD45E0FFE298293","apiUri":"http://xxxx"}

    abc123

  2. 通过NuGet安装开发包:

    Install-Package xu.TinyDBConfigProvider -Version 1.0.0
  3. 配置数据库的连接字符串

    虽然说项目中其他配置都可以放到数据库中了,但是数据库本身的连接字符串依然需要单独配置。它既可以配置到本地配置文件中,也可以通过环境变量等其它方式配置。下面用配置到本地json文件举例。

    打开项目的appsettings.json,增加如下节点:

      "ConnectionStrings": {
        "DefaultConnection": "Data Source=TinyDB.sqlite"
      }

    接下来在Program.cs里的CreateHostBuilder方法的webBuilder.UseStartup();之前增加如下代码:

    var builder = WebApplication.CreateBuilder(args);
    builder.Services.AddControllers();
    
    builder.Host.ConfigureAppConfiguration((hostCtx, configBuilder) =>
    {
        string connStr = builder.Configuration.GetConnectionString("DefaultConnection");
        configBuilder.AddTinyDBConfiguration(() => new Microsoft.Data.Sqlite.SqliteConnection(connStr), reloadOnChange: true, reloadInterval: TimeSpan.FromSeconds(10));
    });
    
    builder.Services.Configure<LogConfig>(builder.Configuration.GetSection("log"));
    
    builder.Services.AddEndpointsApiExplorer();
    builder.Services.AddSwaggerGen();
    var app = builder.Build();
    if (app.Environment.IsDevelopment())
    {
        app.UseSwagger();
        app.UseSwaggerUI();
    }
    app.UseAuthorization();
    app.MapControllers();
    app.Run();

    4.读取配置

    创建类LogConfig

        public class LogConfig
        {
            public string? LogFilePath { get; set; }
            public string? MinLevel { get; set; }
            public int Source { get; set; }
            public string? AppID { get; set; }
            public string? Sign { get; set; }
            public string? ApiUri { get; set; }
        }

    然后在Program.cs中增加如下代码:

    builder.Services.Configure<LogConfig>(builder.Configuration.GetSection("log"));

    在Controller中读取配置:

        [ApiController]
        [Route("[controller]")]
        public class WeatherForecastController : ControllerBase
        {
            private readonly IConfiguration _configuration;
            private readonly IOptionsSnapshot<LogConfig> _logConfig;
    
            public WeatherForecastController(IConfiguration configuration, IOptionsSnapshot<LogConfig> logConfig)
            {
                _configuration = configuration;
                _logConfig = logConfig;
            }
    
            [HttpGet(Name = "GetWeatherForecast")]
            public IActionResult Get()
            {
                var a = _configuration.GetSection("AllowedHosts").Value;
                var b = _configuration.GetSection("Logging:LogLevel:Default").Value;
                var c = _configuration.GetSection("Logging:LogLevel:Microsoft.AspNetCore").Value;
                var d = _logConfig.Value.ApiUri;
                var e = System.Text.Json.JsonSerializer.Serialize(_logConfig.Value);
                var f = _configuration.GetSection("log:logFilePath").Value;
                var g = _configuration.GetSection("log").Value;
                var h = _configuration.GetSection("log").Get<LogConfig>();
                return Ok();
            }
        }
木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

微型配置管理服务中心,通过数据库的方式集中管理,支持多种关系型数据库,理论上只要.net 能连接上的都能支持。 展开 收起
C# 等 2 种语言
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
C#
1
https://gitee.com/xuchanglong/tinyDBConfigProvider.git
git@gitee.com:xuchanglong/tinyDBConfigProvider.git
xuchanglong
tinyDBConfigProvider
tinyDBConfigProvider
master

搜索帮助

53164aa7 5694891 3bd8fe86 5694891