ABP vNext 框架(ABP-234)是一个全栈企业级应用程序开发框架,由微软 MVP 队员尤雨溪和众多志愿开发者共同开发。该框架拥有全面而丰富的功能,并且易于使用和扩展。本文将从多个方面详细阐述 ABP vNext 框架的特点和使用,包括模块化设计、依赖注入、实体框架集成、身份认证和授权、前端开发支持等。
一、模块化设计
ABP-234框架采用模块化设计,将应用程序的各个部分封装在不同的模块中,便于开发、测试和维护。每个模块都具有相应的命名空间、依赖关系和配置文件,使用者可以根据自己的需求自由地选择和组合模块。ABP-234框架内置了众多的模块,如日志记录模块、应用程序设置模块、身份认证模块等等,用户也可以自行开发和集成第三方模块。此外,ABP-234框架还提供了丰富的工具和 API,使得开发者可以方便地管理和部署模块。
// 示例:创建一个自定义模块
[DependsOn(typeof(AbpEntityFrameworkCoreModule))]
public class MyModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
Configure
(options =>
{
options.UseSqlServer();
});
}
public override void OnApplicationInitialization(ApplicationInitializationContext context)
{
context.ServiceProvider.GetService<ILogger<MyModule>>().LogInformation("MyModule initialized.");
}
}
二、依赖注入
ABP-234框架内置了一个轻量级的依赖注入容器,可以方便地管理应用程序中的对象和服务。该容器可以自动解决对象的依赖关系,支持对象池、生命周期管理等高级配置。用户可以在启动时注册依赖项、对象或服务,并在运行时获取它们。
// 示例:注册服务
public class MyService : ITransientDependency
{
public void DoSomething()
{
Console.WriteLine("Hello, World!");
}
}
public class MyController : Controller
{
private readonly MyService _myService;
public MyController(MyService myService)
{
_myService = myService;
}
public IActionResult Index()
{
_myService.DoSomething();
return View();
}
}
[DependsOn(typeof(AbpAspNetCoreMvcModule))]
public class MyAspNetCoreModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
context.Services.AddTransient<MyService>();
}
}
三、实体框架集成
ABP-234框架集成了 Entity Framework Core 来处理数据访问层。该框架提供了强大的 CRUD 操作、查询表达式、缓存等功能,并且支持多种数据库引擎。用户可以使用 LINQ 或者原始 SQL 来查询数据。框架内置了各种数据过滤器,包括软删除支持、多租户支持等等。
// 示例:实体框架集成
public class MyDbContext : AbpDbContext<Tenant, Role, User, MyDbContext>
{
public DbSet<TestEntity> TestEntities { get; set; }
public MyDbContext(DbContextOptions<MyDbContext> options) : base(options)
{
}
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
base.OnModelCreating(modelBuilder);
modelBuilder.Entity<TestEntity>().Property(e => e.Name).HasMaxLength(64);
}
}
public class TestEntity : FullAuditedEntity
{
public string Name { get; set; }
}
[DependsOn(typeof(AbpEntityFrameworkCoreModule))]
public class MyModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
var configuration = context.Services.GetConfiguration();
Configure<AbpDbContextOptions>(options =>
{
options.UseSqlServer(configuration.GetConnectionString("Default"));
});
}
}
四、身份认证和授权
ABP-234框架为用户身份认证和授权提供了全面的支持,并且提供了简单易用的身份认证 API。该框架支持多种身份认证方案,如基于 JWT、IdentityServer4、Google、Facebook 和 Microsoft 的身份认证方案。用户可以使用预定义的身份验证器或者自定义身份验证器。该框架还支持授权策略和声明,可以方便地控制用户的访问权限。
// 示例:身份认证和授权
[Authorize]
public class MyController : Controller
{
private readonly IMyAppService _myAppService;
public MyController(IMyAppService myAppService)
{
_myAppService = myAppService;
}
[HttpGet("{id:int}")]
public async Task<TestEntity> GetTest(int id)
{
return await _myAppService.GetTestByIdAsync(id);
}
}
public class MyAppService : ApplicationService
{
private readonly IRepository<TestEntity> _testRepository;
public MyAppService(IRepository<TestEntity> testRepository)
{
_testRepository = testRepository;
}
public async Task<TestEntity> GetTestByIdAsync(int id)
{
var entity = await _testRepository.GetAsync(id);
return entity;
}
}
[DependsOn(
typeof(AbpIdentityServerDomainModule),
typeof(AbpAccountHttpApiModule),
typeof(MyModule)
)]
public class MyIdentityServerModule : AbpModule
{
public override void PreConfigureServices(ServiceConfigurationContext context)
{
PreConfigure<IdentityServerAuthenticationOptions>(options =>
{
options.Authority = "https://localhost:5001";
options.ApiName = "myapi";
options.RequireHttpsMetadata = false;
});
PreConfigure<JwtBearerOptions>(options =>
{
options.Authority = "https://localhost:5001";
options.Audience = "myapi";
options.RequireHttpsMetadata = false;
});
}
public override void ConfigureServices(ServiceConfigurationContext context)
{
var configuration = context.Services.GetConfiguration();
Configure<AbpJwtSettings>(options =>
{
options.Issuer = configuration["Authentication:JwtBearer:Issuer"];
options.Audience = configuration["Authentication:JwtBearer:Audience"];
options.SigningKey = configuration["Authentication:JwtBearer:SigningKey"];
});
Configure<AbpIdentityServerOptions>(options =>
{
options.ConfigureClients = ConfigureClients;
options.ConfigureApiResources = ConfigureApiResources;
options.ConfigureIdentityResources = ConfigureIdentityResources;
});
}
private void ConfigureClients(List<IdentityServer4.Models.Client> clients)
{
clients.Add(new IdentityServer4.Models.Client
{
ClientId = "myclient",
ClientName = "My Client",
AccessTokenLifetime = 3600,
AllowedGrantTypes = GrantTypes.Implicit,
RedirectUris =
{
"https://localhost:5002/signin-oidc"
},
PostLogoutRedirectUris =
{
"https://localhost:5002/signout-callback-oidc"
},
AllowedScopes =
{
"openid",
"profile",
"email",
"myapi"
},
RequireConsent = false
});
}
private void ConfigureApiResources(List<IdentityServer4.Models.ApiResource> apis)
{
apis.Add(new IdentityServer4.Models.ApiResource("myapi", "My API"));
}
private void ConfigureIdentityResources(List<IdentityServer4.Models.IdentityResource> resources)
{
resources.AddRange(new[]
{
new IdentityServer4.Models.IdentityResources.OpenId(),
new IdentityServer4.Models.IdentityResources.Profile(),
new IdentityServer4.Models.IdentityResources.Email()
});
}
}
五、前端开发支持
ABP-234框架提供多种前端开发支持,包括 Razor 页面、Angular、Vue 等框架。该框架集成了对开发人员友好的响应式设计和国际化支持。开发者可以使用本地化 API 快速创建多语言 UI。
// 示例:前端开发支持
<div>
<label asp-for="Name"></label>
<input asp-for="Name" class="form-control" />
</div>
[AutoValidateAntiforgeryToken]
public async Task<JsonResult> Create(CreateInputDto input)
{
await _testAppService.CreateAsync(input);
return Json(new { success = true });
}
[DependsOn(typeof(AbpAspNetCoreMvcModule))]
public class MyAspNetCoreModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
Configure<AbpMvcOptions>(options =>
{
options.ConventionalControllers.Create(typeof(MyModule).Assembly, setting =>
{
setting.RootPath = "api/MyApp";
});
});
}
}
通过以上阐述,我们可以看出,ABP vNext框架(ABP-234)具有很多优秀的功能和特点,无论是在模块化设计、依赖注入、实体框架集成、身份认证和授权甚至是前端开发支持方面,都有着出色的表现。ABP vNext框架在实际开发中,能够大幅提升开发效率和代码质量,推荐使用。