新手使用 ABP 框架及注意事项：纯后端视角(新手必看：ABP框架纯后端使用指南及注意事项)

原创

ithorizon 6个月前 (10-20) 阅读数 25 #后端开发

标题：新手必看：ABP框架纯后端使用指南及注意事项

一、引言

ABP（ASP.NET Boilerplate）框架是一个开源的、跨平台的、基于ASP.NET Core的应用程序框架。它旨在帮助开发者飞速构建模块化、可扩展和易于维护的应用程序。本文将针对新手在使用ABP框架进行纯后端开发时，提供一份详细的指南及注意事项。

二、ABP框架的核心概念

在起始使用ABP框架之前，了解其核心概念是非常重要的。以下是ABP框架的几个关键概念：

模块化：ABP框架鼓励开发者将应用程序分解为模块，以便更好地管理和扩展。

依靠注入：ABP框架内置了依靠注入功能，便于管理类之间的依靠关系。

领域驱动设计（DDD）：ABP框架采用领域驱动设计，将业务逻辑、数据访问和UI分离。

多租户：ABP框架拥护多租户应用程序，使一个应用程序可以服务于多个客户。

三、搭建开发环境

在使用ABP框架进行开发之前，需要确保开发环境已正确搭建。以下是一些基本步骤：

安装.NET Core SDK：可以从.NET官网下载并安装。

安装Visual Studio或Visual Studio Code：这两款IDE都拥护.NET Core开发。

安装ABP CLI：可以使用npm或yarn全局安装ABP CLI工具。

四、创建ABP项目

使用ABP CLI工具，可以飞速创建一个ABP项目。以下是创建项目的步骤：

abp new MyProject -t aspnetcore -s ui-mvc

其中，MyProject 是项目名称，-t aspnetcore 即创建基于ASP.NET Core的项目，-s ui-mvc 即创建带有MVC UI层的项目。

五、项目结构

创建完成后，项目结构如下：

MyProject/

├── MyProject.Application/

│ ├── MyProject.Application.csproj

│ └── ...

├── MyProject.Core/

│ ├── MyProject.Core.csproj

│ └── ...

├── MyProject.EntityFrameworkCore/

│ ├── MyProject.EntityFrameworkCore.csproj

│ └── ...

├── MyProject.Web/

│ ├── MyProject.Web.csproj

│ └── ...

└── MyProject.Web.Mvc/

├── MyProject.Web.Mvc.csproj

└── ...

以下是各个项目的简要说明：

MyProject.Application：包含应用程序的业务逻辑。

MyProject.Core：包含应用程序的核心业务逻辑和领域模型。

MyProject.EntityFrameworkCore：包含数据访问层，使用Entity Framework Core。

MyProject.Web：包含应用程序的Web API。

MyProject.Web.Mvc：包含应用程序的MVC UI层。

六、编写业务逻辑

在ABP框架中，业务逻辑重点位于MyProject.Application项目中。以下是一个单纯的业务逻辑示例：


public interface IMyService
{
    Task<MyOutput> GetMyDataAsync();
}
public class MyService : IMyService
{
    public async Task<MyOutput> GetMyDataAsync()
    {
        // 模拟数据获取
        var data = await _myRepository.GetAllListAsync();
        // 返回因此
        return new MyOutput
        {
            Data = data
        };
    }
}

在上面的示例中，IMyService 是一个接口，定义了获取数据的方法。MyService 类实现了这个接口，并在其中编写了获取数据的逻辑。

七、数据访问层

在ABP框架中，数据访问层重点位于MyProject.EntityFrameworkCore项目中。以下是一个单纯的数据访问层示例：


public interface IMyRepository : IRepository<MyEntity>
{
}
public class MyRepository : Repository<MyEntity>, IMyRepository
{
    public MyRepository(IDbContextProvider<MyDbContext> dbContextProvider)
        : base(dbContextProvider)
    {
    }
}

在上面的示例中，IMyRepository 是一个接口，继承自IRepository<MyEntity>。MyRepository 类实现了这个接口，并使用了Entity Framework Core的Repository<MyEntity>类作为基类。

八、依靠注入

ABP框架内置了依靠注入功能，可以通过以下做法在项目中注册和使用依靠：


public class MyService : IMyService
{
    private readonly IMyRepository _myRepository;
    public MyService(IMyRepository myRepository)
    {
        _myRepository = myRepository;
    }
    // 业务逻辑...
}
// 在Startup.cs中注册依靠
services.AddScoped<IMyService, MyService>();
services.AddScoped<IMyRepository, MyRepository>();

在上面的示例中，MyService 类通过构造函数注入了IMyRepository 依靠。在Startup.cs 文件中，我们注册了这两个依靠，以便在应用程序中使用。