Django 是一套以 Python 撰寫的開源 Web 框架,採用 MVC 的軟體設計模式(模型 M、視圖 V、控制器 C)。它最早是為了解決勞倫斯出版集團旗下新聞網站的內容管理需求而生,2005 年 7 月以 BSD 授權釋出,名字則取自比利時吉普賽爵士吉他手 Django Reinhardt。
某天嘗試用 jQuery 呼叫 Ajax,發現用 GET 一切正常,一換成 POST 就失敗;再試表單方式的 POST,同樣不行。只要是 POST 就必然回 HTTP 403,實在莫名其妙。
查了一堆資料之後才理解:這是 Django 的 Cross Site Request Forgery protection 在運作,目的是抵禦 CSRF 攻擊。官方文件有完整說明(https://docs.djangoproject.com/en/dev/ref/contrib/csrf/),照著調整即可。
在 settings.py 找到 MIDDLEWARE_CLASSES,把 CSRF 相關中間件補進去:
MIDDLEWARE_CLASSES = (
'django.middleware.common.CommonMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.csrf.CsrfResponseMiddleware', # 加入這個中間件
)
改完之後,表單形式的 POST 就不會再被擋了。
Ajax 的 POST 只改中間件是不夠的,還需要一個每次提交時都會觸發的 cookie 處理流程,把 csrf token 掛到請求標頭上。好消息是,若你用 jQuery,Django 官方直接附了現成都市碼——存成獨立 js 檔,在頁面中引入,同樣要記得排在 jQuery 之後。
$('html').ajaxSend(function(event, xhr, settings) {
function getCookie(name) {
var cookieValue = null;
if (document.cookie && document.cookie != '') {
var cookies = document.cookie.split(';');
for (var i = 0; i < cookies.length; i++) {
var cookie = jQuery.trim(cookies[i]);
if (cookie.substring(0, name.length + 1) == (name + '=')) {
cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
break;
}
}
}
return cookieValue;
}
if (!(/^http:.*/.test(settings.url) || /^https:.*/.test(settings.url))) {
// 只有相對路徑(本站)才送 token
xhr.setRequestHeader("X-CSRFToken", getCookie('csrftoken'));
}
});
折騰完這一圈,Ajax 與 Django 之間才算真正通話正常。
前端的請求碼長這樣:
$.ajax({
type: 'GET',
url: '/store/ds_mgmt_wx/ajax_handle',
dataType: 'html',
success: function(data) {
alert(data);
},
error: function(data) {
alert(data);
}
});
後端對應的處理分支:
if act_job == 'ajax_handle':
return HttpResponse('ajax_handle')
一個提醒:如果你的表單裡有 {% csrf_token %} 產生的隱藏欄位,也可以直接在 data 中帶上 CSRF token,效果與 ajaxSend 相同,只是每個請求都要自己寫一次。ajaxSend 的價值就是「寫一次,全站生效」。