ABP Framework微服务教程第五部分：构建订单服务-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00254/article/details/148392249

ABP Framework微服务教程第五部分：构建订单服务

abp Open-source web application framework for ASP.NET Core! Offers an opinionated architecture to build enterprise software solutions with best practices on top of the .NET. Provides the fundamental infrastructure, cross-cutting-concern implementations, startup templates, application modules, UI themes, tooling and documentation. 项目地址: https://gitcode.com/gh_mirrors/abp1/abp

前言

在微服务架构中，订单服务是电商系统中不可或缺的核心组件。本文将基于ABP Framework，详细介绍如何从零开始构建一个完整的订单微服务。通过本教程，您将学习到ABP框架中实体设计、数据库映射、应用服务实现以及前后端集成等核心概念。

订单实体设计

基础实体结构

我们首先创建Order实体类，它继承自ABP框架提供的CreationAuditedAggregateRoot<Guid>基类。这个基类已经内置了以下常用属性：

Id：实体的唯一标识符
CreationTime：创建时间
CreatorId：创建者ID

public class Order : CreationAuditedAggregateRoot<Guid>
{
    public Guid ProductId { get; set; }
    public string CustomerName { get; set; }
    public OrderState State { get; set; }
}

订单状态枚举

为了表示订单的生命周期，我们定义了OrderState枚举：

public enum OrderState : byte
{
    Placed = 0,    // 已下单
    Delivered = 1, // 已交付
    Canceled = 2   // 已取消
}

数据库集成

实体框架配置

在OrderingServiceDbContext中，我们需要配置EF Core映射：

protected override void OnModelCreating(ModelBuilder builder)
{
    builder.Entity<Order>(b =>
    {
        b.ToTable("Orders");
        b.ConfigureByConvention();
        b.Property(q => q.CustomerName)
            .IsRequired()
            .HasMaxLength(120);
    });
}

关键配置点：

ToTable指定表名
ConfigureByConvention应用ABP的默认约定
对CustomerName字段添加了必要的约束

数据库迁移

使用ABP Studio可以方便地生成迁移：

右键点击项目
选择EF Core CLI -> Add Migration
输入迁移名称

迁移将在应用启动时自动执行，无需手动运行迁移命令。

应用服务实现

服务契约设计

我们定义了清晰的接口契约：

public interface IOrderAppService : IApplicationService
{
    Task<List<OrderDto>> GetListAsync();
    Task CreateAsync(OrderCreationDto input);
}

数据传输对象

创建了两个DTO类：

OrderCreationDto用于创建订单的输入
OrderDto用于返回订单信息

public class OrderCreationDto
{
    [Required]
    [StringLength(150)]
    public string CustomerName { get; set; }

    [Required]
    public Guid ProductId { get; set; }
}

服务实现

服务实现中注入了泛型仓储：

public class OrderAppService : ApplicationService, IOrderAppService
{
    private readonly IRepository<Order, Guid> _orderRepository;

    public async Task CreateAsync(OrderCreationDto input)
    {
        var order = new Order
        {
            CustomerName = input.CustomerName,
            ProductId = input.ProductId,
            State = OrderState.Placed
        };
        await _orderRepository.InsertAsync(order);
    }
}

对象映射配置

配置AutoMapper映射规则：

public class OrderingServiceApplicationAutoMapperProfile : Profile
{
    public OrderingServiceApplicationAutoMapperProfile()
    {
        CreateMap<Order, OrderDto>();
    }
}

前端集成

Razor页面实现

创建订单列表页面：

public class Index : AbpPageModel
{
    public List<OrderDto> Orders { get; set; }

    public async Task OnGetAsync()
    {
        Orders = await _orderAppService.GetListAsync();
    }
}

对应的视图使用ABP的Tag Helpers：

<abp-list-group>
    @foreach (var order in Model.Orders)
    {
        <abp-list-group-item>
            <strong>客户:</strong> @order.CustomerName <br />
            <strong>产品ID:</strong> @order.ProductId <br />
            <strong>状态:</strong> @order.State
        </abp-list-group-item>
    }
</abp-list-group>

静态客户端代理生成

通过ABP Studio生成静态客户端代理：

右键点击Web项目
选择ABP CLI -> Generate Proxy -> C#
选择订单服务并生成

菜单配置

添加订单菜单项：

context.Menu.AddItem(
    new ApplicationMenuItem(
        CloudCrmMenus.Orders,
        "订单",
        "~/Orders",
        "fa-solid fa-basket-shopping"
    )
);