配置应用程序

ASP.NET Core 的配置系统提供了一个基于键值对的配置方法。它是一个可扩展的系统,可以从各种资源中读取键值对,例如 JSON 设置文件、环境变量、命令行参数等等。

设置配置值

默认使用appsettings.json文件是配置的最简单方法。假设我们正在构建一个使用 Azure 发送 SMS 的服务,并且我们需要以下配置值:

  • Sender: 发件人号码
  • ConnectionString: 你的 Azure 资源的连接字符串

我们可以在appsettings.json文件的配置部分定义这些:

{
  ...
  "AzureSmsService": {
    "Sender": "+901112223344",
    "ConnectionString": "..."
  }
}

这里的键名是完全任意的,只要您在代码中使用相同的键,您就可以轻松地读取它们的值。

读取配置值

您可以在需要读取配置值的地方注入IConfiguration以使用该服务。例如,我们可以在 AzureSmsService中获取Azure 配置值用于发送 SMS:

using System.Threading.Tasks;
using Microsoft.Extensions.Configuration;
using Volo.Abp.DependencyInjection;
namespace SmsSending
{
    public class AzureSmsService : ISmsService, ITransientDependency
    {
        private readonly IConfiguration _configuration;
        public AzureSmsService(IConfiguration configuration)
        {
            _configuration = configuration;
        }
        
        public async Task SendAsync(string phoneNumber, string message)
        {
            string sender = _configuration["AzureSmsService:Sender"];
            string ConnectionString = _configuration["AzureSmsService:ConnectionString"];
            //TODO: Use Azure to send the SMS message
        }
    }
}

IConfiguration服务也可用于ConfigureServices中:

public override void ConfigureServices(ServiceConfigurationContext context)
{
    IConfiguration configuration = context.Services.GetConfiguration();
    string sender = configuration["AzureSmsService:Sender"];
}

这里,我们可以在服务注入之前访问配置值。

以上的配置方式固然方便,但是,如果您正在构建一个可重用的库,则选项模式可能是更好的方法,因为它是类型安全

实现选项模式

