# +====================================================================== # | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ] # +---------------------------------------------------------------------- # | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有 # +---------------------------------------------------------------------- # | 开源协议: Apache-2.0 # | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。 # +---------------------------------------------------------------------- # | 官方网站: https://www.djangoadmin.cn # +---------------------------------------------------------------------- # | 研发团队: 小蚂蚁云团队 荣誉出品 # +====================================================================== # | 版权和免责声明: # | 一、知识产权声明 # | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、 # | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权， # | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。 # | 二、使用限制与禁止条款 # | 您理解并同意，禁止将本产品用于以下任何行为： # | 1. 任何违反中华人民共和国法律法规的用途； # | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为； # | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。 # | 三、责任豁免 # | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失 # | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三 # | 方提起索赔或行政机关进行调查，您应独立承担全部责任。 # | 四、违约与法律责任 # | 如发现任何违反本声明的行为，本团队有权： # | 1. 无条件配合公安机关及其他有权机关的调查取证工作； # | 2. 依法追究相关方的民事责任，并要求赔偿全部损失； # | 3. 保留进一步采取刑事控告等法律措施的权利。 # | 五、许可范围说明 # | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包 # | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通 # | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、 # | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造 # | 成的一切经济损失及商誉损害。 # | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件 # | 许可协议》附件为准。 # +====================================================================== """ 用户模型模块 ============================================================= 该模块定义了系统用户相关的数据库模型。 用户是系统的基本操作主体，包含个人信息、登录信息、组织归属等数据。 用户通过角色获得权限，通过部门实现组织管理。 """ from django.db import models from application.models import BaseModel from utils.common import get_table_name # ============================================================= # 用户模型类 # ============================================================= class User(BaseModel): """ 用户模型类 用于存储系统用户的所有信息，包括基本资料、登录信息、组织归属等。 用户是系统权限控制的核心对象，通过角色和部门实现权限管理。 继承自 BaseModel，自动包含： - id: 主键 - is_delete: 逻辑删除标识 - create_user: 创建人 - create_time: 创建时间 - update_user: 更新人 - update_time: 更新时间 主要业务字段： - code: 用户编码 - realname: 用户真实姓名 - gender: 性别（1-男, 2-女, 3-保密） - avatar: 用户头像 - mobile: 手机号 - email: 邮箱 - dept_id: 部门ID - level_id: 职级ID - position_id: 岗位ID - username: 登录用户名 - password: 密码（加密存储） - status: 状态（1-正常, 2-禁用） - sort: 排序值 """ # ---------------------------------------------------------- # 用户编码 # ---------------------------------------------------------- # 字段说明: 用户的编码 # 字段类型: 字符串（CharField） # 约束: 最大长度100字符 # 索引: 添加了数据库索引（db_index=True）以提升查询效率 # 作用: 用于系统内部标识用户 code = models.CharField( max_length=100, db_index=True, verbose_name="用户编码", help_text="用户编码", db_comment='用户编码' # 数据库字段注释 ) # ---------------------------------------------------------- # 用户姓名 # ---------------------------------------------------------- # 字段说明: 用户的真实姓名 # 字段类型: 字符串（CharField） # 约束: 最大长度100字符 # 索引: 添加了数据库索引（db_index=True）以支持姓名搜索 # 作用: 用于前端展示用户姓名 realname = models.CharField( max_length=100, db_index=True, verbose_name="用户姓名", help_text="用户姓名", db_comment='用户姓名' # 数据库字段注释 ) # ---------------------------------------------------------- # 性别 # ---------------------------------------------------------- # 性别常量定义 GENDER_CHOICES = ( (1, "男"), (2, "女"), (3, "保密"), ) # 字段说明: 用户的性别信息 # 字段类型: 整数（IntegerField） # 约束: 使用 GENDER_CHOICES 限制可选值，默认值为1（男） # 作用: 用于用户个人信息展示和统计分析 gender = models.IntegerField( choices=GENDER_CHOICES, default=1, verbose_name="性别：1-男 2-女 3-保密", help_text="性别：1-男 2-女 3-保密", db_comment='性别：1-男 2-女 3-保密', # 数据库字段注释 db_default=1 ) # ---------------------------------------------------------- # 用户头像 # ---------------------------------------------------------- # 字段说明: 用户的头像图片 # 字段类型: 字符串（CharField） # 约束: 最大长度255字符 # 作用: 存储头像图片的URL地址，通过 get_file_url() 生成完整访问URL avatar = models.CharField( max_length=255, verbose_name="用户头像", help_text="用户头像", db_comment='用户头像' # 数据库字段注释 ) # ---------------------------------------------------------- # 手机号 # ---------------------------------------------------------- # 字段说明: 用户的手机号码 # 字段类型: 字符串（CharField） # 约束: 最大长度30字符 # 作用: 可用于登录和接收通知 mobile = models.CharField( max_length=30, verbose_name="手机号", help_text="手机号", db_comment='手机号' # 数据库字段注释 ) # ---------------------------------------------------------- # 邮箱 # ---------------------------------------------------------- # 字段说明: 用户的电子邮箱 # 字段类型: 字符串（CharField） # 约束: 最大长度50字符 # 作用: 可用于登录和接收通知 email = models.CharField( max_length=50, verbose_name="邮箱", help_text="邮箱", db_comment='邮箱' # 数据库字段注释 ) # ---------------------------------------------------------- # 部门ID # ---------------------------------------------------------- # 字段说明: 用户所属部门 # 字段类型: 整数（IntegerField） # 约束: 默认值为0 # 作用: 关联到部门表（Dept）的主键ID，标识用户所属部门 dept_id = models.IntegerField( default=0, verbose_name="部门ID", help_text="部门ID", db_comment='部门ID', # 数据库字段注释 db_default=0 ) # ---------------------------------------------------------- # 职级ID # ---------------------------------------------------------- # 字段说明: 用户的职级 # 字段类型: 整数（IntegerField） # 约束: 默认值为0 # 作用: 关联到职级表（Level）的主键ID，标识用户的职级 level_id = models.IntegerField( default=0, verbose_name="职级ID", help_text="职级ID", db_comment='职级ID', # 数据库字段注释 db_default=0 ) # ---------------------------------------------------------- # 岗位ID # ---------------------------------------------------------- # 字段说明: 用户的岗位 # 字段类型: 整数（IntegerField） # 约束: 默认值为0 # 作用: 关联到岗位表（Position）的主键ID，标识用户的岗位 position_id = models.IntegerField( default=0, verbose_name="岗位ID", help_text="岗位ID", db_comment='岗位ID', # 数据库字段注释 db_default=0 ) # ---------------------------------------------------------- # 省份编码 # ---------------------------------------------------------- # 字段说明: 用户所在省份的行政区划编码 # 字段类型: 字符串（CharField） # 约束: 最大长度30字符 # 作用: 用于存储用户地址的省/直辖市信息 province_code = models.CharField( max_length=30, verbose_name="省份编码", help_text="省份编码", db_comment='省份编码' # 数据库字段注释 ) # ---------------------------------------------------------- # 城市编码 # ---------------------------------------------------------- # 字段说明: 用户所在城市的行政区划编码 # 字段类型: 字符串（CharField） # 约束: 最大长度30字符 # 作用: 用于存储用户地址的市/区信息 city_code = models.CharField( max_length=30, verbose_name="城市编码", help_text="城市编码", db_comment='城市编码' # 数据库字段注释 ) # ---------------------------------------------------------- # 县区编码 # ---------------------------------------------------------- # 字段说明: 用户所在县区的行政区划编码 # 字段类型: 字符串（CharField） # 约束: 最大长度30字符 # 作用: 用于存储用户地址的区/县信息 district_code = models.CharField( max_length=30, verbose_name="县区编码", help_text="县区编码", db_comment='县区编码' # 数据库字段注释 ) # ---------------------------------------------------------- # 街道编码 # ---------------------------------------------------------- # 字段说明: 用户所在街道的行政区划编码 # 字段类型: 字符串（CharField） # 约束: 最大长度30字符 # 作用: 用于存储用户地址的街道/镇信息 street_code = models.CharField( max_length=30, verbose_name="街道编码", help_text="街道编码", db_comment='街道编码' # 数据库字段注释 ) # ---------------------------------------------------------- # 省市区信息 # ---------------------------------------------------------- # 字段说明: 用户所在省市区组合文本 # 字段类型: 字符串（CharField） # 约束: 最大长度255字符 # 作用: 存储用户所在的省市区组合文本，如"北京市-朝阳区" city_info = models.CharField( max_length=255, verbose_name="省市区信息", help_text="省市区信息", db_comment='省市区信息' # 数据库字段注释 ) # ---------------------------------------------------------- # 详细地址 # ---------------------------------------------------------- # 字段说明: 用户的详细街道地址 # 字段类型: 字符串（CharField） # 约束: 最大长度255字符 # 作用: 存储用户的详细地址信息 address = models.CharField( max_length=255, verbose_name="详细地址", help_text="详细地址", db_comment='详细地址' # 数据库字段注释 ) # ---------------------------------------------------------- # 用户名 # ---------------------------------------------------------- # 字段说明: 用户的登录用户名 # 字段类型: 字符串（CharField） # 约束: 最大长度30字符 # 索引: 添加了数据库索引（db_index=True）以支持登录查询 # 作用: 用户登录的唯一标识 username = models.CharField( max_length=30, db_index=True, verbose_name="用户名", help_text="用户名", db_comment='用户名' # 数据库字段注释 ) # ---------------------------------------------------------- # 密码 # ---------------------------------------------------------- # 字段说明: 用户密码的加密值 # 字段类型: 字符串（CharField） # 约束: 允许为空（null=True），最大长度255字符 # 作用: 存储用户密码的加密值，通常使用 MD5 或 bcrypt 加密 password = models.CharField( null=True, max_length=255, verbose_name="密码", help_text="密码", db_comment='密码' # 数据库字段注释 ) # ---------------------------------------------------------- # 加密盐 # ---------------------------------------------------------- # 字段说明: 密码加密时使用的随机盐值 # 字段类型: 字符串（CharField） # 约束: 允许为空（null=True），最大长度30字符 # 作用: 增加密码安全性，防止彩虹表攻击 salt = models.CharField( null=True, max_length=30, verbose_name="加密盐", help_text="加密盐", db_comment='加密盐' # 数据库字段注释 ) # ---------------------------------------------------------- # 个人简介 # ---------------------------------------------------------- # 字段说明: 用户的个人介绍或签名 # 字段类型: 字符串（CharField） # 约束: 允许为空（null=True），最大长度255字符 # 作用: 用于用户个人展示 intro = models.CharField( null=True, max_length=255, verbose_name="个人简介", help_text="个人简介", db_comment='个人简介' # 数据库字段注释 ) # ---------------------------------------------------------- # 用户状态 # ---------------------------------------------------------- # 状态常量定义 STATUS_CHOICES = ( (1, "正常"), # 正常状态：用户可登录 (2, "禁用"), # 禁用状态：用户无法登录 ) # 字段说明: 用户账号的可用状态 # 字段类型: 整数（IntegerField） # 约束: 使用 STATUS_CHOICES 限制可选值，默认值为1（正常） # 作用: 控制用户账号是否可登录系统 status = models.IntegerField( choices=STATUS_CHOICES, default=1, verbose_name="状态：1-正常 2-禁用", help_text="状态：1-正常 2-禁用", db_comment='状态：1-正常 2-禁用', # 数据库字段注释 db_default=1 ) # ---------------------------------------------------------- # 排序 # ---------------------------------------------------------- # 字段说明: 用户的显示顺序 # 字段类型: 整数（IntegerField） # 约束: 默认值为0 # 排序规则: 数字越小越靠前 # 作用: 控制用户列表中的显示顺序 sort = models.IntegerField( default=0, verbose_name="排序", help_text="排序", db_comment='排序', # 数据库字段注释 db_default=0 ) # ---------------------------------------------------------- # 备注 # ---------------------------------------------------------- # 字段说明: 用户的备注信息 # 字段类型: 字符串（CharField） # 约束: 允许为空（null=True），最大长度255字符 # 作用: 存储用户的备注说明、标签等信息 note = models.CharField( null=True, max_length=255, verbose_name="个人备注", help_text="个人备注", db_comment='个人备注' # 数据库字段注释 ) # ============================================================= # 模型元数据配置 # ============================================================= class Meta: """ 模型元数据配置类 定义模型在数据库中的表名、显示名称等。 """ # 数据表名 # 使用配置文件中的表前缀 + "user"，避免与其他应用表名冲突 db_table = get_table_name('user') # 数据表注释 db_table_comment = "用户表" # 模型在admin后台显示的友好名称（单数） verbose_name = "用户表" # 模型在admin后台显示的友好名称（复数） verbose_name_plural = verbose_name # ============================================================= # 实例方法 # ============================================================= def __str__(self): """ 模型的字符串表示方法 当需要将模型实例转换为字符串时调用，如admin后台显示、日志输出等。 Returns: str: 包含用户ID的字符串 """ return f"用户{self.id}"