快捷導(dǎo)航

.NET 6開(kāi)發(fā)TodoList應(yīng)用之實(shí)現(xiàn)數(shù)據(jù)塑形

更新時(shí)間：2022年01月05日 09:05:31 作者：CODE4NOTHING

在查詢(xún)的場(chǎng)景中，還有一類(lèi)需求不是很常見(jiàn)，就是在前端請(qǐng)求中指定返回的字段。所以這篇文章主要介紹了.NET 6如何實(shí)現(xiàn)數(shù)據(jù)塑形，需要的可以參考一下

需求

在查詢(xún)的場(chǎng)景中，還有一類(lèi)需求不是很常見(jiàn)，就是在前端請(qǐng)求中指定返回的字段，所以關(guān)于搜索的最后一個(gè)主題我們就來(lái)演示一下關(guān)于數(shù)據(jù)塑形（Data Shaping）。

目標(biāo)

實(shí)現(xiàn)數(shù)據(jù)塑形搜索請(qǐng)求。

原理與思路

對(duì)于數(shù)據(jù)塑形來(lái)說(shuō)，我們需要定義一些接口和泛型類(lèi)實(shí)現(xiàn)來(lái)完成通用的功能，然后修改對(duì)應(yīng)的查詢(xún)請(qǐng)求，實(shí)現(xiàn)具體的功能。

實(shí)現(xiàn)

定義通用接口和泛型類(lèi)實(shí)現(xiàn)

IDataShaper.cs

using System.Dynamic;

namespace TodoList.Application.Common.Interfaces;

public interface IDataShaper<T>
{
    IEnumerable<ExpandoObject> ShapeData(IEnumerable<T> entities, string fieldString);
    ExpandoObject ShapeData(T entity, string fieldString);
}

并實(shí)現(xiàn)通用的功能：

DataShaper.cs

using System.Dynamic;
using System.Reflection;
using TodoList.Application.Common.Interfaces;

namespace TodoList.Application.Common;

public class DataShaper<T> : IDataShaper<T> where T : class
{
    public PropertyInfo[] Properties { get; set; }

    public DataShaper()
    {
        Properties = typeof(T).GetProperties(BindingFlags.Public | BindingFlags.Instance);
    }

    public IEnumerable<ExpandoObject> ShapeData(IEnumerable<T> entities, string? fieldString)
    {
        var requiredProperties = GetRequiredProperties(fieldString);

        return GetData(entities, requiredProperties);
    }

    public ExpandoObject ShapeData(T entity, string? fieldString)
    {
        var requiredProperties = GetRequiredProperties(fieldString);

        return GetDataForEntity(entity, requiredProperties);
    }

    private IEnumerable<PropertyInfo> GetRequiredProperties(string? fieldString)
    {
        var requiredProperties = new List<PropertyInfo>();

        if (!string.IsNullOrEmpty(fieldString))
        {
            var fields = fieldString.Split(',', StringSplitOptions.RemoveEmptyEntries);
            foreach (var field in fields)
            {
                var property = Properties.FirstOrDefault(pi => pi.Name.Equals(field.Trim(), StringComparison.InvariantCultureIgnoreCase));
                if (property == null)
                {
                    continue;
                }

                requiredProperties.Add(property);
            }
        }
        else
        {
            requiredProperties = Properties.ToList();
        }

        return requiredProperties;
    }

    private IEnumerable<ExpandoObject> GetData(IEnumerable<T> entities, IEnumerable<PropertyInfo> requiredProperties)
    {
        return entities.Select(entity => GetDataForEntity(entity, requiredProperties)).ToList();
    }

    private ExpandoObject GetDataForEntity(T entity, IEnumerable<PropertyInfo> requiredProperties)
    {
        var shapedObject = new ExpandoObject();
        foreach (var property in requiredProperties)
        {
            var objectPropertyValue = property.GetValue(entity);
            shapedObject.TryAdd(property.Name, objectPropertyValue);
        }

        return shapedObject;
    }
}

定義擴(kuò)展方法

為了使我們的Handle方法調(diào)用鏈能夠直接應(yīng)用，我們?cè)贏pplication/Extensions中新增一個(gè)DataShaperExtensions：

DataShaperExtensions.cs

using System.Dynamic;
using TodoList.Application.Common.Interfaces;

namespace TodoList.Application.Common.Extensions;

public static class DataShaperExtensions
{
    public static IEnumerable<ExpandoObject> ShapeData<T>(this IEnumerable<T> entities, IDataShaper<T> shaper, string? fieldString)
    {
        return shaper.ShapeData(entities, fieldString);
    }
}

然后再對(duì)我們之前寫(xiě)的MappingExtensions靜態(tài)類(lèi)中添加一個(gè)方法：

