使用 Asp.net core webapi 集成配置系统,提高程序的灵活和可维护性

本文涉及的产品
Redis 开源版,标准版 2GB
推荐场景:
搭建游戏排行榜
云数据库 Tair(兼容Redis),内存型 2GB
简介: 使用 Asp.net core webapi 集成配置系统,提高程序的灵活和可维护性

前言:什么是集成配置系统?

集成配置系统的主要目的是将应用程序的配置信息与代码分离,使得配置信息可以在不需要修改代码的情况下进行更改。这样可以提高应用程序的灵活性和可维护性。

ASP.NET Core 提供了一种灵活的配置系统,可以轻松地将配置信息从不同的来源加载到应用程序中,并且可以根据环境变量、命令行参数、JSON 文件、XML 文件、环境变量等不同来源来管理配置。

本文主要讲解如何在 Asp.net core webapi 中应用集成配置系统

Step By Step 步骤

  1. 创建一个 ASP.NET Core webapi 项目
  2. 在 SQL Server 数据库中手动创建表 T_Configs,用于保存配置信息
  • 表包含Id、Name、Value这3列
  • Id列定义为整数类型的标识列
  • Name列和Value列都定义为字符串类型
  • Name列为配置项的名字
  • Value列为配置项的值

3.在T_Configs表中增加两行数据

1 Redis {"ConnStr":"127.0.0.1:16379,allowadmin=true"}
2 Smtp  {"Host":"smtp.example.com", "UserName":"test", "Password":"mypass123"}

4.安装并启动 Redis

5.引用以下 Nuget 包:

StackExchange.Redis

System.Data.SqlClient

Zack.AnyDBConfigProvider

6.在项目中创建一个SmtpOptions实体类,对应Smtp的配置值

public record SmtpOptions
{
  public string Host { get; set; }
  public string UserName { get; set; }
  public string Password { get; set; }
}

7.在项目上右击,选择【管理用户机密】,生成 Secrets.json

  • 可以看到在 .csproj 文件中生成了 UserSecretsId 节点
<UserSecretsId>29c6a656-872a-40dc-9793-2a9add90e9fe</UserSecretsId>
  • Secrets.json 存储在:
C:\Users\Jacky\AppData\Roaming\Microsoft\UserSecrets\29c6a656-872a-40dc-9793-2a9add90e9fe\secrets.json
  • 编写 Secrets.json 内容为:
{
  "ConnectionStrings": { "configServer": "Server=(localdb)\\mssqllocaldb;Database=TestDB;Trusted_Connection=True;MultipleActiveResultSets=true" }
}
  • 关闭 Secrets.json 文件后,右键重新【管理用户机密】可以再次打开 Secrets.json 文件

8.打开 Program.cs,编写代码进行配置系统的初始化(注意,看代码注释

using StackExchange.Redis;
using System.Data.SqlClient;
var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();
// 1.读取用户机密文件中的sqlserver连接串
builder.Host.ConfigureAppConfiguration((_, configBuilder) => {
  string connStr = builder.Configuration.GetConnectionString("configServer");
  configBuilder.AddDbConfiguration(() => new SqlConnection(connStr));
});
// 2.采用直接读取builder.Configuration的方式来读取数据库中的配置,并注册服务
builder.Services.Configure<SmtpOptions>(builder.Configuration.GetSection("Smtp"));
builder.Services.AddSingleton<IConnectionMultiplexer>(sp => {
  string connStr = builder.Configuration.GetValue<string>("Redis:ConnStr");
  return ConnectionMultiplexer.Connect(connStr);
}); 
var app = builder.Build();
// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
  app.UseSwagger();
  app.UseSwaggerUI();
}
app.UseHttpsRedirection();
app.UseAuthorization();
app.MapControllers();
app.Run();

9.在控制器中通过构造方法注入获取SmtpOptions和Redis连接对象

using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Options;
using StackExchange.Redis;
namespace 配置系统集成1.Controllers
{
  [ApiController]
  [Route("[controller]/[action]")]
  public class HomeController : ControllerBase
  {
    private readonly IOptionsSnapshot<SmtpOptions> smtpOptions;
    private readonly IConnectionMultiplexer connMultiplexer;
    // 通过构造方法注入获取SmtpOptions和Redis连接对象
    public HomeController(
      IOptionsSnapshot<SmtpOptions> smtpOptions,
      IConnectionMultiplexer connMultiplexer)
    {
      this.smtpOptions = smtpOptions;
      this.connMultiplexer = connMultiplexer;
    }
    // 读取配置信息,连接 Redis 读取数据
    [HttpGet]
    public async Task<string> Index()
    {
      var opt = smtpOptions.Value;
      var timeSpan = connMultiplexer.GetDatabase().Ping();
      
      //写入和读取 Key-value
      var database = connMultiplexer.GetDatabase(1);
      await database.StringSetAsync("name", "Jacky");
      string str = await database.StringGetAsync("name");
      return $"Smtp:{opt} timeSpan:{timeSpan} str:{str}";
    }
  }
}

扩展

