RequestValidator.cs 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199
  1. using FastJSON;
  2. using System;
  3. using System.Collections;
  4. using System.Collections.Generic;
  5. namespace Top.Api.Util
  6. {
  7. /// <summary>
  8. /// 请求验证器。
  9. /// </summary>
  10. public sealed class RequestValidator
  11. {
  12. private const string ERR_CODE_PARAM_MISSING = "40";
  13. private const string ERR_CODE_PARAM_INVALID = "41";
  14. private const string ERR_MSG_PARAM_MISSING = "client-error:Missing required arguments:{0}";
  15. private const string ERR_MSG_PARAM_INVALID = "client-error:Invalid arguments:{0}";
  16. /// <summary>
  17. /// 验证参数是否为空。
  18. /// </summary>
  19. /// <param name="name">参数名</param>
  20. /// <param name="value">参数值</param>
  21. public static void ValidateRequired(string name, object value)
  22. {
  23. if (value == null)
  24. {
  25. throw new TopException(ERR_CODE_PARAM_MISSING, string.Format(ERR_MSG_PARAM_MISSING, name));
  26. }
  27. else
  28. {
  29. if (value.GetType() == typeof(string))
  30. {
  31. string strValue = value as string;
  32. if (string.IsNullOrEmpty(strValue))
  33. {
  34. throw new TopException(ERR_CODE_PARAM_MISSING, string.Format(ERR_MSG_PARAM_MISSING, name));
  35. }
  36. }
  37. }
  38. }
  39. /// <summary>
  40. /// 验证字符串参数的最大长度。
  41. /// </summary>
  42. /// <param name="name">参数名</param>
  43. /// <param name="value">参数值</param>
  44. /// <param name="maxLength">最大长度</param>
  45. public static void ValidateMaxLength(string name, string value, int maxLength)
  46. {
  47. if (value != null && value.Length > maxLength)
  48. {
  49. throw new TopException(ERR_CODE_PARAM_INVALID, string.Format(ERR_MSG_PARAM_INVALID, name));
  50. }
  51. }
  52. /// <summary>
  53. /// 验证上传文件的最大字节长度。
  54. /// </summary>
  55. /// <param name="name">参数名</param>
  56. /// <param name="value">参数值</param>
  57. /// <param name="maxLength">最大长度</param>
  58. public static void ValidateMaxLength(string name, FileItem value, int maxLength)
  59. {
  60. if (value != null && value.GetFileLength() > maxLength)
  61. {
  62. throw new TopException(ERR_CODE_PARAM_INVALID, string.Format(ERR_MSG_PARAM_INVALID, name));
  63. }
  64. }
  65. /// <summary>
  66. /// 验证以逗号分隔的字符串参数的最大列表长度。
  67. /// </summary>
  68. /// <param name="name">参数名</param>
  69. /// <param name="value">参数值</param>
  70. /// <param name="maxSize">最大列表长度</param>
  71. public static void ValidateMaxListSize(string name, string value, int maxSize)
  72. {
  73. if (value != null)
  74. {
  75. string[] data = value.Split(',');
  76. if (data != null && data.Length > maxSize)
  77. {
  78. throw new TopException(ERR_CODE_PARAM_INVALID, string.Format(ERR_MSG_PARAM_INVALID, name));
  79. }
  80. }
  81. }
  82. /// <summary>
  83. /// 验证以逗号分隔的字符串参数的最大列表长度。
  84. /// </summary>
  85. /// <param name="name">参数名</param>
  86. /// <param name="value">参数值</param>
  87. /// <param name="maxSize">最大列表长度</param>
  88. public static void ValidateMaxListSize(string name, List<string> value, int maxSize)
  89. {
  90. if (value != null)
  91. {
  92. if (value != null && value.Count > maxSize)
  93. {
  94. throw new TopException(ERR_CODE_PARAM_INVALID, ERR_MSG_PARAM_INVALID);
  95. }
  96. }
  97. }
  98. /// <summary>
  99. /// 验证以逗号分隔的字符串参数的最大列表长度。
  100. /// </summary>
  101. /// <param name="name">参数名</param>
  102. /// <param name="value">参数值</param>
  103. /// <param name="maxSize">最大列表长度</param>
  104. public static void ValidateMaxListSize(string name, List<long> value, int maxSize)
  105. {
  106. if (value != null)
  107. {
  108. if (value != null && value.Count > maxSize)
  109. {
  110. throw new TopException(ERR_CODE_PARAM_INVALID, ERR_MSG_PARAM_INVALID);
  111. }
  112. }
  113. }
  114. /// <summary>
  115. /// 验证以逗号分隔的字符串参数的最大列表长度。
  116. /// </summary>
  117. /// <param name="name">参数名</param>
  118. /// <param name="value">参数值</param>
  119. /// <param name="maxSize">最大列表长度</param>
  120. public static void ValidateMaxListSize(string name, List<bool> value, int maxSize)
  121. {
  122. if (value != null)
  123. {
  124. if (value != null && value.Count > maxSize)
  125. {
  126. throw new TopException(ERR_CODE_PARAM_INVALID, ERR_MSG_PARAM_INVALID);
  127. }
  128. }
  129. }
  130. /// <summary>
  131. /// 验证复杂结构数组参数的最大列表长度。
  132. /// </summary>
  133. /// <param name="name">参数名</param>
  134. /// <param name="value">参数值</param>
  135. /// <param name="maxSize">最大列表长度</param>
  136. public static void ValidateObjectMaxListSize(string name, string value, int maxSize)
  137. {
  138. if (value != null)
  139. {
  140. IList list = JSON.Parse(value) as IList;
  141. if (list != null && list.Count > maxSize)
  142. {
  143. throw new TopException(ERR_CODE_PARAM_INVALID, string.Format(ERR_MSG_PARAM_INVALID, name));
  144. }
  145. }
  146. }
  147. /// <summary>
  148. /// 验证字符串参数的最小长度。
  149. /// </summary>
  150. /// <param name="name">参数名</param>
  151. /// <param name="value">参数值</param>
  152. /// <param name="minLength">最小长度</param>
  153. public static void ValidateMinLength(string name, string value, int minLength)
  154. {
  155. if (value != null && value.Length < minLength)
  156. {
  157. throw new TopException(ERR_CODE_PARAM_INVALID, string.Format(ERR_MSG_PARAM_INVALID, name));
  158. }
  159. }
  160. /// <summary>
  161. /// 验证数字参数的最大值。
  162. /// </summary>
  163. /// <param name="name">参数名</param>
  164. /// <param name="value">参数值</param>
  165. /// <param name="maxValue">最大值</param>
  166. public static void ValidateMaxValue(string name, Nullable<long> value, long maxValue)
  167. {
  168. if (value != null && value > maxValue)
  169. {
  170. throw new TopException(ERR_CODE_PARAM_INVALID, string.Format(ERR_MSG_PARAM_INVALID, name));
  171. }
  172. }
  173. /// <summary>
  174. /// 验证数字参数的最小值。
  175. /// </summary>
  176. /// <param name="name">参数名</param>
  177. /// <param name="value">参数值</param>
  178. /// <param name="minValue">最小值</param>
  179. public static void ValidateMinValue(string name, Nullable<long> value, long minValue)
  180. {
  181. if (value != null && value < minValue)
  182. {
  183. throw new TopException(ERR_CODE_PARAM_INVALID, string.Format(ERR_MSG_PARAM_INVALID, name));
  184. }
  185. }
  186. }
  187. }