.NET 5 Web API使用EF Core DB First创建模型问题咨询

一、项目结构合理性判断及企业级结构建议 #

你当前的分层思路方向正确，但存在职责混淆、边界不清晰的问题，企业级.NET 5 Web API 通常采用以下分层结构，可对应调整你现有项目：

• 入口API层（对应你现有存放控制器的项目）：仅负责请求路由、基础参数校验、统一响应封装、全局中间件注册、依赖注入配置，不包含任何业务逻辑、数据访问逻辑，该层只引用抽象层、业务层（如果拆分的话）。
• 核心抽象层（对应你现有存放接口定义的类库）：除接口定义外，统一存放跨层使用的DTO、枚举、公共常量、业务抽象约定，该层不依赖任何其他实现类库，所有上层、下层项目均可引用该层。注意数据库实体不要和DTO存放在同一项目，DTO是面向接口契约的，数据库实体是面向表结构的，两者字段、属性不一定完全一致，混放会导致表结构变动直接破坏接口兼容性。
• 数据实体层（对应你现有计划存放EF Core生成模型的类库）：仅存放EF Core自动脚手架生成的数据库实体类、DbContext类，禁止手动修改该目录下自动生成的任何代码，所有自定义逻辑通过分部类实现。
• 数据访问层（对应你现有编写EF Core数据操作逻辑的类库）：存放仓储实现、EF Core查询配置、事务逻辑、存储过程调用封装，该层引用核心抽象层、数据实体层，实现抽象层定义的数据访问接口，不反向引用入口API层。
• 可选业务逻辑层：如果项目业务规则复杂，可单独拆分类库存放核心业务逻辑，不直接依赖EF Core相关包，仅引用抽象层、数据访问层，避免业务逻辑和数据访问逻辑耦合。

二、指定Scaffold-DbContext生成目标项目的操作方法 #

生成的文件落到API项目，是因为执行命令时未指定生成目标项目，EF Core工具默认使用包管理器控制台（PMC）选中的默认项目作为生成目标，用解决方案配置的启动项目作为工具运行时载体。按以下步骤操作即可生成到指定项目：

1. 先确认你存放实体的类库项目已经安装以下NuGet包：
   • Microsoft.EntityFrameworkCore.SqlServer
   • Microsoft.EntityFrameworkCore.Design
   • Microsoft.EntityFrameworkCore.Tools
2. 执行脚手架命令时，通过参数明确指定生成项目和启动项目，参考命令如下：

Scaffold-DbContext "Server=.;Database=BookStore;Trusted_Connection=True;" Microsoft.EntityFrameworkCore.SqlServer 
-Project 你的数据实体类库项目名称 
-StartupProject 你的入口API项目名称 
-OutputDir Entities 
-ContextDir DbContexts

参数说明：

• -Project：指定实体、DbContext代码生成的目标项目
• -StartupProject：指定EF Core设计时工具运行使用的启动项目（通常选入口API项目即可，因为该项目有完整的运行配置）
• -OutputDir：指定实体类在目标项目下的存放目录
• -ContextDir：指定DbContext类在目标项目下的存放目录

如果使用.NET CLI命令执行，先切到数据实体类库的项目目录，执行命令时添加--startup-project ../你的入口API项目路径参数即可。

三、后续表/存储过程增量更新、不覆盖自定义逻辑的方案 #

严格遵循以下规则，即可在增量更新模型时不破坏已有逻辑：

1. 所有自定义逻辑通过分部类（partial class）实现
   EF Core脚手架生成的实体、DbContext默认都是分部类，你需要添加的验证特性、自定义属性、扩展方法，全部在实体项目下单独新建PartialExtensions目录，创建同名分部类编写，和自动生成的文件完全分开。只要不修改自动生成目录下的文件，后续执行脚手架命令覆盖自动生成文件时，你自定义的分部类代码完全不受影响，编译时会自动和自动生成的类合并。
   举个例子：自动生成的Book.cs存放在Entities目录，你需要给Book类加必填验证，就在PartialExtensions目录下新建同名Book.cs，保持命名空间和自动生成类一致，编写public partial class Book后添加对应特性即可。
2. 增量更新时按需指定生成范围，不要全量覆盖

• 新增表时，执行脚手架命令添加-Tables 表名1,表名2,新表名参数，只指定需要生成的表，不要不加参数全库生成，避免拉取不需要的系统表、临时表。
• 仅需要更新已有表结构时，再添加-Force参数覆盖对应表的自动生成代码，不指定-Force时，已存在的自动生成文件不会被覆盖。

3. 存储过程逻辑不要写在自动生成的DbContext中，同样在自定义的分部DbContext类中添加存储过程的执行方法、结果映射，后续更新模型时这部分逻辑不会被覆盖。
4. 接口入参、出参统一使用核心抽象层定义的DTO，通过AutoMapper等工具做实体和DTO的映射，不要直接返回数据库实体，就算数据库实体结构随表变动，只要调整映射规则，上层接口契约、已有的参数验证逻辑不会受影响。

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