为了简化开发,在ASP.NET Core项目中,WebApplication类的CreateBuilder方法会按照下面的顺序来提供默认的配置:

  1. 加载现有的IConfiguration。
  2. 加载项目根目录下的appsettings.json
  3. 加载项目根目录下的appsettings.Environment.json,其中Environment代表当前运行环境的名字
  4. 当程序运行在开发环境下,程序会加载“用户机密”配置
  5. 加载环境变量中的配置
  6. 加载命令行中的配置
相关实践学习
基于Redis实现在线游戏积分排行榜
本场景将介绍如何基于Redis数据库实现在线游戏中的游戏玩家积分排行榜功能。
云数据库 Redis 版使用教程
云数据库Redis版是兼容Redis协议标准的、提供持久化的内存数据库服务,基于高可靠双机热备架构及可无缝扩展的集群架构,满足高读写性能场景及容量需弹性变配的业务需求。 产品详情:https://www.aliyun.com/product/kvstore &nbsp; &nbsp; ------------------------------------------------------------------------- 阿里云数据库体验:数据库上云实战 开发者云会免费提供一台带自建MySQL的源数据库&nbsp;ECS 实例和一台目标数据库&nbsp;RDS实例。跟着指引,您可以一步步实现将ECS自建数据库迁移到目标数据库RDS。 点击下方链接,领取免费ECS&amp;RDS资源,30分钟完成数据库上云实战!https://developer.aliyun.com/adc/scenario/51eefbd1894e42f6bb9acacadd3f9121?spm=a2c6h.13788135.J_3257954370.9.4ba85f24utseFl
相关文章
|
9天前
|
开发框架 .NET 开发者
简化 ASP.NET Core 依赖注入(DI)注册-Scrutor
Scrutor 是一个简化 ASP.NET Core 应用程序中依赖注入(DI)注册过程的开源库,支持自动扫描和注册服务。通过简单的配置,开发者可以轻松地从指定程序集中筛选、注册服务,并设置其生命周期,同时支持服务装饰等高级功能。适用于大型项目,提高代码的可维护性和简洁性。仓库地址:&lt;https://github.com/khellang/Scrutor&gt;
32 5
|
28天前
|
开发框架 .NET C#
在 ASP.NET Core 中创建 gRPC 客户端和服务器
本文介绍了如何使用 gRPC 框架搭建一个简单的“Hello World”示例。首先创建了一个名为 GrpcDemo 的解决方案,其中包含一个 gRPC 服务端项目 GrpcServer 和一个客户端项目 GrpcClient。服务端通过定义 `greeter.proto` 文件中的服务和消息类型,实现了一个简单的问候服务 `GreeterService`。客户端则通过 gRPC 客户端库连接到服务端并调用其 `SayHello` 方法,展示了 gRPC 在 C# 中的基本使用方法。
38 5
在 ASP.NET Core 中创建 gRPC 客户端和服务器
|
17天前
|
开发框架 缓存 .NET
GraphQL 与 ASP.NET Core 集成:从入门到精通
本文详细介绍了如何在ASP.NET Core中集成GraphQL,包括安装必要的NuGet包、创建GraphQL Schema、配置GraphQL服务等步骤。同时,文章还探讨了常见问题及其解决方法,如处理复杂查询、错误处理、性能优化和实现认证授权等,旨在帮助开发者构建灵活且高效的API。
24 3
|
2月前
|
Java Maven Docker
gitlab-ci 集成 k3s 部署spring boot 应用
gitlab-ci 集成 k3s 部署spring boot 应用
|
24天前
|
消息中间件 监控 Java
您是否已集成 Spring Boot 与 ActiveMQ?
您是否已集成 Spring Boot 与 ActiveMQ?
46 0
|
5月前
|
监控 druid Java
spring boot 集成配置阿里 Druid监控配置
spring boot 集成配置阿里 Druid监控配置
316 6
|
5月前
|
Java 关系型数据库 MySQL
如何实现Springboot+camunda+mysql的集成
【7月更文挑战第2天】集成Spring Boot、Camunda和MySQL的简要步骤: 1. 初始化Spring Boot项目,添加Camunda和MySQL驱动依赖。 2. 配置`application.properties`,包括数据库URL、用户名和密码。 3. 设置Camunda引擎属性,指定数据源。 4. 引入流程定义文件(如`.bpmn`)。 5. 创建服务处理流程操作,创建控制器接收请求。 6. Camunda自动在数据库创建表结构。 7. 启动应用,测试流程启动,如通过服务和控制器开始流程实例。 示例代码包括服务类启动流程实例及控制器接口。实际集成需按业务需求调整。
419 4
|
5月前
|
消息中间件 Java 测试技术
【RocketMQ系列八】SpringBoot集成RocketMQ-实现普通消息和事务消息
【RocketMQ系列八】SpringBoot集成RocketMQ-实现普通消息和事务消息
377 1
|
6月前
|
消息中间件 Java Kafka
springboot集成kafka
springboot集成kafka
185 2
|
5月前
|
消息中间件 Java Kafka
Spring Boot与Apache Kafka Streams的集成
Spring Boot与Apache Kafka Streams的集成
下一篇
DataWorks