ABP開發框架先後端開發系列---（6）ABP基礎接口處理和省份城市行政區管理模塊的開發

最近沒有更新ABP框架的相關文章，一直在研究和封裝相關的接口，總算告一段落，開始繼續整理下開發心得。上次我在隨筆《ABP開發框架先後端開發系列---（5）Web API調用類在Winform項目中的使用》中介紹了字典模塊的管理，以及實現了常規的獲取全部記錄，獲取條件查詢記錄，建立、更新、刪除這些接口。本篇繼續深刻介紹ABP框架在實際項目中使用的狀況，本篇隨筆整理對ABP基礎接口，以及展現完成的省份城市行政區管理模塊的內容。

一、ABP常規處理接口

根據ABP框架默認提供的一些接口，咱們能夠在服務端封裝好相關的Web API接口（因爲動態API的便利，實際上是完成ApplicationService層便可），前面介紹了獲取條件查詢記錄，建立、更新、刪除這些接口的實現和處理，以及能夠擴展本身的自定義業務接口，以下是字典模塊的接口關係。

字典管理界面，列出字典類型，並對字典類型下的字典數據進行分頁展現，分頁展現利用分頁控件展現。

新增或者編輯窗體界面以下

或者是批量的字典數據錄入

這個精確或者模糊查詢，則是在應用服務層裏面定義規則的，在應用服務層接口類裏面，重寫CreateFilteredQuery能夠設置GetAll的查詢規則，重寫ApplySorting則能夠指定列表的排序順序。

 

二、ABP常規查詢接口的細化

在前面介紹了的內容彙總，基本上實現了常規數據的分頁查詢，咱們能夠看到，對於字典數據來講，分頁查詢條件是在DictDataPagedDto裏面定義，這個是咱們定義的分頁條件，以下代碼所示。

    /// <summary>
    /// 用於根據條件分頁查詢
    /// </summary>
    public class DictDataPagedDto : PagedResultRequestDto
    {
        /// <summary>
        /// 字典類型ID
        /// </summary>
        public virtual string DictType_ID { get; set; }

        /// <summary>
        /// 類型名稱
        /// </summary>
        public virtual string Name { get; set; }

        /// <summary>
        /// 指定值
        /// </summary>
        public virtual string Value { get; set; }

        /// <summary>
        /// 備註
        /// </summary>
        public virtual string Remark { get; set; }
    }

這個類文件，咱們通常把這個業務模塊相關的統一放在一個文件中，例如字典數據相關的DTO放在一個DictDataDto文件裏面，方便管理，以下所示。

上面是字典模塊的一些基礎介紹，實際上咱們開發業務模塊的時候，錄入數據的時候，還須要一個判斷的步驟，如不容許名稱重複的狀況。在建立新的記錄和更新已有記錄都須要進行必要的判斷，保證數據的有效性和不重複性。

如對於省份管理界面來講，咱們不能運行重複錄入省份名稱，那麼就須要在錄入數據或者更新數據的時候，進行必要的存在性判斷。

那麼上面的處理是如何實現的呢。

主要的界面實現代碼以下所示。

if (string.IsNullOrEmpty(ID))
{
    //判斷存在條件
    var countDto = new ProvincePagedDto() { ProvinceName = this.txtProvince.Text };
    bool isExist = await ProvinceApiCaller.Instance.Count(countDto) > 0;
    if (isExist)
    {
        MessageDxUtil.ShowTips("省份名稱已存在，請選擇其餘名稱");
        this.txtProvince.Focus();
        return;
    }
    else
    {
        //建立新記錄
        tempInfo = await ProvinceApiCaller.Instance.Create(tempInfo);
    }
}
else
{
    //判斷存在條件,排除本記錄同名狀況
    var countDto = new ProvincePagedDto() { ProvinceName = this.txtProvince.Text, ExcludeId = ID.ToInt64() };
    bool isExist = await ProvinceApiCaller.Instance.Count(countDto) > 0;
    if (isExist)
    {
        MessageDxUtil.ShowTips("省份名稱已存在，請選擇其餘名稱");
        this.txtProvince.Focus();
        return;
    }
    else
    {
        //更新記錄
        tempInfo = await ProvinceApiCaller.Instance.Update(tempInfo);
    }
}

