schema.py 11 KB

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