Django如何與Ajax互動

2021-04-29 13:01:06

前後端傳輸資料的編碼格式

前後端傳輸資料的編碼格式主要有三種, 本文接下來將詳細演示。

urlencoded
formdata
json

Ajax提交urlencoded格式資料

Ajax給後臺傳送資料的預設編碼格式是urlencoded，比如username=abcde&password=123456的形式。Django後端拿到符合urlencoded編碼格式的資料都會自動幫你解析分裝到request.POST中,與form表單提交的資料相同。

下面兩種方式是等同的。

//手動構造資料data
$("#btnSubmit").click(function () {
    $.ajax({
        url: '/auth/', //也可以反向解析{% url 'login' %}
        type: 'post',
        data: {
            'username': $("#id_username").val(),
            'password': $('#id_password').val()
        },
        success: function (data){
            
        }
    })；
}；
                    
// .serialize() 方法可將<input>, <textarea> 以及 <select>表單序列化
// 成urlencoded格式資料
                      
$("#btnSubmit").click(function () {
    let data = $("#loginForm").serialize();
    $.ajax({
        url: "/auth/", //別忘了加斜槓
        type: $("#loginForm").attr('method'),
        data: data,
        success: function (data) {
         
        }
    });
});

Ajax通過FormData上傳檔案

Ajax上傳檔案需要藉助於js內建物件FormData，另外上傳檔案時表單千萬別忘了加enctype="multipart/form-data"屬性。

//案例1，點選submi上傳檔案
$("#submitFile").click(function () {
    let formData = new FormData($("#upload-form"));
    $.ajax({
       url:"/upload/",//也可以寫{% url 'upload' %}
       type:"post",
       data:formData,
       //這兩個要必須寫
       processData:false,  //不預處理資料  因為FormData 已經做了
       contentType:false,  //不指定編碼了 因為FormData 已經做了
       success:function(data){
             console.log(data);
       }
    });
});
                       
//案例2,同時上傳檔案並提交其它資料
$("#submitFile").click(function () {
    //js取到檔案
    let myfile = $("#id_file")[0].files[0];
    //生成一個FormData物件
    let formdata = new FormData();
    //加值
    formdata.append('name', $("#id_name").val());
    //加檔案
    formdata.append('myfile', myfile);
    $.ajax({
        url: '/upload/', //url別忘了加/槓
        type: 'post',
        //這兩個要必須寫
        processData:false,  //不預處理資料  因為FormData 已經做了
        contentType:false,  //不指定編碼了 因為FormData 已經做了
        data: formdata,
        success: function (data) {
            console.log(data);
        }
    });
});

Ajax提交Json格式資料

前後端傳輸資料的時候一定要確保宣告的編碼格式跟資料真正的格式是一致的。如果你通過Ajax傳送Json格式資料給Django後端，請一定注意以下三點：

contentType引數指定成application/json;
資料是真正的json格式資料；
Django後端不會幫你處理json格式資料需要你自己去request.body獲取並處理。

$("#submitBtn").click(function () {
    var data_obj={'name':'abcdef','password':123456};//Javascript物件
    $.ajax({
        url:'',
        type:'post',
        contentType:'application/json',  //一定要指定格式 contentType
        data:JSON.stringify(data_obj),    //轉換成json字串格式
        success:function (data) {
            console.log(data)
        }
    });
});

Ajax傳送POST請求時如何通過CSRF認證

// 第一種方式直接在傳送資料中加入csrfmiddlewaretoken
$("#btn").on("click",function () {
    $.ajax({
        url:"/some_url/",
        type:"POST",
        data:{
            csrfmiddlewaretoken: {{ csrf_token }}, //寫在模板中，才會被渲染
        },
        success:function (data) {
    }
});
});
 
//通過jquery選擇器獲取csrfmiddlewaretoken
$("#btn").on("click",function () {
    $.ajax({
        url:"/some_url/",
        type:"POST",
        data:{
            csrfmiddlewaretoken:$('[name="csrfmiddlewaretoken"]').val(),
        },
        success:function (data) {
            
        }
    });
});
 
//使用jquery.cookie.js呼叫請求頭cookie中的csrftoken
<script src="/static/jquery.cookie.js"> 
<script>
     $("#btn").on("click",function () {
     $.ajax({
        url:"/some_url/",
        type:"POST",
        headers:{"X-CSRFToken":$.cookie('csrftoken')},
        data:$("#form1").serialize()
    });
   })
</script>

Django Ajax案例1：聯動下例選單

聯動下拉式選單是Web開發中一個被經常使用的應用。比如當你從一個列表從選擇一個國家的時候，聯動下拉式選單會同步顯示屬於該國家所有城市列表供使用者選擇。今天我們就教你如何使用Django+Ajax生成聯動下拉式選單。

我們的模型如下所示：

class Country(models.Model):
    name = models.CharField(verbose_name="國家", max_length=50)

    def __str__(self):
        return self.name


class City(models.Model):
    name = models.CharField(verbose_name="城市", max_length=50)
    country = models.ForeignKey(Country, on_delete=models.CASCADE, verbose_name="國家",)

    def __str__(self):
        return self.name

我們的模板如下所示，表單中對應國家和城市下拉式選單的DOM元素id分別為id_country和id_city。當用戶選擇國家後，ajax會攜帶國家的id值向後臺傳送請求獲得當前國家的所有城市清單，並在前端渲染顯示。

{% block content %}
<h2>建立使用者 - 聯動下拉式選單</h2>
<form method="post" class="form-horizontal" role='form' action="">
  {% csrf_token %}
  {{ form.as_p }}
  <button type="submit" class="btn btn-primary">Submit</button>
</form>
{% endblock %}

<script src="https://code.jquery.com/jquery-3.1.0.min.js"></script>
<script>
    $("#id_country").change(function() {
      var country_id = $(this).val();

      $.ajax({
        url: '/ajax/load_cities/',
        data: {
          'country_id': country_id
        },
        type: 'GET',
        dataType: 'json',
        success: function (data) {
            var content='';
            $.each(data, function(i, item){
                  content+='<option value='+item.id+'>'+item.name+'</option>'
                });
            $('#id_city').html(content)
        },

      });
    });
  </script>

Django負責處理檢視Ajax請求的檢視函數如下所示：

def ajax_load_cities(request):
    if request.method == 'GET':
        country_id = request.GET.get('country_id', None)
        if country_id:
            data = list(City.objects.filter(country_id=country_id).values("id", "name"))
            return JsonResponse(data, safe=False)

Django Ajax案例2：Ajax上傳檔案

前端模板及js檔案如下所示, 請注意我們是如何在表單中加入了enctype屬性，如何使用FormData上傳檔案，並解決了csrftoken問題的。

{% block content %}
<form action="" method="post" enctype="multipart/form-data" id="form">
    <ul class="errorlist"></ul>
    {% csrf_token %}
{{ form.as_p }}
 <input type="button" class="btn btn-info form-control" value="submit" id="btn" />
</form>
<table class="table table-striped" id="result">
</table>
{% endblock %}

{% block js %}
<script src=" https://cdn.jsdelivr.net/jquery.cookie/1.4.1/jquery.cookie.min.js ">
</script>
<script>
var csrftoken = $.cookie('csrftoken');
function csrfSafeMethod(method) {
    return (/^(GET|HEAD|OPTIONS|TRACE)$/.test(method));
}
$(document).ready(function(){
   $('#btn').click(function(e){
        e.preventDefault();
        // 構建FormData物件
        var form_data = new FormData();
        form_data.append('file', $('#id_file')[0].files[0]);
        $.ajax({
        url: '/file/ajax_upload/',
        data: form_data,
        type: 'POST',
        dataType: 'json',
        // 告訴jQuery不要去處理傳送的資料, 傳送物件。
        processData : false,
        // 告訴jQuery不要去設定Content-Type請求頭
        contentType : false,
        // 獲取POST所需的csrftoken
        beforeSend: function(xhr, settings) {
            if (!csrfSafeMethod(settings.type) && !this.crossDomain) {
            xhr.setRequestHeader("X-CSRFToken", csrftoken);
            }},
        success: function (data) {
            if(data['error_msg']) {
                var content = '<li>'+ data['error_msg'] + '</li>';
                $('ul.errorlist').html(content);
            }
            else
            {
            var content= '<thead><tr>' +
            '<th>Name and URL</th>' +
            '<th>Size</th>' +
            '</tr></thead><tbody>';
             $.each(data, function(i, item) {
                  content = content +
                  '<tr><td>' +
                  "<a href= ' " +
                  item['url'] +
                  " '> " +
                  item['url'] +
                  '</a></td><td>' +
                  item['size'] +
                  '</td><td><tr>'
                });
             content = content + "</tbody>";
             $('#result').html(content);
             }
           },
        });
   });
 });
  </script>
{% endblock %}