ProcessDataSaved(this.btnOK, new EventArgs());
this.DialogResult = System.Windows.Forms.DialogResult.OK;

咱們發現，這裏增長了一個Count的函數用來判斷，傳入的條件就是前面的分頁請求條件。

bool isExist = await ProvinceApiCaller.Instance.Count(countDto) > 0;

咱們看看咱們的應用服務層的接口實現以下所示。

        /// <summary>
        /// 獲取指定條件的數量
        /// </summary>
        /// <param name="input">查找條件</param>
        /// <returns></returns>
        public async virtual Task<int> Count(TGetAllInput input)
        {
            var query = CreateFilteredQuery(input);
            return await Task.FromResult(query.Count());
        }

這裏最終仍是跳轉到 CreateFilteredQuery 函數裏面實現判斷邏輯了。

        /// <summary>
        /// 自定義條件處理
        /// </summary>
        /// <param name="input">查詢條件Dto</param>
        /// <returns></returns>
        protected override IQueryable<Province> CreateFilteredQuery(ProvincePagedDto input)
        {
            return base.CreateFilteredQuery(input)
                .WhereIf(input.ExcludeId.HasValue, t=>t.Id != input.ExcludeId) //不包含排除ID
                .WhereIf(!input.ProvinceName.IsNullOrWhiteSpace(), t => t.ProvinceName.Contains(input.ProvinceName));             
        }

這裏麪包含了兩個判斷條件，一個是排除指定的ID記錄，一個是匹配省份名稱。

由於咱們在更新記錄的時候，須要判斷非本記錄是否有重複的名稱。

//判斷存在條件,排除本記錄同名狀況
var countDto = new ProvincePagedDto() { ProvinceName = this.txtProvince.Text, ExcludeId = ID.ToInt64() };
bool isExist = await ProvinceApiCaller.Instance.Count(countDto) > 0;

這個ExcludeId 咱們在分頁條件裏面增長一個固定的屬性便可。

以上的分頁信息，包含了實體DTO對象的一些屬性，咱們能夠根據須要增長或者減小一部分屬性。

另外咱們定義的建立省份Dto對象和獲取到單個實體的DTO對象，他們的定義和關係以下所示，方便咱們在界面上進行操做。

    /// <summary>
    /// 建立全國省份表，DTO對象
    /// </summary>
    public class CreateProvinceDto : EntityDto<long>
    { 
        /// <summary>
        /// 默認構造函數（須要初始化屬性的在此處理）
        /// </summary>
        public CreateProvinceDto()
        {
         }

        #region Property Members
        
        /// <summary>
        /// 省份名稱
        /// </summary>
        [Required]
        public virtual string ProvinceName { get; set; }


        #endregion

    }

    /// <summary>
    /// 全國省份表，DTO對象
    /// </summary>
    public class ProvinceDto : CreateProvinceDto
    {

    }

固定這些規則後，咱們也能夠用代碼生成工具快速生成對應的DTO文件了。

有了這些分頁屬性後，咱們就能夠在應用服務層裏面定義本身的過濾規則了，如對於字典類型的應用服務層的篩選條件函數，以下所示。

        /// <summary>
        /// 自定義條件處理
        /// </summary>
        /// <param name="input"></param>
        /// <returns></returns>
        protected override IQueryable<DictType> CreateFilteredQuery(DictTypePagedDto input)
        {
            return base.CreateFilteredQuery(input)
                .WhereIf(!string.IsNullOrEmpty(input.ExcludeId), t => t.Id != input.ExcludeId) //不包含排除ID
                .WhereIf(!string.IsNullOrEmpty(input.Name), t => t.Name.Contains(input.Name))
                .WhereIf(!string.IsNullOrEmpty(input.Remark), t => t.Remark.Contains(input.Remark))
                .WhereIf(!string.IsNullOrEmpty(input.Code), t => t.Code == input.Code)
                .WhereIf(!string.IsNullOrEmpty(input.PID), t => t.PID == input.PID);
        }

