關于.NET Attribute在數據校驗中的應用教程

 更新時間:2020-06-14 00:02:02   作者:佚名   我要評論(0)

前言
Attribute(特性)的概念不在此贅述了,相信有點.NET基礎的開發人員都明白,用過Attribute的人也不在少數,畢竟很多框架都提供自定義的屬性,類似于Newtonsoft

前言

Attribute(特性)的概念不在此贅述了,相信有點.NET基礎的開發人員都明白,用過Attribute的人也不在少數,畢竟很多框架都提供自定義的屬性,類似于Newtonsoft.JSON中JsonProperty、JsonIgnore等

自定義特性

.NET 框架允許創建自定義特性,用于存儲聲明性的信息,且可在運行時被檢索。該信息根據設計標準和應用程序需要,可與任何目標元素相關。

創建并使用自定義特性包含四個步驟:

  • 聲明自定義特性
  • 構建自定義特性
  • 在目標程序元素上應用自定義特性
  • 通過反射訪問特性

聲明自定義特性

一個新的自定義特性必須派生自System.Attribute類,例如:

public class FieldDescriptionAttribute : Attribute
{
  public string Description { get; private set; }

  public FieldDescriptionAttribute(string description)
  {
    Description = description;
  }
}
public class UserEntity
{
  [FieldDescription("用戶名稱")]
  public string Name { get; set; }
}

該如何拿到我們標注的信息呢?這時候需要使用反射獲取

   var type = typeof(UserEntity);
   var properties = type.GetProperties();
   foreach (var item in properties)
   {
     if(item.IsDefined(typeof(FieldDescriptionAttribute), true))
     {
       var attribute = item.GetCustomAttribute(typeof(FieldDescriptionAttribute)) as FieldDescriptionAttribute;
       Console.WriteLine(attribute.Description);
     }
   }

執行結果如下:

從執行結果上看,我們拿到了我們想要的數據,那么這個特性在實際使用過程中,到底有什么用途呢?

Attribute特性妙用

在實際開發過程中,我們的系統總會提供各種各樣的對外接口,其中參數的校驗是必不可少的一個環節。然而沒有特性時,校驗的代碼是這樣的:

 public class UserEntity
 {
   /// <summary>
   /// 姓名
   /// </summary>
   [FieldDescription("用戶名稱")]
   public string Name { get; set; }

   /// <summary>
   /// 年齡
   /// </summary>
   public int Age { get; set; }

   /// <summary>
   /// 地址
   /// </summary>
   public string Address { get; set; }
 }
   UserEntity user = new UserEntity();

   if (string.IsNullOrWhiteSpace(user.Name))
   {
     throw new Exception("姓名不能為空");
   }
   if (user.Age <= 0)
   {
     throw new Exception("年齡不合法");
   }
   if (string.IsNullOrWhiteSpace(user.Address))
   {
     throw new Exception("地址不能為空");
   }

字段多了之后這種代碼就看著非常繁瑣,并且看上去不直觀。對于這種繁瑣又惡心的代碼,有什么方法可以優化呢?
使用特性后的驗證寫法如下:

首先定義一個基礎的校驗屬性,提供基礎的校驗方法

  public abstract class AbstractCustomAttribute : Attribute
  {
    /// <summary>
    /// 校驗后的錯誤信息
    /// </summary>
    public string ErrorMessage { get; set; }

    /// <summary>
    /// 數據校驗
    /// </summary>
    /// <param name="value"></param>
    public abstract void Validate(object value);
  }

然后可以定義常用的一些對應的校驗Attribute,例如RequiredAttribute、StringLengthAttribute

    /// <summary>
    /// 非空校驗
    /// </summary>
    [AttributeUsage(AttributeTargets.Property)]
    public class RequiredAttribute : AbstractCustomAttribute
    {
      public override void Validate(object value)
      {
        if (value == null || string.IsNullOrWhiteSpace(value.ToString()))
        {
          throw new Exception(string.IsNullOrWhiteSpace(ErrorMessage) ? "字段不能為空" : ErrorMessage);
        }
      }
    }

    /// <summary>
    /// 自定義驗證,驗證字符長度
    /// </summary>
    [AttributeUsage(AttributeTargets.Property)]
    public class StringLengthAttribute : AbstractCustomAttribute
    {
      private int _maxLength;
      private int _minLength;

      public StringLengthAttribute(int minLength, int maxLength)
      {
        this._maxLength = maxLength;
        this._minLength = minLength;
      }

      public override void Validate(object value)
      {
        if (value != null && value.ToString().Length >= _minLength && value.ToString().Length <= _maxLength)
        {
          return;
        }

        throw new Exception(string.IsNullOrWhiteSpace(ErrorMessage) ? $"字段長度必須在{_minLength}與{_maxLength}之間" : ErrorMessage);
      }
    }

