Web应用程序开发教程 - 第九章: 作者: 用户页面

关于本教程

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

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

本教程分为以下部分:

下载源码

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

如果你在Windows中遇到 “文件名太长” or “解压错误”, 很可能与Windows最大文件路径限制有关. Windows文件路径的最大长度为250字符. 为了解决这个问题,参阅 在Windows 10中启用长路径.

如果你遇到与Git相关的长路径错误, 尝试使用下面的命令在Windows中启用长路径. 参阅 https://github.com/msysgit/msysgit/wiki/Git-cannot-create-a-file-or-directory-with-a-long-path git config --system core.longpaths true

简介

这章阐述如何为前一章介绍的 作者 实体创建CRUD页面.

作者列表页面

在 Acme.BookStore.Web 项目的 Pages/Authors 文件夹下创建一个新的razor页面, Index.cshtml, 修改文件内容如下.

Index.cshtml

  1. @page
  2. @using Acme.BookStore.Localization
  3. @using Acme.BookStore.Permissions
  4. @using Acme.BookStore.Web.Pages.Authors
  5. @using Microsoft.AspNetCore.Authorization
  6. @using Microsoft.Extensions.Localization
  7. @inject IStringLocalizer<BookStoreResource> L
  8. @inject IAuthorizationService AuthorizationService
  9. @model IndexModel
  11. @section scripts
  12. {
  13.     <abp-script src="/Pages/Authors/Index.js"/>
  14. }
  16. <abp-card>
  17.     <abp-card-header>
  18.         <abp-row>
  19.             <abp-column size-md="_6">
  20.                 <abp-card-title>@L["Authors"]</abp-card-title>
  21.             </abp-column>
  22.             <abp-column size-md="_6" class="text-right">
  23.                 @if (await AuthorizationService
  24.                     .IsGrantedAsync(BookStorePermissions.Authors.Create))
  25.                 {
  26.                     <abp-button id="NewAuthorButton"
  27.                                 text="@L["NewAuthor"].Value"
  28.                                 icon="plus"
  29.                                 button-type="Primary"/>
  30.                 }
  31.             </abp-column>
  32.         </abp-row>
  33.     </abp-card-header>
  34.     <abp-card-body>
  35.         <abp-table striped-rows="true" id="AuthorsTable"></abp-table>
  36.     </abp-card-body>
  37. </abp-card>

这是一个简单的页面, 和我们以前创建的图书页面一样. 它导入了一个JavaScript文件, 我们后面会进行介绍这个文件.

IndexModel.cshtml.cs

  1. using Microsoft.AspNetCore.Mvc.RazorPages;
  3. namespace Acme.BookStore.Web.Pages.Authors
  4. {
  5.     public class IndexModel : PageModel
  6.     {
  7.         public void OnGet()
  8.         {
  10.         }
  11.     }
  12. }

Index.js

  1. $(function () {
  2.     var l = abp.localization.getResource('BookStore');
  3.     var createModal = new abp.ModalManager(abp.appPath + 'Authors/CreateModal');
  4.     var editModal = new abp.ModalManager(abp.appPath + 'Authors/EditModal');
  6.     var dataTable = $('#AuthorsTable').DataTable(
  7.         abp.libs.datatables.normalizeConfiguration({
  8.             serverSide: true,
  9.             paging: true,
  10.             order: [[1, "asc"]],
  11.             searching: false,
  12.             scrollX: true,
  13.             ajax: abp.libs.datatables.createAjax(acme.bookStore.authors.author.getList),
  14.             columnDefs: [
  15.                 {
  16.                     title: l('Actions'),
  17.                     rowAction: {
  18.                         items:
  19.                             [
  20.                                 {
  21.                                     text: l('Edit'),
  22.                                     visible:
  23.                                         abp.auth.isGranted('BookStore.Authors.Edit'),
  24.                                     action: function (data) {
  25.                                         editModal.open({ id: data.record.id });
  26.                                     }
  27.                                 },
  28.                                 {
  29.                                     text: l('Delete'),
  30.                                     visible:
  31.                                         abp.auth.isGranted('BookStore.Authors.Delete'),
  32.                                     confirmMessage: function (data) {
  33.                                         return l(
  34.                                             'AuthorDeletionConfirmationMessage',
  35.                                             data.record.name
  36.                                         );
  37.                                     },
  38.                                     action: function (data) {
  39.                                         acme.bookStore.authors.author
  40.                                             .delete(data.record.id)
  41.                                             .then(function() {
  42.                                                 abp.notify.info(
  43.                                                     l('SuccessfullyDeleted')
  44.                                                 );
  45.                                                 dataTable.ajax.reload();
  46.                                             });
  47.                                     }
  48.                                 }
  49.                             ]
  50.                     }
  51.                 },
  52.                 {
  53.                     title: l('Name'),
  54.                     data: "name"
  55.                 },
  56.                 {
  57.                     title: l('BirthDate'),
  58.                     data: "birthDate",
  59.                     render: function (data) {
  60.                         return luxon
  61.                             .DateTime
  62.                             .fromISO(data, {
  63.                                 locale: abp.localization.currentCulture.name
  64.                             }).toLocaleString();
  65.                     }
  66.                 }
  67.             ]
  68.         })
  69.     );
  71.     createModal.onResult(function () {
  72.         dataTable.ajax.reload();
  73.     });
  75.     editModal.onResult(function () {
  76.         dataTable.ajax.reload();
  77.     });
  79.     $('#NewAuthorButton').click(function (e) {
  80.         e.preventDefault();
  81.         createModal.open();
  82.     });
  83. });

