【Django】DRF開發中的一些技巧記錄
問題記錄
問題1：信號沒有按預期觸發
描述
編寫了信號函數後，並沒有如預期一般在必要時候觸發，函數如下：
@receiver(signals.post_save, sender=Prometheus)
def monitor_prometheus_update(instance, **kwargs):
# 當發生修改時，更新控制台url
web_url = "//{ip}:{port}/{route}".format(ip=instance.ip, port=instance.port, route=instance.url)
Prometheus.objects.filter(ip=instance.ip).update(web_url=web_url)
print("觸發", web_url, instance)
解決
理論上應該在每次信息修改時觸發，print出觸發信息，但是並沒生效，我是在apps.py中定義ready方法：
from django.apps import AppConfig
class ServicesConfig(AppConfig):
name = 'apps.services'
default_auto_field = 'django.db.models.BigAutoField'
def ready(self):
import apps.services.signals
問題2：startapp報錯包名衝突
描述
使用startapp創建一個新的應用到指定目錄時，報錯：
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能夠方便拿到請求參數：
class PrometheusList(APIView):
def get(self,request: Request):
"""
:param request:
:return:
"""
param=request.query_params
if param and 'group' in param.keys():
# 支持通過group來進行查詢
queryset = Prometheus.objects.filter(group=param['group'])
else:
queryset = Prometheus.objects.all()
s = PrometheusSerializer(instance=queryset, many=True)
return Response(s.data, status = status.HTTP_200_OK)
隨後創建三條記錄，分組不同，進行測試：
執行GET請求如下：
GET /api/v1/services/prometheus?group=default
返回結果
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept
[
{
"ip": "1.1.1.1",
"port": 9090,
"url": "",
"web_url": "//1.1.1.1:9090/",
"group": "default",
"create_by": "2022-08-23 18:06:19",
"update_by": "2022-08-23 18:06:19"
},
{
"ip": "1.1.1.2",
"port": 9090,
"url": "",
"web_url": "//1.1.1.2:9090/",
"group": "default",
"create_by": "2022-08-23 18:06:25",
"update_by": "2022-08-23 18:06:25"
}
]
問題4：Model字段依賴於其他字段
描述
在我的模型類中，web_url字段需要依賴於ip、port以及url字段生成，格式如下：
web_url = "//{ip}:{port}/{url}"
原先使用信號機制實現這種，當任意一個字段變化時也會觸發web_url變化，但是發現這樣實現並不好；
解決
新的實現方法如下，在模型類中實現save方法：
class Prometheus(models.Model):
STATUS = (
("UP", "運行中"),
("DOWN", "已停止")
)
# Prometheus服務的模型
ip = models.GenericIPAddressField(protocol="IPV4",help_text="指定了Prometheus服務所在服務器IP", verbose_name="服務IP", blank=False,
primary_key=True)
port = models.IntegerField(help_text="指定了Prometheus服務的端口號，不正確會導致服務狀態獲取異常", verbose_name="服務端口",
default=9090)
url = models.CharField(max_length=50, help_text="該值對應了Prometheus的啟動參數web.external-url", verbose_name="訪問路由",
blank=True)
web_url = models.URLField(help_text="可以通過此URL跳轉到Prometheus的Web", verbose_name="控制台", default="")
group = models.CharField(max_length=50, help_text="用戶定義的Prometheus服務所屬的組", verbose_name="分組", default="default")
status = models.CharField(max_length=50,choices=STATUS, help_text="Prometheus節點的狀態，已停止時無法進行部分操作",verbose_name="狀態", default="DOWN")
create_by = models.DateTimeField(verbose_name="創建時間", auto_now_add=True)
update_by = models.DateTimeField(verbose_name="更新時間", auto_now=True)
def save(self, *args, **kwargs):
"""
重寫save方法，自動生成web_url
:param args:
:param kwargs:
:return:
"""
self.web_url = "//{ip}:{port}/{route}".format(ip=self.ip, port=self.port, route=self.url)
super(Prometheus, self).save(*args, **kwargs)
問題5：自定義分頁的格式
描述
在通用類視圖中，使用默認分頁類的默認的返回結構是這樣的：
字段並不是我要的，所以對其最新一定的自定義；
解決
自定義分頁類繼承自PageNumberPagination，然後實現get_paginated_response方法，原本的改方法返回的是OrderDict類型的結果，不過我看python3.6以後的dict也是默認有序了，所以我覺得返回dict是沒問題的：
from rest_framework.pagination import PageNumberPagination
class ServicePageNumberPagination(PageNumberPagination):
page_size_query_param = 'page_size'
page_query_param = "page"
max_page_size = 100
def get_paginated_response(self, data):
return Response(dict([
('total', self.page.paginator.count),
('results', data),
('success', True)
]))
這裡如果想要在返回的結構中打印出當前的url連接，可以通過get_html_context()方法實現：
