C# Abp框架入门系列文章(一)(上)

简介: C# Abp框架入门系列文章(一)

随着技术的进步,各式各样的框架层出不穷,轮子越来越多,那么有没有哪些优秀的开发框架供我们使用呢?如果我们能够将各方面优秀的框架集合起来,应用到项目开发中,我们的工作是不是能事半功倍呢?而且各个框架的使用方向不同,很多配置也不同,如果能够将繁杂的基础工作集成起来,由统一的框架来完成,那么我们就可以专注于业务逻辑,提高工作效率。现在Abp就是这么一个框架,使用流行技术开发现代web应用程序的最佳实践。本文作为Abp框架的入门文章,仅供学习分享使用,如有不足之处,还请指正。

什么是Abp?

ABP是“ASP.NET Boilerplate Project (ASP.NET样板项目)”的简称。

ASP.NET Boilerplate是一个用最佳实践和流行技术开发现代WEB应用程序的新起点,它旨在成为一个通用的WEB应用程序框架和项目模板。ABP是基于最新的ASP.NET CORE,ASP.NET MVC和Web API技术的应用程序框架。并使用流行的框架和库,它提供了便于使用的授权,依赖注入,验证,异常处理,本地化,日志记录,缓存等常用功能。

Abp架构

ABP实现了多层架构(领域层,应用层,基础设施层和表示层),以及领域驱动设计(实体,存储库,领域服务,应用程序服务,DTO等)。还实现和提供了良好的基础设施来实现最佳实践,如依赖注入。

了解了Abp框架的基础知识之后,让我们一步一步的搭建Abp框架,并实现一个简单的小例子。

安装CLI

输入cmd打开命令行窗口,然后输入以下命令,安装Abp.Cli,如下所示:

dotnet tool install -g Volo.Abp.Cli

安装过程,如下图所示:

创建第一个Abp项目

在命令行,切换到程序所在目录【最好是空目录】,然后通过命令进行创建,如下所示:

abp new Acme.BookStore

安装过程,如下图所示:

关于Abp的Cli相关命令,可参考官方文档

项目创建成功后,如下所示:

通过Visual Studio打开解决方案,如下所示:

还原数据库

在Abp解决方案中,通过运行【Acme.BookStore.DbMigrator】进行初始化数据库。该项目是控制台程序,采用Entity Framework的Code First方式迁移数据库。

打开项目【Acme.BookStore.DbMigrator】中 appsettings.json文件,修改数据库连接字符串,为本机连接字符串,如下所示:

将项目设置为启动项目,然后F5(或Ctrl + F5)运行即可。当出现以下页面时,表示数据库迁移成功。如下所示:

数据库还原成功后,打开SQL Server数据库,会多出一个数据库【BookStore】,如下所示:

注意:最新版本的Abp版本为5.0.0,支持的Entity Framework Core版本为6.0,目前已不再支持SQL Server 2008 R2。所以需要升级数据库版本到2012。

运行Abp程序

打开项目【Acme.BookStore.Web】中的appsettings.json文件,修改数据库连接字符串,如下所示:

将项目【Acme.BookStore.Web】设置为启动项目,然后按F5(或Ctrl+F5)运行项目。Visual Studio会自动打开首页【https://localhost:44327/】,如下所示:

在首页上,点击登录【默认用户名 admin,密码 1q2w3E* 】,如下所示:

登录成功后,如下所示:

以上就是Abp最新默认框架示例。接下来让我们一起开发一个图书管理的小功能。

Abp入门示例

1. 创建Book实体类

启动模板中的领域层分为两个项目:

  • Acme.BookStore.Domain包含你的实体, 领域服务和其他核心域对象.
  • Acme.BookStore.Domain.Shared包含可与客户共享的常量,枚举或其他域相关对象.

在解决方案的领域层(Acme.BookStore.Domain项目)中定义实体,如下所示:

在Acme.BookStore.Domain项目中,右键创建文件夹Books,然后新增Book类,如下所示:

namespace Acme.BookStore.Books
{
    public class Book : AuditedAggregateRoot<Guid>
    {
        public string Name { get; set; }
        public BookType Type { get; set; }
        public DateTime PublishDate { get; set; }
        public float Price { get; set; }
    }
}

其中Book继承自AuditedAggregateRoot<Guid>。在Abp中,默认提供了两个实体基类AggregateRootEntity,而AuditedAggregateRoot<Guid>是AggregateRoot的派生类。其中Guid是主键类型。

上述类中用到的BookType为创建的 枚举类型,在Acme.BookStore.Domain.Shared项目中,如下所示:

namespace Acme.BookStore.Books
{
    public enum BookType
    {
        Undefined,
        Adventure,
        Biography,
        Dystopia,
        Fantastic,
        Horror,
        Science,
        ScienceFiction,
        Poetry
    }
}

Book和BookType,如下所示:

2. 将Book实体添加到DbContext中

EF Core需要你将实体和 DbContext 建立关联.最简单的做法是在Acme.BookStore.EntityFrameworkCore项目的BookStoreDbContext类中添加DbSet属性.如下所示:

namespace Acme.BookStore.EntityFrameworkCore
{
    [ReplaceDbContext(typeof(IIdentityDbContext))]
    [ReplaceDbContext(typeof(ITenantManagementDbContext))]
    [ConnectionStringName("Default")]
    public class BookStoreDbContext :
        AbpDbContext<BookStoreDbContext>,
        IIdentityDbContext,
        ITenantManagementDbContext
    {
        /* Add DbSet properties for your Aggregate Roots / Entities here. */
        #region Entities from the modules
        //其他自带的已略去
        /// <summary>
        /// Book示例数据库操作
        /// </summary>
        public DbSet<Book> Books { get; set; }
        #endregion
    }
}

3. 将Book实体映射到数据库表

在本示例中采用Code First方式自动生成数据库,所以需要将实体和数据库表进行映射。在 Acme.BookStore.EntityFrameworkCore 项目中打开 BookStoreDbContextModelCreatingExtensions.cs 文件,添加 Book 实体的映射代码. 最终类应为:

namespace Acme.BookStore.EntityFrameworkCore
{
    public static class BookStoreDbContextModelCreatingExtensions
    {
        public static void ConfigureBookStore(this ModelBuilder builder)
        {
            Check.NotNull(builder, nameof(builder));
            /* Configure your own tables/entities inside here */
            builder.Entity<Book>(b =>
            {
                b.ToTable(BookStoreConsts.DbTablePrefix + "Books",
                          BookStoreConsts.DbSchema);
                b.ConfigureByConvention(); //auto configure for the base class props
                b.Property(x => x.Name).IsRequired().HasMaxLength(128);
            });
        }
    }
}
  • BookStoreConsts 含有用于表的架构和表前缀的常量值. 你不必使用它,但建议在单点控制表前缀.
  • ConfigureByConvention() 方法优雅的配置/映射继承的属性,应始终对你所有的实体使用它.

3. 添加数据迁移

启动模板使用EF Core Code First Migrations创建和维护数据库架构. 我们应该创建一个新的迁移并且应用到数据库.

Acme.BookStore.EntityFrameworkCore 目录打开命令行终端输入以下命令:

dotnet ef migrations add Created_Book_Entity

具体示例如下所示:

上述命令,会添加新的迁移类到项目中,如下所示:

4. 添加种子数据

如果不需要通过代码添加种子数据,可以跳过,建议遵循步骤操作,以熟悉Abp框架。在 Acme.BookStore.Domain 项目下创建派生 IDataSeedContributor 的类,并且拷贝以下代码:

namespace Acme.BookStore.Books
{
    public class BookStoreDataSeederContributor
        : IDataSeedContributor, ITransientDependency
    {
        private readonly IRepository<Book, Guid> _bookRepository;
        public BookStoreDataSeederContributor(IRepository<Book, Guid> bookRepository)
        {
            _bookRepository = bookRepository;
        }
        public async Task SeedAsync(DataSeedContext context)
        {
            if (await _bookRepository.GetCountAsync() <= 0)
            {
                await _bookRepository.InsertAsync(
                    new Book
                    {
                        Name = "1984",
                        Type = BookType.Dystopia,
                        PublishDate = new DateTime(1949, 6, 8),
                        Price = 19.84f
                    },
                    autoSave: true
                );
                await _bookRepository.InsertAsync(
                    new Book
                    {
                        Name = "The Hitchhiker's Guide to the Galaxy",
                        Type = BookType.ScienceFiction,
                        PublishDate = new DateTime(1995, 9, 27),
                        Price = 42.0f
                    },
                    autoSave: true
                );
            }
        }
    }
}
  • 如果数据库中当前没有图书,则此代码使用 IRepository<Book, Guid>(默认为repository)将两本书插入数据库.
相关文章
|
18天前
|
数据可视化 网络协议 C#
C#/.NET/.NET Core优秀项目和框架2024年3月简报
公众号每月定期推广和分享的C#/.NET/.NET Core优秀项目和框架(每周至少会推荐两个优秀的项目和框架当然节假日除外),公众号推文中有项目和框架的介绍、功能特点、使用方式以及部分功能截图等(打不开或者打开GitHub很慢的同学可以优先查看公众号推文,文末一定会附带项目和框架源码地址)。注意:排名不分先后,都是十分优秀的开源项目和框架,每周定期更新分享(欢迎关注公众号:追逐时光者,第一时间获取每周精选分享资讯🔔)。
|
1月前
|
存储 编译器 数据处理
C#基础入门之数据类型
C#基础入门之数据类型
|
7天前
|
IDE 程序员 C#
C#编程入门:从零开始的旅程
【4月更文挑战第20天】本文引导初学者入门C#编程,从环境搭建开始,推荐使用Visual Studio Community版作为IDE。接着,通过编写&quot;Hello, World!&quot;程序,介绍基本语法,包括数据类型、运算符和表达式。文章还涉及控制结构、函数和方法,以及面向对象编程概念。通过学习,读者将对C#有初步了解,并激发进一步探索编程世界的兴趣。
|
2月前
|
算法 BI API
C#/.NET/.NET Core优秀项目和框架2024年1月简报
C#/.NET/.NET Core优秀项目和框架2024年1月简报
|
2月前
|
开发框架 .NET 程序员
C#/.NET该如何自学入门?
C#/.NET该如何自学入门?
|
3月前
|
定位技术 C# 图形学
Unity和C#游戏编程入门:创建迷宫小球游戏示例
Unity和C#游戏编程入门:创建迷宫小球游戏示例
72 2
|
3月前
|
C#
C# 布尔值和条件语句:入门指南和实用示例
在编程中,通常需要一个只能有两个值之一的数据类型,比如: 是 / 否 开 / 关 真 / 假 为此,C# 有一个 bool 数据类型,可以取 true 或 false 的值。
71 3
|
3月前
|
存储 C#
C#入门开发(Hello World,运算符)
C#入门开发(Hello World,运算符)
28 0
|
3月前
|
Java 程序员 C#
C# 介绍、应用领域、入门、语法、输出和注释详解
C#(发音为“C-Sharp”)是一种由 Microsoft 创建的面向对象的编程语言,运行在 .NET Framework 上。源于 C 家族,与流行的语言如 C++ 和 Java 相近。首个版本发布于 2002 年,而最新版本,C# 12,于 2023 年 11 月发布
68 0
|
3月前
|
数据采集 开发框架 JavaScript
C#/.NET/.NET Core优秀项目和框架2023年12月简报
C#/.NET/.NET Core优秀项目和框架2023年12月简报