欢迎来到尧图网

客户服务 关于我们

您的位置:首页 > 汽车 > 维修 > 【后端】【django】【related_name】`related_name` 的作用

【后端】【django】【related_name】`related_name` 的作用

2025/3/16 6:01:00 来源:https://blog.csdn.net/qq_59344127/article/details/146286229  浏览:    关键词:【后端】【django】【related_name】`related_name` 的作用

related_name 的作用

related_name 用于 Django 的 ForeignKeyOneToOneField,用于 反向访问 关联模型的数据。

默认情况下,Django 会自动生成一个反向关系的名字,但如果多个外键指向同一个模型,就可能发生命名冲突。related_name 允许我们自定义反向查询的名称,提升代码的可读性。


举例说明

默认情况(不使用 related_name

class Author(models.Model):name = models.CharField(max_length=100)class Book(models.Model):title = models.CharField(max_length=200)author = models.ForeignKey(Author, on_delete=models.CASCADE)
反向查询
author = Author.objects.get(id=1)
author.book_set.all()  # 通过默认的 `book_set` 访问书籍列表

Django 默认会用 模型名小写 + _set 作为反向查询名称(book_set)。


使用 related_name

class Author(models.Model):name = models.CharField(max_length=100)class Book(models.Model):title = models.CharField(max_length=200)author = models.ForeignKey(Author, on_delete=models.CASCADE, related_name="books")
反向查询
author = Author.objects.get(id=1)
author.books.all()  # 现在可以用 `books` 访问,而不是 `book_set`

这里,related_name="books"Author 可以直接通过 .books 访问其所有的 Book 记录。


避免多个外键冲突

当一个模型有多个外键指向同一个模型时,必须使用 related_name 来区分:

class Employee(models.Model):name = models.CharField(max_length=100)class Task(models.Model):title = models.CharField(max_length=200)assigned_to = models.ForeignKey(Employee, on_delete=models.CASCADE, related_name="assigned_tasks")created_by = models.ForeignKey(Employee, on_delete=models.CASCADE, related_name="created_tasks")
反向查询
employee = Employee.objects.get(id=1)# 该员工创建的任务
employee.created_tasks.all()# 该员工被分配的任务
employee.assigned_tasks.all()

如果不使用 related_name,Django 会报错,因为 task_set 这个默认的反向名称会有两个。


总结

情况默认反向查询自定义 related_name 反向查询
单个外键book_set.all()books.all()
多个外键(指向同一模型)冲突,必须指定assigned_tasks.all() / created_tasks.all()
提高可读性author.book_set.all()author.books.all()

何时使用 related_name

  1. 提高代码可读性,避免 _set
  2. 多个外键指向同一模型,防止冲突
  3. 增强 API 设计,让反向查询更直观

这样,我们就可以更清晰、更直观地操作 Django 的外键关联数据! 🚀

版权声明:

本网仅为发布的内容提供存储空间,不对发表、转载的内容提供任何形式的保证。凡本网注明“来源:XXX网络”的作品,均转载自其它媒体,著作权归作者所有,商业转载请联系作者获得授权,非商业转载请注明出处。

我们尊重并感谢每一位作者,均已注明文章来源和作者。如因作品内容、版权或其它问题,请及时与我们联系,联系邮箱:809451989@qq.com,投稿邮箱:809451989@qq.com

热搜词