【后端】【django】Django DRF `@action` 详解:自定义 ViewSet 方法

news2025/3/15 5:56:33

Django DRF @action 详解:自定义 ViewSet 方法

在 Django REST Framework(DRF)中,@action 装饰器用于为 ViewSet 添加自定义的 API 端点。相比于 updatecreate 等默认方法,@action 允许我们定义 更加清晰、语义化 的 API 访问路径,使接口更加易读且符合 RESTful 设计原则。


1. @action 的作用

@action 主要用于 自定义 API 端点,避免滥用 updatecreate 等标准方法,使 API 语义更加清晰。例如:

  • POST /users/{id}/assign_roles/(自定义用户角色分配接口,语义清晰)
  • POST /users/{id}/change_password/(单独的修改密码接口)
  • GET /users/{id}/permissions/(查询用户权限)

2. @action 的基本用法

📌 示例:为用户分配角色

from rest_framework.decorators import action
from rest_framework.response import Response
from rest_framework import viewsets, status
from django.contrib.auth.models import User

class UserViewSet(viewsets.ModelViewSet):
    queryset = User.objects.all()
    serializer_class = UserSerializer

    @action(detail=True, methods=['post'])
    def assign_roles(self, request, pk=None):
        """
        自定义 API 端点:为用户分配角色
        - `detail=True` 表示该方法针对单个用户(即 /users/{id}/assign_roles/)
        - 仅允许 `POST` 方法
        """
        user = self.get_object()
        roles = request.data.get('roles', [])

        # 处理角色分配逻辑(假设 UserRole 是用户角色关联表)
        UserRole.objects.filter(user=user).delete()
        for role_id in roles:
            UserRole.objects.create(user=user, role_id=role_id)

        return Response({"message": "Roles assigned successfully"}, status=status.HTTP_200_OK)

📌 访问路径

方法访问路径说明
POST/users/{id}/assign_roles/为用户分配角色

3. @action 的参数

@action 可以接收多个参数,主要有:

(1)detail=True/False

  • detail=True:作用于单个对象,路径格式为 /users/{id}/action_name/
  • detail=False:作用于集合,路径格式为 /users/action_name/
@action(detail=True, methods=['post'])
def assign_roles(self, request, pk=None): 
    """ /users/{id}/assign_roles/ """
@action(detail=False, methods=['get'])
def active_users(self, request):  
    """ /users/active_users/ """
    active_users = User.objects.filter(is_active=True)
    serializer = self.get_serializer(active_users, many=True)
    return Response(serializer.data)

(2)methods=['get', 'post', 'put', 'patch', 'delete']

@action 默认使用 GET,但可以指定其他方法:

@action(detail=True, methods=['patch'])
def change_password(self, request, pk=None):  
    """ /users/{id}/change_password/ """
    user = self.get_object()
    new_password = request.data.get('password')
    user.set_password(new_password)
    user.save()
    return Response({"message": "Password updated"}, status=status.HTTP_200_OK)

(3)permission_classes=[...], authentication_classes=[...]

@action 允许自定义权限和认证策略:

from rest_framework.permissions import IsAdminUser

@action(detail=False, methods=['get'], permission_classes=[IsAdminUser])
def admin_users(self, request):  
    """ /users/admin_users/ 仅管理员可访问 """
    admins = User.objects.filter(is_staff=True)
    serializer = self.get_serializer(admins, many=True)
    return Response(serializer.data)

4. @actionupdate 的区别

方法作用访问路径适用场景
update更新单个用户PUT /users/{id}/用户资料更新
@action自定义操作POST /users/{id}/assign_roles/角色分配、修改密码等

📌 最佳实践

  • 简单的用户信息更新 → 用 update
  • 特定业务操作(如分配角色、修改密码) → 用 @action

5. @action 的最佳实践

(1)单一职责:一个 API 只做一件事

错误示例(混合多个逻辑):

def update(self, request, pk=None):
    user = self.get_object()
    user.username = request.data.get('username', user.username)
    user.set_password(request.data.get('password'))
    user.save()

正确示例(拆分成两个 API):

@action(detail=True, methods=['patch'])
def change_username(self, request, pk=None):
    user = self.get_object()
    user.username = request.data.get('username', user.username)
    user.save()
    return Response({"message": "Username updated"}, status=status.HTTP_200_OK)

