schema.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310
  1. from urllib.parse import urlparse
  2. from fastapi import Query
  3. from pydantic import (
  4. BaseModel,
  5. ConfigDict,
  6. EmailStr,
  7. Field,
  8. field_validator,
  9. model_validator,
  10. )
  11. from app.api.v1.module_system.auth.schema import SmsCodeSchema
  12. from app.api.v1.module_system.menu.schema import MenuOutSchema
  13. from app.api.v1.module_system.role.schema import RoleOutSchema
  14. from app.common.enums import QueueEnum
  15. from app.core.base_schema import BaseSchema, CommonSchema, TenantBySchema, UserBySchema
  16. from app.core.validator import DateTimeStr, email_validator, mobile_validator
  17. class CurrentUserUpdateSchema(BaseModel):
  18. """基础用户信息"""
  19. name: str | None = Field(default=None, description="名称")
  20. mobile: str | None = Field(default=None, description="手机号")
  21. email: EmailStr | None = Field(default=None, description="邮箱")
  22. gender: str | None = Field(default=None, description="性别")
  23. avatar: str | None = Field(default=None, description="头像")
  24. @field_validator("mobile")
  25. @classmethod
  26. def validate_mobile(cls, value: str | None):
  27. """
  28. 校验手机号格式(委托到 `mobile_validator`)。
  29. 参数:
  30. - value (str | None): 手机号。
  31. 返回:
  32. - str | None: 校验后的手机号。
  33. 异常:
  34. - CustomException: 手机号格式非法时抛出。
  35. """
  36. return mobile_validator(value)
  37. @field_validator("email")
  38. @classmethod
  39. def validate_email(cls, value: str | None):
  40. """
  41. 校验邮箱格式(为空则跳过;否则委托到 `email_validator`)。
  42. 参数:
  43. - value (str | None): 邮箱。
  44. 返回:
  45. - str | None: 校验后的邮箱。
  46. 异常:
  47. - CustomException: 邮箱格式非法时抛出。
  48. """
  49. if not value:
  50. return value
  51. return email_validator(value)
  52. @field_validator("avatar")
  53. @classmethod
  54. def validate_avatar(cls, value: str | None):
  55. """
  56. 校验头像地址为合法的 HTTP/HTTPS URL。
  57. 参数:
  58. - value (str | None): 头像 URL。
  59. 返回:
  60. - str | None: 校验后的头像 URL。
  61. 异常:
  62. - ValueError: 头像 URL 非法时抛出。
  63. """
  64. if not value:
  65. return value
  66. parsed = urlparse(value)
  67. if parsed.scheme in ("http", "https") and parsed.netloc:
  68. return value
  69. raise ValueError("头像地址需为有效的HTTP/HTTPS URL")
  70. @model_validator(mode="after")
  71. def check_model(self):
  72. """
  73. 校验基础用户信息的长度约束。
  74. 返回:
  75. - CurrentUserUpdateSchema: 校验后的同一实例。
  76. 异常:
  77. - ValueError: 字段长度超限时抛出。
  78. """
  79. if self.name and len(self.name) > 32:
  80. raise ValueError("名称长度不能超过32个字符")
  81. return self
  82. class UserRegisterSchema(SmsCodeSchema):
  83. """注册"""
  84. name: str | None = Field(default=None, description="名称")
  85. mobile: str = Field(default=None, description="手机号")
  86. username: str = Field(..., description="账号")
  87. password: str = Field(..., description="密码哈希值")
  88. role_ids: list[int] | None = Field(default=[1], description="角色ID")
  89. created_id: int | None = Field(default=1, description="创建人ID")
  90. description: str | None = Field(default=None, max_length=255, description="备注")
  91. @field_validator("mobile")
  92. @classmethod
  93. def validate_mobile(cls, value: str | None):
  94. """
  95. 校验手机号格式(委托到 `mobile_validator`)。
  96. 参数:
  97. - value (str | None): 手机号。
  98. 返回:
  99. - str | None: 校验后的手机号。
  100. 异常:
  101. - CustomException: 手机号格式非法时抛出。
  102. """
  103. return mobile_validator(value)
  104. @field_validator("username")
  105. @classmethod
  106. def validate_username(cls, value: str):
  107. """
  108. 校验并规范化账号:字母开头,长度 3-32,仅含字母/数字/_ . -。
  109. 参数:
  110. - value (str): 账号。
  111. 返回:
  112. - str: 规范化后的账号。
  113. 异常:
  114. - ValueError: 账号为空或不满足格式约束时抛出。
  115. """
  116. v = value.strip()
  117. if not v:
  118. raise ValueError("账号不能为空")
  119. # 字母开头,允许字母数字_.-
  120. import re
  121. if not re.match(r"^[A-Za-z][A-Za-z0-9_.-]{2,31}$", v):
  122. raise ValueError("账号需字母开头,3-32位,仅含字母/数字/_ . -")
  123. return v
  124. @model_validator(mode="after")
  125. def check_model(self):
  126. """
  127. 校验注册信息的长度约束。
  128. 返回:
  129. - UserRegisterSchema: 校验后的同一实例。
  130. 异常:
  131. - ValueError: 任一字段长度超限时抛出。
  132. """
  133. if self.name and len(self.name) > 32:
  134. raise ValueError("名称长度不能超过32个字符")
  135. if self.username and len(self.username) > 32:
  136. raise ValueError("账号长度不能超过32个字符")
  137. if self.description and len(self.description) > 255:
  138. raise ValueError("备注长度不能超过255个字符")
  139. if self.password and len(self.password) > 128:
  140. raise ValueError("密码长度不能超过128个字符")
  141. return self
  142. class UserForgetPasswordSchema(BaseModel):
  143. """忘记密码"""
  144. username: str = Field(..., max_length=32, description="用户名")
  145. new_password: str = Field(..., max_length=128, description="新密码")
  146. mobile: str | None = Field(default=None, description="手机号")
  147. @field_validator("mobile")
  148. @classmethod
  149. def validate_mobile(cls, value: str | None):
  150. """
  151. 校验手机号格式(委托到 `mobile_validator`)。
  152. 参数:
  153. - value (str | None): 手机号。
  154. 返回:
  155. - str | None: 校验后的手机号。
  156. 异常:
  157. - CustomException: 手机号格式非法时抛出。
  158. """
  159. return mobile_validator(value)
  160. class UserChangePasswordSchema(BaseModel):
  161. """修改密码"""
  162. old_password: str = Field(..., max_length=128, description="旧密码")
  163. new_password: str = Field(..., max_length=128, description="新密码")
  164. class ResetPasswordSchema(BaseModel):
  165. """重置密码"""
  166. id: int = Field(..., description="主键ID")
  167. password: str = Field(..., min_length=6, max_length=128, description="新密码")
  168. class UserCreateSchema(CurrentUserUpdateSchema):
  169. """新增"""
  170. model_config = ConfigDict(from_attributes=True)
  171. username: str | None = Field(default=None, max_length=32, description="用户名")
  172. password: str | None = Field(default=None, max_length=128, description="密码哈希值")
  173. status: str = Field(default="0", description="是否可用")
  174. description: str | None = Field(default=None, max_length=255, description="备注")
  175. is_superuser: bool | None = Field(default=False, description="是否超管")
  176. dept_id: int | None = Field(default=None, description="部门ID")
  177. tenant_id: int | None = Field(default=None, description="租户ID,仅平台管理员创建时可指定")
  178. role_ids: list[int] | None = Field(default=[], description="角色ID")
  179. position_ids: list[int] | None = Field(default=[], description="岗位ID")
  180. class UserUpdateSchema(UserCreateSchema):
  181. """更新"""
  182. model_config = ConfigDict(from_attributes=True)
  183. last_login: DateTimeStr | None = Field(default=None, description="最后登录时间")
  184. class UserOutSchema(UserUpdateSchema, BaseSchema, UserBySchema, TenantBySchema):
  185. """响应"""
  186. model_config = ConfigDict(arbitrary_types_allowed=True, from_attributes=True)
  187. tenant_id: int | None = Field(
  188. default=None,
  189. exclude=True,
  190. description="创建入参使用;列表/详情出参见 tenant",
  191. )
  192. gitee_login: str | None = Field(default=None, max_length=32, description="Gitee登录")
  193. github_login: str | None = Field(default=None, max_length=32, description="Github登录")
  194. wx_login: str | None = Field(default=None, max_length=32, description="微信登录")
  195. qq_login: str | None = Field(default=None, max_length=32, description="QQ登录")
  196. dept_name: str | None = Field(default=None, description="部门名称")
  197. dept: CommonSchema | None = Field(default=None, description="部门")
  198. positions: list[CommonSchema] | None = Field(default=[], description="岗位")
  199. roles: list[RoleOutSchema] | None = Field(default=[], description="角色")
  200. menus: list[MenuOutSchema] | None = Field(default=[], description="菜单")
  201. class UserQueryParam:
  202. """用户管理查询参数"""
  203. def __init__(
  204. self,
  205. username: str | None = Query(None, description="用户名"),
  206. name: str | None = Query(None, description="名称"),
  207. mobile: str | None = Query(None, description="手机号", pattern=r"^1[3-9]\d{9}$"),
  208. email: str | None = Query(
  209. None,
  210. description="邮箱",
  211. pattern=r"^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$",
  212. ),
  213. dept_id: int | None = Query(None, description="部门ID"),
  214. tenant_id: int | None = Query(None, description="租户ID(仅平台管理员可筛选)"),
  215. status: str | None = Query(None, description="是否可用"),
  216. created_time: list[DateTimeStr] | None = Query(
  217. None,
  218. description="创建时间范围",
  219. examples=["2025-01-01 00:00:00", "2025-12-31 23:59:59"],
  220. ),
  221. updated_time: list[DateTimeStr] | None = Query(
  222. None,
  223. description="更新时间范围",
  224. examples=["2025-01-01 00:00:00", "2025-12-31 23:59:59"],
  225. ),
  226. created_id: int | None = Query(None, description="创建人"),
  227. updated_id: int | None = Query(None, description="更新人"),
  228. ) -> None:
  229. # 模糊查询字段
  230. self.username = (QueueEnum.like.value, username)
  231. self.name = (QueueEnum.like.value, name)
  232. self.mobile = (QueueEnum.like.value, mobile)
  233. self.email = (QueueEnum.like.value, email)
  234. # 精确查询字段
  235. self.dept_id = (QueueEnum.eq.value, dept_id)
  236. self.tenant_id = (QueueEnum.eq.value, tenant_id)
  237. self.created_id = (QueueEnum.eq.value, created_id)
  238. self.updated_id = (QueueEnum.eq.value, updated_id)
  239. self.status = (QueueEnum.eq.value, status)
  240. # 时间范围查询
  241. if created_time and len(created_time) == 2:
  242. self.created_time = (QueueEnum.between.value, (created_time[0], created_time[1]))
  243. if updated_time and len(updated_time) == 2:
  244. self.updated_time = (QueueEnum.between.value, (updated_time[0], updated_time[1]))