ASP.Net Core中使用枚舉類而不是枚舉的方法
更新時間：2019年06月03日 09:10:20 作者：菠蘿吹雪—Code
這篇文章主要給大家介紹了關于ASP.Net Core中使用枚舉類而不是枚舉的相關資料，文中通過示例代碼介紹的非常詳細，對大家學習或者使用ASP.Net Core具有一定的參考學習價值，需要的朋友們下面來一起學習學習吧
前言：
我相信大家在編寫代碼時經(jīng)常會遇到各種狀態(tài)值，而且為了避免硬編碼和代碼中出現(xiàn)魔法數(shù)，通常我們都會定義一個枚舉，來表示各種狀態(tài)值，直到我看到Java中這樣使用枚舉，我再想C# 中可不可以這樣寫，今天就分享一下我的感悟。
一、通常我們是這樣使用枚舉的
（1）switch中使用枚舉
public enum EmployeeType
{
Manager,
Servant,
AssistantToTheRegionalManager
}
public class Employee
{
public EmployeeType Type { get; set; }
public decimal Bonus { get; set; }
}
static void ProcessBonus(Employee employee)
{
switch (employee.Type)
{
case EmployeeType.Manager:
employee.Bonus = 1000m;
break;
case EmployeeType.Servant:
employee.Bonus = 0.01m;
break;
case EmployeeType.AssistantToTheRegionalManager:
employee.Bonus = 1.0m;
break;
default:
throw new ArgumentOutOfRangeException();
}
}
在沒有進某唐時我也是這樣的寫的，代碼很爛，違法了開閉原則，擴展性極差。在代碼規(guī)范中是不允許出現(xiàn)這樣的寫法的。對于上面的寫法可以使用設計模式來重構。后面會繼續(xù)更新設計模式的文章。
（2）類型轉(zhuǎn)換
EnumTricks.IsVolumeHigh((Volume)27); EnumTricks.High((int)Medium);
二、枚舉的不好之處
關于枚舉的MSDN文檔說了什么：
“The enum keyword is used to declare an enumeration, a distinct type that consists of a set of named constants called the enumerator list. Every enumeration type has an underlying type, which can be any integral type except char. The default underlying type of the enumeration elements is int. By default, the first enumerator has the value 0, and the value of each successive enumerator is increased by 1.
（1）沒有類型安全
枚舉是簡單的值類型，可以提供對無效值的保護，并且不會出現(xiàn)任何行為。他們是有用的，因為他們是魔法數(shù)字的改進，但就是這樣。如果要約束類型可能的值，枚舉不一定能幫助您，因為仍然可以提供無效類型。例如，此枚舉有三個值，默認情況下將具有int類型。值范圍為1到3。
public enum Volume
{
Low = 1,
Medium,
High
}
public static class EnumTricks
{
public static bool IsVolumeHigh(Volume volume)
{
var result = false;
switch (volume)
{
case Volume.Low:
Console.WriteLine("Volume is low.");
break;
case Volume.Medium:
Console.WriteLine("Volume is medium.");
break;
case Volume.High:
Console.WriteLine("Volume is high.");
result = true;
break;
}
return result;
}
}
static void Main(string[] args)
{
EnumTricks.IsVolumeHigh((Volume)27);
Console.ReadKey();
}
public static class EnumTricks
{
public static bool IsVolumeHigh(Volume volume)
{
var result = false;
switch (volume)
{
case Volume.Low:
Console.WriteLine("Volume is low.");
break;
case Volume.Medium:
Console.WriteLine("Volume is medium.");
break;
case Volume.High:
Console.WriteLine("Volume is high.");
result = true;
break;
}
return result;
}
public static int EnumToInt(Volume volume)
{
return (int)volume;
}
public static Volume IntToEnum(int intValue)
{
return (Volume)intValue;
}
public static Volume StringToEnum(string stringValue)
{
return (Volume)Enum.Parse(typeof(Volume), stringValue);
}
public static int StringToInt(string stringValue)
{
var volume = StringToEnum(stringValue);
return EnumToInt(volume);
}
public static string EnumToString(Volume volume)
{
return volume.ToString();
}
}
這應該失敗，至少在運行時。它沒有。這真的很奇怪......在編譯期間或運行期間都不會檢測到錯誤的調(diào)用。你會覺得自己處于一個虛假的安全狀態(tài)。如果，我們把傳進去的枚舉轉(zhuǎn)換為string時，來看看這兩種情況有什么不同：
我不知道大家平時在使用枚舉的時候，是否有意識檢查傳入的是否是有效的值?？梢允褂?code>Enum.IsDefined()來檢查int值是否是一個有效的值
解決方案：如果int值在枚舉值的定義范圍內(nèi)，則使用Enum.IsDefined()查找。如果在范圍內(nèi)，則返回True，否則返回False。
（2）轉(zhuǎn)化
您是否嘗試過將enum轉(zhuǎn)換為int，int轉(zhuǎn)換為enum，string轉(zhuǎn)換為enum，將字符串轉(zhuǎn)換為enum的int值？如下代碼：
public static class EnumTricks
{
public static bool IsVolumeHigh(Volume volume)
{
var result = false;
switch (volume)
{
case Volume.Low:
Console.WriteLine("Volume is low.");
break;
case Volume.Medium:
Console.WriteLine("Volume is medium.");
break;
case Volume.High:
Console.WriteLine("Volume is high.");
result = true;
break;
}
return result;
}
public static int EnumToInt(Volume volume)
{
return (int)volume;
}
public static Volume IntToEnum(int intValue)
{
return (Volume)intValue;
}
public static Volume StringToEnum(string stringValue)
{
return (Volume)Enum.Parse(typeof(Volume), stringValue);
}
public static int StringToInt(string stringValue)
{
var volume = StringToEnum(stringValue);
return EnumToInt(volume);
}
}
是不是我們?nèi)粘５拇a中也有這樣的類型轉(zhuǎn)換代碼，不是說不好，只是類型轉(zhuǎn)換也是有性能損失的，如果能換中方式可以同樣實現(xiàn)而且還避免以上問題豈不是更好，這樣我們的代碼也更好維護和擴展，下面我們通過使用枚舉類的方式來解決這個問題。
三、使用枚舉類而不是枚舉類型
public class Enumeration: IComparable
{
private readonly int _value;
private readonly string _displayName;
protected Enumeration()
{
}
protected Enumeration(int value, string displayName)
{
_value = value;
_displayName = displayName;
}
public int Value
{
get { return _value; }
}
public string DisplayName
{
get { return _displayName; }
}
public override string ToString()
{
return DisplayName;
}
public static IEnumerable<T> GetAll<T>() where T : Enumeration, new()
{
var type = typeof(T);
var fields = type.GetFields(BindingFlags.Public | BindingFlags.Static | BindingFlags.DeclaredOnly);
foreach (var info in fields)
{
var instance = new T();
var locatedValue = info.GetValue(instance) as T;
if (locatedValue != null)
{
yield return locatedValue;
}
}
}
public override bool Equals(object obj)
{
var otherValue = obj as Enumeration;
if (otherValue == null)
{
return false;
}
var typeMatches = GetType().Equals(obj.GetType());
var valueMatches = _value.Equals(otherValue.Value);
return typeMatches && valueMatches;
}
public override int GetHashCode()
{
return _value.GetHashCode();
}
public static int AbsoluteDifference(Enumeration firstValue, Enumeration secondValue)
{
var absoluteDifference = Math.Abs(firstValue.Value - secondValue.Value);
return absoluteDifference;
}
public static T FromValue<T>(int value) where T : Enumeration, new()
{
var matchingItem = parse<T, int>(value, "value", item => item.Value == value);
return matchingItem;
}
public static T FromDisplayName<T>(string displayName) where T : Enumeration, new()
{
var matchingItem = parse<T, string>(displayName, "display name", item => item.DisplayName == displayName);
return matchingItem;
}
private static T parse<T, K>(K value, string description, Func<T, bool> predicate) where T : Enumeration, new()
{
var matchingItem = GetAll<T>().FirstOrDefault(predicate);
if (matchingItem == null)
{
var message = string.Format("'{0}' is not a valid {1} in {2}", value, description, typeof(T));
throw new ApplicationException(message);
}
return matchingItem;
}
public int CompareTo(object other)
{
return Value.CompareTo(((Enumeration)other).Value);
}
}
public class Volume: Enumeration
{
private Volume() { throw new Exception(""); }
private Volume(int value, string displayName): base(value, displayName) { }
public static readonly Volume Low = new Volume(1, nameof(Low).ToLowerInvariant());
public static readonly Volume Medium = new Volume(2, nameof(Medium).ToLowerInvariant());
public static readonly Volume High = new Volume(3, nameof(High).ToLowerInvariant());
public static IEnumerable<Volume> List() =>
new[] { Low, Medium, High };
public static Volume From(int value)
{
var state = List().SingleOrDefault(s => s.Value == value);
if (state == null)
{
throw new Exception($"Possible values for Volume: {String.Join(",", List().Select(s => s.Value))}");
}
return state;
}
public static Volume FromName(string name)
{
var state = List()
.SingleOrDefault(s => String.Equals(s.DisplayName, name, StringComparison.CurrentCultureIgnoreCase));
if (state == null)
{
throw new Exception($"Possible values for Volume: {String.Join(",", List().Select(s => s.DisplayName))}");
}
return state;
}
}
static void Main(string[] args)
{
//EnumTricks.IsVolumeHigh((Volume)27);
//var tmp = Enum.IsDefined(typeof(Volume), 3);
//var str = EnumTricks.EnumToString((Volume)27);
//var str2 = EnumTricks.EnumToString((Volume)3);
//Console.WriteLine($"Volume 27:{str}");
//Console.WriteLine($"Volume 3:{str2}");
Console.WriteLine("------------------------------------------------------------");
Console.WriteLine(Volume.High.Value);
Console.WriteLine(Volume.High.DisplayName);
var volume = Volume.From(2);
var volume2 = Volume.FromName("high");
var none = Volume.From(27);
Console.ReadKey();
}
四、應用
代碼如下：
Error文件下：
public interface ICommonError
{
int GetErrCode();
string GetErrMsg();
ICommonError SetErrMsg(string errMsg);
}
public class Enumeration : IComparable
{
private readonly int _value;
private readonly string _displayName;
protected Enumeration()
{
}
protected Enumeration(int value, string displayName)
{
_value = value;
_displayName = displayName;
}
public int Value
{
get { return _value; }
}
public string DisplayName
{
get { return _displayName; }
}
public override string ToString()
{
return DisplayName;
}
public static IEnumerable<T> GetAll<T>() where T : Enumeration, new()
{
var type = typeof(T);
var fields = type.GetFields(BindingFlags.Public | BindingFlags.Static | BindingFlags.DeclaredOnly);
foreach (var info in fields)
{
var instance = new T();
var locatedValue = info.GetValue(instance) as T;
if (locatedValue != null)
{
yield return locatedValue;
}
}
}
public override bool Equals(object obj)
{
var otherValue = obj as Enumeration;
if (otherValue == null)
{
return false;
}
var typeMatches = GetType().Equals(obj.GetType());
var valueMatches = _value.Equals(otherValue.Value);
return typeMatches && valueMatches;
}
public override int GetHashCode()
{
return _value.GetHashCode();
}
public static int AbsoluteDifference(Enumeration firstValue, Enumeration secondValue)
{
var absoluteDifference = Math.Abs(firstValue.Value - secondValue.Value);
return absoluteDifference;
}
public static T FromValue<T>(int value) where T : Enumeration, new()
{
var matchingItem = parse<T, int>(value, "value", item => item.Value == value);
return matchingItem;
}
public static T FromDisplayName<T>(string displayName) where T : Enumeration, new()
{
var matchingItem = parse<T, string>(displayName, "display name", item => item.DisplayName == displayName);
return matchingItem;
}
private static T parse<T, K>(K value, string description, Func<T, bool> predicate) where T : Enumeration, new()
{
var matchingItem = GetAll<T>().FirstOrDefault(predicate);
if (matchingItem == null)
{
var message = string.Format("'{0}' is not a valid {1} in {2}", value, description, typeof(T));
throw new ApplicationException(message);
}
return matchingItem;
}
public int CompareTo(object other)
{
return Value.CompareTo(((Enumeration)other).Value);
}
}
public class EmBusinessError : Enumeration, ICommonError
{
private int errCode;
private String errMsg;
public static readonly EmBusinessError parameterValidationError = new EmBusinessError(10001, "參數(shù)不合法");
private EmBusinessError() { throw new Exception("私有構造函數(shù)不能調(diào)用"); }
private EmBusinessError(int value, string displayName) : base(value, displayName) {
this.errCode = value;
this.errMsg = displayName;
}
public int GetErrCode()
{
return this.errCode;
}
public string GetErrMsg()
{
return this.errMsg;
}
public void SetErrCode(int errCode)
{
this.errCode = errCode;
}
public ICommonError SetErrMsg(string errMsg)
{
this.errMsg = errMsg;
return this;
}
}
//包裝器業(yè)務異常類實現(xiàn)
public class BusinessException : Exception, ICommonError
{
private ICommonError commonError;
//直接接收EmBusinessError的傳參用于構造業(yè)務異常
public BusinessException(ICommonError commonError):base()
{
this.commonError = commonError;
}
public BusinessException(ICommonError commonError, string errMsg):base()
{
this.commonError = commonError;
this.commonError.SetErrMsg(errMsg);
}
public int GetErrCode()
{
return this.commonError.GetErrCode();
}
public string GetErrMsg()
{
return this.commonError.GetErrMsg();
}
public ICommonError SetErrMsg(string errMsg)
{
this.commonError.SetErrMsg(errMsg);
return this;
}
public ICommonError GetCommonError()
{
return commonError;
}
}
異常中間件：
public class ExceptionHandlerMiddleWare
{
private readonly RequestDelegate next;
/// <summary>
///
/// </summary>
/// <param name="next"></param>
public ExceptionHandlerMiddleWare(RequestDelegate next)
{
this.next = next;
}
public async Task Invoke(HttpContext context)
{
try
{
await next(context);
}
catch (Exception ex)
{
await HandleExceptionAsync(context, ex);
}
}
private static async Task HandleExceptionAsync(HttpContext context, Exception exception)
{
if (exception == null) return;
await WriteExceptionAsync(context, exception).ConfigureAwait(false);
}
private static async Task WriteExceptionAsync(HttpContext context, Exception exception)
{
var response = context.Response;
response.ContentType = "application/json;charset=utf-8";
var result = new CommonReturnType();
if (exception is BusinessException)
{
var businessException = (BusinessException)exception;
var errModel = new { errCode= businessException.GetErrCode(), errMsg= businessException.GetErrMsg() };
result = CommonReturnType.Create(errModel, "fail");
}
await response.WriteAsync(JsonConvert.SerializeObject(new { data = result.GetData(), status = result.GetStatus() }) ).ConfigureAwait(false);
}
}
Response文件夾：
public class CommonReturnType
{
//表明對應請求的返回處理結果 "success" 或 "fail"
private string status;
//若status=success,則data內(nèi)返回前端需要的json數(shù)據(jù)
//若status=fail，則data內(nèi)使用通用的錯誤碼格式
private object data;
//定義一個通用的創(chuàng)建方法
public static CommonReturnType Create(object result)
{
return CommonReturnType.Create(result, "success");
}
public static CommonReturnType Create(object result, string status)
{
CommonReturnType type = new CommonReturnType();
type.SetStatus(status);
type.SetData(result);
return type;
}
public string GetStatus()
{
return status;
}
public void SetStatus(string status)
{
this.status = status;
}
public object GetData()
{
return data;
}
public void SetData(object data)
{
this.data = data;
}
}
最后推薦一個類庫，這是我在Nuget上發(fā)現(xiàn)的枚舉類庫，地址：https://github.com/ardalis/SmartEnum
好了，先分享到這里，希望對你有幫助和啟發(fā)。
參考資料：
（2）https://ardalis.com/enum-alternatives-in-c
總結
以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對大家的學習或者工作具有一定的參考學習價值，謝謝大家對腳本之家的支持。
您可能感興趣的文章:
相關文章
.Net Core 之 Ubuntu 14.04 部署過程（圖文詳解）
本篇文章主要介紹了.Net Core 之 Ubuntu 14.04 部署過程（圖文詳解），有興趣的可以了解一下。2016-11-11
window.showModalDialog兩次加載問題清除緩存方法
window.showModalDialog兩次加載問題:你第一次打開窗口后，第二次瀏覽器沒有從服務器端取數(shù)據(jù)，而直接找到了你已經(jīng)下載的文件2013-08-08
asp.net 刪除項目文件/文件夾IIS重啟，Session丟失問題
最近在做一個項目，涉及到大量文件中轉(zhuǎn)（先上傳到本項目的某個文件夾中，在移動到FTP中），后面發(fā)現(xiàn)每次一刪除文件之后在做操作都會提示未登錄，剛開始以為是WebService Session丟失問題，后面發(fā)現(xiàn)緩存也更新了2011-12-12
在ASP.Net項目中使用存儲過程,首先可以提高數(shù)據(jù)庫的安全性，其次可以提高運行SQL代碼運行的速度，在大型項目中一般是必不可少的。2009-11-11
本文給大家介紹的是.net實現(xiàn)網(wǎng)站用戶登錄認證的方法和實例，都非常的簡單實用，需要的小伙伴可以參考下。2015-11-11
ASP.NET2.0新特性概述...2006-09-09
這篇文章主要介紹了編譯?dotnet和aspnetcore?源代碼詳情，圍繞主題相關資料展開展開全文內(nèi)容，具有一定的參考價值需要的小伙伴可以參考一下2022-03-03
asp.net中獲取遠程網(wǎng)頁的內(nèi)容之一（downmoon原創(chuàng)）
asp.net中獲取遠程網(wǎng)頁的內(nèi)容之一（downmoon原創(chuàng)）...2007-04-04
ASP.NET中操作SQL數(shù)據(jù)庫(連接字符串的配置及獲取)
要想在ASP.NET中操作SQL數(shù)據(jù)庫首先需要在WebConfig中配置數(shù)據(jù)庫連接字符串，之后在.cs文件中獲取連接字符串，具體的配置及獲取方法如下，感興趣的朋友可以參考下哈2013-06-06
asp.net使用DataSet的ReadXml讀取XML文件及Stream流的方法
這篇文章主要介紹了asp.net使用DataSet的ReadXml讀取XML文件及Stream流的方法,實例分析了asp.net以字符流的形式讀取與寫入xml文件的相關技巧,需要的朋友可以參考下2016-06-06