Django入门指南-第5章:模型设计

    这些模型基本上代表了应用程序的数据库设计。我们在本节中要做的是创建 Django 所表示的类,这些类就是在上一节中建模的类:Board,Topic和Post。User 模型被命名为内置应用叫 auth,它以命名空间 django.contrib.auth 的形式出现在 配置中。

    我们要做的工作都在 boards/models.py 文件中。以下是我们在Django应用程序中如何表示类图的代码:

    所有模型都是django.db.models.Model类的子类。每个类将被转换为数据库表。每个字段由 django.db.models.Field子类(内置在Django core)的实例表示,它们并将被转换为数据库的列。

    字段 CharField,DateTimeField等等,都是 django.db.models.Field 的子类,包含在Django的核心里面-随时可以使用。

    在这里,我们仅使用 CharField,TextField,DateTimeField,和ForeignKey 字段来定义我们的模型。不过在Django提供了更广泛的选择来代表不同类型的数据,例如 IntegerField,BooleanField, DecimalField和其它一些字段。我们会在需要的时候提及它们。

    有些字段需要参数,例如CharField。我们应该始终设定一个 max_length。这些信息将用于创建数据库列。Django需要知道数据库列需要多大。该 max_length参数也将被Django Forms API用来验证用户输入。

    Board模型定义中,更具体地说,在name字段中,我们设置了参数 unique=True,顾名思义,它将强制数据库级别字段的唯一性。

    Post模型中,created_at字段有一个可选参数,auto_now_add设置为True。这将告诉Django创建Post对象时为当前日期和时间。

    模型之间的关系使用ForeignKey字段。它将在模型之间创建一个连接,并在数据库级别创建适当的关系(译注:外键关联)。该ForeignKey字段需要一个位置参数related_name,用于引用它关联的模型。(译注:例如 created_by 是外键字段,关联的User模型,表明这个帖子是谁创建的,related_name=posts 表示在 User 那边可以使用 user.posts 来查看这个用户创建了哪些帖子)

    例如,在Topic模型中,board字段是Board模型的ForeignKey。它告诉Django,一个Topic实例只涉及一个Board实例。related_name参数将用于创建反向关系,Board实例通过属性topics访问属于这个版块下的Topic列表。

    Django自动创建这种反向关系,related_name是可选项。但是,如果我们不为它设置一个名称,Django会自动生成它:(class_name)_set。例如,在Board模型中,所有Topic列表将用topic_set属性表示。而这里我们将其重新命名为了topics,以使其感觉更自然。

    Post模型中,该updated_by字段设置related_name='+'。这指示Django我们不需要这种反向关系,所以它会被忽略(译注:也就是说我们不需要关系用户修改过哪些帖子)。

    下面您可以看到类图和Django模型的源代码之间的比较,绿线表示我们如何处理反向关系。

    这时,你可能会问自己:“主键/ ID呢?”?如果我们没有为模型指定主键,Django会自动为我们生成它。所以现在一切正常。在下一节中,您将看到它是如何工作的。

    下一步是告诉Django创建数据库,以便我们可以开始使用它。

    打开终端 ,激活虚拟环境,转到 manage.py文件所在的文件夹,然后运行以下命令:

    1. python manage.py makemigrations
    1. Migrations for 'boards':
    2. boards/migrations/0001_initial.py
    3. - Create model Board
    4. - Create model Post
    5. - Create model Topic
    6. - Add field topic to post

    此时,Django 在 boards/migrations 目录创建了一个名为 0001_initial.py的文件。它代表了应用程序模型的当前状态。在下一步,Django将使用该文件创建表和列。

    迁移文件将被翻译成SQL语句。如果您熟悉SQL,则可以运行以下命令来检验将是要被数据库执行的SQL指令

    1. python manage.py sqlmigrate boards 0001

    如果你不熟悉SQL,也不要担心。在本系列教程中,我们不会直接使用SQL。所有的工作都将使用Django ORM来完成,它是一个与数据库进行通信的抽象层。

    下一步是将我们生成的迁移文件应用到数据库:

    1. python manage.py migrate

    输出内容应该是这样的:

    1. Operations to perform:
    2. Apply all migrations: admin, auth, boards, contenttypes, sessions
    3. Running migrations:
    4. Applying contenttypes.0001_initial... OK
    5. Applying auth.0001_initial... OK
    6. Applying admin.0001_initial... OK
    7. Applying admin.0002_logentry_remove_auto_add... OK
    8. Applying contenttypes.0002_remove_content_type_name... OK
    9. Applying auth.0002_alter_permission_name_max_length... OK
    10. Applying auth.0003_alter_user_email_max_length... OK
    11. Applying auth.0004_alter_user_username_opts... OK
    12. Applying auth.0006_require_contenttypes_0002... OK
    13. Applying auth.0007_alter_validators_add_error_messages... OK
    14. Applying auth.0008_alter_user_username_max_length... OK
    15. Applying boards.0001_initial... OK
    16. Applying sessions.0001_initial... OK

    因为这是我们第一次迁移数据库,所以migrate命令把Django contrib app 中现有的迁移文件也执行了,这些内置app列在了INSTALLED_APPS。这是预料之中的。

    Applying boards.0001_initial... OK是我们在上一步中生成的迁移脚本。

    好了!我们的数据库已经可以使用了。

    featured

    使用Python进行开发的一个重要优点是交互式shell。我一直在使用它。这是一种快速尝试和试验API的方法。

    您可以使用manage.py 工具加载我们的项目来启动 Python shell :

    1. python manage.py shell
    1. Python 3.6.2 (default, Jul 17 2017, 16:44:45)
    2. [GCC 4.2.1 Compatible Apple LLVM 8.1.0 (clang-802.0.42)] on darwin
    3. Type "help", "copyright", "credits" or "license" for more information.
    4. (InteractiveConsole)
    5. >>>

    这与直接输入python指令来调用交互式控制台是非常相似的,除此之外,项目将被添加到sys.path并加载Django。这意味着我们可以在项目中导入我们的模型和其他资源并使用它。

    让我们从导入Board类开始:

    1. from boards.models import Board

    要创建新的 boarrd 对象,我们可以执行以下操作:

    1. board.save()

    save方法用于创建和更新对象。这里Django创建了一个新对象,因为这时Board 实例没有id。第一次保存后,Django会自动设置ID:

    1. board.id
    2. 1

    您可以将其余的字段当做Python属性访问:

    1. board.name
    2. 'Django'
    1. 'This is a board about Django.'

    要更新一个值,我们可以这样做:

    1. board.description = 'Django discussion board.'
    2. board.save()

    每个Django模型都带有一个特殊的属性; 我们称之为模型管理器(Model Manager)。你可以通过属性objects 来访问这个管理器,它主要用于数据库操作。例如,我们可以使用它来直接创建一个新的Board对象:

    1. board = Board.objects.create(name='Python', description='General discussion about Python.')
    1. board.id
    2. 2
    1. board.name

    所以,现在我们有两个版块了。我们可以使用objects列出数据库中所有现有的版块:

    结果是一个QuerySet。稍后我们会进一步了解。基本上,它是从数据库中查询的对象列表。我们看到有两个对象,但显示的名称是 Board object。这是因为我们尚未实现 Board 的__str__ 方法。

    __str__方法是对象的字符串表示形式。我们可以使用版块的名称来表示它。

    首先,退出交互式控制台:

    1. exit()

    现在编辑boards app 中的 models.py 文件:

    1. class Board(models.Model):
    2. name = models.CharField(max_length=30, unique=True)
    3. description = models.CharField(max_length=100)
    4. def __str__(self):
    5. return self.name

    让我们重新查询,再次打开交互式控制台:

    1. python manage.py shell
    1. from boards.models import Board
    2. Board.objects.all()
    3. <QuerySet [<Board: Django>, <Board: Python>]>

    好多了,对吧?

    我们可以将这个QuerySet看作一个列表。假设我们想遍历它并打印每个版块的描述:

    1. boards_list = Board.objects.all()
    2. for board in boards_list:
    3. print(board.description)

    结果是:

    1. Django discussion board.
    2. General discussion about Python.

    同样,我们可以使用模型的 管理器(Manager) 来查询数据库并返回单个对象。为此,我们要使用 get 方法:

    1. django_board = Board.objects.get(id=1)
    2. django_board.name
    3. 'Django'

    但我们必须小心这种操作。如果我们试图查找一个不存在的对象,例如,查找id=3的版块,它会引发一个异常:

    1. board = Board.objects.get(id=3)
    2. boards.models.DoesNotExist: Board matching query does not exist.

    get方法的参数可以是模型的任何字段,但最好使用可唯一标识对象的字段来查询。否则,查询可能会返回多个对象,这也会导致异常。

    请注意,查询区分大小写,小写“django”不匹配:

    在下一小节中,我们将开始编写视图并在HTML页面中显示我们的版块。