快捷導(dǎo)航

.NET?Core?特性(Attribute)底層原理解析

更新時(shí)間：2024年11月20日 08:53:52 作者：叫我安不理

Attribute不僅僅局限于C#中,在整個(gè).NET框架中都提供了非常大的拓展點(diǎn),任何地方都有Attribute的影子,這篇文章主要介紹了.NET?Core?特性(Attribute)底層原理,本文給大家介紹的非常詳細(xì),需要的朋友可以參考下

Attribute的使用場(chǎng)景

Attribute不僅僅局限于C#中，在整個(gè).NET框架中都提供了非常大的拓展點(diǎn)，任何地方都有Attribute的影子

編譯器層
比如 Obsolete，Conditional
C#層
GET,POST,Max,Range,Require
CLR VM層
StructLayout,DllImport
JIT 層
MethodImpl

Attribute在C#中的調(diào)用

舉個(gè)常用的例子，讀取枚舉上的自定義特性。

    public enum Test
    {
        [EnumDescription("hhhhhh")]
        None = 0,
        [EnumDescription("xxxxxx")]
        Done =1
    }
	private static IEnumerable<string> GetEnumDescriptions(this Enum e)
	{
		IEnumerable<string> result = null;
        var type = e.GetType();
        var fieldInfo = type.GetField(e.ToString());
        var attr = fieldInfo?.GetCustomAttributes(typeof(EnumDescriptionAttribute), false);
        if (attr?.Length > 0)
        {
			result = attr.Cast<EnumDescriptionAttribute>().Select(x => x.Description);
        }
		return result ?? Enumerable.Empty<string>();
	}

可以看到，Attribute底層在C#中實(shí)現(xiàn)依舊是依賴反射，所以為什么說(shuō)Attribute是寫(xiě)給代碼看的注釋，因此對(duì)反射的優(yōu)化思路也可以用在Attribute中。
比如在代碼中，使用Dictionary緩存結(jié)果集。避免過(guò)多調(diào)用反射造成的性能問(wèn)題。

        private static IEnumerable<string> GetEnumDescriptionsCache(this Enum e)
        {
            var key = $"{e.GetType().Name}_{e.ToString()}";
            if (_enumMap.ContainsKey(key))
            {
                return _enumMap[key];
            }
            else
            {
                var result = GetEnumDescriptions(e);
                _enumMap.TryAdd(key, result);
                return result;
            }
        }

循環(huán)100000次造成的性能差距還是很明顯的

Newtonsoft.Json對(duì)Attrubute的使用

以JsonConverter為藍(lán)本舉例說(shuō)明。

    public class Person
    {
        [JsonConverter(typeof(DateTimeConverter))]
        public DateTime CreateTime { get; set; }
    }
	public class DateTimeConverter : JsonConverter<DateTime>
    {
        public override DateTime ReadJson(JsonReader reader, Type objectType, DateTime existingValue, bool hasExistingValue, JsonSerializer serializer)
        {
            if (reader.Value == null)
                return DateTime.MinValue;
            if (DateTime.TryParse(reader.Value.ToString(), out DateTime result))
                return result;
            return DateTime.MinValue;
        }
        public override void WriteJson(JsonWriter writer, DateTime value, JsonSerializer serializer)
        {
            writer.WriteValue(value.ToString("yyyy-MM-dd HH:mm:ss"));
        }
    }

定義了一個(gè)Attribute：JsonConverter.其底層調(diào)用如下：

        [RequiresUnreferencedCode(MiscellaneousUtils.TrimWarning)]
        [RequiresDynamicCode(MiscellaneousUtils.AotWarning)]
        public static JsonConverter? GetJsonConverter(object attributeProvider)
        {
			// 底層還是調(diào)用Reflection，為了性能，也緩存了對(duì)象元數(shù)據(jù)。
            JsonConverterAttribute? converterAttribute = GetCachedAttribute<JsonConverterAttribute>(attributeProvider);
            if (converterAttribute != null)
            {
                Func<object[]?, object> creator = CreatorCache.Instance.Get(converterAttribute.ConverterType);
                if (creator != null)
                {
                    return (JsonConverter)creator(converterAttribute.ConverterParameters);
                }
            }
            return null;
        }

https://github.com/JamesNK/Newtonsoft.Json/blob/master/Src/Newtonsoft.Json/Serialization/JsonTypeReflector.cs

Attribute在CLR上的調(diào)用

    public class NativeMethods
    {
        [DllImport("xxxxx", EntryPoint = "add", CallingConvention = CallingConvention.Cdecl)]
        public extern static int ManagedAdd(int a, int b);
    }

在CLR中，同樣用來(lái)調(diào)用 C/C++ 的導(dǎo)出函數(shù)。有興趣的朋友可以使用windbg查看線程調(diào)用棧。以及在MetaData中有一張ImplMap表，存儲(chǔ)著C#方法與C++函數(shù)的mapping關(guān)系

Attribute在JIT上的調(diào)用

    public class Person
    {
        public int id { get; set; } = 0;
        [MethodImpl(MethodImplOptions.Synchronized)]
        public void SyncMethod()
        {
            id++;
        }
    }

JIT會(huì)自動(dòng)為該Attribute注入同步代碼