在這個前后端分離開發的今天，前端通過呼叫后端提供的api介面，實作頁面資料的展示，而往往在實際場景中，會出現兩個版塊呼叫的資料極度相似的情況，A頁面與B頁面所展示的串列，僅僅相差了幾個欄位，
如果這個時候，我們選擇將資料的所有欄位一起回傳，則會增大了Http請求的體積，好處是后續版塊需求變化時，前端直接替換對應的欄位即可，后端不需要修改回傳的資料，但這樣明顯是不符合規范的，而且在特定情況下會導致資訊泄露，
還有一種方法，我們針對A頁面與B頁面各自回傳一個DTO或VO，這樣資訊就不會泄露，但這樣卻違背了RESTful的原則，且加大了視圖（UI）與應用層（Application）之間的耦合度，應用層回傳什么資料原則上不應該由視圖決定，
所以，我們需要一個可以由前端來指定api回傳欄位的方式，那就是資料塑形，
首先，為DTO設計一個塑形介面，并將介面方法默認實作：
1 public interface IShapeDto 2 { 3 /// <summary> 4 /// 資料塑形 5 /// </summary> 6 /// <param name="fields">指定的回傳欄位;欄位之間用,分隔</param> 7 /// <returns></returns> 8 dynamic ShapeData(string fields) 9 { 10 //驗證欄位是否為空 11 if (string.IsNullOrEmpty(fields)) 12 return this; 13 //拆分欄位 14 var fieldsAfterSplit = fields.Split(',', StringSplitOptions.RemoveEmptyEntries); 15 //驗證可用數量 16 if (fieldsAfterSplit.Length == 0) 17 return this; 18 //得到當前DTO的型別 19 var dtoType = GetType(); 20 //開辟一個用于存盤有效屬性的記憶體 21 var newFields = new Queue<PropertyInfo>(); 22 //public指定公共成員要包括在搜索中 Instance指定實體成員要包括在搜索中 IgnoreCase指定在系結時不應考慮成員名稱的大小寫 23 var bindingFlasgs = BindingFlags.Public | BindingFlags.Instance | BindingFlags.IgnoreCase; 24 foreach (var field in fieldsAfterSplit) 25 { 26 //搜索指定名稱的屬性 27 var propertyInfo = dtoType.GetProperty(field, bindingFlasgs); 28 //壓入符合的屬性 29 if (propertyInfo != null) 30 newFields.Enqueue(propertyInfo); 31 } 32 //創建一個即將回傳的DTO物件 33 var newDto = new ExpandoObject(); 34 while (newFields.Count > 0) 35 { 36 //彈出符合的屬性 37 var newField = newFields.Dequeue(); 38 //添加自定義欄位及欄位值 39 newDto.TryAdd(newField.Name, newField.GetValue(this)); 40 } 41 return newDto; 42 }
這里需要提到的是，ExpandoObject的資料結構本質上是一個Dictionary物件，其自身實作了IDictionary<string,object>，所以我們可以通過TryAdd()為其添加自定義的屬性和值，從而構建了一個動態物件：
//
// 摘要:
// Represents an object whose members can be dynamically added and removed at run
// time.
public sealed class ExpandoObject : ICollection<KeyValuePair<string, object>>, IEnumerable<KeyValuePair<string, object>>, IEnumerable, IDictionary<string, object>,
INotifyPropertyChanged, IDynamicMetaObjectProvider
{
//
// 摘要:
// Initializes a new ExpandoObject that does not have members.
public ExpandoObject();
}
TryAdd()在System.Collections.Generic.CollectionExtensions下：
public static bool TryAdd<TKey, TValue>(this IDictionary<TKey, TValue> dictionary, TKey key, TValue value) where TKey : notnull;
接下來，根據功能需求設計一個DTO類，并實作IShapeDto：
1 public class GetPersonDto : IShapeDto 2 { 3 public string Name { set; get; } 4 public int Age { set; get; } 5 public string Address { set; get; } 6 }
然后，我們在Service中撰寫業務：
1 public async Task<GetPersonDto> GetPerson(int id) 2 { 3 var personEntity = await personRepository.GetPersonAsync(id); 4 return mapper.Map<GetPersonDto>(personEntity);//任意形式的映射 將 Entity 轉 DTO 5 }
最后，在Controller中塑形：
1 [HttpGet("{id}")] 2 public async Task<ActionResult<string>> Get(int id, string fields) 3 { 4 var resultDto= await personService.GetPerson(id) as IShapeDto; 5 return new JsonResult(resultDto.ShapeData(fields)); 6 }
需要注意的是，上面的代碼只能運用于單個DTO物件的塑形，如果是基于IEnumerable<IShapeDto>，不建議使用Select(dto => dto.ShapeData(fields))的形式，原因是ShapeData()中反射屬性名的代碼不需要執行多次，建議將其提取出來，
而碰到這個情況，我們應該針對IEnumerable<IShapeDto>撰寫擴展方法，不了解的伙伴可以參考我的代碼自行撰寫，這里我就不過多贅述，
public static IEnumerable<dynamic> ShapeData(this IEnumerable<IShapeDto> dtos, string fields)
最后，有的小伙伴可能會問，塑形動作應該是放在介面層還是放在應用層？IShapeDto為什么不寫成抽象類進行繼承？為什么不寫擴展方法對所有object進行擴展？類似于這些問題，我只想說都可以，上面的代碼完全是我個人的一個編碼習慣，不能成為一個指導性的東西，在代碼設計層面，每個人都會有不一樣的看法，歡迎大家評論交流，
author:https://www.cnblogs.com/abnerwong/
轉載請註明出處，本文鏈接：https://www.uj5u.com/net/241652.html
標籤：.NET Core