简单来说, 这个JavaScript页面:

  • 创建了一个具有 操作, 姓名 和 生日 列的数据表格.
    • Actions 列用来添加 编辑 和 删除 操作.
    • 生日 提供了一个 render 函数, 使用 luxon 库格式化 DateTime 值.
  • 使用 abp.ModalManager 打开 新建 和 编辑 模态表单.

这块代码与以前创建的图书页面非常相似, 所以我们不再赘述.

本地化

这个页面使用了一些需要声明的本地化键. 打开 Acme.BookStore.Domain.Shared 项目中 Localization/BookStore 文件夹下的 en.json 文件, 加入以下条目:

  1. "Menu:Authors": "Authors",
  2. "Authors": "Authors",
  3. "AuthorDeletionConfirmationMessage": "Are you sure to delete the author '{0}'?",
  4. "BirthDate": "Birth date",
  5. "NewAuthor": "New author"

简体中文翻译请打开zh-Hans.json文件 ,并将”Texts”对象中对应的值替换为中文.

注意我们加入了额外的键. 它们会在下面的小节中被使用.

加入主菜单

打开 Acme.BookStore.Web 项目的 Menus 文件夹中的 BookStoreMenuContributor.cs , 在 ConfigureMainMenuAsync 方法的结尾加入以下代码:

  1. if (await context.IsGrantedAsync(BookStorePermissions.Authors.Default))
  2. {
  3.     bookStoreMenu.AddItem(new ApplicationMenuItem(
  4.         "BooksStore.Authors",
  5.         l["Menu:Authors"],
  6.         url: "/Authors"
  7.     ));
  8. }

运行应用程序

运行并登录应用程序. 因为你还没有权限, 所以不能看见菜单项. 转到 Identity/Roles 页面, 点击 操作 按钮并选择管理员角色的权限操作:

bookstore-author-permissions

如你所见, 管理员角色还没有作者管理权限. 单击复选框并保存, 赋予权限. 刷新页面后, 你会在主菜单中的图书商店下看到作者菜单项:

bookstore-authors-page

页面是完全可以工作的, 除了 新建作者 和 操作/编辑, 因为它们还没有实现 .

提示: 如果你在定义一个新权限后运行 .DbMigrator 控制台程序, 它会自动将这些权限赋予管理员角色, 你不需要手工赋予权限.

新建模态窗口

在 Acme.BookStore.Web 项目的 Pages/Authors 文件夹下创建一个 razor 页面 CreateModal.cshtml, 修改它的内容如下:

CreateModal.cshtml

  1. @page
  2. @using Acme.BookStore.Localization
  3. @using Acme.BookStore.Web.Pages.Authors
  4. @using Microsoft.Extensions.Localization
  5. @using Volo.Abp.AspNetCore.Mvc.UI.Bootstrap.TagHelpers.Modal
  6. @model CreateModalModel
  7. @inject IStringLocalizer<BookStoreResource> L
  8. @{
  9.     Layout = null;
  10. }
  11. <form asp-page="/Authors/CreateModal">
  12.     <abp-modal>
  13.         <abp-modal-header title="@L["NewAuthor"].Value"></abp-modal-header>
  14.         <abp-modal-body>
  15.             <abp-input asp-for="Author.Name" />
  16.             <abp-input asp-for="Author.BirthDate" />
  17.             <abp-input asp-for="Author.ShortBio" />
  18.         </abp-modal-body>
  19.         <abp-modal-footer buttons="@(AbpModalButtons.Cancel|AbpModalButtons.Save)"></abp-modal-footer>
  20.     </abp-modal>
  21. </form>

