Known框架实战演练——进销存基础数据

本文介绍如何实现进销存管理系统的基础数据模块，基础数据模块包括商品信息、供应商管理和客户管理3个菜单页面。供应商和客户字段相同，因此可共用一个页面组件类。

• 项目代码：JxcLite
• 开源地址： https://gitee.com/known/JxcLite

1. 配置模块

运行项目，在【系统管理-模块管理】中添加商品信息、供应商管理、客户管理3个模块菜单，模块基本信息、模型、页面、表单设置之前有视频教程，这里不再细说了。

2. 实体类

在JxcLite项目Entities文件夹下面添加JxGoods.cs和JxPartner.cs两个实体类文件，实体类代码可以直接复制模块管理中由模型设置生成的代码。文章中只简单描述一下实体类的定义，具体代码参见开源，代码定义如下：

namespace JxcLite.Entities;

/// <summary>
/// 商品信息类。
/// </summary>
public class JxGoods : EntityBase { }

/// <summary>
/// 商业伙伴信息类。
/// </summary>
public class JxPartner : EntityBase { }

3. 建表脚本

最理想的情况是：在系统安装时，通过实体类和数据库类型自动生成建表脚本创建实体数据库表。这里还是用传统手动方式执行建表脚本，在JxcLite.Web项目Resources文件夹下添加Tables.sql资源文件，复制粘贴由【模块管理-模型设置】中生成的建表脚本。文章中只简单描述一下建表脚本，具体脚本参见开源，内容如下：

CREATE TABLE [JxGoods] (
    [Id]         varchar(50)      NOT NULL PRIMARY KEY,
    ...
    [Files]      nvarchar(500)    NULL
);

CREATE TABLE [JxPartner] (
    [Id]         varchar(50)      NOT NULL PRIMARY KEY,
    ...
    [Note]       ntext            NULL,
    [Files]      nvarchar(500)    NULL
);

4. 服务接口

在JxcLite项目Services文件夹下面添加基础数据模块服务接口类，文件名定义为IBaseDataService.cs，该接口定义前后端交互的Api访问方法，包括分页查询、批量删除实体、保存实体。具体方法定义如下：

namespace JxcLite.Services;

public interface IBaseDataService : IService
{
    //分页查询商品信息
    Task<PagingResult<JxGoods>> QueryGoodsesAsync(PagingCriteria criteria);
    //批量删除商品信息
    Task<Result> DeleteGoodsesAsync(List<JxGoods> models);
    //保存商品信息
    Task<Result> SaveGoodsAsync(UploadInfo<JxGoods> info);

    //分页查询供应商和客户信息
    Task<PagingResult<JxPartner>> QueryPartnersAsync(PagingCriteria criteria);
    //批量删除供应商和客户信息
    Task<Result> DeletePartnersAsync(List<JxPartner> models);
    //保存供应商和客户信息
    Task<Result> SavePartnerAsync(UploadInfo<JxPartner> info);
}

5. 服务实现

在JxcLite.Web项目Services文件夹下面添加基础数据模块服务接口的实现类，文件名定义为BaseDataService.cs，文章中只简单描述一下实现类的定义和继承，具体实现参见开源，定义如下：

namespace JxcLite.Web.Services;

class BaseDataService(Context context) : ServiceBase(context), IBaseDataService
{
    public Task<PagingResult<JxGoods>> QueryGoodsesAsync(PagingCriteria criteria) { }
    public Task<Result> DeleteGoodsesAsync(List<JxGoods> models) { }
    public Task<Result> SaveGoodsAsync(UploadInfo<JxGoods> info) { }

    public Task<PagingResult<JxPartner>> QueryPartnersAsync(PagingCriteria criteria) { }
    public Task<Result> DeletePartnersAsync(List<JxPartner> models) { }
    public Task<Result> SavePartnerAsync(UploadInfo<JxPartner> info) { }
}

双击打开JxcLite.Web项目中的AppWeb.cs文件，在AddJxcLiteCore方法中注册服务类，前端组件可以通过依赖注入工厂创建服务的实例。代码如下：

public static class AppWeb
{
    public static void AddJxcLiteCore(this IServiceCollection services)
    {
        services.AddScoped<IBaseDataService, BaseDataService>();
    }
}

6. 数据依赖

在JxcLite.Web项目Repositories文件夹下面添加基础数据模块数据依赖类，文件名定义为BaseDataRepository.cs，文章中只简单描述一下依赖类的定义，具体实现参见开源，定义如下：

