ABP.IO分层应用模板项目生产环境部署配置实操问答

背景 #

部署分层架构ABP.IO应用模板项目时会遇到若干配置问题，其中部分属于ASP.NET Core通用部署范畴。初始核心疑问为：生产环境对应的appsettings.Production.json文件，是需要在所有类库项目（如MyProduct.Application、MyProduct.Application.Contracts等）和4个可部署ASP.NET项目（MyProduct.HttpApi.Host、MyProduct.IdentityServer、MyProduct.Web、MyProduct.Web.Public）中全部创建，还是仅需在4个ASP.NET可部署项目中创建，再把类库用到的配置项统一汇总到宿主项目的生产配置文件中。

待解答问题 #

• 是否需要在类库/DLL项目中创建appsettings.Production.json文件？
• 若上一问题答案为是，launchSettings.json是否是配置类库按生产环境构建的正确位置？
• 若上一问题答案为是，生产环境部署时有哪些注意事项？已知需要在服务器上配置对应环境变量。
• 若前两个问题任意一个答案为否，要如何构建类库使其加载生产环境配置？
• 是否支持替换所有位置的客户端密钥？官方文档未找到相关说明，直接全局搜索替换默认密钥是否足够，是否需要修改代码？
• 是否支持将所有localhost引用替换为对应站点（Host/API、IdentityServer、Web、Web.Public）的全限定域名（FQDN）？分层模板部署是否必须完成该配置？当前采用IIS部署，未使用Docker或Kubernetes。
• 部署过程中还有哪些容易遗漏的注意事项？

前期排查时，在ABP框架官网、ABP商业版官网、社区论坛、Discord频道均未找到对应的部署指南或检查清单；查阅微软官方ASP.NET Core 6.0配置、环境相关文档后，对ASP.NET Core配置机制有了基础了解，但仍未找到类库生产环境配置的明确答案。

实测验证的可行方案 #

经实际部署验证，仅需在所有可部署项目中添加appsettings.Production.json文件即可，类库项目不需要单独创建配置文件，类库依赖的配置项全部汇总到对应宿主项目的生产配置文件中就能正常加载。

实操核心注意事项：

• IdentityServer数据库表的一次性种子数据初始化是极易遗漏的关键步骤，部署后需第一时间执行，否则会出现权限、客户端认证相关异常。
• 客户端密钥无需修改业务代码，全局替换所有配置文件中的默认密钥即可生效。
• IIS部署场景下必须将所有配置中的localhost引用替换为各站点对应的全限定域名，否则会出现跨域、回调地址校验不通过、服务间调用失败等问题。
• 服务器端除配置对应环境变量外，还需确认部署账号有数据库读写权限、站点对应IIS应用池有站点目录读写权限、HTTPS证书已正确加载到服务器信任存储区。

多环境一键数据库迁移方案 #

通过DbMigrator项目的配置可实现多环境一键执行迁移，无需手动修改连接字符串：

1. 右键点击DbMigrator项目，选择「属性」，进入Debug分类的启动配置文件编辑器
2. 分别创建本地开发、生产环境两个启动配置文件，可按需为各预发布（staging）环节新增对应配置，删除默认以项目名/命名空间命名的冗余配置
3. 开发环境配置核心为添加环境变量ASPNETCORE_ENVIRONMENT=Development，生产环境配置核心为添加环境变量ASPNETCORE_ENVIRONMENT=Production
4. 配置保存后会自动在项目Properties文件夹下生成launchSettings.json文件，也可手动创建该文件夹及文件，参考配置内容如下：

{
  "profiles": {
    "EnvironmentConfiguration.Cli (Development)": {
      "commandName": "Project",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },
    "EnvironmentConfiguration.Cli (Production)": {
      "commandName": "Project",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Production"
      }
    }
  }
}

执行迁移时，只需将DbMigrator项目设为启动项目，即可在调试菜单选择对应环境的启动配置一键执行迁移。

内容的提问来源于stack exchange，提问作者jlavallet