[ABP教程]第一章 创建服务端

合集 - 测试1(73)

1.windwos terminal 主题美化 包括WSL和其他终端命令行2023-03-122.win11+cuda11.2+cudnn+Tensorflow-GPU 环境配置2022-10-223.win11+wls2+ubuntu2004配置cuda+cudnn+pytorch2022-10-144.xshell7 无法打开 提示"要继续使用此程序,您必须应用最新的更新或使用新版本" 解决方案2022-10-085.wls2 ubuntu22 kind k8s 配置记录2022-09-126.wsl2安装与配置2022-09-117.PVE UPS NUT配置 自动关机2022-07-318.centos-stream-9 centos9 配置国内源 阿里云源2022-04-209.群晖gitlab备份迁移2022-01-2810.国内网站recaptcha无法使用的解决办法2022-01-0611.[每日小技巧] vscode配置vue项目基础2021-11-0912.Windows11 AirPods /AirPods Pro 声音小解决方案2021-10-2413.windows端口占用快速查询解决方法2021-05-1414.解决github无法连接错误 OpenSSL SSL_connect: Connection was reset in connection to github.com:4432021-03-1715.[ABP教程]第七章 作者:数据库集成2020-12-2416.[ABP教程]第六章 作者：领域层2020-12-2417.[ABP教程]第五章 授权2020-12-2418.[ABP教程]第四章 集成测试2020-12-2419.[ABP教程]第三章 创建、更新和删除图书2020-12-2420.[ABP教程]第二章 图书列表页面2020-12-24

21.[ABP教程]第一章 创建服务端2020-12-24

22.[Skill] git下载助手2020-12-2323.[Abp]Abp 新手入门随记2020-12-2024.[Skill] 记一次vue项目热更新失败案例2020-12-1525.[Skill]加速npm与yarn还原2020-11-2226.解决黑群晖"抱歉，您所指定的页面不存在"-记一次黑群晖修复案例2020-09-1527.如何下载youtube的视频？2020-09-1328.[新手教程]申请https泛域名解析2020-09-0729.docker frps 内网穿透容器化服务2020-09-0230.docker nginx 自定义配置容器2020-09-0231.asp.net core 学习笔记2020-07-0932.gitlab git仓库地址修改后更新方法2020-05-3133.树莓派(4B)新手入门教程2020-05-3034.Docker-MsSqlServer和安装版本异同2020-04-1135.Win Task 任务管理器 批量杀进程方法2020-04-0936.Win Docker 安装C盘清理方法之一2020-04-0337.中移动ipv6-老毛子固件获取ipv6设置2020-03-2038.win7-win10 禁用IPV6临时地址2020-03-2039.辅助调用函数【call,apply,bind】2020-02-2740.Unraid修改docker镜像地址&默认启动2020-02-2641.docker基本入门知识-小白向2020-02-2642.[不止于代码]Unraid基本使用速记2020-02-2643.Dockerfile文件说明2020-01-1944.Git之pull,fetch差别2019-08-2645.ES6+Webpack+Babel基本环境搭建2019-08-2646.抽象类和接口的异同及实例解析2018-11-2247.KVM与OpenVZ架构的区别2018-08-0248.关闭win10 defender的方法集锦2018-07-1949.ChromeDriver与Chrome版本对应表2018-05-2850.Hexo-Next-多地同步丢失解决(WARN No layout: index.html)2018-04-2651.修改vs模板添加版权注释信息2018-03-2752.Easyui中form表单验证事件不通过处理方法2018-03-2753.最简化版本-Centos7 配置.Net Core 及Jexus服务器2018-03-1254.常用开发中使用到的作图工具(开发向)2018-02-2555.Git 常用指令备注2018-01-3156.记一次 未能加载文件或程序集“”或它的某一个依赖项。试图加载格式不正确的程序 错误解决方案2018-01-3157.截图工具小结2018-01-2958.更优雅的处理数据-linqjs2018-01-2959.解决未安装Sql Server 配置数据库别名2018-01-2860.windows添加右键菜单-此处运行CMD2018-01-2461.记一次微信开发安卓访问阿里云服务器慢处理方案2018-01-1362.Hexo发布到Github丢失readme和CNAME解决方案2018-01-1163.Git之别名配置2018-01-0864.Github博客多地同步文章2018-01-0765.Github博客 自定义域名2018-01-0766.Github 搭建个人博客2018-01-0467.(转载)开源许可证教程2018-01-0268.小米路由mini刷 改华硕[N14U N54U]5G 2G的7620老毛子Padavan固件(私人云储存 aria2 QOS)2017-12-3169.小米路由mini刷不死breed2017-12-3170.小米路由mini开启ssh2017-12-3171.比特币是什么？2017-12-2172.IIS发布网站出现拒绝访问的错误分析2017-11-0773.公众平台服务号、订阅号、企业微信、小程序的相关说明2017-11-07

