AppUITMPInputField.cs 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477
  1. using AppUI.Localization;
  2. using System;
  3. using System.Text.RegularExpressions;
  4. using JCUnityLib;
  5. using TMPro;
  6. using UnityEngine;
  7. using UnityEngine.Events;
  8. namespace AppUI.Util.Input
  9. {
  10. /// <summary>输入用途,决定校验规则与 <see cref="TMP_InputField"/> 默认配置。</summary>
  11. public enum AppUIInputKind
  12. {
  13. Generic,
  14. Nickname,
  15. Password,
  16. Email,
  17. Phone,
  18. SmsCode,
  19. }
  20. /// <summary>校验结果,供外部逻辑分支处理。</summary>
  21. public readonly struct AppUIInputValidation
  22. {
  23. public bool IsValid { get; }
  24. /// <summary>失败时已本地化的提示文案。</summary>
  25. public string Message { get; }
  26. public static AppUIInputValidation Ok => new AppUIInputValidation(true, null);
  27. public AppUIInputValidation(bool isValid, string message)
  28. {
  29. IsValid = isValid;
  30. Message = message;
  31. }
  32. }
  33. /// <summary>
  34. /// 挂在 <c>TMPInput</c> 预制体根节点,统一管理左侧 Title、<see cref="TMP_InputField"/> 及可选 <see cref="TMP_InputFieldActionBar"/>。
  35. /// 外部通过 <see cref="Text"/> / <see cref="Validate"/> / 事件获取输入,无需直接操作子节点。
  36. /// </summary>
  37. [DisallowMultipleComponent]
  38. [ExecuteAlways]
  39. public class AppUITMPInputField : MonoBehaviour
  40. {
  41. const string PathTitleLabel = "Content/Title/Label";
  42. const string PathInputField = "Content/InputField (TMP)";
  43. [Header("展示")]
  44. [Tooltip("多语言 key;非空时优先于 Title 文案")]
  45. [SerializeField]
  46. string titleKey;
  47. [Tooltip("左侧 Title/Label 文案;titleKey 为空时使用,Editor 预览用")]
  48. [SerializeField]
  49. string title = "Password";
  50. [Tooltip("Placeholder 多语言 key;非空时优先于 Placeholder 文案")]
  51. [SerializeField]
  52. string placeholderKey;
  53. [Tooltip("占位符;placeholderKey 为空时使用;两者都为空则不修改预制体 Placeholder")]
  54. [SerializeField]
  55. string placeholder = "";
  56. [SerializeField]
  57. AppUIInputKind kind = AppUIInputKind.Generic;
  58. [Header("引用(可留空,运行时按路径自动绑定)")]
  59. [SerializeField]
  60. TMP_Text titleLabel;
  61. [SerializeField]
  62. TMP_InputField inputField;
  63. [SerializeField]
  64. TMP_InputFieldActionBar actionBar;
  65. [Header("校验(0 表示使用类型默认值)")]
  66. [SerializeField]
  67. int minLength;
  68. [SerializeField]
  69. int maxLength;
  70. [SerializeField]
  71. bool required = true;
  72. [Header("仅点击(不弹出键盘)")]
  73. [Tooltip("开启后输入框只读,点击时触发 OnClick,可在 Inspector 绑定其他对象方法")]
  74. [SerializeField]
  75. bool clickOnly;
  76. [SerializeField]
  77. UnityEvent onClick = new UnityEvent();
  78. static readonly Regex PasswordAlphanumeric = new Regex("[^A-Za-z0-9]");
  79. /// <summary>左侧标题文案。</summary>
  80. public string Title
  81. {
  82. get => title;
  83. set
  84. {
  85. title = value ?? string.Empty;
  86. ApplyTitleToLabel();
  87. }
  88. }
  89. public AppUIInputKind Kind => kind;
  90. /// <summary>原始输入(未 Trim)。</summary>
  91. public string Text => inputField != null ? inputField.text : string.Empty;
  92. /// <summary>去除首尾空白后的输入,提交表单时优先使用。</summary>
  93. public string TrimmedText => Text.Trim();
  94. public bool HasValue => TrimmedText.Length > 0;
  95. public TMP_InputField InputField => inputField;
  96. public TMP_InputFieldActionBar ActionBar => actionBar;
  97. public bool ClickOnly => clickOnly;
  98. public string TitleKey => titleKey;
  99. public string PlaceholderKey => placeholderKey;
  100. /// <summary>Inspector 中 <c>onClick</c> 的代码订阅入口。</summary>
  101. public event Action OnClicked;
  102. /// <summary>输入内容变化(与 TMP 一致,参数为当前全文)。</summary>
  103. public event Action<string> OnValueChanged;
  104. /// <summary>结束编辑(失焦 / 提交)。</summary>
  105. public event Action<string> OnEndEdit;
  106. void Awake()
  107. {
  108. ResolveReferences();
  109. ApplyKindSettings();
  110. }
  111. void OnEnable()
  112. {
  113. ResolveReferences();
  114. ApplyLocalizedTexts();
  115. ApplyClickOnlyMode();
  116. BindInputListeners();
  117. AppUILocalization.OnLanguageChanged += HandleLanguageChanged;
  118. }
  119. void OnDisable()
  120. {
  121. AppUILocalization.OnLanguageChanged -= HandleLanguageChanged;
  122. UnbindInputListeners();
  123. }
  124. #if UNITY_EDITOR
  125. void OnValidate()
  126. {
  127. ResolveReferences();
  128. ApplyLocalizedTexts();
  129. if (!Application.isPlaying)
  130. ApplyKindSettings();
  131. if (inputField != null)
  132. inputField.readOnly = clickOnly;
  133. }
  134. #endif
  135. void ResolveReferences()
  136. {
  137. if (titleLabel == null)
  138. {
  139. var labelTr = transform.Find(PathTitleLabel);
  140. if (labelTr != null)
  141. titleLabel = labelTr.GetComponent<TMP_Text>();
  142. }
  143. if (inputField == null)
  144. {
  145. var fieldTr = transform.Find(PathInputField);
  146. if (fieldTr != null)
  147. inputField = fieldTr.GetComponent<TMP_InputField>();
  148. if (inputField == null)
  149. inputField = GetComponentInChildren<TMP_InputField>(true);
  150. }
  151. if (actionBar == null)
  152. actionBar = GetComponentInChildren<TMP_InputFieldActionBar>(true);
  153. }
  154. void BindInputListeners()
  155. {
  156. if (inputField == null)
  157. return;
  158. inputField.onValueChanged.RemoveListener(HandleValueChanged);
  159. inputField.onEndEdit.RemoveListener(HandleEndEdit);
  160. inputField.onSelect.RemoveListener(HandleClickOnlySelect);
  161. if (!clickOnly)
  162. {
  163. inputField.onValueChanged.AddListener(HandleValueChanged);
  164. inputField.onEndEdit.AddListener(HandleEndEdit);
  165. }
  166. else
  167. inputField.onSelect.AddListener(HandleClickOnlySelect);
  168. }
  169. void UnbindInputListeners()
  170. {
  171. if (inputField == null)
  172. return;
  173. inputField.onValueChanged.RemoveListener(HandleValueChanged);
  174. inputField.onEndEdit.RemoveListener(HandleEndEdit);
  175. inputField.onSelect.RemoveListener(HandleClickOnlySelect);
  176. }
  177. /// <summary>同步只读状态;运行中切换 <see cref="clickOnly"/> 时会重新绑定监听。</summary>
  178. public void ApplyClickOnlyMode()
  179. {
  180. if (inputField == null)
  181. return;
  182. inputField.readOnly = clickOnly;
  183. if (isActiveAndEnabled)
  184. BindInputListeners();
  185. }
  186. void HandleClickOnlySelect(string _)
  187. {
  188. if (!clickOnly)
  189. return;
  190. if (inputField != null)
  191. inputField.DeactivateInputField();
  192. InvokeClick();
  193. }
  194. /// <summary>供外部 Button 等转发调用,与点击输入区域效果相同。</summary>
  195. public void InvokeClick()
  196. {
  197. onClick?.Invoke();
  198. OnClicked?.Invoke();
  199. }
  200. void HandleValueChanged(string value)
  201. {
  202. var filtered = value;
  203. var changed = false;
  204. if (kind == AppUIInputKind.Password)
  205. changed = FilterPasswordAlphanumeric(ref filtered);
  206. else if (kind == AppUIInputKind.SmsCode || kind == AppUIInputKind.Phone)
  207. changed = FilterDigitsOnly(ref filtered, GetEffectiveMaxLength());
  208. if (changed && inputField != null)
  209. inputField.SetTextWithoutNotify(filtered);
  210. OnValueChanged?.Invoke(inputField != null ? inputField.text : filtered);
  211. }
  212. void HandleEndEdit(string value) => OnEndEdit?.Invoke(value);
  213. void HandleLanguageChanged(LanguageEnum _) => ApplyLocalizedTexts();
  214. /// <summary>按 titleKey / placeholderKey(或明文 fallback)刷新 Title 与 Placeholder。</summary>
  215. public void ApplyLocalizedTexts()
  216. {
  217. #if UNITY_EDITOR
  218. if (!Application.isPlaying)
  219. AppUILocalization.Reload();
  220. #endif
  221. ApplyTitleToLabel();
  222. ApplyPlaceholder();
  223. }
  224. void ApplyTitleToLabel()
  225. {
  226. if (titleLabel == null)
  227. return;
  228. if (string.IsNullOrEmpty(titleKey) && string.IsNullOrEmpty(title))
  229. return;
  230. titleLabel.text = ResolveDisplayText(titleKey, title);
  231. }
  232. void ApplyPlaceholder()
  233. {
  234. if (inputField == null)
  235. return;
  236. string text = ResolveDisplayText(placeholderKey, placeholder);
  237. if (string.IsNullOrEmpty(text))
  238. return;
  239. if (inputField.placeholder is TMP_Text ph)
  240. ph.text = text;
  241. }
  242. static string ResolveDisplayText(string key, string fallback)
  243. {
  244. if (!string.IsNullOrEmpty(key))
  245. {
  246. AppUILocalization.Init();
  247. return AppUILocalization.GetTextByKey(key);
  248. }
  249. return fallback ?? string.Empty;
  250. }
  251. /// <summary>按 <see cref="kind"/> 配置 ContentType、长度与密码过滤等。</summary>
  252. public void ApplyKindSettings()
  253. {
  254. if (inputField == null)
  255. return;
  256. inputField.lineType = TMP_InputField.LineType.SingleLine;
  257. inputField.characterValidation = TMP_InputField.CharacterValidation.None;
  258. switch (kind)
  259. {
  260. case AppUIInputKind.Password:
  261. inputField.contentType = TMP_InputField.ContentType.Password;
  262. break;
  263. case AppUIInputKind.Email:
  264. inputField.contentType = TMP_InputField.ContentType.EmailAddress;
  265. break;
  266. case AppUIInputKind.Phone:
  267. inputField.contentType = TMP_InputField.ContentType.IntegerNumber;
  268. break;
  269. case AppUIInputKind.SmsCode:
  270. inputField.contentType = TMP_InputField.ContentType.IntegerNumber;
  271. break;
  272. case AppUIInputKind.Nickname:
  273. inputField.contentType = TMP_InputField.ContentType.Standard;
  274. break;
  275. default:
  276. inputField.contentType = TMP_InputField.ContentType.Standard;
  277. break;
  278. }
  279. inputField.characterLimit = GetEffectiveMaxLength();
  280. inputField.ForceLabelUpdate();
  281. }
  282. int GetEffectiveMaxLength()
  283. {
  284. if (maxLength > 0)
  285. return maxLength;
  286. switch (kind)
  287. {
  288. case AppUIInputKind.Phone:
  289. return 11;
  290. case AppUIInputKind.SmsCode:
  291. return 6;
  292. case AppUIInputKind.Nickname:
  293. return 32;
  294. default:
  295. return 0;
  296. }
  297. }
  298. int GetEffectiveMinLength()
  299. {
  300. if (minLength > 0)
  301. return minLength;
  302. if (kind == AppUIInputKind.Password)
  303. return 6;
  304. return required ? 1 : 0;
  305. }
  306. static bool FilterPasswordAlphanumeric(ref string value)
  307. {
  308. var match = PasswordAlphanumeric.Match(value);
  309. if (!match.Success)
  310. return false;
  311. value = value.Replace(match.Value, string.Empty);
  312. return true;
  313. }
  314. static bool FilterDigitsOnly(ref string value, int maxLen)
  315. {
  316. if (string.IsNullOrEmpty(value))
  317. return false;
  318. var filtered = string.Empty;
  319. foreach (var c in value)
  320. {
  321. if (!char.IsDigit(c))
  322. continue;
  323. filtered += c;
  324. if (maxLen > 0 && filtered.Length >= maxLen)
  325. break;
  326. }
  327. if (filtered == value)
  328. return false;
  329. value = filtered;
  330. return true;
  331. }
  332. public void SetText(string value)
  333. {
  334. if (inputField == null)
  335. return;
  336. inputField.text = value ?? string.Empty;
  337. }
  338. public void Clear() => SetText(string.Empty);
  339. public void Focus() => inputField?.ActivateInputField();
  340. /// <summary>按类型做格式/非空校验,返回本地化提示文案(失败时)。</summary>
  341. public AppUIInputValidation Validate()
  342. {
  343. var text = TrimmedText;
  344. var min = GetEffectiveMinLength();
  345. if (required && text.Length == 0)
  346. return Fail(EmptyMessageForKind());
  347. if (min > 0 && text.Length > 0 && text.Length < min)
  348. return Fail(TooShortMessageForKind(min));
  349. switch (kind)
  350. {
  351. case AppUIInputKind.Email:
  352. if (text.Length > 0 && !ValidateHelper.IsEmail(text))
  353. return Fail(AppUILocalization.GetTextByKey("RelateValidateView-a0"));
  354. break;
  355. case AppUIInputKind.Phone:
  356. if (text.Length > 0 && !ValidateHelper.IsMobilePhone(text))
  357. return Fail(AppUILocalization.GetTextByKey("RelateValidateView-a1"));
  358. break;
  359. case AppUIInputKind.SmsCode:
  360. if (text.Length > 0 && (text.Length != 6 || !int.TryParse(text, out _)))
  361. return Fail(AppUILocalization.GetTextByKey("RelateValidateView-a3"));
  362. break;
  363. }
  364. return AppUIInputValidation.Ok;
  365. }
  366. /// <summary>校验是否通过。</summary>
  367. public bool TryValidate(out string errorMessage)
  368. {
  369. var result = Validate();
  370. errorMessage = result.IsValid ? null : result.Message;
  371. return result.IsValid;
  372. }
  373. static AppUIInputValidation Fail(string message) =>
  374. new AppUIInputValidation(false, message);
  375. string EmptyMessageForKind()
  376. {
  377. switch (kind)
  378. {
  379. case AppUIInputKind.Nickname:
  380. return AppUILocalization.GetTextByCNKey("请输入游戏昵称");
  381. case AppUIInputKind.Password:
  382. return AppUILocalization.GetTextByCNKey("请输入密码");
  383. case AppUIInputKind.Email:
  384. return AppUILocalization.GetTextByKey("RelateValidateView-a0");
  385. case AppUIInputKind.Phone:
  386. return AppUILocalization.GetTextByKey("RelateValidateView-a1");
  387. case AppUIInputKind.SmsCode:
  388. return AppUILocalization.GetTextByKey("RelateValidateView-a3");
  389. default:
  390. return AppUILocalization.GetTextByCNKey("请输入账号");
  391. }
  392. }
  393. string TooShortMessageForKind(int min)
  394. {
  395. if (kind == AppUIInputKind.Password)
  396. return AppUILocalization.GetTextByCNKey("密码长度至少6位");
  397. return AppUILocalization.GetTextByCNKey("请输入账号");
  398. }
  399. }
  400. }