.NET 6開發(fā)TodoList應(yīng)用之實(shí)現(xiàn)數(shù)據(jù)塑形
需求
在查詢的場(chǎng)景中,還有一類需求不是很常見,就是在前端請(qǐng)求中指定返回的字段,所以關(guān)于搜索的最后一個(gè)主題我們就來演示一下關(guān)于數(shù)據(jù)塑形(Data Shaping)。
目標(biāo)
實(shí)現(xiàn)數(shù)據(jù)塑形搜索請(qǐng)求。
原理與思路
對(duì)于數(shù)據(jù)塑形來說,我們需要定義一些接口和泛型類實(shí)現(xiàn)來完成通用的功能,然后修改對(duì)應(yīng)的查詢請(qǐng)求,實(shí)現(xiàn)具體的功能。
實(shí)現(xiàn)
定義通用接口和泛型類實(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ì)我們之前寫的MappingExtensions靜態(tà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);
}
添加依賴注入
在Application的DependencyInjection.cs中添加依賴注入:
DependencyInjection.cs
// 省略其他 services.AddScoped(typeof(IDataShaper<>), typeof(DataShaper<>));
修改查詢請(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ù)塑形和分頁返回
.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í)行查詢TodoItem的請(qǐng)求:
請(qǐng)求

響應(yīng)

我們?cè)侔阎爸v到的過濾和搜索添加到請(qǐng)求里來:
請(qǐng)求

響應(yīng)

總結(jié)
對(duì)于數(shù)據(jù)塑形的請(qǐng)求,關(guān)鍵步驟就是使用反射獲取待返回對(duì)象的所有配置的可以返回的屬性,再通過前端傳入的屬性名稱進(jìn)行過濾和值的重組進(jìn)行返回。實(shí)現(xiàn)起來是比較簡單的。但是在實(shí)際的使用過程中我不推薦這樣用,除了某些非常適用的特殊場(chǎng)景。個(gè)人更偏向于向前端提供明確的接口定義。
到此這篇關(guān)于.NET 6開發(fā)TodoList應(yīng)用之實(shí)現(xiàn)數(shù)據(jù)塑形的文章就介紹到這了,更多相關(guān).NET 6數(shù)據(jù)塑形內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- .NET 6開發(fā)TodoList應(yīng)用之實(shí)現(xiàn)全局異常處理
- .NET 6開發(fā)TodoList應(yīng)用之實(shí)現(xiàn)PUT請(qǐng)求
- .NET?6開發(fā)TodoList應(yīng)用之實(shí)現(xiàn)DELETE請(qǐng)求與HTTP請(qǐng)求冪等性
- .NET 6開發(fā)TodoList應(yīng)用之實(shí)現(xiàn)接口請(qǐng)求驗(yàn)證
- .NET 6開發(fā)TodoList應(yīng)用之實(shí)現(xiàn)ActionFilter
- .NET 6開發(fā)TodoList應(yīng)用之實(shí)現(xiàn)查詢分頁
- .NET?6開發(fā)TodoList應(yīng)用之請(qǐng)求日志組件HttpLogging介紹
- .NET 6開發(fā)TodoList應(yīng)用之實(shí)現(xiàn)查詢排序
相關(guān)文章
ASP.NET如何使用web服務(wù)的會(huì)話狀態(tài)
這篇文章主要介紹了ASP.NET如何使用web服務(wù)的會(huì)話狀態(tài),使用一個(gè)GridView中的會(huì)話對(duì)象來展示最近的計(jì)算結(jié)果,感興趣的小伙伴們可以參考一下2015-11-11
ASP.NET MVC 中實(shí)現(xiàn)基于角色的權(quán)限控制的處理方法
在ASP.NET MVC中,通過使用其所提供的內(nèi)置2013-03-03
ASP.NET驗(yàn)證碼實(shí)現(xiàn)(附源碼)
這篇文章主要介紹了ASP.NET驗(yàn)證碼實(shí)現(xiàn)過程,并為大家分享了源碼下載,感興趣的小伙伴們可以參考一下2015-11-11
仿vs實(shí)現(xiàn)WPF好看的進(jìn)度條
由于WPF自帶的進(jìn)度條其實(shí)不怎么好看,而且沒啥視覺效果。下面給大家分享的是仿VS的進(jìn)度條效果的代碼,有需要的小伙伴可以參考下。2015-06-06
詳解Spring Boot 中使用 Java API 調(diào)用 lucene
這篇文章主要介紹了詳解Spring Boot 中使用 Java API 調(diào)用 lucene,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2017-11-11