收起

Web应用程序开发教程 - 第一章: 创建服务端

关于本教程#

在本系列教程中, 你将构建一个名为 Acme.BookStore 的用于管理书籍及其作者列表的基于ABP的应用程序. 它是使用以下技术开发的:

• Entity Framework Core 做为ORM提供程序.
• MVC / Razor Pages 做为UI框架.

本教程分为以下部分:

• Part 1: 创建服务端 (本章)
• Part 2: 图书列表页面
• Part 3: 创建,更新和删除图书
• Part 4: 集成测试
• Part 5: 授权
• Part 6: 作者: 领域层
• Part 7: 作者: 数据库集成
• Part 8: 作者: 应用服务层
• Part 9: 作者: 用户页面
• Part 10: 图书到作者的关系

下载源码#

本教程根据你的UI 和 Database偏好有多个版,我们准备了两种可供下载的源码组合:

• MVC (Razor Pages) UI 与 EF Core
• Angular UI 与 MongoDB

创建解决方案#

在开始开发之前,请按照入门教程创建名为 Acme.BookStore 的新解决方案.

创建Book实体#

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

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

在解决方案的领域层(Acme.BookStore.Domain项目)中定义你的实体.

该应用程序的主要实体是Book. 在Acme.BookStore.Domain项目中创建一个 Books 文件夹并在其中添加一个名为 Book 的类,如下所示:

Copy
using System;
using Volo.Abp.Domain.Entities.Auditing;

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; }
    }
}

• ABP为实体提供了两个基本的基类: AggregateRoot和Entity. Aggregate Root是领域驱动设计 概念之一. 可以视为直接查询和处理的根实体(请参阅实体文档).
• Book实体继承了AuditedAggregateRoot,AuditedAggregateRoot类在AggregateRoot类的基础上添加了一些审计属性(CreationTime, CreatorId, LastModificationTime 等). ABP框架自动为你管理这些属性.
• Guid是Book实体的主键类型.

为了保持简单,本教程将实体属性保留为 public get/set . 如果你想了解关于DDD最佳实践,请参阅实体文档.

BookType枚举#

上面所用到了 BookType 枚举,在 Acme.BookStore.Domain.Shared 项目创建 BookType.

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

最终的文件夹/文件结构应该如下所示:

将Book实体添加到DbContext中#

{{if DB == "EF"}}

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

Copy
public class BookStoreDbContext : AbpDbContext<BookStoreDbContext>
{
    public DbSet<Book> Books { get; set; }
    //...
}

{{end}}

{{if DB == "Mongo"}}

添加 IMongoCollection<Book> Book 属性到 Acme.BookStore.MongoDB 项目的 BookStoreMongoDbContext 中.

Copy
public class BookStoreMongoDbContext : AbpMongoDbContext
{
    public IMongoCollection<Book> Books => Collection<Book>();
    //...
}

{{end}}

{{if DB == "EF"}}

将Book实体映射到数据库表#

在 Acme.BookStore.EntityFrameworkCore 项目中打开 BookStoreDbContextModelCreatingExtensions.cs 文件,添加 Book 实体的映射代码. 最终类应为:

Copy
using Acme.BookStore.Books;
using Microsoft.EntityFrameworkCore;
using Volo.Abp;
using Volo.Abp.EntityFrameworkCore.Modeling;

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() 方法优雅的配置/映射继承的属性,应始终对你所有的实体使用它.

添加数据迁移#

启动模板使用EF Core Code First Migrations创建和维护数据库架构. 打开菜单工具 > NuGet包管理器下的程序包管理控制台 (PMC).

选择 Acme.BookStore.EntityFrameworkCore.DbMigrations 做为默认项目然后执行以下命令:

