【后端】【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 的外键关联数据! 🚀

相关推荐
OceanBase数据库官方博客几秒前
滔搏基于OceanBase实现 15TB到0.9TB“无痛切换”与“系统瘦身”
数据库·oceanbase·分布式数据库
Jess076 分钟前
MySQL内置函数
数据库·mysql
OceanBase数据库官方博客7 分钟前
爱奇艺基于OceanBase实现百亿级卡券业务的“单库双擎”架构升级
数据库·架构·oceanbase·分布式数据库
weixin1997010801610 分钟前
锦程物流item_get - 获取详情接口对接全攻略:从入门到精通
数据库·python
AC赳赳老秦13 分钟前
DeepSeek 辅助科研项目申报:可行性报告与经费预算框架的智能化撰写指南
数据库·人工智能·科技·mongodb·ui·rabbitmq·deepseek
2501_9277730713 分钟前
Linux系统编程——sqlite数据库
数据库
mahailiang17 分钟前
codeblocks+wxWidgets Projects中引用第三方库(sqlite3)
数据库·sqlite·wxwidgets·codeblocks
cyforkk38 分钟前
09、Java 基础硬核复习:异常处理(容错机制)的核心逻辑与面试考点
java·数据库·面试
CC.GG1 小时前
【Linux】进程控制(二)----进程程序替换、编写自主Shell命令行解释器(简易版)
linux·服务器·数据库
2301_765703141 小时前
开发一个简单的Python计算器
jvm·数据库·python