上面是對於包含、相等或者不等於的三種狀況的條件判斷，若是咱們還須要一個時間區間範圍或者數值範圍的判斷，那麼一樣能夠在這裏進行管理規則，以下是針對產品應用服務層的過濾規則，以下代碼所示。

        /// <summary>
        /// 自定義條件處理
        /// </summary>
        /// <param name="input">查詢條件Dto</param>
        /// <returns></returns>
        protected override IQueryable<Product> CreateFilteredQuery(ProductPagedDto input)
        {
            return base.CreateFilteredQuery(input)
                .WhereIf(!input.ExcludeId.IsNullOrWhiteSpace(), t => t.Id != input.ExcludeId) //不包含排除ID

                .WhereIf(!input.ProductNo.IsNullOrWhiteSpace(), t => t.ProductNo.Contains(input.ProductNo)) //如須要精確匹配則用Equals
                .WhereIf(!input.BarCode.IsNullOrWhiteSpace(), t => t.BarCode.Contains(input.BarCode)) //如須要精確匹配則用Equals
                .WhereIf(!input.MaterialCode.IsNullOrWhiteSpace(), t => t.MaterialCode.Contains(input.MaterialCode)) //如須要精確匹配則用Equals
                .WhereIf(!input.ProductType.IsNullOrWhiteSpace(), t => t.ProductType.Contains(input.ProductType)) //如須要精確匹配則用Equals
                .WhereIf(!input.ProductName.IsNullOrWhiteSpace(), t => t.ProductName.Contains(input.ProductName)) //如須要精確匹配則用Equals
                .WhereIf(!input.Unit.IsNullOrWhiteSpace(), t => t.Unit.Contains(input.Unit)) //如須要精確匹配則用Equals
                .WhereIf(!input.Note.IsNullOrWhiteSpace(), t => t.Note.Contains(input.Note)) //如須要精確匹配則用Equals
                .WhereIf(!input.Description.IsNullOrWhiteSpace(), t => t.Description.Contains(input.Description)) //如須要精確匹配則用Equals
                 
                 //狀態
                .WhereIf(input.Status.HasValue, t => t.Status==input.Status)
                                                                                              
                 //成本價區間查詢
                .WhereIf(input.PriceStart.HasValue, s => s.Price >= input.PriceStart.Value)
                .WhereIf(input.PriceEnd.HasValue, s => s.Price <= input.PriceEnd.Value)

                //銷售價區間查詢
                .WhereIf(input.SalePriceStart.HasValue, s => s.SalePrice >= input.SalePriceStart.Value)
                .WhereIf(input.SalePriceEnd.HasValue, s => s.SalePrice <= input.SalePriceEnd.Value)

                //特價區間查詢
                .WhereIf(input.SpecialPriceStart.HasValue, s => s.SpecialPrice >= input.SpecialPriceStart.Value)
                .WhereIf(input.SpecialPriceEnd.HasValue, s => s.SpecialPrice <= input.SpecialPriceEnd.Value)
                .WhereIf(input.IsUseSpecial.HasValue, t => t.IsUseSpecial == input.IsUseSpecial) //如須要精確匹配則用Equals
                                                                                                  
                //最低折扣區間查詢
                .WhereIf(input.LowestDiscountStart.HasValue, s => s.LowestDiscount >= input.LowestDiscountStart.Value)
                .WhereIf(input.LowestDiscountEnd.HasValue, s => s.LowestDiscount <= input.LowestDiscountEnd.Value)

                //建立日期區間查詢
                .WhereIf(input.CreationTimeStart.HasValue, s => s.CreationTime >= input.CreationTimeStart.Value)
                .WhereIf(input.CreationTimeEnd.HasValue, s => s.CreationTime <= input.CreationTimeEnd.Value);
        }

以上就是咱們深刻對分頁查詢和判斷是否存在接口的細節處理，能夠包含不少自定義的條件，如等於或不等於、包含或者不包含，區間查詢（大於或者小於等）條件的處理。對於省份城市行政區管理模塊的重複性判斷，咱們經過Count函數來判斷，同時在後臺應用服務層對這些參數進行規則過濾便可。