添加一個用于校驗的ValidateExtensions

public static class ValidateExtensions
 {
   /// <summary>
   /// 校驗
   /// </summary>
   /// <typeparam name="T"></typeparam>
   /// <returns></returns>
   public static void Validate<T>(this T entity) where T : class
   {
     Type type = entity.GetType();

     foreach (var item in type.GetProperties())
     {
       //需要對Property的字段類型做區分處理針對Object List 數組需要做區分處理
       if (item.PropertyType.IsPrimitive || item.PropertyType.IsEnum || item.PropertyType.IsValueType || item.PropertyType == typeof(string))
       {
         //如果是基元類型、枚舉類型、值類型或者字符串 直接進行校驗
         CheckProperty(entity, item);
       }
       else
       {
         //如果是引用類型
         var value = item.GetValue(entity, null);
         CheckProperty(entity, item);
         if (value != null)
         {
           if ((item.PropertyType.IsGenericType && Array.Exists(item.PropertyType.GetInterfaces(), t => t.GetGenericTypeDefinition() == typeof(IList<>))) || item.PropertyType.IsArray)
           {
             //判斷IEnumerable
             var enumeratorMI = item.PropertyType.GetMethod("GetEnumerator");
             var enumerator = enumeratorMI.Invoke(value, null);
             var moveNextMI = enumerator.GetType().GetMethod("MoveNext");
             var currentMI = enumerator.GetType().GetProperty("Current");
             int index = 0;
             while (Convert.ToBoolean(moveNextMI.Invoke(enumerator, null)))
             {
               var currentElement = currentMI.GetValue(enumerator, null);
               if (currentElement != null)
               {
                 currentElement.Validate();
               }
               index++;
             }
           }
           else
           {
             value.Validate();
           }
         }
       }
     }
   }

   private static void CheckProperty(object entity, PropertyInfo property)
   {
     if (property.IsDefined(typeof(AbstractCustomAttribute), true))//此處是重點
     {
       //此處是重點
       foreach (AbstractCustomAttribute attribute in property.GetCustomAttributes(typeof(AbstractCustomAttribute), true))
       {
         if (attribute == null)
         {
           throw new Exception("AbstractCustomAttribute not instantiate");
         }

         attribute.Validate(property.GetValue(entity, null));
       }
     }
   }
 }

新的實體類

 public class UserEntity
 {
   /// <summary>
   /// 姓名
   /// </summary>
   [Required]
   public string Name { get; set; }

   /// <summary>
   /// 年齡
   /// </summary>
   public int Age { get; set; }

   /// <summary>
   /// 地址
   /// </summary>
   [Required]
   public string Address { get; set; }

   [StringLength(11, 11)]
   public string PhoneNum { get; set; }
 }

調用方式

UserEntity user = new UserEntity();
user.Validate();

上面的校驗邏輯寫的比較復雜,主要是考慮到對象中包含復雜對象的情況,如果都是簡單對象,可以不用考慮,只需針對單個屬性做字段校驗

現有的方式是在校驗不通過的時候拋出異常,此處大家也可以自定義異常來表示校驗的問題,也可以返回自定義的校驗結果實體來記錄當前是哪個字段出的問題,留待大家自己實現

如果您有更好的建議和想法歡迎提出,共同進步

總結

到此這篇關于.NET Attribute在數據校驗中的應用的文章就介紹到這了,更多相關.NET Attribute在數據校驗的應用內容請搜索腳本之家以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持腳本之家!

您可能感興趣的文章:

  • 詳解.Net Core 權限驗證與授權(AuthorizeFilter、ActionFilterAttribute)
  • ASP.NET MVC使用ActionFilterAttribute實現權限限制的方法(附demo源碼下載)
  • .NET獲取枚舉DescriptionAttribute描述信息性能改進的多種方法
  • asp.net MVC利用ActionFilterAttribute過濾關鍵字的方法