@action(detail=True, methods=['patch'])
def change_password(self, request, pk=None):
    user = self.get_object()
    user.set_password(request.data.get('password'))
    user.save()
    return Response({"message": "Password updated"}, status=status.HTTP_200_OK)

(2)语义化 URL

  • 用户更新资料PUT /users/{id}/
  • 分配角色POST /users/{id}/assign_roles/
  • 查询活跃用户GET /users/active_users/
  • 修改密码POST /users/{id}/change_password/

避免滥用 update 处理多个逻辑!


(3)权限控制

确保敏感操作(如修改密码)有适当的权限:

@action(detail=True, methods=['post'], permission_classes=[IsAuthenticated])
def change_password(self, request, pk=None):
    """ 只有登录用户才能修改密码 """

6. 总结

  • @action 适用于自定义 API 端点
  • 避免滥用 update,拆分独立逻辑
  • 更符合 RESTful 设计,使 API 语义清晰
  • 可搭配权限、认证等更灵活

👉 结论:@action 是 DRF 中提升代码可读性和 API 设计的重要工具,建议在特定业务场景下使用! 🚀

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2315271.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

数据结构——双向链表dlist

前言:大家好😍,本文主要介绍了数据结构——双向链表dlist 一 双向链表定义 1. 双向链表的节点结构 二 双向链表操作 2.1 定义 2.2 初始化 2.3 插入 2.3.1 头插 2.3.2 尾插 2.3.3 按位置插 2.4 删除 2.4.1 头删 2.4.2 尾删 2.4.3 按…

IDEA 一键完成:打包 + 推送 + 部署docker镜像