之前我们已经使用ABP框架的 动态表单开发了图书页面. 这里可以使用相同的方法, 但我们希望展示如何手工完成它. 实际上, 没有那么手工化, 因为在这个例子中我们使用了 abp-input 标签简化了表单元素的创建.

你当然可以使用标准Bootstrap HTML结构, 但是这需要写很多代码. abp-input 自动添加验证, 本地化和根据数据类型生成标准元素.

CreateModal.cshtml.cs

  1. using System;
  2. using System.ComponentModel.DataAnnotations;
  3. using System.Threading.Tasks;
  4. using Acme.BookStore.Authors;
  5. using Microsoft.AspNetCore.Mvc;
  6. using Volo.Abp.AspNetCore.Mvc.UI.Bootstrap.TagHelpers.Form;
  8. namespace Acme.BookStore.Web.Pages.Authors
  9. {
  10.     public class CreateModalModel : BookStorePageModel
  11.     {
  12.         [BindProperty]
  13.         public CreateAuthorViewModel Author { get; set; }
  15.         private readonly IAuthorAppService _authorAppService;
  17.         public CreateModalModel(IAuthorAppService authorAppService)
  18.         {
  19.             _authorAppService = authorAppService;
  20.         }
  22.         public void OnGet()
  23.         {
  24.             Author = new CreateAuthorViewModel();
  25.         }
  27.         public async Task<IActionResult> OnPostAsync()
  28.         {
  29.             var dto = ObjectMapper.Map<CreateAuthorViewModel, CreateAuthorDto>(Author);
  30.             await _authorAppService.CreateAsync(dto);
  31.             return NoContent();
  32.         }
  34.         public class CreateAuthorViewModel
  35.         {
  36.             [Required]
  37.             [StringLength(AuthorConsts.MaxNameLength)]
  38.             public string Name { get; set; }
  40.             [Required]
  41.             [DataType(DataType.Date)]
  42.             public DateTime BirthDate { get; set; }
  44.             [TextArea]
  45.             public string ShortBio { get; set; }
  46.         }
  47.     }
  48. }

这个页面模型类注入和使用 IAuthorAppService 创建新作者. 它和图书创建模型类之间主要的区别是这个模型类为视图模型声明了一个新类 CreateAuthorViewModel, 而不是重用 CreateAuthorDto.

这么做的主要原因是展示在页面中如何使用不同的模型. 但还有一个好处: 我们为类成员添加了两个不存在于 CreateAuthorDto 中的特性:

  • 为 BirthDate 添加 [DataType(DataType.Date)] 特性, 这会在UI为这个属性显示一个日期选择控件.
  • 为 ShortBio 添加 [TextArea] 特性, 这会显示一个多行文本框, 而不是标准文本框.

通过这种方式, 可以根据UI需求定制视图模型类, 而无需修改DTO. 这么做的一个结果是: 使用 ObjectMapper 将 CreateAuthorViewModel 映射到 CreateAuthorDto. 为了完成映射, 需要在 BookStoreWebAutoMapperProfile 构造函数中加入新的映射代码:

  1. using Acme.BookStore.Authors; // ADDED NAMESPACE IMPORT
  2. using Acme.BookStore.Books;
  3. using AutoMapper;
  5. namespace Acme.BookStore.Web
  6. {
  7.     public class BookStoreWebAutoMapperProfile : Profile
  8.     {
  9.         public BookStoreWebAutoMapperProfile()
  10.         {
  11.             CreateMap<BookDto, CreateUpdateBookDto>();
  13.             // ADD a NEW MAPPING
  14.             CreateMap<Pages.Authors.CreateModalModel.CreateAuthorViewModel,
  15.                       CreateAuthorDto>();
  16.         }
  17.     }
  18. }

当你重新运行应用程序后, 点击”新建作者” 按钮会打开一个新的模态窗口.

bookstore-new-author-modal

编辑模态窗口

在 Acme.BookStore.Web 项目的 Pages/Authors 文件夹下创建一个 razor 页面 EditModal.cshtml, 修改它的内容如下:

