如何为ASP.NET Boilerplate的每个插件创建独立DbContext与UI

一、独立DbContext的实现 #

• 拆分插件项目结构：给每个插件创建独立的类库集合，至少包含[PluginName].Core（存放实体、服务接口）和[PluginName].EntityFrameworkCore（存放DbContext与数据访问逻辑）两个项目，彻底与主项目代码解耦。
• 定义插件专属实体：在[PluginName].Core中创建实体类，继承ABP框架的Entity或FullAuditedEntity等基类，示例代码：

  public class PluginProduct : FullAuditedEntity<int>
  {
      public string Name { get; set; }
      public decimal Price { get; set; }
  }
  

• 创建独立DbContext：在[PluginName].EntityFrameworkCore中实现专属DbContext，继承AbpDbContext<[PluginName]DbContext>，并在OnModelCreating中配置实体映射：

  [DependsOn(typeof(AbpEntityFrameworkCoreModule))]
  public class PluginNameEntityFrameworkCoreModule : AbpModule
  {
      public override void PreInitialize()
      {
          Configuration.Modules.AbpEfCore().AddDbContext<PluginNameDbContext>(options =>
          {
              if (options.ExistingConnection != null)
              {
                  PluginNameDbContextConfigurer.Configure(options.DbContextOptions, options.ExistingConnection);
              }
              else
              {
                  PluginNameDbContextConfigurer.Configure(options.DbContextOptions, options.ConnectionString);
              }
          });
      }
  
      public override void Initialize()
      {
          IocManager.RegisterAssemblyByConvention(typeof(PluginNameEntityFrameworkCoreModule).GetAssembly());
      }
  }
  
  public class PluginNameDbContext : AbpDbContext<PluginNameDbContext>
  {
      public DbSet<PluginProduct> PluginProducts { get; set; }
  
      public PluginNameDbContext(DbContextOptions<PluginNameDbContext> options)
          : base(options)
      {
      }
  
      protected override void OnModelCreating(ModelBuilder modelBuilder)
      {
          base.OnModelCreating(modelBuilder);
          modelBuilder.Entity<PluginProduct>(b =>
          {
              b.ToTable("PluginProducts");
              b.Property(p => p.Name).IsRequired().HasMaxLength(128);
          });
      }
  }
  

• 独立数据库迁移：针对插件DbContext单独生成迁移脚本，使用Package Manager Console命令：

  Add-Migration InitialPluginNameMigration -Context PluginNameDbContext
  Update-Database -Context PluginNameDbContext
  

  也可在插件模块的Initialize方法中自动执行迁移，确保插件启动时数据库结构就绪。

二、独立UI的实现 #

基于MVC的UI方案 #

• 创建插件Web类库：新建[PluginName].Web类库项目，引用主项目的ABP Web模块及插件Core项目。
• 实现插件专属控制器与视图：控制器继承AbpController，利用ABP的权限、本地化特性，示例代码：

  [AbpAuthorize("PluginName.ManageProducts")]
  public class PluginProductsController : AbpController
  {
      private readonly IPluginProductAppService _productAppService;
  
      public PluginProductsController(IPluginProductAppService productAppService)
      {
          _productAppService = productAppService;
      }
  
      public async Task<IActionResult> Index()
      {
          var products = await _productAppService.GetAllAsync();
          return View(products);
      }
  }
  

  视图文件放在插件项目的Views目录下，ABP框架会自动识别插件视图路径。
• 配置独立路由：在插件Web模块的PreInitialize方法中注册路由，设置专属前缀避免冲突：

  public override void PreInitialize()
  {
      Configuration.Navigation.Providers.Add<PluginNameNavigationProvider>();
      Configuration.Modules.AbpMvc().Routes.MapRoute(
          name: "PluginName_default",
          template: "plugin-name/{controller=Home}/{action=Index}/{id?}"
      );
  }
  

• 隔离静态资源：插件的CSS、JS等静态资源放在wwwroot/plugin-name目录下，引用时使用相对路径，避免与主项目资源冲突。

基于Angular的UI方案 #

• 创建插件Angular模块：在前端项目中新建plugin-name目录，创建独立的Angular模块PluginNameModule，导入ABP核心模块：

  @NgModule({
    imports: [
      CommonModule,
      AbpModule,
      RouterModule.forChild([
        {
          path: 'plugin-name',
          component: PluginProductListComponent,
          canActivate: [AbpAuthGuard],
          data: { requiredPermissions: ['PluginName.ManageProducts'] }
        }
      ])
    ],
    declarations: [PluginProductListComponent]
  })
  export class PluginNameModule { }
  

• 注册插件模块：在主Angular模块中动态导入插件模块，或通过ABP插件机制加载。
• 独立资源管理：插件的组件样式、图片等资源放在模块目录内，利用Angular组件样式隔离特性按需调整。

关键注意事项 #

• 依赖注入隔离：插件模块通过DependsOn声明依赖，确保插件的DbContext、服务等仅在插件内部或授权范围内可用。
• 权限独立配置：在插件Core模块中定义专属权限，主项目无需修改权限配置，ABP权限系统会自动合并权限项。

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