相關文章

  • 關于.NET Attribute在數據校驗中的應用教程

    關于.NET Attribute在數據校驗中的應用教程

    前言 Attribute(特性)的概念不在此贅述了,相信有點.NET基礎的開發人員都明白,用過Attribute的人也不在少數,畢竟很多框架都提供自定義的屬性,類似于Newtonsoft
    2020-06-14
  • ASP.NET開源導入導出庫Magicodes.IE完成Csv導入導出的方法

    ASP.NET開源導入導出庫Magicodes.IE完成Csv導入導出的方法

    說明 本章主要說明如何使用Magicodes.IE.Csv進行Csv導入導出. 關于Magicodes.IE 導入導出通用庫,通過導入導出DTO模型來控制導入和導出,支持Excel、Word、Pd
    2020-06-14
  • .net core 3.1在iis上發布的踩坑記錄

    .net core 3.1在iis上發布的踩坑記錄

    前言 寫這篇文章的目的是希望像我一樣喜歡.net 的人在發布 core到 iis上時少走點彎路 網上找了些資料,其實實際操作比較簡單,就是有幾個坑很惡心 踩坑記錄 首先是你
    2020-06-14
  • .NET IoC模式依賴反轉(DIP)、控制反轉(Ioc)、依賴注入(DI)

    .NET IoC模式依賴反轉(DIP)、控制反轉(Ioc)、依賴注入(DI)

    依賴倒置原則(DIP) 依賴倒置(Dependency Inversion Principle,縮寫DIP)是面向對象六大基本原則之一。他是指一種特定的的解耦形式,使得高層次的模塊不依賴低層次的
    2020-06-14
  • asp.net mvc core管道及攔截器的理解

    asp.net mvc core管道及攔截器的理解

    今天來看一下asp.net core的執行管道。先看下官方說明: 從上圖可以拋光,asp.net core的執行順序是,當收到一個請求后,request請求會先經過已注冊的中間件,然后
    2020-06-14
  • 聊一聊Asp.net過濾器Filter那一些事

    聊一聊Asp.net過濾器Filter那一些事

    最近在整理優化.net代碼時,發現幾個很不友好的處理現象:登錄判斷、權限認證、日志記錄、異常處理等通用操作,在項目中的action中到處都是。在代碼優化上,這一點是
    2020-06-14
  • xUnit 編寫 ASP.NET Core 單元測試的方法

    xUnit 編寫 ASP.NET Core 單元測試的方法

    還記得 .NET Framework 的 ASP.NET WebForm 嗎?那個年代如果要在 Web 層做單元測試簡直就是災難啊。.NET Core 吸取教訓,在設計上考慮到了可測試性,就連 ASP.NET
    2020-06-14
  • ASP.NET Core自定義中間件如何讀取Request.Body與Response.Body的內容詳解

    ASP.NET Core自定義中間件如何讀取Request.Body與Response.Body的內容詳解

    背景# 最近在徒手造輪子,編寫一個ASP.NET Core的日志監控器,其中用到了自定義中間件讀取Request.Body和Response.Body的內容,但是編寫過程,并不像想象中的一帆
    2020-06-14
  • ASP.NET Core MVC如何實現運行時動態定義Controller類型

    ASP.NET Core MVC如何實現運行時動態定義Controller類型

    昨天有個朋友在微信上問我一個問題:他希望通過動態腳本的形式實現對ASP.NET Core MVC應用的擴展,比如在程序運行過程中上傳一段C#腳本將其中定義的Controller類型注
    2020-06-14
  • 實例講解PHP表單

    實例講解PHP表單

    表單處理 GET vs. POST 1 GET 和 POST 都創建數組(例如,array( key => value, key2 => value2, key3 => value3, ...))。此數組包含鍵/值對,其中的鍵是表單控
    2020-06-10

最新評論

买宝宝用品赚钱吗 湖北30选5中奖如何规则 江苏十一选五开奖结果 广东快乐10分开户 快乐十分选号技巧视频 基金配资申请 江苏十一选五开奖结果 北京赛车计划网页 北京赛车预测网址最全 全国最大彩票论坛 股票指数 北京pk10定位胆怎么玩的 体彩十一运夺金奖金 股市趋势技术分析 内蒙古快3遗漏号 河南快3走试图 广东快乐十分爱彩乐开奖记录