手把手教你使用Django + Vue.js 快速構建項目

Posted on by

1. 前言

本篇將基於Django + Vue.js，手把手教大傢快速的實現一個前後端分離的Web項目。

2. 環境準備

  1.  Python 3.6.1
  2. Mysql 5.7.23
  3. Pycharm （專業版）
  4. Node

3. 創建 Django 項目

在這裡插入圖片描述

創建完成後，目錄結構如下所示

在這裡插入圖片描述

使用 Navicat 工具創建數據庫 DjangoVue

在這裡插入圖片描述

安裝 mysqlclient 庫

在這裡插入圖片描述

在這裡插入圖片描述

配置 settings.py 文件，配置 Mysql 數據庫引擎

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'DjangoVue',
        'USER': 'root',
        'PASSWORD': 'root',
        'HOST': '127.0.0.1',
    }
}

執行同步操作，將數據遷移到 Mysql

在這裡插入圖片描述

啟動 Django Server ，驗證默認配置是否正常

python manage.py runserver 0.0.0.0:8000

在這裡插入圖片描述

打開瀏覽器，訪問 http://localhost:8000

在這裡插入圖片描述

創建一個 app 作為項目後端

python manage.py startapp backend

創建完成後，目錄結構如下所示

在這裡插入圖片描述

把 backend 加入到 settings.py 文件中的 INSTALLED_APPS 列表裡

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'backend'
]

在 backend/models.py 裡寫一個簡單 model 如下

from django.db import models

# Create your models here.


class Book(models.Model):
	# 如果沒有指定主鍵的話Django會自動新增一個自增id作為主鍵
    bookName = models.CharField(max_length=128, verbose_name='書名')
    createTime = models.DateTimeField(auto_now_add=True, verbose_name='創建時間')

    def __unicode__(self):
        return self.bookName

    def __str__(self):
        return self.bookName

根據修改創建遷移文件，並應用這些修改到數據庫中

# 創建遷移文件
python manage.py makemigrations
# 應用修改到數據庫
python manage.py migrate

在這裡插入圖片描述

Django 生成的表名將以 app 名加上 model 中的類名組合而成，也可以自定義表名，如下

from django.db import models

# Create your models here.


class Book(models.Model):
    bookName = models.CharField(max_length=128, verbose_name='書名')
    createTime = models.DateTimeField(auto_now_add=True, verbose_name='創建時間')

    def __unicode__(self):
        return self.bookName

    def __str__(self):
        return self.bookName

    class Meta:
        db_table = 'backend_book'

在 backend/views 裡我們新增兩個接口，一個返回所有的書籍列表，一個往數據庫裡添加一條book數據。

import json

from django.core import serializers
from django.http import JsonResponse
from django.shortcuts import render
from django.views.decorators.http import require_http_methods

from backend.models import Book


@require_http_methods(["GET"])
def add_book(request):
    response = {}
    try:
        book_name = request.GET.get('book_name')
        book = Book(bookName=book_name)
        book.save()
        response['respMsg'] = 'success'
        response['respCode'] = '000000'
    except Exception as e:
        response['respMsg'] = str(e)
        response['respCode'] = '999999'
    return JsonResponse(response)


@require_http_methods(["GET"])
def show_books(request):
    response = {}
    try:
        books = Book.objects.filter()
        response['list'] = json.loads(serializers.serialize("json", books))
        response['respMsg'] = 'success'
        response['respCode'] = '000000'
    except Exception as e:
        response['respMsg'] = str(e)
        response['respCode'] = '999999'
    return JsonResponse(response)

在 backend 目錄下，新增一個 urls.py 文件，把我們新增的兩個接口添加到路由裡

# -*- coding: utf-8 -*-
"""
-------------------------------------------------
   File Name ：     urls.py
   Description :    
   Author :         FHQI
   date ：          2021-08-19
-------------------------------------------------
"""
from django.conf.urls import url

from backend.views import add_book, show_books

urlpatterns = [
    url("add_book", add_book, ),
    url("show_books", show_books, ),
]

最後要把backend 下的 urls 添加到項目 djangoVue 下的 urls 中，才算完成路由

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/', include('backend.urls')),
]

重新啟動服務，測試一下剛才寫的兩個接口

python manage.py runserver 0.0.0.0:8000

