ASP.NET MVC使用EF脚手架生成控制器时抛出System.InvalidOperationException求助

错误信息 #

运行代码生成器时出现错误：

There was an error running the selected code generator:
'Exception of type 'System.InvalidOperationException' was thrown.'

控制台输出：

Finding the generator 'controller'...
Running the generator 'controller'...
Minimal hosting scenario!
Exception of type 'System.InvalidOperationException' was thrown.
at Microsoft.VisualStudio.Web.CodeGeneration.ActionInvoker.<BuildCommandLine>b__6_0()
at Microsoft.Extensions.CommandLineUtils.CommandLineApplication.Execute(String[] args)
at Microsoft.VisualStudio.Web.CodeGeneration.ActionInvoker.Execute(String[] args)
at Microsoft.VisualStudio.Web.CodeGeneration.CodeGenCommand.Execute(String[] args)

解决方案 #

以下是针对该问题的排查和修复步骤：

• 检查DbContext配置
  确保你的DbContext类包含接受DbContextOptions的构造函数，并且在项目的服务配置中正确注册：

  public class AppDbContext : DbContext
  {
      public AppDbContext(DbContextOptions<AppDbContext> options) : base(options)
      {
      }
  
      // 定义你的DbSet
      public DbSet<YourModel> YourModels { get; set; }
  }
  

  在Program.cs中注册DbContext服务：

  builder.Services.AddDbContext<AppDbContext>(options =>
      options.UseSqlServer(builder.Configuration.GetConnectionString("DefaultConnection")));
  

• 清理重建项目并重置VS缓存
  执行命令清理和重建项目：

  dotnet clean
  dotnet build
  

  关闭并重新打开Visual Studio，清除可能存在的缓存问题。

• 确认脚手架工具版本匹配
  检查全局dotnet-aspnet-codegenerator工具版本是否与项目SDK版本一致：

  dotnet tool list --global
  

  若版本不匹配，更新工具：

  dotnet tool update --global dotnet-aspnet-codegenerator
  

• 使用命令行手动生成控制器
  绕过Visual Studio UI，直接用命令行生成控制器，避免UI层面的问题：

  dotnet aspnet-codegenerator controller -name YourController -m YourModel -dc AppDbContext --relativeFolderPath Controllers --useDefaultLayout --referenceScriptLibraries
  

  将YourController、YourModel、AppDbContext替换为你项目中的实际名称。

• 验证数据库连接字符串
  检查appsettings.json中的连接字符串是否正确，确保能正常连接到数据库：

  "ConnectionStrings": {
      "DefaultConnection": "Server=(localdb)\\mssqllocaldb;Database=YourDatabaseName;Trusted_Connection=True;MultipleActiveResultSets=true"
  }
  

  可以尝试通过DbContext手动初始化数据库，验证连接有效性。

• 检查模型类的主键配置
  确保你的实体模型包含主键属性，EF需要主键才能生成完整的控制器脚手架：

  public class YourModel
  {
      // 主键可以是Id或[ModelName]Id格式，也可通过[Key]标记
      public int Id { get; set; }
      // 其他属性
      public string Name { get; set; }
  }
  

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