ReflectionUtil.cs 17 KB

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