在這裡插入圖片描述

在這裡插入圖片描述

4. 創建 Vue.js 前端項目

使用 node 自帶的 npm 包管理器安裝 vue 和相關模塊。推薦使用淘寶的 cnpm 命令行工具代替默認的 npm。

npm install -g cnpm --registry=https://registry.npm.taobao.org

安裝 vue.js

cnpm install -g vue

安裝vue-cli腳手架工具（vue-cli是官方腳手架工具，能迅速幫你搭建起vue項目的框架）

cnpm install -g vue-cli

在 djangoVue 項目根目錄下，新建一個前端工程目錄

vue-init webpack frontend

在創建項目的過程中會彈出一些與項目相關的選項需要回答，按照真實情況進行輸入即可，如下：

Project name（工程名）:回車
Project description（工程介紹）：回車
Author：作者名 ：回車
Vue build ==> （是否安裝編譯器）runtime-compiler、 runtime-only 都是打包方式，第二個效率更高；
Install vue-router ==> 是否要安裝 vue-router，項目中肯定要使用到路由，所以Y 回車；
Use ESLint to lint your code ==> 是否需要ESLint檢測代碼，目前我們不需要所以 n 回車；
Set up unit tests ==> 是否安裝 單元測試工具 目前我們不需要 所以 n 回車；
Setup e2e tests with Nightwatch ==>是否需要端到端測試工具目前我們不需要所以n回車；
Should we run npm install for you after the project has been created? (recommended) (Use arrow keys)==> 安裝依賴npm install
回車；

在這裡插入圖片描述

安裝 vue 依賴模塊

cd frontend
cnpm install
cnpm install vue-resource
cnpm install element-ui

現在整個文件目錄結構如下

在這裡插入圖片描述

在 frontend 目錄 src 下包含入口文件 main.js，入口組件 App.vue 等。後綴為 vue 的是 Vue.js 框架定義的單文件組件，一個文件包含且僅包含三塊內容，如下：

1. <template></template > 前端渲染的模板
2. 專為此模板寫渲染邏輯的 <script></script>
3. 專為此模板寫樣式的 <style></style>

在 src/components 文件夾下新建一個名為 Home.vue 的組件，通過調用之前在 Django 上寫好的 api，實現添加書籍和展示書籍信息的功能。在樣式組件上我們使用瞭餓瞭麼團隊推出的 element-ui，這是一套專門匹配 Vue.js 框架的功能樣式組件。由於組件的編碼涉及到瞭很多 js、html、css 的知識，並不是本文的重點，因此在此隻貼出部分代碼。

<template>
<div class="home">
<el-row display="margin-top:10px">
<el-input v-model="input" placeholder="請輸入書名" style="display:inline-table; width: 30%; float:left"></el-input>
<el-button type="primary" @click="addBook()" style="float:left; margin: 2px;">新增</el-button>
</el-row>
<el-row>
<el-table :data="bookList" style="width: 100%" border>
<el-table-column prop="id" label="編號" min-width="100">
<template slot-scope="scope"> {{ scope.row.pk }} </template>
</el-table-column>
<el-table-column prop="bookName" label="書名" min-width="100">
<template slot-scope="scope"> {{ scope.row.fields.bookName }} </template>
</el-table-column>
<el-table-column prop="createTime" label="添加時間" min-width="100">
<template slot-scope="scope"> {{ scope.row.fields.createTime }} </template>
</el-table-column>
</el-table>
    </el-row>
  </div>
</template>

<script>
export default {
  name: 'home',
  data () {
    return {
      input: '',
      bookList: []
    }
  },
  mounted: function () {
    this.showBooks()
  },
  methods: {
    addBook () {
      this.$http.get('http://127.0.0.1:8000/api/add_book?book_name=' + this.input)
        .then((response) => {
          var res = JSON.parse(response.bodyText)
          if (res.respCode === '000000') {
            this.showBooks()
          } else {
            this.$message.error('新增書籍失敗，請重試')
            console.log(res['respMsg'])
          }
        })
    },
    showBooks () {
      this.$http.get('http://127.0.0.1:8000/api/show_books')
        .then((response) => {
          var res = JSON.parse(response.bodyText)
          console.log(res)
          if (res.respCode === '000000') {
            this.bookList = res['list']
          } else {
            this.$message.error('查詢書籍失敗')
            console.log(res['respMsg'])
          }
        })
    }
  }
}
</script>

