主要內容
- 1. 前言
- 2. 環境準備
- 3. 創建 Django 專案
- 4. 創建 Vue.js 前端專案
- 5. 解決跨域問題
- 6. 整合 Django 和 Vue.js 前端
1. 前言
本篇將基于Django + Vue.js，手把手教大家快速的實作一個前后端分離的Web專案，
2. 環境準備
- Python 3.6.1
- Mysql 5.7.23
- Pycharm （專業版）
- 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 前端工程，
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/295412.html
標籤：python