EditModal.cshtml

  1. @page
  2. @using Acme.BookStore.Localization
  3. @using Acme.BookStore.Web.Pages.Authors
  4. @using Microsoft.Extensions.Localization
  5. @using Volo.Abp.AspNetCore.Mvc.UI.Bootstrap.TagHelpers.Modal
  6. @model EditModalModel
  7. @inject IStringLocalizer<BookStoreResource> L
  8. @{
  9.     Layout = null;
  10. }
  11. <form asp-page="/Authors/EditModal">
  12.     <abp-modal>
  13.         <abp-modal-header title="@L["Update"].Value"></abp-modal-header>
  14.         <abp-modal-body>
  15.             <abp-input asp-for="Author.Id" />
  16.             <abp-input asp-for="Author.Name" />
  17.             <abp-input asp-for="Author.BirthDate" />
  18.             <abp-input asp-for="Author.ShortBio" />
  19.         </abp-modal-body>
  20.         <abp-modal-footer buttons="@(AbpModalButtons.Cancel|AbpModalButtons.Save)"></abp-modal-footer>
  21.     </abp-modal>
  22. </form>

EditModal.cshtml.cs

  1. using System;
  2. using System.ComponentModel.DataAnnotations;
  3. using System.Threading.Tasks;
  4. using Acme.BookStore.Authors;
  5. using Microsoft.AspNetCore.Mvc;
  6. using Volo.Abp.AspNetCore.Mvc.UI.Bootstrap.TagHelpers.Form;
  8. namespace Acme.BookStore.Web.Pages.Authors
  9. {
  10.     public class EditModalModel : BookStorePageModel
  11.     {
  12.         [BindProperty]
  13.         public EditAuthorViewModel Author { get; set; }
  15.         private readonly IAuthorAppService _authorAppService;
  17.         public EditModalModel(IAuthorAppService authorAppService)
  18.         {
  19.             _authorAppService = authorAppService;
  20.         }
  22.         public async Task OnGetAsync(Guid id)
  23.         {
  24.             var authorDto = await _authorAppService.GetAsync(id);
  25.             Author = ObjectMapper.Map<AuthorDto, EditAuthorViewModel>(authorDto);
  26.         }
  28.         public async Task<IActionResult> OnPostAsync()
  29.         {
  30.             await _authorAppService.UpdateAsync(
  31.                 Author.Id,
  32.                 ObjectMapper.Map<EditAuthorViewModel, UpdateAuthorDto>(Author)
  33.             );
  35.             return NoContent();
  36.         }
  38.         public class EditAuthorViewModel
  39.         {
  40.             [HiddenInput]
  41.             public Guid Id { get; set; }
  43.             [Required]
  44.             [StringLength(AuthorConsts.MaxNameLength)]
  45.             public string Name { get; set; }
  47.             [Required]
  48.             [DataType(DataType.Date)]
  49.             public DateTime BirthDate { get; set; }
  51.             [TextArea]
  52.             public string ShortBio { get; set; }
  53.         }
  54.     }
  55. }

这个类与 CreateModal.cshtml.cs 类似, 主要不同是:

  • 使用 IAuthorAppService.GetAsync(...) 方法从应用层获取正在编辑的作者.
  • EditAuthorViewModel 拥有一个额外的 Id 属性, 它被 [HiddenInput] 特性标记, 会为这个属性在页面上创建一个隐藏输入框.

这个类要求在 BookStoreWebAutoMapperProfile 类中添加两个对象映射声明:

  1. using Acme.BookStore.Authors;
  2. using Acme.BookStore.Books;
  3. using AutoMapper;
  5. namespace Acme.BookStore.Web
  6. {
  7.     public class BookStoreWebAutoMapperProfile : Profile
  8.     {
  9.         public BookStoreWebAutoMapperProfile()
  10.         {
  11.             CreateMap<BookDto, CreateUpdateBookDto>();
  13.             CreateMap<Pages.Authors.CreateModalModel.CreateAuthorViewModel,
  14.                       CreateAuthorDto>();
  16.             // ADD THESE NEW MAPPINGS
  17.             CreateMap<AuthorDto, Pages.Authors.EditModalModel.EditAuthorViewModel>();
  18.             CreateMap<Pages.Authors.EditModalModel.EditAuthorViewModel,
  19.                       UpdateAuthorDto>();
  20.         }
  21.     }
  22. }

这就是全部了! 你可以运行应用程序并尝试编辑一个作者.

下一章

查看本教程的下一章.