AnalyzerHelper.cs 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using Microsoft.CodeAnalysis;
  5. using Microsoft.CodeAnalysis.CSharp;
  6. using Microsoft.CodeAnalysis.CSharp.Syntax;
  7. using Microsoft.CodeAnalysis.Diagnostics;
  8. using Microsoft.CodeAnalysis.FlowAnalysis;
  9. using Exception = System.Exception;
  10. namespace ET
  11. {
  12. public static class AnalyzerHelper
  13. {
  14. /// <summary>
  15. /// 获取语法树节点的子节点中第一个指定类型节点
  16. /// </summary>
  17. /// <param name="syntaxNode">语法树节点</param>
  18. /// <typeparam name="T">指定语法节点类型</typeparam>
  19. /// <returns>第一个指定类型节点</returns>
  20. public static T? GetFirstChild<T>(this SyntaxNode syntaxNode) where T : SyntaxNode
  21. {
  22. foreach (SyntaxNode? childNode in syntaxNode.ChildNodes())
  23. {
  24. if (childNode.GetType() == typeof (T))
  25. {
  26. return childNode as T;
  27. }
  28. }
  29. return null;
  30. }
  31. public static SyntaxNode? GetFirstChild(this SyntaxNode syntaxNode)
  32. {
  33. var childNodes = syntaxNode.ChildNodes();
  34. if (childNodes.Count() > 0)
  35. {
  36. return childNodes.First();
  37. }
  38. return null;
  39. }
  40. /// <summary>
  41. /// 获取语法树节点的子节点中最后一个指定类型节点
  42. /// </summary>
  43. /// <param name="syntaxNode">语法树节点</param>
  44. /// <typeparam name="T">指定语法节点类型</typeparam>
  45. /// <returns>最后一个指定类型节点</returns>
  46. public static T? GetLastChild<T>(this SyntaxNode syntaxNode) where T : SyntaxNode
  47. {
  48. foreach (SyntaxNode? childNode in syntaxNode.ChildNodes().Reverse())
  49. {
  50. if (childNode.GetType() == typeof (T))
  51. {
  52. return childNode as T;
  53. }
  54. }
  55. return null;
  56. }
  57. /// <summary>
  58. /// 获取语法节点所属的ClassDeclarationSyntax
  59. /// </summary>
  60. public static ClassDeclarationSyntax? GetParentClassDeclaration(this SyntaxNode syntaxNode)
  61. {
  62. SyntaxNode? parentNode = syntaxNode.Parent;
  63. while (parentNode != null)
  64. {
  65. if (parentNode is ClassDeclarationSyntax classDeclarationSyntax)
  66. {
  67. return classDeclarationSyntax;
  68. }
  69. parentNode = parentNode.Parent;
  70. }
  71. return null;
  72. }
  73. /// <summary>
  74. /// INamedTypeSymbol 是否有指定的Attribute
  75. /// </summary>
  76. public static bool HasAttribute(this ITypeSymbol typeSymbol, string AttributeName)
  77. {
  78. foreach (AttributeData? attributeData in typeSymbol.GetAttributes())
  79. {
  80. if (attributeData.AttributeClass?.ToString() == AttributeName)
  81. {
  82. return true;
  83. }
  84. }
  85. return false;
  86. }
  87. public static bool HasAttributeInTypeAndBaseTyes(this ITypeSymbol typeSymbol, string AttributeName)
  88. {
  89. if (typeSymbol.HasAttribute(AttributeName))
  90. {
  91. return true;
  92. }
  93. foreach (var baseType in typeSymbol.BaseTypes())
  94. {
  95. if (baseType.HasAttribute(AttributeName))
  96. {
  97. return true;
  98. }
  99. }
  100. return false;
  101. }
  102. public static IEnumerable<ITypeSymbol> BaseTypes(this ITypeSymbol typeSymbol)
  103. {
  104. ITypeSymbol? baseType = typeSymbol.BaseType;
  105. while (baseType!=null)
  106. {
  107. yield return baseType;
  108. baseType = baseType.BaseType;
  109. }
  110. }
  111. /// <summary>
  112. /// INamedTypeSymbol 是否有指定的基类Attribute
  113. /// </summary>
  114. public static bool HasAttribute(this INamedTypeSymbol namedTypeSymbol, string AttributeName)
  115. {
  116. foreach (AttributeData? attributeData in namedTypeSymbol.GetAttributes())
  117. {
  118. INamedTypeSymbol? attributeType = attributeData.AttributeClass;
  119. while (attributeType != null)
  120. {
  121. if (attributeType.ToString() == AttributeName)
  122. {
  123. return true;
  124. }
  125. attributeType = attributeType.BaseType;
  126. }
  127. }
  128. return false;
  129. }
  130. /// <summary>
  131. /// INamedTypeSymbol 获取指定类型的第一个Attribute
  132. /// </summary>
  133. public static AttributeData? GetFirstAttribute(this INamedTypeSymbol namedTypeSymbol, string AttributeName)
  134. {
  135. foreach (AttributeData? attributeData in namedTypeSymbol.GetAttributes())
  136. {
  137. if (attributeData.AttributeClass?.ToString() == AttributeName)
  138. {
  139. return attributeData;
  140. }
  141. }
  142. return null;
  143. }
  144. /// <summary>
  145. /// INamedTypeSymbol 是否含有指定接口
  146. /// </summary>
  147. public static bool HasInterface(this INamedTypeSymbol namedTypeSymbol, string InterfaceName)
  148. {
  149. foreach (INamedTypeSymbol? iInterface in namedTypeSymbol.AllInterfaces)
  150. {
  151. if (iInterface.IsInterface(InterfaceName))
  152. {
  153. return true;
  154. }
  155. }
  156. return false;
  157. }
  158. /// <summary>
  159. /// 某个接口symbol 是否是指定的接口
  160. /// </summary>
  161. public static bool IsInterface(this INamedTypeSymbol namedTypeSymbol, string InterfaceName)
  162. {
  163. return $"{namedTypeSymbol.GetNameSpace()}.{namedTypeSymbol.Name}" == InterfaceName;
  164. }
  165. /// <summary>
  166. /// 判断指定的程序集是否需要分析
  167. /// </summary>
  168. public static bool IsAssemblyNeedAnalyze(string? assemblyName, params string[] analyzeAssemblyNames)
  169. {
  170. if (assemblyName == null)
  171. {
  172. return false;
  173. }
  174. foreach (string analyzeAssemblyName in analyzeAssemblyNames)
  175. {
  176. if (assemblyName == analyzeAssemblyName)
  177. {
  178. return true;
  179. }
  180. }
  181. return false;
  182. }
  183. /// <summary>
  184. /// 获取 成员访问语法节点的父级类型
  185. /// </summary>
  186. public static ITypeSymbol? GetMemberAccessSyntaxParentType(this MemberAccessExpressionSyntax memberAccessExpressionSyntax,
  187. SemanticModel semanticModel)
  188. {
  189. SyntaxNode? firstChildSyntaxNode = memberAccessExpressionSyntax.GetFirstChild();
  190. if (firstChildSyntaxNode == null)
  191. {
  192. return null;
  193. }
  194. ISymbol? firstChildSymbol = semanticModel.GetSymbolInfo(firstChildSyntaxNode).Symbol;
  195. if (firstChildSymbol == null)
  196. {
  197. return null;
  198. }
  199. if (firstChildSymbol is ILocalSymbol localSymbol)
  200. {
  201. return localSymbol.Type;
  202. }
  203. if (firstChildSymbol is IParameterSymbol parameterSymbol)
  204. {
  205. return parameterSymbol.Type;
  206. }
  207. if (firstChildSymbol is IPropertySymbol propertySymbol)
  208. {
  209. return propertySymbol.Type;
  210. }
  211. if (firstChildSymbol is IMethodSymbol methodSymbol)
  212. {
  213. return methodSymbol.ReturnType;
  214. }
  215. if (firstChildSymbol is IFieldSymbol fieldSymbol)
  216. {
  217. return fieldSymbol.Type;
  218. }
  219. if (firstChildSymbol is IEventSymbol eventSymbol)
  220. {
  221. return eventSymbol.Type;
  222. }
  223. return null;
  224. }
  225. /// <summary>
  226. /// 获取最近的指定类型祖先节点
  227. /// </summary>
  228. public static T? GetNeareastAncestor<T>(this SyntaxNode syntaxNode) where T:SyntaxNode
  229. {
  230. foreach (var ancestorNode in syntaxNode.Ancestors())
  231. {
  232. if (ancestorNode is T Tancestor)
  233. {
  234. return Tancestor;
  235. }
  236. }
  237. return null ;
  238. }
  239. /// <summary>
  240. /// 判断函数是否是否含有指定类型的参数
  241. /// </summary>
  242. public static bool HasParameterType(this IMethodSymbol methodSymbol, string parameterType, out IParameterSymbol? cencelTokenSymbol)
  243. {
  244. foreach (var parameterSymbol in methodSymbol.Parameters)
  245. {
  246. if (parameterSymbol.Type.ToString() == parameterType)
  247. {
  248. cencelTokenSymbol = parameterSymbol;
  249. return true;
  250. }
  251. }
  252. cencelTokenSymbol = null;
  253. return false;
  254. }
  255. /// <summary>
  256. /// 获取所有指定类型的子节点
  257. /// </summary>
  258. public static IEnumerable<T> DescendantNodes<T>(this SyntaxNode syntaxNode) where T : SyntaxNode
  259. {
  260. foreach (var descendantNode in syntaxNode.DescendantNodes())
  261. {
  262. if (descendantNode is T node)
  263. {
  264. yield return node;
  265. }
  266. }
  267. }
  268. /// <summary>
  269. /// 获取与该语法节点同层级的上一个节点
  270. /// </summary>
  271. public static SyntaxNode? PreviousNode(this SyntaxNode syntaxNode)
  272. {
  273. if (syntaxNode.Parent==null)
  274. {
  275. return null;
  276. }
  277. int index = 0;
  278. foreach (var childNode in syntaxNode.Parent.ChildNodes())
  279. {
  280. if (childNode == syntaxNode)
  281. {
  282. break;
  283. }
  284. index++;
  285. }
  286. if (index==0)
  287. {
  288. return null;
  289. }
  290. return syntaxNode.Parent.ChildNodes().ElementAt(index-1);
  291. }
  292. /// <summary>
  293. /// 获取与该语法节点同层级的下一个节点
  294. /// </summary>
  295. public static SyntaxNode? NextNode(this SyntaxNode syntaxNode)
  296. {
  297. if (syntaxNode.Parent==null)
  298. {
  299. return null;
  300. }
  301. int index = 0;
  302. foreach (var childNode in syntaxNode.Parent.ChildNodes())
  303. {
  304. if (childNode == syntaxNode)
  305. {
  306. break;
  307. }
  308. index++;
  309. }
  310. if (index == syntaxNode.Parent.ChildNodes().Count()-1)
  311. {
  312. return null;
  313. }
  314. return syntaxNode.Parent.ChildNodes().ElementAt(index+1);
  315. }
  316. /// <summary>
  317. /// 获取await表达式所在的控制流block
  318. /// </summary>
  319. public static BasicBlock? GetAwaitStatementControlFlowBlock(StatementSyntax statementSyntax,AwaitExpressionSyntax awaitExpressionSyntax ,SemanticModel semanticModel)
  320. {
  321. // 跳过 return 表达式
  322. if (statementSyntax.IsKind(SyntaxKind.ReturnStatement))
  323. {
  324. return null;
  325. }
  326. var methodSyntax = statementSyntax.GetNeareastAncestor<MethodDeclarationSyntax>();
  327. if (methodSyntax==null)
  328. {
  329. return null;
  330. }
  331. // 构建表达式所在函数的控制流图
  332. var controlFlowGraph = ControlFlowGraph.Create(methodSyntax, semanticModel);
  333. if (controlFlowGraph==null)
  334. {
  335. return null;
  336. }
  337. if (statementSyntax is LocalDeclarationStatementSyntax)
  338. {
  339. return null;
  340. }
  341. BasicBlock? block = controlFlowGraph.Blocks.FirstOrDefault(x => x.Operations.Any(y => y.Syntax.Contains(statementSyntax)));
  342. return block;
  343. }
  344. /// <summary>
  345. /// 判断类是否为partial类
  346. /// </summary>
  347. public static bool IsPartial(this ClassDeclarationSyntax classDeclaration)
  348. {
  349. foreach (var modifier in classDeclaration.Modifiers)
  350. {
  351. if (modifier.IsKind(SyntaxKind.PartialKeyword))
  352. {
  353. return true;
  354. }
  355. }
  356. return false;
  357. }
  358. public static string? GetNameSpace(this INamedTypeSymbol namedTypeSymbol)
  359. {
  360. INamespaceSymbol? namespaceSymbol = namedTypeSymbol.ContainingNamespace;
  361. string? namespaceName = namespaceSymbol?.Name;
  362. while (namespaceSymbol?.ContainingNamespace != null)
  363. {
  364. namespaceSymbol = namespaceSymbol.ContainingNamespace;
  365. if (string.IsNullOrEmpty(namespaceSymbol.Name))
  366. {
  367. break;
  368. }
  369. namespaceName = $"{namespaceSymbol.Name}.{namespaceName}";
  370. }
  371. if (string.IsNullOrEmpty(namespaceName))
  372. {
  373. return null;
  374. }
  375. return namespaceName;
  376. }
  377. /// <summary>
  378. /// 根据语义模型的文件路径 判断是否需要分析
  379. /// </summary>
  380. public static bool IsSemanticModelNeedAnalyze(SemanticModel semanticModel, params string[] filePaths)
  381. {
  382. foreach (var filePath in filePaths)
  383. {
  384. if (semanticModel.SyntaxTree.FilePath.Contains(filePath))
  385. {
  386. return true;
  387. }
  388. }
  389. return false;
  390. }
  391. /// <summary>
  392. /// 类型symbol是否有指定名字 指定参数的方法
  393. /// </summary>
  394. public static bool HasMethodWithParams(this INamedTypeSymbol namedTypeSymbol, string methodName, params ITypeSymbol[] typeSymbols)
  395. {
  396. foreach (var member in namedTypeSymbol.GetMembers())
  397. {
  398. if (member is not IMethodSymbol methodSymbol)
  399. {
  400. continue;
  401. }
  402. if (methodSymbol.Name!=methodName)
  403. {
  404. continue;
  405. }
  406. if (typeSymbols.Length!=methodSymbol.Parameters.Length)
  407. {
  408. continue;
  409. }
  410. if (typeSymbols.Length==0)
  411. {
  412. return true;
  413. }
  414. bool isEqual = true;
  415. for (int i = 0; i < typeSymbols.Length; i++)
  416. {
  417. if (typeSymbols[i].ToString()!=methodSymbol.Parameters[i].Type.ToString())
  418. {
  419. isEqual = false;
  420. break;
  421. }
  422. }
  423. if (isEqual)
  424. {
  425. return true;
  426. }
  427. }
  428. return false;
  429. }
  430. /// <summary>
  431. /// 类型symbol是否有指定名字 指定参数的方法
  432. /// </summary>
  433. public static bool HasMethodWithParams(this INamedTypeSymbol namedTypeSymbol, string methodName, params string[] typeSymbols)
  434. {
  435. foreach (var member in namedTypeSymbol.GetMembers())
  436. {
  437. if (member is not IMethodSymbol methodSymbol)
  438. {
  439. continue;
  440. }
  441. if (methodSymbol.Name!=methodName)
  442. {
  443. continue;
  444. }
  445. if (typeSymbols.Length!=methodSymbol.Parameters.Length)
  446. {
  447. continue;
  448. }
  449. if (typeSymbols.Length==0)
  450. {
  451. return true;
  452. }
  453. bool isEqual = true;
  454. for (int i = 0; i < typeSymbols.Length; i++)
  455. {
  456. if (typeSymbols[i]!=methodSymbol.Parameters[i].Type.ToString())
  457. {
  458. isEqual = false;
  459. break;
  460. }
  461. }
  462. if (isEqual)
  463. {
  464. return true;
  465. }
  466. }
  467. return false;
  468. }
  469. /// <summary>
  470. /// 方法symbol 是否有指定的attribute
  471. /// </summary>
  472. public static bool HasAttribute(this IMethodSymbol methodSymbol, string AttributeName)
  473. {
  474. foreach (AttributeData? attributeData in methodSymbol.GetAttributes())
  475. {
  476. if (attributeData?.AttributeClass?.ToString()==AttributeName)
  477. {
  478. return true;
  479. }
  480. }
  481. return false;
  482. }
  483. /// <summary>
  484. /// 类型symbol是否是实体类 包含 enity及其子类 lsentity及其子类
  485. /// </summary>
  486. public static bool IsETEntity(this ITypeSymbol typeSymbol)
  487. {
  488. string typeName = typeSymbol.ToString();
  489. string? baseType = typeSymbol.BaseType?.ToString();
  490. return typeName == Definition.EntityType || baseType == Definition.EntityType || baseType == Definition.LSEntityType;
  491. }
  492. /// <summary>
  493. /// 类型symbol是否是EntiyRef 或EntityWeakRef类
  494. /// </summary>
  495. public static bool IsEntityRefOrEntityWeakRef(this ITypeSymbol typeSymbol)
  496. {
  497. if (typeSymbol is not INamedTypeSymbol namedTypeSymbol)
  498. {
  499. return false;
  500. }
  501. if (!namedTypeSymbol.IsGenericType)
  502. {
  503. return false;
  504. }
  505. string typeName = namedTypeSymbol.Name;
  506. return typeName is Definition.EntityRefType or Definition.EntityWeakRefType;
  507. }
  508. }
  509. }