ReflectionUtil.cs 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502
  1. using System;
  2. using System.Collections.Concurrent;
  3. using System.Collections.Generic;
  4. using System.ComponentModel;
  5. using System.Diagnostics.CodeAnalysis;
  6. using System.IO;
  7. using System.Linq;
  8. using System.Linq.Expressions;
  9. using System.Reflection;
  10. using System.Resources;
  11. using System.Text;
  12. using Masuit.Tools.Systems;
  13. namespace Masuit.Tools.Reflection
  14. {
  15. /// <summary>
  16. /// 反射操作辅助类,如获取或设置字段、属性的值等反射信息。
  17. /// </summary>
  18. public static class ReflectionUtil
  19. {
  20. #region 属性字段设置
  21. public static BindingFlags bf = BindingFlags.DeclaredOnly | BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.Static;
  22. /// <summary>
  23. /// 执行方法
  24. /// </summary>
  25. /// <param name="obj">反射对象</param>
  26. /// <param name="methodName">方法名,区分大小写</param>
  27. /// <param name="args">方法参数</param>
  28. /// <typeparam name="T">约束返回的T必须是引用类型</typeparam>
  29. /// <returns>T类型</returns>
  30. public static T InvokeMethod<T>(this object obj, string methodName, object[] args)
  31. {
  32. return (T)obj.GetType().GetMethod(methodName, args.Select(o => o.GetType()).ToArray()).Invoke(obj, args);
  33. }
  34. /// <summary>
  35. /// 执行方法
  36. /// </summary>
  37. /// <param name="obj">反射对象</param>
  38. /// <param name="methodName">方法名,区分大小写</param>
  39. /// <param name="args">方法参数</param>
  40. /// <returns>T类型</returns>
  41. public static void InvokeMethod(this object obj, string methodName, object[] args)
  42. {
  43. var type = obj.GetType();
  44. type.GetMethod(methodName, args.Select(o => o.GetType()).ToArray()).Invoke(obj, args);
  45. }
  46. /// <summary>
  47. /// 设置字段
  48. /// </summary>
  49. /// <param name="obj">反射对象</param>
  50. /// <param name="name">字段名</param>
  51. /// <param name="value">值</param>
  52. public static void SetField<T>(this T obj, string name, object value) where T : class
  53. {
  54. SetProperty(obj, name, value);
  55. }
  56. /// <summary>
  57. /// 获取字段
  58. /// </summary>
  59. /// <param name="obj">反射对象</param>
  60. /// <param name="name">字段名</param>
  61. /// <typeparam name="T">约束返回的T必须是引用类型</typeparam>
  62. /// <returns>T类型</returns>
  63. public static T GetField<T>(this object obj, string name)
  64. {
  65. return GetProperty<T>(obj, name);
  66. }
  67. /// <summary>
  68. /// 获取所有的字段信息
  69. /// </summary>
  70. /// <param name="obj">反射对象</param>
  71. /// <returns>字段信息</returns>
  72. public static FieldInfo[] GetFields(this object obj)
  73. {
  74. FieldInfo[] fieldInfos = obj.GetType().GetFields(bf);
  75. return fieldInfos;
  76. }
  77. /// <summary>
  78. /// 设置属性
  79. /// </summary>
  80. /// <param name="obj">反射对象</param>
  81. /// <param name="name">属性名</param>
  82. /// <param name="value">值</param>
  83. public static string SetProperty<T>(this T obj, string name, object value) where T : class
  84. {
  85. var parameter = Expression.Parameter(typeof(T), "e");
  86. var property = Expression.PropertyOrField(parameter, name);
  87. var before = Expression.Lambda(property, parameter).Compile().DynamicInvoke(obj);
  88. if (value == before)
  89. {
  90. return value?.ToString();
  91. }
  92. if (property.Type.IsGenericType && property.Type.GetGenericTypeDefinition() == typeof(Nullable<>))
  93. {
  94. typeof(T).GetProperty(name)?.SetValue(obj, value);
  95. }
  96. else
  97. {
  98. var valueExpression = Expression.Parameter(property.Type, "v");
  99. var assign = Expression.Assign(property, valueExpression);
  100. Expression.Lambda(assign, parameter, valueExpression).Compile().DynamicInvoke(obj, value);
  101. }
  102. return before.ToJsonString();
  103. }
  104. private static readonly ConcurrentDictionary<string, Delegate> DelegateCache = new();
  105. /// <summary>
  106. /// 获取属性
  107. /// </summary>
  108. /// <param name="obj">反射对象</param>
  109. /// <param name="name">属性名</param>
  110. /// <typeparam name="T">约束返回的T必须是引用类型</typeparam>
  111. /// <returns>T类型</returns>
  112. public static T GetProperty<T>(this object obj, string name)
  113. {
  114. var type = obj.GetType();
  115. if (DelegateCache.TryGetValue(type.Name + "." + name, out var func))
  116. {
  117. return (T)func.DynamicInvoke(obj);
  118. }
  119. var parameter = Expression.Parameter(type, "e");
  120. var property = Expression.PropertyOrField(parameter, name);
  121. func = Expression.Lambda(property, parameter).Compile();
  122. DelegateCache.TryAdd(type.Name + "." + name, func);
  123. return (T)func.DynamicInvoke(obj);
  124. }
  125. /// <summary>
  126. /// 获取所有的属性信息
  127. /// </summary>
  128. /// <param name="obj">反射对象</param>
  129. /// <returns>属性信息</returns>
  130. public static PropertyInfo[] GetProperties(this object obj)
  131. {
  132. return obj.GetType().GetProperties(bf);
  133. }
  134. #endregion 属性字段设置
  135. #region 获取Description
  136. /// <summary>
  137. /// 获取枚举值的Description信息
  138. /// </summary>
  139. /// <param name ="value">枚举值</param>
  140. /// <param name ="args">要格式化的对象</param>
  141. /// <returns>如果未找到DescriptionAttribute则返回null或返回类型描述</returns>
  142. public static string GetDescription(this Enum value, params object[] args)
  143. {
  144. if (value == null)
  145. {
  146. throw new ArgumentNullException(nameof(value));
  147. }
  148. var type = value.GetType();
  149. if (!Enum.IsDefined(type, value))
  150. {
  151. return value.ToString();
  152. }
  153. FieldInfo fi = type.GetField(value.ToString());
  154. var attributes = (DescriptionAttribute[])fi.GetCustomAttributes(typeof(DescriptionAttribute), false);
  155. var text = attributes.Length > 0 ? attributes[0].Description : value.ToString();
  156. if (args is { Length: > 0 })
  157. {
  158. return string.Format(text, args);
  159. }
  160. return text;
  161. }
  162. /// <summary>
  163. /// 获取枚举值的Description信息
  164. /// </summary>
  165. /// <param name ="value">枚举值</param>
  166. /// <returns>如果未找到DescriptionAttribute则返回null或返回类型描述</returns>
  167. public static EnumDescriptionAttribute GetEnumDescription(this Enum value)
  168. {
  169. return GetEnumDescriptions(value).FirstOrDefault();
  170. }
  171. /// <summary>
  172. /// 获取枚举值的Description信息
  173. /// </summary>
  174. /// <param name ="value">枚举值</param>
  175. /// <returns>如果未找到DescriptionAttribute则返回null或返回类型描述</returns>
  176. public static NullableDictionary<string, (string Description, string Display)> GetTypedEnumDescriptions(this Enum value)
  177. {
  178. return GetEnumDescriptions(value).ToDictionarySafety(a => a.Language, a => (Description: a.Description, Display: a.Display));
  179. }
  180. /// <summary>
  181. /// 获取枚举值的Description信息
  182. /// </summary>
  183. /// <param name ="value">枚举值</param>
  184. /// <returns>如果未找到DescriptionAttribute则返回null或返回类型描述</returns>
  185. public static IEnumerable<EnumDescriptionAttribute> GetEnumDescriptions(this Enum value)
  186. {
  187. if (value == null)
  188. {
  189. throw new ArgumentNullException(nameof(value));
  190. }
  191. var type = value.GetType();
  192. if (!Enum.IsDefined(type, value))
  193. {
  194. return new List<EnumDescriptionAttribute>();
  195. }
  196. FieldInfo fi = type.GetField(value.ToString());
  197. return fi.GetCustomAttributes(typeof(EnumDescriptionAttribute), false).OfType<EnumDescriptionAttribute>();
  198. }
  199. /// <summary>
  200. /// 根据成员信息获取Description信息
  201. /// </summary>
  202. /// <param name="member">成员信息</param>
  203. /// <returns>如果未找到DescriptionAttribute则返回null或返回类型描述</returns>
  204. public static string GetDescription(this MemberInfo member)
  205. {
  206. return GetDescription(member, null);
  207. }
  208. /// <summary>
  209. /// 根据成员信息获取Description信息
  210. /// </summary>
  211. /// <param name="member">成员信息</param>
  212. /// <param name="args">格式化占位对象</param>
  213. /// <returns>如果未找到DescriptionAttribute则返回null或返回类型描述</returns>
  214. public static string GetDescription(this MemberInfo member, params object[] args)
  215. {
  216. if (member == null)
  217. {
  218. throw new ArgumentNullException(nameof(member));
  219. }
  220. return member.IsDefined(typeof(DescriptionAttribute), false) ? member.GetAttribute<DescriptionAttribute>().Description : string.Empty;
  221. }
  222. #endregion 获取Description
  223. /// <summary>
  224. /// 获取对象的Attribute
  225. /// </summary>
  226. /// <returns></returns>
  227. public static T GetAttribute<T>(this ICustomAttributeProvider provider) where T : Attribute
  228. {
  229. var attributes = provider.GetCustomAttributes(typeof(T), true);
  230. return attributes.Length > 0 ? attributes[0] as T : null;
  231. }
  232. /// <summary>
  233. /// 获取对象的Attributes
  234. /// </summary>
  235. /// <returns></returns>
  236. public static IEnumerable<T> GetAttributes<T>(this ICustomAttributeProvider provider) where T : Attribute
  237. {
  238. return provider.GetCustomAttributes(typeof(T), true).OfType<T>();
  239. }
  240. #region 资源获取
  241. /// <summary>
  242. /// 根据资源名称获取图片资源流
  243. /// </summary>
  244. /// <param name="_"></param>
  245. /// <param name="resourceName">资源的名称</param>
  246. /// <returns>数据流</returns>
  247. public static Stream GetImageResource(this Assembly _, string resourceName)
  248. {
  249. Assembly asm = Assembly.GetExecutingAssembly();
  250. return asm.GetManifestResourceStream(resourceName);
  251. }
  252. /// <summary>
  253. /// 获取程序集资源的文本资源
  254. /// </summary>
  255. /// <param name="assemblyType">程序集中的某一对象类型</param>
  256. /// <param name="resName">资源项名称</param>
  257. /// <param name="resourceHolder">资源的根名称。例如,名为“MyResource.en-US.resources”的资源文件的根名称为“MyResource”。</param>
  258. public static string GetStringRes(this Type assemblyType, string resName, string resourceHolder)
  259. {
  260. Assembly thisAssembly = Assembly.GetAssembly(assemblyType);
  261. ResourceManager rm = new ResourceManager(resourceHolder, thisAssembly);
  262. return rm.GetString(resName);
  263. }
  264. /// <summary>
  265. /// 获取程序集嵌入资源的文本形式
  266. /// </summary>
  267. /// <param name="assemblyType">程序集中的某一对象类型</param>
  268. /// <param name="charset">字符集编码</param>
  269. /// <param name="resName">嵌入资源相对路径</param>
  270. /// <returns>如没找到该资源则返回空字符</returns>
  271. public static string GetManifestString(this Type assemblyType, string charset, string resName)
  272. {
  273. Assembly asm = Assembly.GetAssembly(assemblyType);
  274. Stream st = asm.GetManifestResourceStream(string.Concat(assemblyType.Namespace, ".", resName.Replace("/", ".")));
  275. if (st == null)
  276. {
  277. return "";
  278. }
  279. int iLen = (int)st.Length;
  280. byte[] bytes = new byte[iLen];
  281. st.Read(bytes, 0, iLen);
  282. return Encoding.GetEncoding(charset).GetString(bytes);
  283. }
  284. #endregion 资源获取
  285. #region 创建实例
  286. /// <summary>
  287. /// 获取默认实例
  288. /// </summary>
  289. /// <param name="type">类型</param>
  290. /// <returns></returns>
  291. public static object GetInstance(this Type type)
  292. {
  293. return GetInstance<TypeToIgnore, object>(type, null);
  294. }
  295. /// <summary>
  296. /// 获取默认实例
  297. /// </summary>
  298. /// <param name="type">类型</param>
  299. /// <returns></returns>
  300. public static T GetInstance<T>(this Type type) where T : class, new()
  301. {
  302. return GetInstance<TypeToIgnore, T>(type, null);
  303. }
  304. /// <summary>
  305. /// 获取默认实例
  306. /// </summary>
  307. /// <param name="type">类型</param>
  308. /// <returns></returns>
  309. public static T GetInstance<T>(string type) where T : class, new()
  310. {
  311. return GetInstance<TypeToIgnore, T>(Type.GetType(type), null);
  312. }
  313. /// <summary>
  314. /// 获取默认实例
  315. /// </summary>
  316. /// <param name="type">类型</param>
  317. /// <returns></returns>
  318. public static object GetInstance(string type)
  319. {
  320. return GetInstance<TypeToIgnore, object>(Type.GetType(type), null);
  321. }
  322. /// <summary>
  323. /// 获取一个构造参数的实例
  324. /// </summary>
  325. /// <typeparam name="TArg">参数类型</typeparam>
  326. /// <typeparam name="T"></typeparam>
  327. /// <param name="type">实例类型</param>
  328. /// <param name="argument">参数值</param>
  329. /// <returns></returns>
  330. public static T GetInstance<TArg, T>(this Type type, TArg argument) where T : class, new()
  331. {
  332. return GetInstance<TArg, TypeToIgnore, T>(type, argument, null);
  333. }
  334. /// <summary>
  335. /// 获取一个构造参数的实例
  336. /// </summary>
  337. /// <typeparam name="TArg">参数类型</typeparam>
  338. /// <typeparam name="T"></typeparam>
  339. /// <param name="type">实例类型</param>
  340. /// <param name="argument">参数值</param>
  341. /// <returns></returns>
  342. public static T GetInstance<TArg, T>(string type, TArg argument) where T : class, new()
  343. {
  344. return GetInstance<TArg, TypeToIgnore, T>(Type.GetType(type), argument, null);
  345. }
  346. /// <summary>
  347. /// 获取2个构造参数的实例
  348. /// </summary>
  349. /// <typeparam name="TArg1">参数类型</typeparam>
  350. /// <typeparam name="TArg2">参数类型</typeparam>
  351. /// <typeparam name="T"></typeparam>
  352. /// <param name="type">实例类型</param>
  353. /// <param name="argument1">参数值</param>
  354. /// <param name="argument2">参数值</param>
  355. /// <returns></returns>
  356. public static T GetInstance<TArg1, TArg2, T>(this Type type, TArg1 argument1, TArg2 argument2) where T : class, new()
  357. {
  358. return GetInstance<TArg1, TArg2, TypeToIgnore, T>(type, argument1, argument2, null);
  359. }
  360. /// <summary>
  361. /// 获取2个构造参数的实例
  362. /// </summary>
  363. /// <typeparam name="TArg1">参数类型</typeparam>
  364. /// <typeparam name="TArg2">参数类型</typeparam>
  365. /// <typeparam name="T"></typeparam>
  366. /// <param name="type">实例类型</param>
  367. /// <param name="argument1">参数值</param>
  368. /// <param name="argument2">参数值</param>
  369. /// <returns></returns>
  370. public static T GetInstance<TArg1, TArg2, T>(string type, TArg1 argument1, TArg2 argument2) where T : class, new()
  371. {
  372. return GetInstance<TArg1, TArg2, TypeToIgnore, T>(Type.GetType(type), argument1, argument2, null);
  373. }
  374. /// <summary>
  375. /// 获取3个构造参数的实例
  376. /// </summary>
  377. /// <typeparam name="TArg1">参数类型</typeparam>
  378. /// <typeparam name="TArg2">参数类型</typeparam>
  379. /// <typeparam name="TArg3">参数类型</typeparam>
  380. /// <typeparam name="T"></typeparam>
  381. /// <param name="type">实例类型</param>
  382. /// <param name="argument1">参数值</param>
  383. /// <param name="argument2">参数值</param>
  384. /// <param name="argument3">参数值</param>
  385. /// <returns></returns>
  386. public static T GetInstance<TArg1, TArg2, TArg3, T>(this Type type, TArg1 argument1, TArg2 argument2, TArg3 argument3) where T : class, new()
  387. {
  388. return InstanceCreationFactory<TArg1, TArg2, TArg3, T>.CreateInstanceOf(type, argument1, argument2, argument3);
  389. }
  390. /// <summary>
  391. /// 获取3个构造参数的实例
  392. /// </summary>
  393. /// <typeparam name="TArg1">参数类型</typeparam>
  394. /// <typeparam name="TArg2">参数类型</typeparam>
  395. /// <typeparam name="TArg3">参数类型</typeparam>
  396. /// <typeparam name="T"></typeparam>
  397. /// <param name="type">实例类型</param>
  398. /// <param name="argument1">参数值</param>
  399. /// <param name="argument2">参数值</param>
  400. /// <param name="argument3">参数值</param>
  401. /// <returns></returns>
  402. public static T GetInstance<TArg1, TArg2, TArg3, T>(string type, TArg1 argument1, TArg2 argument2, TArg3 argument3) where T : class, new()
  403. {
  404. return InstanceCreationFactory<TArg1, TArg2, TArg3, T>.CreateInstanceOf(Type.GetType(type), argument1, argument2, argument3);
  405. }
  406. private class TypeToIgnore
  407. {
  408. }
  409. private static class InstanceCreationFactory<TArg1, TArg2, TArg3, TObject> where TObject : class, new()
  410. {
  411. private static readonly Dictionary<Type, Func<TArg1, TArg2, TArg3, TObject>> InstanceCreationMethods = new Dictionary<Type, Func<TArg1, TArg2, TArg3, TObject>>();
  412. public static TObject CreateInstanceOf(Type type, TArg1 arg1, TArg2 arg2, TArg3 arg3)
  413. {
  414. CacheInstanceCreationMethodIfRequired(type);
  415. return InstanceCreationMethods[type](arg1, arg2, arg3);
  416. }
  417. private static void CacheInstanceCreationMethodIfRequired(Type type)
  418. {
  419. if (InstanceCreationMethods.ContainsKey(type))
  420. {
  421. return;
  422. }
  423. var argumentTypes = new[]
  424. {
  425. typeof(TArg1),
  426. typeof(TArg2),
  427. typeof(TArg3)
  428. };
  429. Type[] constructorArgumentTypes = argumentTypes.Where(t => t != typeof(TypeToIgnore)).ToArray();
  430. var constructor = type.GetConstructor(BindingFlags.Instance | BindingFlags.Public, null, CallingConventions.HasThis, constructorArgumentTypes, new ParameterModifier[0]);
  431. var lamdaParameterExpressions = new[]
  432. {
  433. Expression.Parameter(typeof(TArg1), "param1"),
  434. Expression.Parameter(typeof(TArg2), "param2"),
  435. Expression.Parameter(typeof(TArg3), "param3")
  436. };
  437. var constructorParameterExpressions = lamdaParameterExpressions.Take(constructorArgumentTypes.Length).ToArray();
  438. var constructorCallExpression = Expression.New(constructor, constructorParameterExpressions);
  439. var constructorCallingLambda = Expression.Lambda<Func<TArg1, TArg2, TArg3, TObject>>(constructorCallExpression, lamdaParameterExpressions).Compile();
  440. InstanceCreationMethods[type] = constructorCallingLambda;
  441. }
  442. }
  443. #endregion 创建实例
  444. }
  445. }