Dkd.Infra.Filter 1.9.0

dotnet add package Dkd.Infra.Filter --version 1.9.0
                    
NuGet\Install-Package Dkd.Infra.Filter -Version 1.9.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Dkd.Infra.Filter" Version="1.9.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Dkd.Infra.Filter" Version="1.9.0" />
                    
Directory.Packages.props
<PackageReference Include="Dkd.Infra.Filter" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Dkd.Infra.Filter --version 1.9.0
                    
#r "nuget: Dkd.Infra.Filter, 1.9.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Dkd.Infra.Filter@1.9.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Dkd.Infra.Filter&version=1.9.0
                    
Install as a Cake Addin
#tool nuget:?package=Dkd.Infra.Filter&version=1.9.0
                    
Install as a Cake Tool

Dkd.Infra.Filter

پکیج فیلتر پویای JSON — تبدیل فیلترهای پیچیده‌ی JSON (خروجی کتابخانه‌ی فرانت‌اند) به Expression و اعمال آن‌ها روی IQueryable قبل از صفحه‌بندی (Paging). پشتیبانی از عملگرهای متنوع، گروه‌های تو در تو (AND/OR) و اعتبارسنجی امنیتی فیلدها.

  • TargetFramework: net8.0
  • نسخه‌ی فعلی: 1.8.1
  • لایسنس: MIT
  • Namespace اصلی: Dkd.Infra.Filter

معرفی

این پکیج برای صفحه‌بندی‌های پویا (Dynamic Paging) طراحی شده است؛ جایی که کاربر فرانت‌اند می‌خواهد فیلترهای دلخواه بسازد. قرارداد JSON دقیقاً همان خروجی پکیج فرانت‌اند @dkd/filter (UniversalFilter) است.

مزایا:

  1. قدرت‌مندی: عملگرهای contains، between، >، <، isempty و …
  2. گروه‌بندی: گروه‌های تو در تو با AND/OR (بازگشتی).
  3. امنیت: امکان محدودکردن فیلدهای مجاز (allowedFields).
  4. سادگی: با یک متد ApplyJsonFilter همه‌چیز انجام می‌شود.

امکانات اصلی

  • اعتبارسنجی JSON فیلتر با FilterJsonValidator (ساختار، عملگرها و مقادیر).
  • ساخت Expression با FilterExpressionBuilder (با Reflection و تبدیل خودکار نوع).
  • اعمال روی IQueryable با QueryableFilterExtensions (ApplyJsonFilter / ApplyFilter).
  • پشتیبانی از مسیر نقطه‌ای (a.b.c) برای پراپرتی‌های تو در تو.
  • خطای فارسی با BusinessException (HTTP 400) هنگام ورودی نامعتبر.
  • فیلتر خالی/null: بدون تغییر کوئری.

قرارداد JSON

{
  "combinator": "AND",
  "rules": [
    { "field": "name", "operator": "contains", "value": "علی" },
    { "field": "salary", "operator": "between", "value": 2000, "valueTo": 4000 },
    { "combinator": "OR", "rules": [ { "field": "status", "operator": "=", "value": true } ] }
  ]
}
بخش توضیح
combinator AND یا OR
rules آرایه‌ای از «شرط ساده» یا «گروه تو در تو»
field نام/مسیر پراپرتی موجودیت (مسیر نقطه‌ای a.b.c پشتیبانی می‌شود)
operator contains beginsWith endsWith = != < > <= >= between isempty isnotempty
value / valueTo مقدار (عدد، رشته، بولی، تاریخ ISO) — valueTo فقط برای between

سمانتیک تاریخ بر اساس «روز» است (مطابق فرانت‌اند): = → بازه [روز, روز+۱) | < → قبل از روز | > → از روز بعد | between → [از, تا+۱).


ساختار پروژه

Dkd.Infra.Filter/
├── FilterOperator.cs                       # enum عملگرها + Parse از رشته JSON
├── Dtos/FilterGroupDto.cs                  # قرارداد JSON (گروه + آیتم بازگشتی)
├── Validation/FilterJsonValidator.cs       # اعتبارسنجی ساختار، عملگر و مقادیر
├── Expressions/FilterExpressionBuilder.cs  # ساخت Expression tree
└── Extensions/QueryableFilterExtensions.cs # ApplyJsonFilter / ApplyFilter

کلاس‌های کلیدی

نام توضیح
FilterGroupDto قرارداد JSON گروه فیلتر (بازگشتی).
FilterOperator عملگرهای پشتیبانی‌شده و Parse آن‌ها.
FilterJsonValidator اعتبارسنجی ساختار، عملگرها و مقادیر قبل از ساخت Expression.
FilterExpressionBuilder ساخت Expression<Func<T, bool>> با Reflection و تبدیل خودکار نوع.
QueryableFilterExtensions متدهای ApplyJsonFilter و ApplyFilter روی IQueryable<T>.

روش استفاده

using Dkd.Infra.Filter.Extensions;

public async Task<ServiceResult<PageModelDto<UserDto>>> GetPagedAsync(
    UserSearchPagedDto search, CancellationToken ct = default)
{
    var query = _db.Users.AsNoTracking()
        .ApplyJsonFilter(search.Filter);            // اعتبارسنجی + اعمال فیلتر

    var total = await query.CountAsync(ct);
    var items = await query
        .OrderBy(x => x.Id)
        .Skip(search.SkipRows())
        .Take(search.PageSize)
        .ToListAsync(ct);

    return ServiceResult(new PageModelDto<UserDto>(search.PageIndex, search.PageSize, total, items));
}

محدود کردن فیلدهای مجاز (اختیاری — امنیت):

query.ApplyJsonFilter(search.Filter, allowedFields: ["id", "name", "account", "status"]);

وابستگی‌ها

  • Dkd.Infra.Core (برای BusinessException و JsonHelper)
  • System.Text.Json
  • بدون پکیج خارجی جدید.

اطلاعات تکمیلی

  • ورژن: 1.8.1
  • پیشوند پکیج: Dkd.Infra
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.9.0 107 8/12/2026
1.8.1 119 8/10/2026