<style scoped>
  h1, h2 {
    font-weight: normal;
  }

  ul {
  list-style-type: none;
  padding: 0;
}

li {
  display: inline-block;
  margin: 0 10px;
}

a {
  color: #42b983;
}
</style>

在 src/router 目錄的 index.js 中，把新建的 Home 組件，配置到 vue-router 路由中

import Vue from 'vue'
import Router from 'vue-router'
// import HelloWorld from '@/components/HelloWorld'
import Home from '@/components/Home'

Vue.use(Router)

export default new Router({
  routes: [
    {
      path: '/',
      // name: 'HelloWorld',
      name: 'Home',
      // component: HelloWorld
      component: Home
    }
  ]
})

在 src/main.js 文件中，導入 element-ui、vue-resource 庫。

import Vue from 'vue'
import App from './App'
import router from './router'
import ElementUI from 'element-ui'
import VueResource from 'vue-resource'
import 'element-ui/lib/theme-chalk/index.css'

Vue.use(ElementUI)
Vue.use(VueResource)

Vue.config.productionTip = false

/* eslint-disable no-new */
new Vue({
  el: '#app',
  router,
  render: h => h(App)
})

在前端工程 frontend 目錄下，輸入 npm run dev 啟動 node 自帶的服務器，自動打開瀏覽器，如下頁面：

在這裡插入圖片描述

5. 解決跨域問題

此時出現瞭一個問題，數據是空的，打開開發者工具，發現有錯誤。因為我們使用 VueJS 的開發環境脫離瞭 Django 環境，訪問 Django 寫的 API，出現瞭跨域問題，有兩種方法解決，一種是在 VueJS 層上做轉發（proxyTable），另一種是在 Django 層註入 header，這裡使用後者，用 Django 的第三方包 django-cors-headers 來解決跨域問題。

pip install django-cors-headers

修改 settings.py

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'corsheaders.middleware.CorsMiddleware',    # 添加1，註意中間件的添加順序
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

CORS_ORIGIN_ALLOW_ALL = True        # 添加2

至此，頁面上有數據瞭，如下：

在這裡插入圖片描述

新增書籍，如填入：“Django從入門到放棄”，新增的書籍信息會實時反映到頁面的列表中，這得益於Vue.js的數據雙向綁定特性。

在這裡插入圖片描述

6. 整合 Django 和 Vue.js 前端

目前我們已經分別完成瞭 Django 後端和 Vue.js 前端工程的創建和編寫，但實際上它們是運行在各自的服務器上，和我們的要求是不一致的。

在前端工程 frontend 目錄下，輸入 npm run build，如果項目沒有錯誤的話，就能夠看到所有的組件、css、圖片等都被 webpack 自動打包到 dist 目錄下瞭，裡面有一個 index.html 和一個文件夾 static。

在這裡插入圖片描述

修改 djangoVue 下的 urls ，使用通用視圖創建最簡單的模板控制器，訪問 『/』時直接返回 index.html

from django.contrib import admin
from django.urls import path, include
from django.views.generic import TemplateView

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/', include('backend.urls')),
    path(r'', TemplateView.as_view(template_name="index.html")),
]

配置 Django 項目的模板搜索路徑。上一步使用瞭 Django 的模板系統，所以需要配置一下模板使 Django 知道從哪裡找到 index.html。修改 settings.py 文件，如下：

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        # 'DIRS': [os.path.join(BASE_DIR, 'templates')],
        'DIRS': [os.path.join(BASE_DIR, 'frontend/dist')],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

配置靜態文件的搜索路徑。

# Add for vuejs
STATICFILES_DIRS = [
    os.path.join(BASE_DIR, "frontend/dist/static"),
]

配置完成，啟動 Django 服務 python manage.py runserver，就能夠看到我們的前端頁面在瀏覽器上展現：

在這裡插入圖片描述

此時服務的端口已經是 Django 服務的 8000 而不是 node 服務的 8080 瞭，說明我們已經成功通過 Django 集成瞭 Vue 前端工程。

到此這篇關於手把手教你使用Django + Vue.js 快速構建項目的文章就介紹到這瞭,更多相關Django Vue.js構建項目內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：