Copy
Add-Migration "Created_Book_Entity"

它会在 Acme.BookStore.EntityFrameworkCore.DbMigrations 项目中的 Migrations 文件内创建一个新的迁移类.

在更新数据库之前,请阅读下面的部分了解如何将一些初始数据插入到数据库.

如果你使用其他IDE而不是Visual Studio, 你可以使用 dotnet-ef 工具.

{{end}}

添加种子数据#

在运行应用程序之前最好将初始数据添加到数据库中. 本节介绍ABP框架的数据种子系统. 如果你不想创建种子数据可以跳过本节,但是建议你遵循它来学习这个有用的ABP Framework功能。

在 *.Domain 项目下创建派生 IDataSeedContributor 的类,并且拷贝以下代码:

Copy
using System;
using System.Threading.Tasks;
using Acme.BookStore.Books;
using Volo.Abp.Data;
using Volo.Abp.DependencyInjection;
using Volo.Abp.Domain.Repositories;

namespace Acme.BookStore
{
    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)将两本书插入数据库.

更新数据库#

运行 Acme.BookStore.DbMigrator 应用程序来更新数据库:

.DbMigrator 是一个控制台使用程序,可以在开发和生产环境迁移数据库架构和初始化种子数据.

创建应用程序#

应用程序层由两个分离的项目组成:

• Acme.BookStore.Application.Contracts 包含你的DTO和应用服务接口.
• Acme.BookStore.Application 包含你的应用服务实现.

在本部分中,你将创建一个应用程序服务,使用ABP Framework的 CrudAppService 基类来获取,创建,更新和删除书籍.

BookDto#

CrudAppService 基类需要定义实体的基本DTO. 在 Acme.BookStore.Application.Contracts 项目中创建一个名为 BookDto 的DTO类:

Copy
using System;
using Volo.Abp.Application.Dtos;

namespace Acme.BookStore
{
    public class BookDto : AuditedEntityDto<Guid>
    {
        public string Name { get; set; }

        public BookType Type { get; set; }

        public DateTime PublishDate { get; set; }

        public float Price { get; set; }
    }
}

• DTO类被用来在 表示层 和 应用层 传递数据.查看DTO文档查看更多信息.
• 为了在页面上展示书籍信息,BookDto被用来将书籍数据传递到表示层.
• BookDto继承自 AuditedEntityDto<Guid>.跟上面定义的 Book 实体一样具有一些审计属性.

在将书籍返回到表示层时,需要将Book实体转换为BookDto对象. AutoMapper库可以在定义了正确的映射时自动执行此转换. 启动模板配置了AutoMapper,因此你只需在Acme.BookStore.Application项目的BookStoreApplicationAutoMapperProfile类中定义映射:

Copy
using Acme.BookStore.Books;
using AutoMapper;

namespace Acme.BookStore
{
    public class BookStoreApplicationAutoMapperProfile : Profile
    {
        public BookStoreApplicationAutoMapperProfile()
        {
            CreateMap<Book, BookDto>();
        }
    }
}

参阅 对象对对象映射 文档了解详情.

CreateUpdateBookDto#

在Acme.BookStore.Application.Contracts项目中创建一个名为 CreateUpdateBookDto 的DTO类:

Copy
using System;
using System.ComponentModel.DataAnnotations;

namespace Acme.BookStore.Books
{
    public class CreateUpdateBookDto
    {
        [Required]
        [StringLength(128)]
        public string Name { get; set; }

        [Required]
        public BookType Type { get; set; } = BookType.Undefined;

        [Required]
        [DataType(DataType.Date)]
        public DateTime PublishDate { get; set; } = DateTime.Now;

        [Required]
        public float Price { get; set; }
    }
}

• 这个DTO类被用于在创建或更新书籍的时候从用户界面获取图书信息.
• 它定义了数据注释属性(如[Required])来定义属性的验证. DTO由ABP框架自动验证.

就像上面的BookDto一样,创建一个从CreateUpdateBookDto对象到Book实体的映射,最终映射配置类如下:

Copy
using Acme.BookStore.Books;
using AutoMapper;

