前導工作：參見后端開發三步曲之二-python-django-基于docker的項目開發
Django后端精要：最簡DEMO
每次新建一個頁面（應用），常規操作都是
1，setting注冊APP，
2，urls設置路由使得服務器可以找到新的頁面（urls用于調用views中函數），
3，views當請求request來的時候可以返回頁面到前端（views中函數用于HttpReponse或renderHTML模板，數據操作用Model和ORM，也可直接操作數據庫）
一、從第一個django項目myPrj和應用myApp開始
按前一步驟配置和初始化好項目，PyCharm的Terminal窗口中測試運行通過，然后CTRL+C結束。
docker-compose up
開一個終端進入容器可進行管理項目：
docker exec -it myapp_container /bn/bash
cd /myapp
保持該終端待用。
在主目錄中Pycharm建立新的Python package：Apps，將新建立的myapp移進該目錄統一管理
在主項目settings.py中修改搜索路徑
import sys
# ...
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
# 在前面一行后加下以下內容
sys.path.insert(0, os.path.join(BASE_DIR, 'Apps'))
#在INSTALLED_APPS列表中加入Apps.myApp
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'Apps.myApp',
]
建立第一個基于模板的應用，項目settings.py中加入模板搜索路徑
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [os.path.join(BASE_DIR, 'templates')],
'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',
],
},
},
]
編寫一個測試模板index.html放入templates目錄
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>myapp demo</title>
</head>
<body>
<div>
<h1>Hello, friend from {{ user_ip }} </h1>,<br />
<a href="/list">Click Here to show article list.</a>
</div>
</body>
</html>
修改Apps.myApp下的views.py，增加兩個函數：
from django.shortcuts import render
from django.http import HttpResponse
def index(request):
return render(request, 'index.html') # 用模板渲染
def hello(request):
return HttpResponse('Hello world!') # 不用模板也能干
生成myApp本地路由，在myApp目錄下生成新的urls.py
from django.urls import path
from . import views
urlpatterns = [
path('', views.index),
path('hello/', views.hello),
]
在全局路由中引用該局部路由：
from django.contrib import admin
from django.urls import path
# from Apps.myApp import views # 有局部路由引用則不需要了
from django.urls import include # 引用urls的相關包
urlpatterns = [
path('admin/', admin.site.urls),
path('', include('Apps.myApp.urls'))， # 引用局部路由
# path('', views.index), # 也可以直接設置全局路由
# path('hello/', views.hello) # 也可以直接設置全局路由
]
！用到再學，路由:path,re_path,url支持的通配模式，以及參數化url傳遞給views處理函數
二、使用模型和后臺管理模型
更改Apps/myApp/models.py，主要作用是對數據庫做修改
from django.db import models
from django.utils import timezone
class Article(models.Model):
author = models.ForeignKey('auth.User',on_delete=models.CASCADE)
title = models.CharField(max_length=200)
text = models.TextField()
created_date = models.DateTimeField(default=timezone.now)
published_date = models.DateTimeField(blank=True, null=True)
def publish(self):
self.published_date = timezone.now()
self.save()
def __str__(self):
return self.title
打開 Apps/myApp/admin.py 文件，修改為：
from django.contrib import admin
from .models import Article
admin.site.register(Article)
進入容器內部，在之前打開的終端（容器內）中：
# 創建superuser
python manage.py createsuperuser
# 如：root/Root123456
更新model到數據庫
python manage.py makemigrations myApp
python manage.py migrate myApp
可以通過http://0.0.0.0:8080/admin/登錄并在站點管理中看到用戶及MYAPP應用的Articles表（模型）管理界面
三、用視圖連接模型與模板
1、顯示列表頁
1）建立列表頁的路由
每一個新的應用都需要在urls.py中注冊路由修改Apps/myApp/urls.py 文件。
from django.urls import path
from . import views
urlpatterns = [
path('', views.index),
path('hello/', views.hello),
path('list/', views.article_list),
]
2）視圖方法，Django ORM 和 QuerySets（查詢集）
在Apps/myApp/views.py中修改
from django.shortcuts import render
from django.utils import timezone
from .models import Article
# ...
def article_list(request):
#按時間順序排列
posts = Article.objects.filter(published_date__lte=timezone.now()).order_by('published_date')
return render(request, 'article_list.html', {'posts': posts})
3）Django模板，嵌套層級
在myApp應用的目錄下創建一個名為 static 的文件夾，在新建一個css文件夾，設計一個my.css
在templates目錄創建基礎模板base.html
<!DOCTYPE html>
{% load staticfiles %}
<html lang="en">
<head>
<meta charset="UTF-8">
<title>myapp articles</title>
<link rel="stylesheet" href="{% static 'css/my.css' %}">
</head>
<body>
<div>
<h1><a href="/">Home</a></h1>
{% block content %}
{% endblock %}
</div>
</body>
</html>
創建article_list.html擴展基礎模板
{% extends 'base.html' %}
{% block content %}
<!-- 只有管理員才能發貼 -->
{% if user.is_authenticated %}
<a href="{% url 'new' %}">Click here to post new article</a>
{% endif %}
<!-- 只有管理員才能發貼 -->
{% for post in posts %}
<div>
<h1>{{ post.title }}</h1>
<p>published: {{ post.published_date }}</p>
<p>{{ post.text|linebreaksbr }}</p>
</div>
{% endfor %}
{% endblock %}ock %}
2、表單頁,用于提交數據
1）建立路由，urls.py中添加
from django.urls import path
from . import views
urlpatterns = [
path('', views.index),
path('hello/', views.hello),
path('list/', views.article_list),
path('new/', views.article_new, name='new'), # 起名字，在模板語言中可以用url 'new'引用
]
2）視圖處理
表單，創建一個文件forms.py放在myApp目錄下。
from django import forms
from .models import Article
class PostForm(forms.ModelForm):
class Meta:
model = Article
fields = ('title', 'text',)
修改views.py
from django.shortcuts import render
from django.http import HttpResponse, HttpResponseRedirect
from django.utils import timezone
from .models import Article
from .forms import PostForm
#...
def article_new(request):
if request.method == "POST":
form = PostForm(request.POST)
if form.is_valid():
post = form.save(commit=False)
post.author = request.user
post.published_date = timezone.now()
post.save()
return HttpResponseRedirect('/list')
else:
form = PostForm()
return render(request, 'article_new.html', {'form': form})
3）模板article_new.html
{% extends 'base.html' %}
{% block content %}
<h1>New Article</h1>
<form method="POST" class="post-form">
{% csrf_token %}
{{ form.as_p }}
<button type="submit" class="save btn btn-default">Save</button>
</form>
{% endblock %}
四、使用Django RESTful Framework做API
1、Serializers
要定義序列化器。創建一個名為myApp/serializers.py的新模塊。目前這部分是個黑箱還沒有研究，以下代碼似乎可以正常運行：
from django.contrib.auth.models import User, Group
from .models import Article
from rest_framework import serializers
class ArticleSerializer(serializers.ModelSerializer):
class Meta:
model = Article
fields = ['title', 'text', 'author']
class UserSerializer(serializers.ModelSerializer):
articles = ArticleSerializer(many=True, read_only=True)
class Meta:
model = User
fields = ['url', 'username', 'email', 'groups', 'articles']
class GroupSerializer(serializers.ModelSerializer):
users = serializers.StringRelatedField(many=True)
class Meta:
model = Group
fields = ['url', 'name', 'users']
2、Views
打開myApp/views.py新增代碼：
########################################################################
# 以下為RESTful framework所用
from rest_framework import viewsets
from django.contrib.auth.models import User, Group
from .serializers import ArticleSerializer, UserSerializer, GroupSerializer
class UserViewSet(viewsets.ModelViewSet):
""" API endpoint that allows users to be viewed or edited. """
queryset = User.objects.all().order_by('-date_joined')
serializer_class = UserSerializer
class GroupViewSet(viewsets.ModelViewSet):
""" API endpoint that allows groups to be viewed or edited. """
queryset = Group.objects.all()
serializer_class = GroupSerializer
class ArticleViewSet(viewsets.ModelViewSet):
queryset = Article.objects.all().order_by('-published_date')
serializer_class = ArticleSerializer
不是分開寫多個視圖，分組所有常見的行為成稱為 ViewSets 的類。可以把這些分成單個的views, 但使用viewsets可保持視圖邏輯很好地組織以及非常簡潔。
3、路由url
設置API URLs路由到myPrj/urls.py...
from rest_framework import routers
router = routers.DefaultRouter()
router.register(r'users', views.UserViewSet)
router.register(r'groups', views.GroupViewSet)
router.register(r'articles', views.ArticleViewSet)
# Additionally, we include login URLs for the browsable API.
urlpatterns = [
path('admin/', admin.site.urls),
path('', include('Apps.myApp.urls')),
# path('', views.index),
path('api/', include(router.urls)),
path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]
使用viewsets代替views，可以通過用一個路由類注冊viewsets為API自動生成URL conf。
同時如果對API URLs需要更多的控制，可以簡單地使用常規的views并明確地寫URL conf。
這里為browsable API包含了默認的登入登出veiws，這是可選的，但對于Browsable API需要認證時很有用。
4、分頁
每個頁面分頁允許控制多少個對象返回。它添加以下行到settings.py
REST_FRAMEWORK = {
'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
'PAGE_SIZE': 10
}
5、配置Settings
添加 'rest_framework' to INSTALLED_APPS.。設置settings.py
INSTALLED_APPS = [ ... 'rest_framework',]
6、測試API(容器內，容器外使用8080端口)
$ curl -H 'Accept: application/json; indent=4' -u root:Root123456 http://127.0.0.1:8000/api/articles/
{
"count": 5,
"next": null,
"previous": null,
"results": [
{
"title": "test4",
"text": "test4",
"author": 1
},
{
"title": "test3",
"text": "test3",
"author": 1
},
{
"title": "test2",
"text": "test2",
"author": 1
},
{
"title": "test1",
"text": "test1",
"author": 1
},
{
"title": "test6",
"text": "test6",
"author": 1
}
]
}
或直接通過瀏覽器,通過訪問URLhttp://127.0.0.1:8080/api/articles/.(容器外部)..
五、使用git做版本控制
$ git init
Initialized empty Git repository in ~/djangogirls/.git/#建立git倉庫
$ git config --global user.name "Your Name"
$ git config --global user.email you@example.com
建立.gitignore文件用于git忽略一些文件
*.pyc
__pycache__
myvenv
db.sqlite3
mysql_data
可以使用git status來查看
然后做添加并確認準備上傳到github的文件
$ git add --all .
$ git commit -m "My Django app, first commit"
創建gitee倉庫myApp（不要初始化否則與本地不同步），拷貝github倉庫接口 https://gitee.com/njbinbin/myApp.git
連接本地git倉庫和github倉庫，上傳本地git倉庫代碼到github倉庫使用push
連接本地git倉庫和github倉庫
$ git remote add origin https://gitee.com/njbinbin/myApp.git
上傳本地git倉庫到github倉庫
$ git push -u origin master
# 后續更新倉庫
git status
git add --all .
# 綠色顯示準備上傳文件
git status
git commit -m "Some messages."
# 上傳到github倉庫
git push
六、小結
面向任務完成的工作，面對兩個龐大的框架，其實完全不了解其ORM，Serializer的機制，憑網上幾個例子去猜丟什么樣的代碼進去會生成什么樣的數據庫結構，吐出來什么樣的JSON。框架的學習比語言本身要難多了，尤其是不知道設計者的思想，不知道其創造出來的各種新術語，借用的各種模式目的是解決什么問題。而從quickstart開始的文檔和網上各種文章，往往就是人云亦云地丟一段代碼證明跑通了這個任務。動不動就Talk is cheap, show me the code。。。我倒是覺得多些Talk剖析一下原理與設計思路，比秀一段能跑的代碼強得多。
另外，上面的例子只能證明框架按基本的模式可以運行了，認證和安全性相關的機制也沒有考慮，因為我還沒看到那么細的資料。這個DEMO不能作為一個新項目的起點。
有時間研究下Flask，據說相對簡潔。