为了使用选项模式,我们使用一个普通的类(有时称为POCOPlain Old C# Object),我们从如何定义、配置和使用配置开始。

定义选项类

选项类是一个简单的类。我们为 Azure SMS 服务定义一个选项类,如以下代码块所示:

public class AzureSmsServiceOptions
{
    public string Sender { get; set; }
    public string ConnectionString { get; set; }
}

将后缀Options添加到选项类是一种约定。

配置选项

您可以在模块的ConfigureServices方法中配置,可以使用IServiceCollection.Configure的扩展方法为任何选项类设置值。看下下面的代码块是如何配置的:

[DependsOn(typeof(SmsSendingModule))]
public class MyStartupModule : AbpModule
{
    public override void ConfigureServices(ServiceConfigurationContext context)
    {
        context.Services.Configure<AzureSmsServiceOptions>(options =>
        {
            options.Sender = "+901112223344";
            options.ConnectionString = "...";
        });
    }
}

context.Services.Configure方法是获取选项类的通用方法。它还需要一个委托来设置选项值。在此示例中,我们通过在指定的 lambda 表达式中设置SenderConnectionString属性来进行配置。

AbpModule基类提供了一个Configure方法作为context.Services.Configure方法的快捷方式,因此您可以重写代码如下:

public override void ConfigureServices(ServiceConfigurationContext context)
{
    Configure<AzureSmsServiceOptions>(options =>
    {
        options.Sender = "+901112223344";
        options.ConnectionString = "...";
    });
}

你应该看到了一点点区别了吧?

使用配置选项值

ASP.NET Core 提供了一个IOptions<T>接口来注入选项类。我们使用AzureSmsServiceOptions重写AzureSmsService里的IConfiguration服务,如以下代码块所示:

public class AzureSmsService : ISmsService, ITransientDependency

{

private readonly AzureSmsServiceOptions _options;
    public AzureSmsService(IOptions<AzureSmsServiceOptions> options)
    {
        _options = options.Value;
    }
    
    public async Task SendAsync(string phoneNumber, string message)
    {
        string sender = _options.Sender;
        string ConnectionString = _options.ConnectionString;
        //TODO...
    }
}

我们注入IOptions<AzureSmsServiceOptions>并使用其Value属性来获取配置值。IOptions<T>接口定义在Microsoft.Extensions.Options包里,是一种标准的选项类注入方式,如果你直接注入AzureSmsServiceOptions类,你会得到一个依赖注入异常。所以要通过IOptions<T>把选项类包裹起来.

上面只是简单地定义、配置和使用了这些选项。如果我们想结合配置系统来设置选项该怎么办?

首先,我们用IConfiguration读取配置,并设置选项值:

[DependsOn(typeof(SmsSendingModule))]
public class MyStartupModule : AbpModule
{
    public override void ConfigureServices(ServiceConfigurationContext context)
    {
        var configuration = context.Services.GetConfiguration();        
        Configure<AzureSmsServiceOptions>(options =>
        {
            options.Sender =  configuration\["AzureSmsService:Sender"\];
            options.ConnectionString = configuration\["AzureSmsService:ConnectionString"\];
        });
    }
}

我们通过上下文的context.Services.GetConfiguration()方法获得IConfiguration接口,然后进行赋值操作。

由于这种用法很常见,我们可以重写一下代码,如下块所示:

public override void ConfigureServices(ServiceConfigurationContext context)
{
    var configuration = context.Services.GetConfiguration();    
    Configure<AzureSmsServiceOptions>(configuration.GetSection("AzureSmsService"));
}

[success] 翻译点评:虽然改动量很小,但是非常漂亮,可见作者精益求精的态度。

使用这种用法,配置代替了委托操作,它通过命名约定自动将配置键与选项类的属性进行匹配。如果AzureSmsService未在配置中定义,则此代码也不会影响选项。

选项模式为开发人员提供了更大的灵活性:他们可以从IConfiguration或者其他数据源进行选项设置。

[success] 提示:默认情况下从配置中设置选项

如果您正在构建可重用模块,最好尽可能从配置中设置选项。也就是说,您可以将前面的代码写入您的模块中。这样,开发人员可以直接从appsettings.json文件中配置他们的模块。

ASP.NET Core 和 ABP 选项

ASP.NET Core 和 ABP 框架都集中预先使用选项模式配置选项。

以下示例显示了在 ABP 框架中配置选项:

Configure<AbpAuditingOptions>(options =>
{
    options.IgnoredTypes.Add(typeof(ProductDto));
});

AbpAuditingOptions由 ABP 框架的审计日志系统定义。我们正在添加一个类型,用于在审计日志中忽略ProductDto

下一个示例显示在 ASP.NET Core 中配置选项:

Configure<MvcOptions>(options =>
{
    options.RespectBrowserAcceptHeader = true;
});

MvcOptions由 ASP.NET Core 内部定义,用于配置 ASP.NET Core MVC 框架的行为。

选项类中的复杂类型

请注意,AbpAuditingOptions.IgnoredTypes是一个的Type列表,它不是在appsettings.json文件中定义的那种简单原始类型,这是选项模式的好处之一:您可以定义具有复杂类型的属性甚至回调动作。

配置和选项系统提供了一种便捷的方式来配置服务的行为。

日志系统

日志记录是每个应用的基础设施。ASP.NET Core 提供了一个简单而高效的日志系统。它可以与流行的日志库集成,例如 NLog、Log4Net 和 Serilog。

Serilog 是一个广泛使用的库,它为日志目标提供了许多选项,包括控制台、文本文件和 Elasticsearch。ABP 启动模板带有预安装和配置的 Serilog 库。它将日志写入应用的Logs文件夹中,如果需要,您可以配置 Serilog 以将日志写入不同的目标(所有配置都包含在启动模板中)。请参考 Serilog 的官方文档来配置 Serilog 选项。

Serilog 不是 ABP 框架的核心依赖,因此,我们可以轻松使用其他提供商进行替换。

ILogger<T>接口用于在 ASP.NET Core 中写入日志,T通常是您的服务类型。

下面是一个写入日志的示例服务:

public class AzureSmsService : ISmsService, ITransientDependency
{
    private readonly ILogger<AzureSmsService> _logger;
    public AzureSmsService(ILogger<AzureSmsService> logger)
    {
        _logger = logger;
    }
    public async Task SendAsync(string phoneNumber, string message)
    {
        _logger.LogInformation($"Sending SMS to {phoneNumber}: {message}");
        //TODO...
    }
}

该类在其构造函数中注入ILogger<AzureSmsService>服务并使用LogInformation方法将日志写入日志系统。

ILogger接口上有更多的方法可以写入不同严重级别的日志,例如LogError和LogDebug。有关所有详细信息,请参阅 ASP.NET Core 的文档日志系统

概括

本章介绍了 ASP.NET Core 和 ABP 框架的核心模块。

你已经了解了如何使用Startup类、配置系统和选项模式来配置 ASP.NET Core 和 ABP 框架服务。

ABP 提供了一个模块化系统,相比 ASP.NET Core 的初始化和配置,ABP支持创建多个模块,其中每个模块支持独立的初始化和配置。通过这种方式,您可以将应用拆分为多个模块,以更好地方式组织代码或创建在不同应用中可重用的模块。

依赖注入系统是ASP.NET Core 最基本的基础设施。一个服务通常使用依赖注入系统消费其他服务。这里介绍了依赖注入系统的基本方面,并解释了 ABP 如何简化服务注册。

下一章重点介绍数据访问基础架构,这是业务应用程序的一个重要方面。我们将看到 ABP 框架如何标准化定义实体和使用存储库来抽象和执行数据库操作,同时自动化数据库连接和事务管理。

探索ABP基础架构-下的更多相关文章

  1. 探索ABP基础架构

    为了了解应用程序是如何配置和初始化,本文将探讨ASP.NET Core和ABP框架最基本的构建模块.我们将从 ASP.NET Core 的 Startup类开始了解为什么我们需要模块化系统,以及 AB ...

  2. 一、项目基础架构(附GitHub地址)——以ABP为基础架构的一个中等规模的OA开发日志

    前言: 最近园子里ABP炒的火热.看了几篇对于ABP的介绍后,深感其设计精巧,实现优雅.个人感觉,ABP或ABP衍生品的架构设计,未来会成为中型Net项目的首选架构模式.如果您还不了解ABP是什么,有 ...

  3. Pass Infrastructure基础架构(下)

    Pass Infrastructure基础架构(下) pass注册  PassRegistration该类在示例中简要显示了各种pass类型的定义 .该机制允许注册pass类,以便可以在文本pass管 ...

  4. 云计算服务模型,第 1 部分: 基础架构即服务(IaaS)

    英文原文:Cloud computing service models, Part 1: Infrastructure as a Service 本文介绍三个云类别中的第一个:基础架构即服务(infr ...

  5. 如何使用 Docker、ECS、Terraform 重建基础架构?

    早期 Segment 基础架构普遍组合在一起.我们通过 AWS 界面设定实例,使用许多闲散的 AMI,并且采用三种不同的部署方式. 然而随着商业的飞速发展,工程师团队的规模不断扩大,基础架构的复杂度也 ...

  6. 微服务架构下分布式事务解决方案——阿里GTS

    1 微服务的发展 微服务倡导将复杂的单体应用拆分为若干个功能简单.松耦合的服务,这样可以降低开发难度.增强扩展性.便于敏捷开发.当前被越来越多的开发者推崇,很多互联网行业巨头.开源社区等都开始了微服务 ...

  7. DCOS :私有云的物理基础架构管理引擎

    https://cloud.tencent.com/developer/article/1005598 一.引言 云计算经过多年的发展,逐渐从概念到渐为人认知.到接受.到现在全行业拥抱上云,云的客户也 ...

  8. 微服务架构下分布式事务解决方案——阿里云GTS

    https://blog.csdn.net/jiangyu_gts/article/details/79470240 1 微服务的发展 微服务倡导将复杂的单体应用拆分为若干个功能简单.松耦合的服务,这 ...

  9. ARM64架构下,OpenJDK的官方Docker镜像为何没有8版本

    为什么需要ARM64架构的OpenJDK8的Docker镜像 对现有的Java应用,之前一直运行在x86处理器环境下,编译和运行都是JDK8,如今在树莓派的Docker环境运行(也可能是其他ARM环境 ...

随机推荐

  1. Hadoop学习笔记—4.初识MapReduce

    一.神马是高大上的MapReduce MapReduce是Google的一项重要技术,它首先是一个编程模型,用以进行大数据量的计算.对于大数据量的计算,通常采用的处理手法就是并行计算.但对许多开发者来 ...

  2. strcat 函数的实现

    原型        extern char *strcat(char *dest,char *src); 用法        #include <string.h> 功能        把 ...

  3. WPF自定义控件与样式(8)-ComboBox与自定义多选控件MultComboBox

    一.前言 申明:WPF自定义控件与样式是一个系列文章,前后是有些关联的,但大多是按照由简到繁的顺序逐步发布的等,若有不明白的地方可以参考本系列前面的文章,文末附有部分文章链接. 本文主要内容: 下拉选 ...

  4. (六) 一起学 Unix 环境高级编程 (APUE) 之 进程控制

    . . . . . 目录 (一) 一起学 Unix 环境高级编程 (APUE) 之 标准IO (二) 一起学 Unix 环境高级编程 (APUE) 之 文件 IO (三) 一起学 Unix 环境高级编 ...

  5. html之大白

    <!doctype html> <html> <head> <meta charset="utf-8"> <title> ...

  6. Sublime Text shift+ctrl妙用

    1 :按住shift+ctrl然后按←或→可快速选中一行中的某一部分,相当于双击鼠标选中. 当你想在代码末尾加注释的话,这个方法很好用 输入文字->光标移到文字末尾->按住shift+ct ...

  7. 181102 Windows下安装kivy(用python写APP)

    了解到Instgram,知乎等APP是用python写的.我也决定学习用python写APP.这里我们需要安装kivy. 环境:win7,python3.6 安装方式:DOS命令窗口 注意事项:目前不 ...

  8. vs code编写的时候自动回车的原因

    今天在书写一个空白的scss文件的时候,刚打2个字就自动回车换行了: 测试了几次,发现了规律就是输入停下来0.5秒左右就会自动换行,比如,打了2个中文,再连续打一个句子,键盘虽然在动,但是vs cod ...

  9. 怎样在div中添加图片或设置颜色

    1.插入图片<div><img src="图片地址" /></div>2.图片做背景<div style="background ...

  10. django 动态生成CSV文件

    CSV (Comma Separated Values),以纯文本形式存储数字和文本数据的存储方式.纯文本意味着该文件是一个字符序列,不含必须像二进制数字那样的数据.CSV文件由任意数目的记录组成,记 ...