NetPro.Startup 6.0.16

NetPro.Satrtup使用

无代码侵入性的Startup初始化插件

使用

约定

默认站点根目录下所有json自动在配置中生效，通过IConfiguration获取配置，有一些例外的json文件不在此生效： runtimeconfig.template.json；startup.json；global.json

启用服务

通过添加环境变量ASPNETCORE_HOSTINGSTARTUPASSEMBLIES=NetPro.Satrtup，开发环境可以通过设置launchSettings.json来启用NetPro.Satrtup插件

{ 
  "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development",
        "ASPNETCORE_HOSTINGSTARTUPASSEMBLIES": "NetPro.Satrtup" 
      }
}

生产环境通过设置系统环境方式启用以docker为例

docker run -e ASPNETCORE_HOSTINGSTARTUPASSEMBLIES=NetPro.Satrtup

k8s为例

env:
- name:ASPNETCORE_HOSTINGSTARTUPASSEMBLIES
  value:"NetPro.Satrtup"

linux为例

export ASPNETCORE_HOSTINGSTARTUPASSEMBLIES=NetPro.Satrtup

高级用法

更改Startup执行顺序，既中间件的执行顺序

增加startup.json 文件到程序运行目录

{
	"NetProCoreStartup": 0,
	"NetProCoreStartup1": 1
}

//key为继承INetProStartup的实现类名称
//value为对应的执行顺序
//不区分大小写
//数字越大越靠后执行

覆盖替换指定Startup

感谢KamenRiderKuuga提交的此功能"用于使用自定义Startup替换已有的Startup".

日常开发中，可能我们并不想使用已经内置的Startup实现，比如NetPro.Web.Api包内的ErrorHandlerStartup处理异常操作， 此时我们想用我们自己的实现替换他，就可用到ReplaceStartupAttribute

    /// <summary>
    /// 自定义异常处理中间件
    /// </summary>
    [ReplaceStartup("ErrorHandlerStartup")]
    public class CustomErrorHandlerStartup : INetProStartup
    {

    }

此时ErrorHandlerStartup将失效,又ApiStartup所在功能覆盖。

指定配置文件路径（用于整理拆分配置文件）：

在appsettings.json文件中增加配置项ConfigPath，指定配置文件夹存放路径，例如此处，appsetting.json中只有这一条配置项：

{
  "ConfigPath": "ConfigJsons"
}

所有在程序运行目录ConfigJsons中的json文件将被读取为配置项，此时，原有的appsetting.json被拆分为：

E:.
|   appsettings.json
|   Project.csproj
|
\---ConfigJsons
        globalization.json
        log.json
        mq.json
        redis.json
        swagger.json

注：这里的配置文件同样支持按环境适配，比如在开发环境下，mq.Development.json文件中的相应配置项将会生效

可覆盖

在appsetting.json中可以配置Overridable属性，这个变量用来决定在appsetting.json和ConfigPath中配置文件有相同的配置节点时，是否用ConfigPath中配置文件的节点来覆盖appsetting.json中的配置节点，当不配置时默认为true，即存在相同配置节点时，appsetting.json中的配置节点会被覆盖，调整这个属性为false有助于在使用ConfigJsons整理配置项的同时，将一些经常变动的配置项集中到appsetting.json进行调整

{
  "Overridable": true
}