.NET 6开发TodoList应用之实现数据塑形

 更新时间:2022年01月05日 09:05:31   作者:CODE4NOTHING  
在查询的场景中,还有一类需求不是很常见,就是在前端请求中指定返回的字段。所以这篇文章主要介绍了.NET 6如何实现数据塑形,需要的可以参考一下

需求

在查询的场景中,还有一类需求不是很常见,就是在前端请求中指定返回的字段,所以关于搜索的最后一个主题我们就来演示一下关于数据塑形(Data Shaping)。

目标

实现数据塑形搜索请求。

原理与思路

对于数据塑形来说,我们需要定义一些接口和泛型类实现来完成通用的功能,然后修改对应的查询请求,实现具体的功能。

实现

定义通用接口和泛型类实现

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);
}

并实现通用的功能:

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;
    }
}

定义扩展方法

为了使我们的Handle方法调用链能够直接应用,我们在Application/Extensions中新增一个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);
    }
}

然后再对我们之前写的MappingExtensions静态类中添加一个方法:

MappingExtensions.cs

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

添加依赖注入

在Application的DependencyInjection.cs中添加依赖注入:

DependencyInjection.cs

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

修改查询请求和Controller接口

我们在上一篇文章实现排序的基础上增加一个字段用于指明数据塑形字段并对应修改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()
                // 进行数据塑形和分页返回
                .ShapeData(_shaper, request.Fields)
                .PaginatedListFromEnumerable(request.PageNumber, request.PageSize)
            );
    }
}

对应修改Controller:

TodoItemController.cs

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

验证

启动Api项目,执行查询TodoItem的请求:

请求

响应

我们再把之前讲到的过滤和搜索添加到请求里来:

请求

响应

总结

对于数据塑形的请求,关键步骤就是使用反射获取待返回对象的所有配置的可以返回的属性,再通过前端传入的属性名称进行过滤和值的重组进行返回。实现起来是比较简单的。但是在实际的使用过程中我不推荐这样用,除了某些非常适用的特殊场景。个人更偏向于向前端提供明确的接口定义。

到此这篇关于.NET 6开发TodoList应用之实现数据塑形的文章就介绍到这了,更多相关.NET 6数据塑形内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • ASP.NET MVC使用异步Action的方法

    ASP.NET MVC使用异步Action的方法

    这篇文章介绍了ASP.NET MVC使用异步Action的方法,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-10-10
  • ASP.NET如何使用web服务的会话状态

    ASP.NET如何使用web服务的会话状态

    这篇文章主要介绍了ASP.NET如何使用web服务的会话状态,使用一个GridView中的会话对象来展示最近的计算结果,感兴趣的小伙伴们可以参考一下
    2015-11-11
  • 浅析ASP.NET路由模型工作原理

    浅析ASP.NET路由模型工作原理

    很多人知道Asp.Net中路由怎么用的,却不知道路由模型内部的运行原理,今天我就给大家吹下ASP.NET的路由模块是如何工作的
    2016-03-03
  • ASP.NET MVC 中实现基于角色的权限控制的处理方法

    ASP.NET MVC 中实现基于角色的权限控制的处理方法

    在ASP.NET MVC中,通过使用其所提供的内置
    2013-03-03
  • ASP.NET验证码实现(附源码)

    ASP.NET验证码实现(附源码)

    这篇文章主要介绍了ASP.NET验证码实现过程,并为大家分享了源码下载,感兴趣的小伙伴们可以参考一下
    2015-11-11
  • asp.net 半角全角转化工具

    asp.net 半角全角转化工具

    asp.net下半角和全角字符转换工具实现代码
    2008-12-12
  • 仿vs实现WPF好看的进度条

    仿vs实现WPF好看的进度条

    由于WPF自带的进度条其实不怎么好看,而且没啥视觉效果。下面给大家分享的是仿VS的进度条效果的代码,有需要的小伙伴可以参考下。
    2015-06-06
  • 详解Spring Boot 中使用 Java API 调用 lucene

    详解Spring Boot 中使用 Java API 调用 lucene

    这篇文章主要介绍了详解Spring Boot 中使用 Java API 调用 lucene,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-11-11
  • ASP.NET使用TreeView显示文件的方法

    ASP.NET使用TreeView显示文件的方法

    这篇文章主要介绍了ASP.NET使用TreeView显示文件的方法,包括控件的使用、页面加载代码及节点事件,是WEB应用程序中非常实用的技巧,需要的朋友可以参考下
    2014-09-09
  • .NET Core中使用gRPC的方法

    .NET Core中使用gRPC的方法

    gRPC 一开始由 google 开发,是一款语言中立、平台中立、开源的远程过程调用(RPC)系统,所以叫g(google)RPC,这篇文章主要介绍了.NET Core中使用gRPC,需要的朋友可以参考下
    2022-09-09

最新评论