1、本方案要解决场景? 想直接通过本地 IDEA 将最新的代码部署到远程服务器上。 2、本方案适用于什么样的项目? 项目是一个 Spring Boot 的 Java 项目。项目用 maven 进行管理。项目的运行基于 docker 容器(即项目将被打成 docker image&am…

图像分类数据集

《动手学深度学习》-3.5-学习笔记 # 通过ToTensor实例将图像数据从PIL类型变换成32位浮点数格式, # 并除以255使得所有像素的数值均在0~1之间 trans transforms.ToTensor()#用于将图像数据从 PIL 图像格式(Python Imaging Library&#xff…

设计模式之美

UML建模 统一建模语言(UML)是用来设计软件的可视化建模语言。它的语言特点是简单 统一 图形化 能表达软件设计中的动态与静态信息。 UML的分类 动态结构图: 类图 对象图 组件图 部署图 动态行为图: 状态图 活动图 时序图 协作…

2025-03-15 学习记录--C/C++-PTA 练习3-4 统计字符

合抱之木,生于毫末;九层之台,起于累土;千里之行,始于足下。💪🏻 一、题目描述 ⭐️ 练习3-4 统计字符 本题要求编写程序,输入10个字符,统计其中英文字母、空格或回车、…

802.11标准

系列文章目录 文章目录 系列文章目录一、相关知识二、使用步骤1.802.11修正比较2.802.11ac 三、杂记 一、相关知识 跳频扩频:射频信号可分为窄带信号和扩频信号。如果射频信号的带宽大于承载数据所需的带宽,该信号就属于扩频信号。跳频扩频(FHSS)是一种…

母婴商城系统Springboot设计与实现

项目概述 《母婴商城系统Springboot》是一款基于Springboot框架开发的母婴类电商平台,旨在为母婴产品提供高效、便捷的在线购物体验。该系统功能全面,涵盖用户管理、商品分类、商品信息、商品资讯等核心模块,适合母婴电商企业或个人开发者快…

C#通过API接口返回流式响应内容---分块编码方式

1、背景 上一篇文章《C#通过API接口返回流式响应内容—SSE方式》阐述了通过SSE(Server Send Event)方式,由服务器端推送数据到浏览器。本篇是通过分块编码的方式实现 2、效果 3、具体代码 3.1 API端实现 [HttpGet] public async Task Chu…

游戏引擎学习第158天

回顾和今天的计划 我们在这里会实时编码一个完整的游戏,没有使用引擎或库,一切都由我们自己做所有的编程工作,游戏中的每一部分,无论需要做什么,我们都亲自实现,并展示如何完成这些任务。今天,…

[新能源]新能源汽车快充与慢充说明

接口示意图 慢充接口为交流充电口(七孔),快充接口为直流充电口(九孔)。 引脚说明 上图给的是充电口的引脚图,充电枪的为镜像的。 慢充接口引脚说明 快充接口引脚说明 充电流程 慢充示意图 慢充&…

在IDEA中连接达梦数据库:详细配置指南

达梦数据库(DM Database)作为国产关系型数据库的代表,广泛应用于企业级系统开发。本文将详细介绍如何在IntelliJ IDEA中配置并连接达梦数据库,助力开发者高效完成数据库开发工作。 准备工作 1. 下载达梦JDBC驱动 访问达梦官方资…

基于yolov8+streamlit实现目标检测系统带漂亮登录界面

【项目介绍】 基于YOLOv8和Streamlit实现的目标检测系统,结合了YOLOv8先进的目标检测能力与Streamlit快速构建交互式Web应用的优势,为用户提供了一个功能强大且操作简便的目标检测平台。该系统不仅具备高精度的目标检测功能,还拥有一个漂亮且…

软件性能测试与功能测试联系和区别

随着软件开发技术的迅猛发展,软件性能测试和功能测试成为了确保软件质量的两个重要环节。那么只有一字之差的性能测试和功能测试分别是什么?又有哪些联系和区别呢? 一、软件性能测试是什么?   软件性能测试是为了评估软件系统在特定条件下的表现,包…

Axure设计之堆叠柱状图教程(中继器)

堆叠柱状图是一种常用的数据可视化工具,它通过在同一柱状图内堆叠不同类别的数据,以展示每个类别在总体中的贡献或占比。堆叠柱状图不仅可以帮助我们观察数据的总量,还能清晰地揭示各部分之间的关系和变化趋势。以下是一个使用Axure制作动态效…

本地部署Hive集群

规划 服务机器Hive本体部署在Node1元数据服务所需的关系型数据库(MYSQL)部署在Node1 安装MYSQL数据库 # 更新密钥 rpm --import https://repo.mysql.com/RPM-GPG-KEY-mysql-2022# 安装Mysql yum库 rpm -Uvh http://repo.mysql.com//mysql57-community-release-el7-7.noarch.…

零成本本地化搭建开源AI神器LocalAI支持CPU推理运行部署方案

文章目录 前言1. Docker部署2. 简单使用演示3. 安装cpolar内网穿透4. 配置公网地址5. 配置固定公网地址 前言 嘿,小伙伴们!今天给大家带来一个超酷的黑科技——LocalAI。没错,你没听错,就是那个能在你的个人电脑上运行大型语言模…

git使用命令总结

文章目录 Git 复制创建提交步骤Git 全局设置:创建 git 仓库:已有仓库? 遇到问题解决办法:问题一先git pull一下,具体流程为以下几步: 详细步骤 Git 复制 git clone -b RobotModelSetting/develop https://gitlab.123/PROJECT/123.git创建提…

内容中台的核心架构是什么?

模块化架构设计解析 内容中台的模块化架构通过分层解耦实现灵活扩展,其核心由基础资源层、能力服务层与业务应用层构成。基础层以统一数据治理体系为支撑,通过标准化接口实现结构化与非结构化数据的统一存储,例如Baklib采用分布式存储架构保…

bootloader相关部分

简单说明 程序烧录的方式主要有ICP,ISP,IAP 其中ICP就是常用的jlink等工具 ISP就是利用MCU自带的一些特殊引脚烧录,比如uart IAP就是利用用户写的bootloader代码烧录 bootloader主要分为三层,厂家出厂的bootrom ,用户自己写的bootloader,…

AI+视频监控电力巡检:EasyCVR视频中台方案如何赋能电力行业智能化转型

随着电力行业的快速发展,电力设施的安全性、稳定性和运维效率变得至关重要。传统视频监控系统在实时性、智能化及多系统协同等方面面临严峻挑战。EasyCVR视频中台解决方案作为一种先进的技术手段,在电力行业中得到了广泛应用,为电力设施的监控…