namespace Acme.BookStore
{
    public class BookStoreApplicationAutoMapperProfile : Profile
    {
        public BookStoreApplicationAutoMapperProfile()
        {
            CreateMap<Book, BookDto>();
            CreateMap<CreateUpdateBookDto, Book>();
        }
    }
}

IBookAppService#

下一步是为应用程序定义接口,在Acme.BookStore.Application.Contracts项目中定义一个名为IBookAppService的接口:

Copy
using System;
using Volo.Abp.Application.Dtos;
using Volo.Abp.Application.Services;

namespace Acme.BookStore.Books
{
    public interface IBookAppService :
        ICrudAppService< //Defines CRUD methods
            BookDto, //Used to show books
            Guid, //Primary key of the book entity
            PagedAndSortedResultRequestDto, //Used for paging/sorting
            CreateUpdateBookDto> //Used to create/update a book
    {

    }
}

• 框架定义应用程序服务的接口不是必需的. 但是,它被建议作为最佳实践.
• ICrudAppService定义了常见的CRUD方法:GetAsync,GetListAsync,CreateAsync,UpdateAsync和DeleteAsync. 你可以从空的IApplicationService接口继承并手动定义自己的方法(将在下一部分中完成).
• ICrudAppService有一些变体, 你可以在每个方法中使用单独的DTO,也可以分别单独指定(例如使用不同的DTO进行创建和更新).

BookAppService#

在Acme.BookStore.Application项目中创建名为 BookAppService 的 IBookAppService 实现:

Copy
using System;
using Volo.Abp.Application.Dtos;
using Volo.Abp.Application.Services;
using Volo.Abp.Domain.Repositories;

namespace Acme.BookStore.Books
{
    public class BookAppService :
        CrudAppService<
            Book, //The Book entity
            BookDto, //Used to show books
            Guid, //Primary key of the book entity
            PagedAndSortedResultRequestDto, //Used for paging/sorting
            CreateUpdateBookDto>, //Used to create/update a book
        IBookAppService //implement the IBookAppService
    {
        public BookAppService(IRepository<Book, Guid> repository)
            : base(repository)
        {

        }
    }
}

• BookAppService继承了CrudAppService<...>.它实现了 ICrudAppService 定义的CRUD方法.
• BookAppService注入IRepository <Book,Guid>,这是Book实体的默认仓储. ABP自动为每个聚合根(或实体)创建默认仓储. 请参阅仓储文档
• BookAppService使用IObjectMapper将Book对象转换为BookDto对象, 将CreateUpdateBookDto对象转换为Book对象. 启动模板使用AutoMapper库作为对象映射提供程序. 我们之前定义了映射, 因此它将按预期工作.

自动生成API Controllers#

你通常创建Controller以将应用程序服务公开为HTTP API端点. 因此允许浏览器或第三方客户端通过AJAX调用它们.

ABP可以自动按照惯例将你的应用程序服务配置为MVC API控制器.

Swagger UI#

启动模板配置为使用Swashbuckle.AspNetCore运行swagger UI. 运行应用程序并在浏览器中输入https://localhost:XXXX/swagger/(用你自己的端口替换XXXX)作为URL.

你会看到一些内置的接口和Book的接口,它们都是REST风格的:

Swagger有一个很好的UI来测试API.

你可以尝试执行[GET] /api/app/book API来获取书籍列表, 服务端会返回以下JSON结果:

Copy
{
  "totalCount": 2,
  "items": [
    {
      "name": "The Hitchhiker's Guide to the Galaxy",
      "type": 7,
      "publishDate": "1995-09-27T00:00:00",
      "price": 42,
      "lastModificationTime": null,
      "lastModifierId": null,
      "creationTime": "2020-07-03T21:04:18.4607218",
      "creatorId": null,
      "id": "86100bb6-cbc1-25be-6643-39f62806969c"
    },
    {
      "name": "1984",
      "type": 3,
      "publishDate": "1949-06-08T00:00:00",
      "price": 19.84,
      "lastModificationTime": null,
      "lastModifierId": null,
      "creationTime": "2020-07-03T21:04:18.3174016",
      "creatorId": null,
      "id": "41055277-cce8-37d7-bb37-39f62806960b"
    }
  ]
}

这很酷,因为我们没有编写任何代码来创建API控制器,但是现在我们有了一个可以正常使用的REST API!

下一章#

参阅教程的下一章.