MappingExtensions.cs

// 省略其他...
public static PaginatedList<TDestination> PaginatedListFromEnumerable<TDestination>(this IEnumerable<TDestination> entities, int pageNumber, int pageSize)
{
    return PaginatedList<TDestination>.Create(entities, pageNumber, pageSize);   
}

添加依賴(lài)注入

在Application的DependencyInjection.cs中添加依賴(lài)注入：

DependencyInjection.cs

// 省略其他
services.AddScoped(typeof(IDataShaper<>), typeof(DataShaper<>));

修改查詢(xún)請(qǐng)求和Controller接口

我們?cè)?a href="http://www.dbjr.com.cn/article/233579.htm" target="_blank">上一篇文章實(shí)現(xiàn)排序的基礎(chǔ)上增加一個(gè)字段用于指明數(shù)據(jù)塑形字段并對(duì)應(yīng)修改Handle方法：

GetTodoItemsWithConditionQuery.cs

using System.Dynamic;
using AutoMapper;
using AutoMapper.QueryableExtensions;
using MediatR;
using TodoList.Application.Common.Extensions;
using TodoList.Application.Common.Interfaces;
using TodoList.Application.Common.Mappings;
using TodoList.Application.Common.Models;
using TodoList.Application.TodoItems.Specs;
using TodoList.Domain.Entities;
using TodoList.Domain.Enums;

namespace TodoList.Application.TodoItems.Queries.GetTodoItems;

public class GetTodoItemsWithConditionQuery : IRequest<PaginatedList<ExpandoObject>>
{
    public Guid ListId { get; set; }
    public bool? Done { get; set; }
    public string? Title { get; set; }
    // 前端指明需要返回的字段
    public string? Fields { get; set; }
    public PriorityLevel? PriorityLevel { get; set; }
    public string? SortOrder { get; set; } = "title_asc";
    public int PageNumber { get; set; } = 1;
    public int PageSize { get; set; } = 10;
}

public class GetTodoItemsWithConditionQueryHandler : IRequestHandler<GetTodoItemsWithConditionQuery, PaginatedList<ExpandoObject>>
{
    private readonly IRepository<TodoItem> _repository;
    private readonly IMapper _mapper;
    private readonly IDataShaper<TodoItemDto> _shaper;

    public GetTodoItemsWithConditionQueryHandler(IRepository<TodoItem> repository, IMapper mapper, IDataShaper<TodoItemDto> shaper)
    {
        _repository = repository;
        _mapper = mapper;
        _shaper = shaper;
    }

    public Task<PaginatedList<ExpandoObject>> Handle(GetTodoItemsWithConditionQuery request, CancellationToken cancellationToken)
    {
        var spec = new TodoItemSpec(request);
        return Task.FromResult(
            _repository
                .GetAsQueryable(spec)
                .ProjectTo<TodoItemDto>(_mapper.ConfigurationProvider)
                .AsEnumerable()
                // 進(jìn)行數(shù)據(jù)塑形和分頁(yè)返回
                .ShapeData(_shaper, request.Fields)
                .PaginatedListFromEnumerable(request.PageNumber, request.PageSize)
            );
    }
}

對(duì)應(yīng)修改Controller：

TodoItemController.cs

[HttpGet]
public async Task<ApiResponse<PaginatedList<ExpandoObject>>> GetTodoItemsWithCondition([FromQuery] GetTodoItemsWithConditionQuery query)
{
    return ApiResponse<PaginatedList<ExpandoObject>>.Success(await _mediator.Send(query));
}

驗(yàn)證

啟動(dòng)Api項(xiàng)目，執(zhí)行查詢(xún)TodoItem的請(qǐng)求：

請(qǐng)求

響應(yīng)

我們?cè)侔阎爸v到的過(guò)濾和搜索添加到請(qǐng)求里來(lái)：

請(qǐng)求

響應(yīng)

總結(jié)

對(duì)于數(shù)據(jù)塑形的請(qǐng)求，關(guān)鍵步驟就是使用反射獲取待返回對(duì)象的所有配置的可以返回的屬性，再通過(guò)前端傳入的屬性名稱(chēng)進(jìn)行過(guò)濾和值的重組進(jìn)行返回。實(shí)現(xiàn)起來(lái)是比較簡(jiǎn)單的。但是在實(shí)際的使用過(guò)程中我不推薦這樣用，除了某些非常適用的特殊場(chǎng)景。個(gè)人更偏向于向前端提供明確的接口定義。

到此這篇關(guān)于.NET 6開(kāi)發(fā)TodoList應(yīng)用之實(shí)現(xiàn)數(shù)據(jù)塑形的文章就介紹到這了,更多相關(guān).NET 6數(shù)據(jù)塑形內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: