【Django】DRF开发中的一些技巧记录

问题记录

问题1：信号没有按预期触发

描述

编写了信号函数后，并没有如预期一般在必要时候触发，函数如下：

1. @receiver(signals.post_save, sender=Prometheus)
2. def monitor_prometheus_update(instance, **kwargs):
3.     # 当发生修改时，更新控制台url
4.     web_url = "http://{ip}:{port}/{route}".format(ip=instance.ip, port=instance.port, route=instance.url)
5.     Prometheus.objects.filter(ip=instance.ip).update(web_url=web_url)
6.     print("触发", web_url, instance)

复制代码

解决

理论上应该在每次信息修改时触发，print出触发信息，但是并没生效，我是在apps.py中定义ready方法：

1. from django.apps import AppConfig
4. class ServicesConfig(AppConfig):
5.     name = 'apps.services'
6.     default_auto_field = 'django.db.models.BigAutoField'
8.     def ready(self):
9.         import apps.services.signals

复制代码

问题2：startapp报错包名冲突

描述

使用startapp创建一个新的应用到指定目录时，报错：

1. CommandError: 'apps' conflicts with the name of an existing Python module and cannot be used as an app directory. Please try another directory.

复制代码

使用的命令是startapp services .apps
解决

在项目目录下新建apps目录，然后在其中新建空目录services，此时使用命令startapp services ./apps/services就可以在指定的目录下创建新的应用了。
问题3：Get请求获取query_params

描述

编写了Get请求后，需要支持用户在请求时携带部分参数，方便查询
解决

使用rest_framework.request.Request的query_params能够方便拿到请求参数：

1. class PrometheusList(APIView):
3.     def get(self,request: Request):
4.         """
5.         :param request:
6.         :return:
7.         """
8.         param=request.query_params
9.         if param and 'group' in param.keys():
10.                                     # 支持通过group来进行查询
11.             queryset = Prometheus.objects.filter(group=param['group'])
12.         else:
13.             queryset = Prometheus.objects.all()
15.         s = PrometheusSerializer(instance=queryset, many=True)
16.         return Response(s.data, status = status.HTTP_200_OK)

复制代码

随后创建三条记录，分组不同，进行测试：

执行GET请求如下：

1. GET /api/v1/services/prometheus?group=default

复制代码

返回结果

1. HTTP 200 OK
2. Allow: GET, HEAD, OPTIONS
3. Content-Type: application/json
4. Vary: Accept
6. [
7.     {
8.         "ip": "1.1.1.1",
9.         "port": 9090,
10.         "url": "",
11.         "web_url": "http://1.1.1.1:9090/",
12.         "group": "default",
13.         "create_by": "2022-08-23 18:06:19",
14.         "update_by": "2022-08-23 18:06:19"
15.     },
16.     {
17.         "ip": "1.1.1.2",
18.         "port": 9090,
19.         "url": "",
20.         "web_url": "http://1.1.1.2:9090/",
21.         "group": "default",
22.         "create_by": "2022-08-23 18:06:25",
23.         "update_by": "2022-08-23 18:06:25"
24.     }
25. ]

复制代码

问题4：Model字段依赖于其他字段

描述

在我的模型类中，web_url字段需要依赖于ip、port以及url字段生成，格式如下：

1. web_url = "http://{ip}:{port}/{url}"

复制代码

原先使用信号机制实现这种，当任意一个字段变化时也会触发web_url变化，但是发现这样实现并不好；
解决

新的实现方法如下，在模型类中实现save方法：

1. class Prometheus(models.Model):
3.     STATUS = (
4.         ("UP", "运行中"),
5.         ("DOWN", "已停止")
6.     )
8.     # Prometheus服务的模型
9.     ip = models.GenericIPAddressField(protocol="IPV4",help_text="指定了Prometheus服务所在服务器IP", verbose_name="服务IP", blank=False,
10.                                       primary_key=True)
11.     port = models.IntegerField(help_text="指定了Prometheus服务的端口号，不正确会导致服务状态获取异常", verbose_name="服务端口",
12.                                default=9090)
13.     url = models.CharField(max_length=50, help_text="该值对应了Prometheus的启动参数web.external-url", verbose_name="访问路由",
14.                            blank=True)
15.     web_url = models.URLField(help_text="可以通过此URL跳转到Prometheus的Web", verbose_name="控制台", default="")
16.     group = models.CharField(max_length=50, help_text="用户定义的Prometheus服务所属的组", verbose_name="分组", default="default")
17.     status = models.CharField(max_length=50,choices=STATUS, help_text="Prometheus节点的状态，已停止时无法进行部分操作",verbose_name="状态", default="DOWN")
18.     create_by = models.DateTimeField(verbose_name="创建时间", auto_now_add=True)
19.     update_by = models.DateTimeField(verbose_name="更新时间", auto_now=True)
20.                
22.     def save(self, *args, **kwargs):
23.         """
24.         重写save方法，自动生成web_url
25.         :param args:
26.         :param kwargs:
27.         :return:
28.         """
29.         self.web_url = "http://{ip}:{port}/{route}".format(ip=self.ip, port=self.port, route=self.url)
30.         super(Prometheus, self).save(*args, **kwargs)

复制代码

问题5：自定义分页的格式

描述

在通用类视图中，使用默认分页类的默认的返回结构是这样的：

字段并不是我要的，所以对其最新一定的自定义；
解决

自定义分页类继承自PageNumberPagination，然后实现get_paginated_response方法，原本的改方法返回的是OrderDict类型的结果，不过我看python3.6以后的dict也是默认有序了，所以我觉得返回dict是没问题的：

1. from rest_framework.pagination import PageNumberPagination
3. class ServicePageNumberPagination(PageNumberPagination):
4.     page_size_query_param = 'page_size'
5.     page_query_param = "page"
6.     max_page_size = 100
7.                
8.                     def get_paginated_response(self, data):
9.         return Response(dict([
10.             ('total', self.page.paginator.count),
11.             ('results', data),
12.             ('success', True)
13.         ]))

复制代码

这里如果想要在返回的结构中打印出当前的url连接，可以通过get_html_context()方法实现：

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！