ProtoCommentGenerator.cs 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
  1. using System;
  2. using System.Collections.Generic;
  3. using System.IO;
  4. using System.Linq;
  5. using System.Text;
  6. using System.Xml.Linq;
  7. using System.Reflection;
  8. using ProtoBuf;
  9. using Grpc.Extension.BaseService.Model;
  10. namespace Grpc.Extension.Common.Internal
  11. {
  12. internal static class ProtoCommentGenerator
  13. {
  14. //Xml文档注释
  15. static List<XmlCommentInfo> xmlComments = new List<XmlCommentInfo>();
  16. //ProtoType
  17. static List<Type> protoTypes;
  18. static ProtoCommentGenerator()
  19. {
  20. string path = Environment.CurrentDirectory;
  21. string[] temp = path.Split("\\".ToCharArray());
  22. string patha = "";
  23. for (int i = 0; i < temp.Length - 1; i++)
  24. {
  25. patha += temp[i];
  26. patha += "\\";
  27. }
  28. //加载注释xml文件
  29. ///var files = Directory.GetFiles(AppDomain.CurrentDomain.BaseDirectory, "*.xml");
  30. var files = Directory.GetFiles(patha, "*.xml", SearchOption.AllDirectories);
  31. Dictionary<string, string> keys = new Dictionary<string, string>();
  32. foreach (string file in files) {
  33. string[] p= file.Split("\\".ToCharArray());
  34. string fileName = p[p.Length - 1];
  35. keys[fileName] = file;
  36. }
  37. List<string> fils = new List<string>();
  38. foreach (string file in keys.Keys)
  39. {
  40. fils.Add(keys[file]);
  41. }
  42. var assembliyNames = new List<string>();
  43. foreach (var file in fils)
  44. {
  45. var xe = XElement.Load(file);
  46. //检查是否为注释xml文件
  47. if (xe.Element("assembly") == null || xe.Element("members") == null) continue;
  48. assembliyNames.Add(xe.Element("assembly").Value);
  49. foreach (var item in xe.Element("members").Elements())
  50. {
  51. var name = item.Attribute("name")?.Value;
  52. //bool flag = false;
  53. //foreach (XmlCommentInfo commentInfo in xmlComments) {
  54. // if (name.Equals(commentInfo.FullName)) {
  55. // flag = true;
  56. // }
  57. //}
  58. //if (flag) {
  59. // continue;
  60. //}
  61. var nameArr = name?.Split(':');
  62. if (name != null && nameArr.Length > 1)
  63. {
  64. xmlComments.Add(new XmlCommentInfo()
  65. {
  66. FullName = nameArr[1],
  67. Type = nameArr[0],
  68. Summary = item.Element("summary")?.Value?.Trim()
  69. });
  70. }
  71. }
  72. }
  73. //初始化protoTypes
  74. var assemblies = AppDomain.CurrentDomain.GetAssemblies().Where(p => assembliyNames.Contains(p.GetName().Name));
  75. protoTypes = assemblies.SelectMany(p => p.GetTypes().Where(t => t.GetCustomAttribute<ProtoContractAttribute>() != null)).ToList();
  76. }
  77. /// <summary>
  78. /// 获取注释集合
  79. /// </summary>
  80. /// <param name="types"></param>
  81. /// <param name="fullName"></param>
  82. /// <returns></returns>
  83. public static Dictionary<string,string> GetComments(string[] types,string fullName)
  84. {
  85. return xmlComments.Where(p => types.Contains(p.Type) && p.FullName.StartsWith(fullName)).ToDictionary(p => p.FullName, p => p.Summary);
  86. }
  87. /// <summary>
  88. /// 获取注释
  89. /// </summary>
  90. /// <param name="type"></param>
  91. /// <param name="fullName"></param>
  92. /// <returns></returns>
  93. public static string GetComment(string type, string fullName)
  94. {
  95. return xmlComments.FirstOrDefault(p => p.Type == type && p.FullName.StartsWith(fullName))?.Summary;
  96. }
  97. /// <summary>
  98. /// 给Message加入注释
  99. /// </summary>
  100. /// <typeparam name="TEntity"></typeparam>
  101. /// <param name="proto"></param>
  102. /// <returns></returns>
  103. public static string AddMessageComment<TEntity>(this string proto)
  104. {
  105. var dicComment = new Dictionary<string,string>();
  106. var lines = new List<string>();
  107. using (var ms = new MemoryStream(Encoding.UTF8.GetBytes(proto)))
  108. using (var sr = new StreamReader(ms))
  109. {
  110. while (sr.Peek() > 0)
  111. {
  112. var line = sr.ReadLine();
  113. var lineArr = line.Split(new string[]{ " ", "repeated" },StringSplitOptions.RemoveEmptyEntries);
  114. if (lineArr.Length > 1)
  115. {
  116. var typeName = lineArr[1];//message和enum后的类型名
  117. if (ProtoGenerator.protoMsgStartWithKeywords.Any(q => line.StartsWith(q)))
  118. {
  119. var fullName = GetProtoTypeFullName<TEntity>(typeName);
  120. if(!string.IsNullOrEmpty(fullName)) dicComment = GetComments(new string[] { "T", "P","F" }, fullName);
  121. }
  122. var propertyName = lineArr[1];//属性名
  123. var comment = dicComment.FirstOrDefault(p => p.Key.EndsWith("." + propertyName)).Value;
  124. if (!string.IsNullOrWhiteSpace(comment))
  125. {
  126. if (line.EndsWith(";"))
  127. {
  128. lines.Add(AddComment(comment, " "));
  129. }
  130. else
  131. {
  132. lines.Add(AddComment(comment));
  133. }
  134. }
  135. }
  136. lines.Add(line);
  137. }
  138. }
  139. return string.Join(Environment.NewLine, lines);
  140. }
  141. //添加注释(多行注释)
  142. private static string AddComment(string comment, string prefix = "")
  143. {
  144. var arr = comment.Split(new string[] { "\n" }, StringSplitOptions.RemoveEmptyEntries);
  145. return string.Join(Environment.NewLine, arr.Select(p => $"{prefix}//{p.TrimStart()}"));
  146. }
  147. /// <summary>
  148. /// 根据名字获取ProtoType的FullName
  149. /// </summary>
  150. /// <typeparam name="TEntity"></typeparam>
  151. /// <param name="name"></param>
  152. /// <returns></returns>
  153. private static string GetProtoTypeFullName<TEntity>(string name)
  154. {
  155. //判断TEntity是否就是要获取的类型
  156. if (typeof(TEntity).Name == name) return typeof(TEntity).FullName;
  157. //从protoTypes里获取
  158. var type = protoTypes.Where(t => t.Name == name).FirstOrDefault();
  159. return type?.FullName;
  160. }
  161. /// <summary>
  162. /// 给Service加入注释
  163. /// </summary>
  164. /// <param name="proto"></param>
  165. /// <param name="sb"></param>
  166. public static void AddServiceComment(ProtoMethodInfo proto,StringBuilder sb)
  167. {
  168. var comment = string.Empty;
  169. var handler = MetaModel.Methods.FirstOrDefault(p => p.FullName == proto.FullName)?.Handler;
  170. if (handler != null)
  171. {
  172. //var fullName = handler.Method.GetPropertyValue<string>("FullName", BindingFlags.Instance | BindingFlags.NonPublic);
  173. var fullName = GetMethodFullName(handler.Method);
  174. //将方法的FullName转换成注释的FullName
  175. var xmlFullName = fullName.Replace(" ", "").Replace("`1[", "{").Replace("]", "}");
  176. comment = GetComment("M", xmlFullName);
  177. if (!string.IsNullOrWhiteSpace(comment))
  178. {
  179. sb.AppendLine(AddComment(comment, " "));
  180. }
  181. }
  182. }
  183. /// <summary>
  184. /// 获取方法的FullName
  185. /// </summary>
  186. /// <param name="method"></param>
  187. /// <returns></returns>
  188. private static string GetMethodFullName(MethodInfo method)
  189. {
  190. var parameters = method.GetParameters();
  191. var paraStr = string.Join(",", parameters.Select(p => p.ParameterType.ToString()));
  192. return $"{method.DeclaringType.FullName}.{method.Name}({paraStr})";
  193. }
  194. }
  195. }