dotnet
abp
microservice
netcore6
This is third post of the series: .NET Microservice with ABP
Posts in the Series
Part 3. Administration Service (this post)
Part 8. Identity server and Angular App
Table of contents
- Setup Administration service
- Add the shared project as a reference to the host
- Update the connection string
- Update the
AdministrationServiceHttpApiHostModule - Create the
DbContextFactoryin the EntityFrameworkCore project - Update the
AdministrationServiceDbContext - Update the
AdministrationServiceEntityFrameworkCoreModule - Prepare for the migration
- Migration
Setup Administration service
Adminstration service is where we uses Audit log, feature, settings and permission management modules. We will use a separate database to store everything in the administration service.
Add the shared project as a reference to the host
We need to add shared project as the reference to the Administration service. once this is added we can do some cleanup in the host module of the administration.
<ProjectReference Include="..\..\..\..\shared\Tasky.Shared.Hosting\Tasky.Shared.Hosting.csproj" />
Update the connection string
User ID=postgres;Password=postgres;Host=localhost;Port=5432;Database=AdministrationService;Pooling=false;
Update the AdministrationServiceHttpApiHostModule
Update the depends on with the shared module. Once the shared module is added then we can removed most of the modules in the host module. Below is how the final depends on looks like.
[DependsOn(
typeof(TaskyHostingModule),
typeof(AdministrationServiceApplicationModule),
typeof(AdministrationServiceEntityFrameworkCoreModule),
typeof(AdministrationServiceHttpApiModule),
)]
Remove the things which are configured in the shared project.
Create the DbContextFactory in the EntityFrameworkCore project
We need to create a Factory class for the DbContext so that we can create migration in the EfCore project. this is necessary to build the configuration form the host project.
using System.IO;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Design;
using Microsoft.Extensions.Configuration;
namespace Tasky.AdministrationService.EntityFrameworkCore;
public class AdministrationServiceDbContextFactory : IDesignTimeDbContextFactory<AdministrationServiceDbContext>
{
public AdministrationServiceDbContext CreateDbContext(string[] args)
{
var builder = new DbContextOptionsBuilder<AdministrationServiceDbContext>()
.UseNpgsql(GetConnectionStringFromConfiguration());
return new AdministrationServiceDbContext(builder.Options);
}
private static string GetConnectionStringFromConfiguration()
{
return BuildConfiguration()
.GetConnectionString(AdministrationServiceDbProperties.ConnectionStringName);
}
private static IConfigurationRoot BuildConfiguration()
{
var builder = new ConfigurationBuilder()
.SetBasePath(
Path.Combine(
Directory.GetParent(Directory.GetCurrentDirectory())?.Parent!.FullName!,
$"host{Path.DirectorySeparatorChar}Tasky.AdministrationService.HttpApi.Host"
)
)
.AddJsonFile("appsettings.json", false);
return builder.Build();
}
}
Update the AdministrationServiceDbContext
In the DbContext we need to updated it with the DbContext of the modules. We have added 4 modules in the administration service and all modules have a db context. So we have to inherit from the db context of the modules. this is add the DBSet of the modules to the administration module.
using Microsoft.EntityFrameworkCore;
using Volo.Abp.Data;
using Volo.Abp.EntityFrameworkCore;
using Volo.Abp.AuditLogging.EntityFrameworkCore;
using Volo.Abp.FeatureManagement.EntityFrameworkCore;
using Volo.Abp.PermissionManagement.EntityFrameworkCore;
using Volo.Abp.SettingManagement.EntityFrameworkCore;
using Volo.Abp.AuditLogging;
using Volo.Abp.FeatureManagement;
using Volo.Abp.PermissionManagement;
using Volo.Abp.SettingManagement;
namespace Tasky.AdministrationService.EntityFrameworkCore;
[ConnectionStringName(AdministrationServiceDbProperties.ConnectionStringName)]
public class AdministrationServiceDbContext : AbpDbContext<AdministrationServiceDbContext>,
IPermissionManagementDbContext,
ISettingManagementDbContext,
IFeatureManagementDbContext,
IAuditLoggingDbContext,
IAdministrationServiceDbContext
{
/* Add DbSet for each Aggregate Root here. Example:
* public DbSet<Question> Questions { get; set; }
*/
public AdministrationServiceDbContext(DbContextOptions<AdministrationServiceDbContext> options)
: base(options)
{
}
public DbSet<AuditLog> AuditLogs { get; set; }
public DbSet<FeatureValue> FeatureValues { get; set; }
public DbSet<PermissionGrant> PermissionGrants { get; set; }
public DbSet<Setting> Settings { get; set; }
protected override void OnModelCreating(ModelBuilder builder)
{
base.OnModelCreating(builder);
builder.ConfigureAdministrationService();
builder.ConfigurePermissionManagement();
builder.ConfigureSettingManagement();
builder.ConfigureAuditLogging();
builder.ConfigureFeatureManagement();
}
}
Update the AdministrationServiceEntityFrameworkCoreModule
This is the final setup before creating the migration. we have to inform the ef core that we are using postgres as database. we can do that configuring AbpDbContextOptions and replace the db context of the modules with the administration db context.
using Microsoft.Extensions.DependencyInjection;
using Volo.Abp.EntityFrameworkCore;
using Volo.Abp.Modularity;
using Volo.Abp.AuditLogging.EntityFrameworkCore;
using Volo.Abp.FeatureManagement.EntityFrameworkCore;
using Volo.Abp.PermissionManagement.EntityFrameworkCore;
using Volo.Abp.SettingManagement.EntityFrameworkCore;
using System;
namespace Tasky.AdministrationService.EntityFrameworkCore;
[DependsOn(
typeof(AdministrationServiceDomainModule),
typeof(AbpEntityFrameworkCoreModule)
)]
[DependsOn(typeof(AbpAuditLoggingEntityFrameworkCoreModule))]
[DependsOn(typeof(AbpFeatureManagementEntityFrameworkCoreModule))]
[DependsOn(typeof(AbpPermissionManagementEntityFrameworkCoreModule))]
[DependsOn(typeof(AbpSettingManagementEntityFrameworkCoreModule))]
public class AdministrationServiceEntityFrameworkCoreModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
Configure<AbpDbContextOptions>(options =>
{
options.UseNpgsql();
});
AppContext.SetSwitch("Npgsql.EnableLegacyTimestampBehavior", true);
context.Services.AddAbpDbContext<AdministrationServiceDbContext>(options =>
{
options.ReplaceDbContext<IPermissionManagementDbContext>();
options.ReplaceDbContext<ISettingManagementDbContext>();
options.ReplaceDbContext<IFeatureManagementDbContext>();
options.ReplaceDbContext<IAuditLoggingDbContext>();
options.AddDefaultRepositories(true);
});
}
}
Prepare for the migration
Add the ef core design nuget for the migrations.
<PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="6.0.1">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
Once this is created delete EntityFrameworkCore folder can be created from the host project.
Migration
To create migrations
dotnet ef migrations add Init
To update database
dotnet ef database update