namespace JxcLite.Web.Repositories;

class BaseDataRepository
{
    internal static Task<PagingResult<JxGoods>> QueryGoodsesAsync(Database db, PagingCriteria criteria) { }

    internal static async Task<bool> ExistsGoodsCodeAsync(Database db, JxGoods model) { }

    internal static Task<PagingResult<JxPartner>> QueryPartnersAsync(Database db, PagingCriteria criteria) { }

    internal static async Task<bool> ExistsPartnerNameAsync(Database db, JxPartner model) { }
}

7. 数据导入类

在JxcLite.Web项目Imports文件夹下面添加商品信息、供应商和客户的导入类，文件名定义为JxGoodsImport.cs和JxPartnerImport.cs，导入类名称命名规范是：实体类名+Import，导入框架自动根据名称识别，文章中只简单描述一下导入类的定义，具体实现参见开源，定义如下：

namespace JxcLite.Web.Imports;

class JxGoodsImport(ImportContext context) : ImportBase<JxGoods>(context)
{
    //初始化导入字段，自动生成导入规范Excel文件
    public override void InitColumns() { }
    //执行导入文件
    public override async Task<Result> ExecuteAsync(SysFile file) { }
}

class JxPartnerImport(ImportContext context) : ImportBase<JxPartner>(context)
{
    public override void InitColumns() { }
    public override async Task<Result> ExecuteAsync(SysFile file) { }
}

8. 前端页面

在JxcLite.Client项目Pages\BaseData文件夹下面添加商品信息和商业伙伴页面类，文件名定义为GoodsList.cs和PartnerList.cs，这3个模块的功能和页面非常简单，只有单表的增删改查导功能，表单页面直接通过在线表单进行配置。列表页面继承BaseTablePage类，由于该框架类封装了列表页面常用的增删改查导功能，因此具体的功能列表页面代码显得格外简单，只需要定义各操作的服务调用方法即可，具体的完整代码如下：

• 商品信息页面

namespace JxcLite.Client.Pages.BaseData;

[StreamRendering]
[Route("/bds/goods")]
public class GoodsList : BaseTablePage<JxGoods>
{
    private IBaseDataService Service;

    protected override async Task OnPageInitAsync()
    {
        await base.OnPageInitAsync();
        Service = await CreateServiceAsync<IBaseDataService>();
        Table.OnQuery = Service.QueryGoodsesAsync;
    }

    public void New() => Table.NewForm(Service.SaveGoodsAsync, new JxGoods());
    public void DeleteM() => Table.DeleteM(Service.DeleteGoodsesAsync);
    public void Edit(JxGoods row) => Table.EditForm(Service.SaveGoodsAsync, row);
    public void Delete(JxGoods row) => Table.Delete(Service.DeleteGoodsesAsync, row);
    public void Import() => ShowImportForm();
    public async void Export() => await ExportDataAsync();
}

• 供应商和客户页面

[StreamRendering]
[Route("/bds/suppliers")]
public class SupplierList : PartnerList
{
    protected override string Type => PartnerType.Supplier;
}

[StreamRendering]
[Route("/bds/customers")]
public class CustomerList : PartnerList
{
    protected override string Type => PartnerType.Customer;
}

public class PartnerList : BaseTablePage<JxPartner>
{
    private IBaseDataService Service;

    //商业伙伴类型虚拟属性，供应商和客户页面覆写。
    protected virtual string Type { get; }

    protected override async Task OnPageInitAsync()
    {
        await base.OnPageInitAsync();
        Service = await CreateServiceAsync<IBaseDataService>();
        Table.OnQuery = QueryPartnersAsync;
    }

    public void New() => Table.NewForm(Service.SavePartnerAsync, new JxPartner { Type = Type });
    public void DeleteM() => Table.DeleteM(Service.DeletePartnersAsync);
    public void Edit(JxPartner row) => Table.EditForm(Service.SavePartnerAsync, row);
    public void Delete(JxPartner row) => Table.Delete(Service.DeletePartnersAsync, row);
    public void Import() => ShowImportForm();
    public async void Export() => await ExportDataAsync();

    private Task<PagingResult<JxPartner>> QueryPartnersAsync(PagingCriteria criteria)
    {
        criteria.SetQuery(nameof(JxPartner.Type), QueryType.Equal, Type);
        return Service.QueryPartnersAsync(criteria);
    }
}