mirror of
https://gitee.com/fudiwei/DotNetCore.SKIT.FlurlHttpClient.Wechat.git
synced 2025-04-05 17:37:54 +08:00
611 lines
31 KiB
C#
611 lines
31 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using System.Linq;
|
|
using System.Reflection;
|
|
using System.Text;
|
|
using System.Text.RegularExpressions;
|
|
using System.Xml.Serialization;
|
|
|
|
namespace SKIT.FlurlHttpClient.Wechat
|
|
{
|
|
public static class CodeStyleUtil
|
|
{
|
|
private static bool TryJsonize(string json, Type type, out Exception exception)
|
|
{
|
|
exception = null;
|
|
|
|
var newtonsoftJsonSettings = FlurlNewtonsoftJsonSerializer.GetDefaultSerializerSettings();
|
|
newtonsoftJsonSettings.CheckAdditionalContent = true;
|
|
newtonsoftJsonSettings.MissingMemberHandling = Newtonsoft.Json.MissingMemberHandling.Error;
|
|
var newtonsoftJsonSerializer = new FlurlNewtonsoftJsonSerializer(newtonsoftJsonSettings);
|
|
var systemTextJsonSerializer = new FlurlSystemTextJsonSerializer();
|
|
|
|
try
|
|
{
|
|
newtonsoftJsonSerializer.Deserialize(json, type);
|
|
systemTextJsonSerializer.Deserialize(json, type);
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
if (ex is Newtonsoft.Json.JsonException)
|
|
exception = new Exception($"通过 Newtonsoft.Json 反序列化 `{type.Name}` 失败。", ex);
|
|
else if (ex is System.Text.Json.JsonException)
|
|
exception = new Exception($"通过 System.Text.Json 反序列化 `{type.Name}` 失败。", ex);
|
|
else
|
|
exception = new Exception($"JSON 反序列化 `{type.Name}` 遇到问题。", ex);
|
|
}
|
|
|
|
try
|
|
{
|
|
object instance = Activator.CreateInstance(type);
|
|
TestReflectionUtil.InitializeProperties(instance);
|
|
|
|
newtonsoftJsonSerializer.Serialize(instance, type);
|
|
systemTextJsonSerializer.Serialize(instance, type);
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
if (ex is Newtonsoft.Json.JsonException)
|
|
exception = new Exception($"通过 Newtonsoft.Json 序列化 `{type.Name}` 失败。", ex);
|
|
else if (ex is System.Text.Json.JsonException)
|
|
exception = new Exception($"通过 System.Text.Json 序列化 `{type.Name}` 失败。", ex);
|
|
else
|
|
exception = new Exception($"JSON 序列化 `{type.Name}` 遇到问题。", ex);
|
|
}
|
|
|
|
PropertyInfo[] lstPropInfo = TestReflectionUtil.GetAllProperties(type);
|
|
foreach (PropertyInfo propInfo in lstPropInfo)
|
|
{
|
|
var newtonsoftJsonAttribute = propInfo.GetCustomAttribute<Newtonsoft.Json.JsonPropertyAttribute>();
|
|
var systemTextJsonAttribute = propInfo.GetCustomAttribute<System.Text.Json.Serialization.JsonPropertyNameAttribute>();
|
|
if (newtonsoftJsonAttribute?.PropertyName != systemTextJsonAttribute?.Name)
|
|
exception = new Exception($"类型 `{type.Name}` 的可 JSON 序列化字段声明不一致：`{newtonsoftJsonAttribute.PropertyName}` & `{systemTextJsonAttribute.Name}`。");
|
|
}
|
|
|
|
return exception == null;
|
|
}
|
|
|
|
public static bool VerifyApiModelsNaming(Assembly assembly, out Exception exception)
|
|
{
|
|
if (assembly == null) throw new ArgumentNullException(nameof(assembly));
|
|
|
|
var lstModelType = TestReflectionUtil.GetAllApiModelsTypes(assembly);
|
|
var lstError = new List<Exception>();
|
|
|
|
foreach (Type modelType in lstModelType)
|
|
{
|
|
string name = modelType.Name.Split('`')[0];
|
|
|
|
if (!name.EndsWith("Request") && !name.EndsWith("Response"))
|
|
{
|
|
lstError.Add(new Exception($"`{name}` 类名结尾应为 \"Request\" 或 \"Response\"。"));
|
|
continue;
|
|
}
|
|
|
|
if (name.EndsWith("Request"))
|
|
{
|
|
if (!typeof(ICommonRequest).IsAssignableFrom(modelType))
|
|
{
|
|
lstError.Add(new Exception($"`{name}` 类需实现自 `ICommonRequest`。"));
|
|
continue;
|
|
}
|
|
|
|
if (!lstModelType.Any(e => e.Name == $"{name.Substring(0, name.Length - "Request".Length)}Response"))
|
|
{
|
|
lstError.Add(new Exception($"`{name}` 是请求模型，但不存在对应的响应模型。"));
|
|
continue;
|
|
}
|
|
}
|
|
|
|
if (name.EndsWith("Response"))
|
|
{
|
|
if (!typeof(ICommonResponse).IsAssignableFrom(modelType))
|
|
{
|
|
lstError.Add(new Exception($"`{name}` 类需实现自 `ICommonResponse`。"));
|
|
continue;
|
|
}
|
|
|
|
if (!lstModelType.Any(e => e.Name == $"{name.Substring(0, name.Length - "Response".Length)}Request"))
|
|
{
|
|
lstError.Add(new Exception($"`{name}` 是响应模型，但不存在对应的请求模型。"));
|
|
continue;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (lstError.Any())
|
|
{
|
|
exception = new AggregateException(lstError);
|
|
return false;
|
|
}
|
|
|
|
exception = null;
|
|
return true;
|
|
}
|
|
|
|
public static bool VerifyApiModelsDefinition(Assembly assembly, string workdir, out Exception exception)
|
|
{
|
|
if (assembly == null) throw new ArgumentNullException(nameof(assembly));
|
|
if (workdir == null) throw new ArgumentNullException(nameof(workdir));
|
|
|
|
var lstModelType = TestReflectionUtil.GetAllApiModelsTypes(assembly);
|
|
var lstError = new List<Exception>();
|
|
|
|
var lstFile = TestIOUtil.GetAllFiles(workdir)
|
|
.Where(e => string.Equals(Path.GetExtension(e), ".json", StringComparison.InvariantCultureIgnoreCase))
|
|
.ToList();
|
|
if (!lstFile.Any())
|
|
{
|
|
lstError.Add(new Exception($"路径 \"{workdir}\" 下不存在 JSON 格式的模型示例文件，请检查路径是否正确。"));
|
|
}
|
|
|
|
foreach (string file in lstFile)
|
|
{
|
|
string json = File.ReadAllText(file);
|
|
string name = Path.GetFileNameWithoutExtension(file).Split('.')[0];
|
|
|
|
Type type = assembly.GetTypes().SingleOrDefault(e => e.FullName.StartsWith($"{assembly.GetName().Name}.Models.") && e.Name == name);
|
|
if (type == null)
|
|
{
|
|
lstError.Add(new Exception($"类型 `{name}`不存在。"));
|
|
continue;
|
|
}
|
|
|
|
if (!TryJsonize(json, type, out Exception ex))
|
|
{
|
|
lstError.Add(ex);
|
|
}
|
|
}
|
|
|
|
if (lstError.Any())
|
|
{
|
|
exception = new AggregateException(lstError);
|
|
return false;
|
|
}
|
|
|
|
exception = null;
|
|
return true;
|
|
}
|
|
|
|
public static bool VerifyApiEventsDefinition(Assembly assembly, string workdir, out Exception exception)
|
|
{
|
|
if (assembly == null) throw new ArgumentNullException(nameof(assembly));
|
|
if (workdir == null) throw new ArgumentNullException(nameof(workdir));
|
|
|
|
var lstModelType = TestReflectionUtil.GetAllApiModelsTypes(assembly);
|
|
var lstError = new List<Exception>();
|
|
|
|
var lstJsonFile = TestIOUtil.GetAllFiles(workdir)
|
|
.Where(e => string.Equals(Path.GetExtension(e), ".json", StringComparison.InvariantCultureIgnoreCase))
|
|
.ToArray();
|
|
var lstXmlFile = TestIOUtil.GetAllFiles(workdir)
|
|
.Where(e => string.Equals(Path.GetExtension(e), ".xml", StringComparison.InvariantCultureIgnoreCase))
|
|
.ToArray();
|
|
if (!lstJsonFile.Any() && !lstXmlFile.Any())
|
|
{
|
|
lstError.Add(new Exception($"路径 \"{workdir}\" 下不存在 JSON 或 XML 格式的事件示例文件，请检查路径是否正确。"));
|
|
}
|
|
|
|
foreach (string file in lstJsonFile)
|
|
{
|
|
string json = File.ReadAllText(file);
|
|
string name = Path.GetFileNameWithoutExtension(file).Split('.')[0];
|
|
|
|
Type type = assembly.GetTypes().SingleOrDefault(e => e.FullName.StartsWith($"{assembly.GetName().Name}.Events.") && e.Name == name);
|
|
if (type == null)
|
|
{
|
|
lstError.Add(new Exception($"类型 `{name}`不存在。"));
|
|
continue;
|
|
}
|
|
|
|
if (!TryJsonize(json, type, out Exception ex))
|
|
{
|
|
lstError.Add(ex);
|
|
}
|
|
}
|
|
|
|
foreach (string file in lstXmlFile)
|
|
{
|
|
string xml = File.ReadAllText(file);
|
|
string name = Path.GetFileNameWithoutExtension(file).Split('.')[0];
|
|
|
|
Type type = assembly.GetTypes().SingleOrDefault(e => e.FullName.StartsWith($"{assembly.GetName().Name}.Events.") && e.Name == name);
|
|
if (type == null)
|
|
{
|
|
lstError.Add(new Exception($"类型 `{name}`不存在。"));
|
|
continue;
|
|
}
|
|
|
|
try
|
|
{
|
|
using StringReader reader = new StringReader(xml);
|
|
XmlSerializer xmlSerializer = new XmlSerializer(type, new XmlRootAttribute("xml"));
|
|
xmlSerializer.Deserialize(reader);
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
lstError.Add(new Exception($"XML 反序列化 `{type.Name}` 遇到问题。", ex));
|
|
}
|
|
}
|
|
|
|
if (lstError.Any())
|
|
{
|
|
exception = new AggregateException(lstError);
|
|
return false;
|
|
}
|
|
|
|
exception = null;
|
|
return true;
|
|
}
|
|
|
|
public static bool VerifyApiExtensionsNaming(Assembly assembly, out Exception exception)
|
|
{
|
|
if (assembly == null) throw new ArgumentNullException(nameof(assembly));
|
|
|
|
var lstExtType = TestReflectionUtil.GetAllApiExtensionsTypes(assembly);
|
|
var lstError = new List<Exception>();
|
|
|
|
foreach (Type extType in lstExtType)
|
|
{
|
|
MethodInfo[] lstMethod = extType.GetMethods()
|
|
.Where(e =>
|
|
e.IsPublic &&
|
|
e.IsStatic &&
|
|
typeof(ICommonClient).IsAssignableFrom(e.GetParameters().FirstOrDefault().ParameterType)
|
|
)
|
|
.ToArray();
|
|
|
|
foreach (MethodInfo methodInfo in lstMethod)
|
|
{
|
|
ParameterInfo[] lstParamInfo = methodInfo.GetParameters();
|
|
|
|
// 参数签名必为 this client + request + cancelToken
|
|
if (lstParamInfo.Length != 3)
|
|
{
|
|
lstError.Add(new Exception($"`{extType.Name}.{methodInfo.Name}` 方法需有且仅有 3 个入参。"));
|
|
continue;
|
|
}
|
|
|
|
// 第二个参数必为 ICommonRequest 子类
|
|
if (!typeof(ICommonRequest).IsAssignableFrom(lstParamInfo[1].ParameterType))
|
|
{
|
|
lstError.Add(new Exception($"`{extType.Name}.{methodInfo.Name}` 方法第 1 个入参需实现自 `ICommonRequest`。"));
|
|
continue;
|
|
}
|
|
|
|
// 方法名与第二个参数、返回值均有相同命名
|
|
string func = methodInfo.Name;
|
|
string para = lstParamInfo[1].ParameterType.Name;
|
|
string retv = methodInfo.ReturnType.GenericTypeArguments.FirstOrDefault()?.Name;
|
|
if (para == null || !para.EndsWith("Request"))
|
|
{
|
|
lstError.Add(new Exception($"`{extType.Name}.{methodInfo.Name}` 方法第 1 个入参类名应以 `Request` 结尾。"));
|
|
continue;
|
|
}
|
|
else if (retv == null || !retv.EndsWith("Response"))
|
|
{
|
|
if (!methodInfo.ReturnType.GenericTypeArguments.First().IsGenericType)
|
|
{
|
|
lstError.Add(new Exception($"`{extType.Name}.{methodInfo.Name}` 方法返回值类名应以 `Response` 结尾。"));
|
|
}
|
|
continue;
|
|
}
|
|
else if (!string.Equals(func, $"Execute{para.Substring(0, para.Length - "Request".Length)}Async"))
|
|
{
|
|
lstError.Add(new Exception($"`{extType.Name}.{methodInfo.Name}` 方法与请求模型应同名。"));
|
|
continue;
|
|
}
|
|
else if (!string.Equals(func, $"Execute{retv.Substring(0, retv.Length - "Response".Length)}Async"))
|
|
{
|
|
lstError.Add(new Exception($"`{extType.Name}.{methodInfo.Name}` 方法与响应模型应同名。"));
|
|
continue;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (lstError.Any())
|
|
{
|
|
exception = new AggregateException(lstError);
|
|
return false;
|
|
}
|
|
|
|
exception = null;
|
|
return true;
|
|
}
|
|
|
|
public static bool VerifySourceCodeStyle(string workdir, out Exception exception)
|
|
{
|
|
if (workdir == null) throw new ArgumentNullException(nameof(workdir));
|
|
|
|
var lstError = new List<Exception>();
|
|
|
|
var lstExtensionsCodeFile = TestIOUtil.GetAllFiles(workdir)
|
|
.Where(e => string.Equals(Path.GetExtension(e), ".cs", StringComparison.InvariantCultureIgnoreCase))
|
|
.Where(e => Path.GetDirectoryName(e).StartsWith(Path.Combine(workdir, "Extensions")))
|
|
.Where(e => Path.GetFileNameWithoutExtension(e).StartsWith("Wechat"))
|
|
.Where(e => Path.GetFileNameWithoutExtension(e).Contains("ClientExecute"))
|
|
.Where(e => Path.GetFileNameWithoutExtension(e).EndsWith("Extensions"))
|
|
.ToArray();
|
|
var lstModelsCodeFile = TestIOUtil.GetAllFiles(workdir)
|
|
.Where(e => string.Equals(Path.GetExtension(e), ".cs", StringComparison.InvariantCultureIgnoreCase))
|
|
.Where(e => Path.GetDirectoryName(e).StartsWith(Path.Combine(workdir, "Models")))
|
|
.Where(e => Path.GetFileNameWithoutExtension(e).EndsWith("Request") || Path.GetFileNameWithoutExtension(e).EndsWith("Response"))
|
|
.ToArray();
|
|
if (!lstExtensionsCodeFile.Any() || !lstModelsCodeFile.Any())
|
|
{
|
|
lstError.Add(new Exception($"路径 \"{workdir}\" 下不存在 CSharp 格式的源代码文件，请检查路径是否正确。"));
|
|
}
|
|
|
|
foreach (string extCodeFilePath in lstExtensionsCodeFile)
|
|
{
|
|
string extCodeFileName = Path.GetFileName(extCodeFilePath);
|
|
|
|
string[] array = File.ReadAllText(extCodeFilePath)
|
|
.Split("<summary>", StringSplitOptions.RemoveEmptyEntries)
|
|
.Where(e => e.Contains("Async") && !e.Contains("public static class"))
|
|
.ToArray();
|
|
for (int i = 0; i < array.Length; i++)
|
|
{
|
|
bool TryCheckExtensionSourceCode(string sourceCode, out (string Name, string Method, string Url)? request)
|
|
{
|
|
request = null;
|
|
|
|
// 匹配 <para> ... </para> 结构
|
|
var regexPara = new Regex("<para(([\\s\\S])*?)</para>").Match(sourceCode);
|
|
if (!regexPara.Success)
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{extCodeFileName}\" 下第 {i + 1} 段文档注释不齐全，未能匹配到 \"<para> ... </para>\"。"));
|
|
return false;
|
|
}
|
|
|
|
// 匹配 [...] ... 结构
|
|
var regexApi = new Regex("\\[(\\S*)\\]\\s*(\\S*)").Match(regexPara.Groups[1].Value);
|
|
if (!regexApi.Success)
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{extCodeFileName}\" 下第 {i + 1} 段文档注释不齐全，未能匹配到 \"异步调用 ... 接口\"。"));
|
|
return false;
|
|
}
|
|
|
|
// 比对请求谓词
|
|
string expectedMethod = regexApi.Groups[1].Value.Trim();
|
|
string expectedUrl = regexApi.Groups[2].Value.Split('?')[0].Trim();
|
|
string actualMethod = sourceCode.Contains(".CreateRequest(request, new HttpMethod(\"") ?
|
|
sourceCode.Split(".CreateRequest(request, new HttpMethod(\"")[1].Split("\"")[0] :
|
|
sourceCode.Contains(".CreateRequest(request, HttpMethod.") ?
|
|
sourceCode.Split(".CreateRequest(request, HttpMethod.")[1].Split(",")[0].Split(")")[0] :
|
|
string.Empty;
|
|
if (!string.Equals(expectedMethod, actualMethod, StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{extCodeFileName}\" 下第 {i + 1} 段文档注释有误，`[{expectedMethod}] {expectedUrl}` 与实际接口谓词不一致。"));
|
|
return false;
|
|
}
|
|
|
|
// 比对请求路由
|
|
string actualUrl = sourceCode
|
|
.Split("CreateRequest(request,", StringSplitOptions.RemoveEmptyEntries)[1]
|
|
.Substring(sourceCode.Split("CreateRequest(request,", StringSplitOptions.RemoveEmptyEntries)[1].Split(",")[0].Length + 1)
|
|
.Split('\n')[0]
|
|
.Trim()
|
|
.TrimEnd(')', ';')
|
|
.Trim();
|
|
string[] expectedUrlSegments = expectedUrl.Split('/', StringSplitOptions.RemoveEmptyEntries);
|
|
string[] actualUrlSegments = actualUrl.Split(',', StringSplitOptions.RemoveEmptyEntries).Select(e => e.Trim()).ToArray();
|
|
if (expectedUrlSegments.Length != actualUrlSegments.Length)
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{extCodeFileName}\" 下第 {i + 1} 段文档注释有误，`[{expectedMethod}] {expectedUrl}` 与实际接口路由不一致。"));
|
|
return false;
|
|
}
|
|
else
|
|
{
|
|
for (int urlSegmentIndex = 0; urlSegmentIndex < expectedUrlSegments.Length; urlSegmentIndex++)
|
|
{
|
|
string expectedUrlSegment = expectedUrlSegments[urlSegmentIndex].Trim('/');
|
|
string actualUrlSegment = actualUrlSegments[urlSegmentIndex].Trim('/');
|
|
if (expectedUrlSegment.Contains("{"))
|
|
{
|
|
if (actualUrlSegment.StartsWith("\""))
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{extCodeFileName}\" 下第 {i + 1} 段文档注释有误，`[{expectedMethod}] {expectedUrl}` 与实际接口路由不一致。"));
|
|
break;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
actualUrlSegment = actualUrlSegment.Replace("\"", string.Empty).Trim('/');
|
|
if (!string.Equals(expectedUrlSegment, actualUrlSegment))
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{extCodeFileName}\" 下第 {i + 1} 段文档注释有误，`[{expectedMethod}] {expectedUrl}` 与实际接口路由不一致。"));
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// 比对 .SendRequestAsync() 方法
|
|
if (!"GET".Equals(actualMethod, StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
if (sourceCode.Contains("flurlReq, cancellationToken"))
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{extCodeFileName}\" 下第 {i + 1} 段代码有误，`[{expectedMethod}] {expectedUrl}` 为非简单请求但不包含请求正文。"));
|
|
return false;
|
|
}
|
|
}
|
|
|
|
string apiName = new Regex("Execute([a-zA-Z0-9]*)Async").Match(sourceCode).Groups[1].Value;
|
|
request = (apiName, expectedMethod, expectedUrl);
|
|
return true;
|
|
}
|
|
bool TryCheckRequestModelSourceCode(string filePath, string expectedRequestMethod, string expectedRequestUrl)
|
|
{
|
|
string reqCodeFileName = Path.GetFileName(filePath);
|
|
string reqCodeSourceCode = File.ReadAllText(filePath);
|
|
|
|
// 匹配 <para> ... </para> 结构
|
|
var regexPara = new Regex("<para(([\\s\\S])*?)</para>").Match(reqCodeSourceCode);
|
|
if (!regexPara.Success)
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{reqCodeFileName}\" 下文档注释不齐全，未能匹配到 \"<para> ... </para>\"。"));
|
|
return false;
|
|
}
|
|
|
|
// 匹配 [...] ... 结构
|
|
var regexApi = new Regex("\\[(\\S*)\\]\\s*(\\S*)").Match(regexPara.Groups[1].Value);
|
|
if (!regexApi.Success)
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{reqCodeFileName}\" 下文档注释不齐全，未能匹配到 \"异步调用 ... 接口\"。"));
|
|
return false;
|
|
}
|
|
|
|
// 比对请求谓词
|
|
string actualMethod = regexApi.Groups[1].Value.Trim();
|
|
if (!string.Equals(expectedRequestMethod, actualMethod, StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{reqCodeFileName}\" 下文档注释有误，与实际接口谓词不一致。"));
|
|
return false;
|
|
}
|
|
|
|
// 对比请求路由
|
|
string actualUrl = regexApi.Groups[2].Value.Split('?')[0].Trim();
|
|
if (!string.Equals(expectedRequestUrl, actualUrl, StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{reqCodeFileName}\" 下文档注释有误，与实际接口路由不一致。"));
|
|
return false;
|
|
}
|
|
|
|
// 检验是否包含 `default!` 的赋值
|
|
if (new Regex("=\\s*default!").IsMatch(reqCodeSourceCode))
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{reqCodeFileName}\" 下代码有误，请求模型不应包含 `= default!` 赋值。"));
|
|
return false;
|
|
}
|
|
|
|
// 检验是否包含数组类型字段
|
|
if (new Regex("public\\s*[a-zA-Z0-9.]*\\[\\]\\s*[a-zA-Z0-9]*\\s*{\\s*get;\\s*set;\\s*}").IsMatch(reqCodeSourceCode.Replace("byte[]", string.Empty).Replace("Byte[]", string.Empty)))
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{reqCodeFileName}\" 下代码有误，请求模型不应包含数组类型字段。"));
|
|
return false;
|
|
}
|
|
|
|
// 校验是否包含可空字段的初始化
|
|
if (new Regex("\\? [a-zA-Z0-9]* \\{ get; set; \\} =").IsMatch(reqCodeSourceCode))
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{reqCodeFileName}\" 下代码有误，可空字段不应初始化。"));
|
|
return false;
|
|
}
|
|
|
|
// 如果是 GET 请求，检查是否包含 JSON 序列化字段
|
|
if ("GET".Equals(expectedRequestMethod, StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
if (!(reqCodeSourceCode.Contains("/* @codestyle-disable") && reqCodeSourceCode.Contains("no-jsonable-property-in-request-get")))
|
|
{
|
|
if (new Regex("\\[Newtonsoft.Json.JsonProperty\\(\"[a-zA-Z0-9_]*\"\\)\\]").IsMatch(reqCodeSourceCode))
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{reqCodeFileName}\" 下代码有误，请求模型为简单请求、不应包含可 JSON 序列化字段。"));
|
|
return false;
|
|
}
|
|
|
|
if (new Regex("\\[System.Text.Json.Serialization.JsonPropertyName\\(\"[a-zA-Z0-9_]*\"\\)\\]").IsMatch(reqCodeSourceCode))
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{reqCodeFileName}\" 下代码有误，请求模型为简单请求、不应包含可 JSON 序列化字段。"));
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
bool TryCheckResponseModelSourceCode(string filePath, string expectedRequestMethod, string expectedRequestUrl)
|
|
{
|
|
string resCodeFileName = Path.GetFileName(filePath);
|
|
string resCodeSourceCode = File.ReadAllText(filePath);
|
|
|
|
// 匹配 <para> ... </para> 结构
|
|
var regexPara = new Regex("<para(([\\s\\S])*?)</para>").Match(resCodeSourceCode);
|
|
if (!regexPara.Success)
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{resCodeFileName}\" 下文档注释不齐全，未能匹配到 \"<para> ... </para>\"。"));
|
|
return false;
|
|
}
|
|
|
|
// 匹配 [...] ... 结构
|
|
var regexApi = new Regex("\\[(\\S*)\\]\\s*(\\S*)").Match(regexPara.Groups[1].Value);
|
|
if (!regexApi.Success)
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{resCodeFileName}\" 下文档注释不齐全，未能匹配到 \"异步调用 ... 接口\"。"));
|
|
return false;
|
|
}
|
|
|
|
// 比对请求谓词
|
|
string actualMethod = regexApi.Groups[1].Value.Trim();
|
|
if (!string.Equals(expectedRequestMethod, actualMethod, StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{resCodeFileName}\" 下文档注释有误，与实际接口谓词不一致。"));
|
|
return false;
|
|
}
|
|
|
|
// 对比请求路由
|
|
string actualUrl = regexApi.Groups[2].Value.Split('?')[0].Trim();
|
|
if (!string.Equals(expectedRequestUrl, actualUrl, StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{resCodeFileName}\" 下文档注释有误，与实际接口路由不一致。"));
|
|
return false;
|
|
}
|
|
|
|
// 检验是否包含 `string.Empty` 的赋值
|
|
if (new Regex("=\\s*string.Empty").IsMatch(resCodeSourceCode))
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{resCodeFileName}\" 下代码有误，响应模型不应包含 `= string.Empty` 赋值。"));
|
|
return false;
|
|
}
|
|
|
|
// 检验是否包含 `new class()` 的赋值
|
|
if (!(resCodeSourceCode.Contains("/* @codestyle-disable") && resCodeSourceCode.Contains("no-instantiated-property-in-response")))
|
|
{
|
|
if (new Regex("=\\s*new\\s[a-zA-Z0-9.]*\\(\\)").IsMatch(resCodeSourceCode))
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{resCodeFileName}\" 下代码有误，响应模型不应包含 `= new class()` 赋值。"));
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// 检验是否包含列表类型字段
|
|
if (new Regex("public\\s*IList<[a-zA-Z0-9.]*>\\s*[a-zA-Z0-9]*\\s*{\\s*get;\\s*set;\\s*}").IsMatch(resCodeSourceCode))
|
|
{
|
|
lstError.Add(new Exception($"源代码 \"{resCodeFileName}\" 下代码有误，响应模型不应包含列表类型字段。"));
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
if (!TryCheckExtensionSourceCode(array[i], out var request))
|
|
{
|
|
continue;
|
|
}
|
|
else
|
|
{
|
|
string requestModelFileName = lstModelsCodeFile.Single(e => string.Equals(Path.GetFileNameWithoutExtension(e), $"{request.Value.Name}Request"));
|
|
string responseModelFileName = lstModelsCodeFile.Single(e => string.Equals(Path.GetFileNameWithoutExtension(e), $"{request.Value.Name}Response"));
|
|
bool isValidReq = TryCheckRequestModelSourceCode(requestModelFileName, request.Value.Method, request.Value.Url);
|
|
bool isValidRes = TryCheckResponseModelSourceCode(responseModelFileName, request.Value.Method, request.Value.Url);
|
|
if (!isValidReq || !isValidRes)
|
|
{
|
|
continue;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if (lstError.Any())
|
|
{
|
|
exception = new AggregateException(lstError);
|
|
return false;
|
|
}
|
|
|
|
exception = null;
|
|
return true;
|
|
}
|
|
}
|
|
}
|