hualinux dj3 2.6：drf ViewSets使用@action添加路由及传参

目录

一、viewSets @active修饰器介绍

1.1 介绍

1.2 用法 

二、例子

2.1 需求

2.2 分析

2.2.1 @action自定义路由

2.2.2 @action url_path不支持尖括号传参问题

2.3 实现代码

2.4 测试效果

---

上篇讲了，使用视图集ViewSets编写通过学号sid查找学生成绩。我们使用router功能注册视图集时，自动帮生成了一套http方法get、post、put、patch、delete等，它生成的方法名是固定的。

如果我想像通用视图generics例子那样，自定义方法并传参怎办？可以使用@action修饰器。这篇就是主要讲的。

一、viewSets @active修饰器介绍

1.1 介绍

Django默认的路由分发规则决定了视图函数只能以get、post等请求方式命名，如果想要使用自定义的方式命名，我们可以使用action去映射请求方法名与自定义方法。

1.2 用法 

源码中action方法如下：

def action(methods=None, detail=None, url_path=None, url_name=None, **kwargs):
    ...

• methods
  • 支持的请求方式，为一个列表，默认为['get']
• detail
  • 必传参数，
  • 要处理的是否是详情资源对象（即是否通过url路径获取主键）
  • True表示需要传递主键id，使用通过URL获取的主键对应的数据对象
  • False表示不需要传递主键id，不使用URL获取主键
• url_path
  • 指定url路由名称，默认为action名称
• url_name
  • 指定url的名称，默认为action名称

注：url_path不支持尖括号<>传参数，如'<str:stuName>'这种是不支持的。但支持python正则表达式，可以使用形如 (?P<stuName>\w+)

二、例子

2.1 需求

我们在上篇例子基础上，改一下不通过学号sid查询学生成绩，而是通过自定义方法名findStuByName学生名查询成绩。

2.2 分析

例子中默认使用的是以学号sid查询成绩的，如果改用自定义方法findStuByName查询成绩的话有几点需要考虑

2.2.1 @action自定义路由

我们定义了方法名需要添加路由，那么我们可以使用@action修饰器

2.2.2 @action url_path不支持尖括号传参问题

@action url_path参数是不支持尖括号<>传参数的，如果写成<str:stuName>'，会报404找不到

比如 我把url_path写成

url_path='name/<str:stuName>'

其中 name/ 是 路径，stuName是要传的参数，名字叫stuName，访问会报404

因为它不支持<>，但它支持正则表达式，我们可以写成

url_path=r'name/(?P<stuName>\w+)'

2.3 实现代码

我没有添加权限，因为学生名可能有多个，所以我使用的是查询集并不是单实例或对象的get方法

app/views.py中StuViewSet类代码修改如下：

# 使用drf通用视图，queryset和serializer_class属性不能少
class StuViewSet(viewsets.ModelViewSet):
    queryset = Stu.objects.all()
    serializer_class = StudentSerializer
    # 默认是pk主键，我修改为sid字段
    lookup_field = 'sid'

    # url_path后面不要加‘/’，否则变成双斜杠，如url_path='t1/‘ ，访问变成www.xxxx.com/xxx/t1//
    # rul_path不支持参数，可以放百请求主体中，get写成/stu/t1/?name=fly
    @action(methods=['get',  'post'], detail=False, name='t1', url_path=r'name/(?P<stuName>\w+)')
    def stuName(self, request, stuName):
        print(request.data)
        res = Stu.objects.filter(name=stuName)
        serializer = StudentSerializer(res, many=True)
        return Response(serializer.data)

因为我在app/urls.py做了一个路由注册

router.register(r'stu', views.StuViewSet)
...
urlpatterns = [
    ...
    # 把路由的url包含进去，这样就做到了路径与函数的映射
    re_path('', include(router.urls)),
]

.这样就上面的访问路径变成 xxx:<端口号>/stu/name/<学生名>

2.4 测试效果

运行django，打开浏览器并输入 http://127.0.0.1:8000/stu/name/fly/，效果如下图所示：