ReflectionUtil.cs 17 KB

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