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

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

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


举例说明

python 复制代码
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)
反向查询
python 复制代码
author = Author.objects.get(id=1)
author.book_set.all()  # 通过默认的 `book_set` 访问书籍列表

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


python 复制代码
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")
反向查询
python 复制代码
author = Author.objects.get(id=1)
author.books.all()  # 现在可以用 `books` 访问,而不是 `book_set`

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


避免多个外键冲突

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

python 复制代码
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")
反向查询
python 复制代码
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()
  1. 提高代码可读性 ,避免 _set
  2. 多个外键指向同一模型,防止冲突
  3. 增强 API 设计,让反向查询更直观

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

相关推荐
SelectDB3 小时前
阶跃星辰基于 SelectDB 构建 PB 级 Agent 可观测平台
大数据·数据库·aigc
这个DBA有点耶4 小时前
GROUP BY优化全解:如何写出既不丢数据又飞快的分组查询
数据库·mysql·架构
掉头发的王富贵7 小时前
【StarRocks】极限十分钟入门StarRocks
数据库·sql·mysql
Nturmoils7 小时前
WHERE 条件别凭习惯写,常用查询先跑一遍
数据库
Databend1 天前
在 AWS 中国峰会逛了一天,我在 Databend 展台看到了 Agent 数据基础设施的新思路
数据库·人工智能·agent
ClouGence2 天前
Oracle 数据同步为什么会出现数据不一致?长事务是常被忽略的原因
数据库·后端·oracle
飞将2 天前
从零实现数据库(2)——HashIndex + IndexManager
数据库
兵慌码乱3 天前
面向桌面端的资产管理系统分层架构设计与核心模块实现
python·系统架构·sqlite·pyqt5·数据库设计·桌面应用开发·mvc架构
呱呱复呱呱3 天前
Django CBV 源码解读:一个请求是怎么找到你的 get() 方法的
python·django
Nturmoils3 天前
订单列表慢查询,先看 WHERE、ORDER BY 和 LIMIT
数据库