python 爲 mysql 實現 restful 接口的詳細步驟代碼

restful一種軟件架構風格,設計風格而不是標准,只是提供了一組設計原則和約束條件。它主要用于客戶端和伺服器交互類的軟件。現在我們來講講用 python 爲 mysql 實現 restful 接口。

最近在做遊戲服務分層的時候,一直想把mysql的訪問獨立成一個單獨的服務DBGate,原因如下:
請求收攏到DBGate,可以使DBGate變爲無狀態的,方便橫向擴展
當請求量或者存儲量變大時,mysql需要做分庫分表,DBGate可以內部直接處理,外界無感知
通過restful限制對數據請求的形式,僅支持簡單的get/post/patch/put 進行增刪改查,並不支持複雜查詢。這個也是和遊戲業務的特性有關,如果網站等需要複雜查詢的業務,對此並不適合
DBGate使用多進程模式,方便控制與mysql之間的鏈接數,進行mysql訪問量閥值保護
方便在DBGate上進行訪問量統計,慢查詢統計、權限控制等等一系列邏輯
目前是使用python,以後要使用其他語言進行mysql操作時,只要進行標准的http請求即可,不會出現不兼容的情況
當然壞處也是有的:
首當其沖就是單次請求的回應時間變長,畢竟中間加了一層服務,並且還是http格式
部署上比原來複雜了一些,很多對mysql直接操作的思維需要進行轉變,一開始可能會有些不適
不過總的來說,還是利大于弊,所以最終還是決定搭建DBGate
當然,我們不可能去手工挨個寫每個庫表對應的restful服務,值得慶幸的是django和flask都提供了對應的解決方案,我們一個個介紹.

Flask

參考鏈接: http://flask-restless.readthedocs.org/en/latest/
flask-restless使用方法比較簡單,我直接貼一下代碼即可:
# -*- coding: utf-8 -*-
import datetime
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_restless import APIManager
app = Flask(__name__)
db = SQLAlchemy(app)
restless = APIManager(app, flask_sqlalchemy_db=db)
class User(db.Model):
"""
user
"""
id = db.Column(db.Integer, primary_key=True)
username = db.Column(db.String(255), unique=True, nullable=False)
password = db.Column(db.String(255), nullable=False)
create_time = db.Column(db.DateTime, nullable=False, default=datetime.datetime.utcnow)
login_time = db.Column(db.DateTime)
restless.create_api(User, methods=['GET', 'POST', 'DELETE', 'PATCH', 'PUT'], results_per_page=100)
db.create_all()
if __name__ == '__main__':
app.run(port=25000)
其對應的restful操作如下:
獲取用戶列表: GET /user
添加用戶: POST /user
獲取單個用戶: GET /user/1
覆蓋單個用戶: PUT /user/1
修改單個用戶: PATCH /user/1
注意:
在http請求中,記得加入header: Content-Type: application/json
flask-restless中,PUT和PATCH一樣,都是傳入什麽字段,只修改什麽字段,不會完全覆蓋
Django
參考鏈接: Django REST framework
Django用起來要更複雜一些,也因爲django版自帶了一個可視化的操作頁面,如下:

python 爲 mysql 實現 restful 接口的詳細步驟代碼

1. 在settings中添加:
REST_FRAMEWORK = {
# Use hyperlinked styles by default.
# Only used if the `serializer_class` attribute is not set on a view.
'DEFAULT_MODEL_SERIALIZER_CLASS':
'rest_framework.serializers.HyperlinkedModelSerializer',
# Use Django's standard `django.contrib.auth` permissions,
# or allow read-only access for unauthenticated users.
'DEFAULT_PERMISSION_CLASSES': [
#'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly',
'rest_framework.permissions.IsAdminUser',
]
}
2. 通過startapp建立一個app: demo
3. 修改demo的models:
class User(models.Model):
# key是保留字
password = models.IntegerField()
nick = models.CharField(max_length=255)
create_time = models.DateTimeField(default=datetime.datetime.now)
4. 在demo下新建serializers.py
from rest_framework import serializers
from models import User
class UserSerializer(serializers.ModelSerializer):
class Meta:
model = User
5. 在demo下修改views.py
from django.shortcuts import render
from rest_framework import viewsets
from serializers import UserSerializer
from models import User
class UserViewSet(viewsets.ModelViewSet):
queryset = User.objects.all()
serializer_class = UserSerializer

6. 在demo下新建urls.py

import os.path
from django.conf.urls import patterns, include, url
from django.conf.urls.static import static
from django.conf import settings
import views
from rest_framework import routers
appname = os.path.basename(os.path.dirname(os.path.abspath(__file__)))
router = routers.DefaultRouter()
router.register('users', views.UserViewSet, appname)
urlpatterns = patterns('',
url(r'^', include(router.urls)),
)
7. 在mysite.urls下include demo.urls和rest_framework.urls
urlpatterns = patterns('',
url(r'^demo/', include('demo.urls')),
url(r'^admin/', include(admin.site.urls)),
url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
)
8. 執行初始化數據操作:
python manage.py syncdb
之後訪問: http://127.0.0.1:8000/demo 即可看到如下界面了:

python 爲 mysql 實現 restful 接口的詳細步驟代碼

對應的測試代碼如下:
import json
import requests
from urlparse import urljoin
BASE_URL = 'http://127.0.0.1:16500/'
AUTH = ('admin', 'admin')
def test_get_user_list():
rsp = requests.get(urljoin(BASE_URL, '/demo/users/'), auth=AUTH, headers={
'Accept': 'application/json'
})
assert rsp.ok
def test_post_user_list():
json_data = dict(
password=0,
nick='oo',
create_time='2014-03-3T03:3:3'
)
rsp = requests.post(urljoin(BASE_URL, '/demo/users/'), auth=AUTH, headers={
'Accept': 'application/json',
'Content-Type': 'application/json',
}, data=json.dumps(json_data))
assert rsp.ok
def test_get_user():
rsp = requests.get(urljoin(BASE_URL, '/demo/users/1'), auth=AUTH, headers={
'Accept': 'application/json',
'Content-Type': 'application/json',
})
assert rsp.ok
def test_put_user():
json_data = dict(
password=100,
nick='xx',
create_time='2014-03-3T03:3:3'
)
# 注意最後的 /
rsp = requests.put(urljoin(BASE_URL, '/demo/users/1/'), auth=AUTH, headers={
'Accept': 'application/json',
'Content-Type': 'application/json',
}, data=json.dumps(json_data),
)
assert rsp.ok, rsp.status_code
def test_patch_user():
json_data = dict(
password=300,
)
rsp = requests.patch(urljoin(BASE_URL, '/demo/users/1/'), auth=AUTH, headers={
'Accept': 'application/json',
'Content-Type': 'application/json',
}, data=json.dumps(json_data),
)
assert rsp.ok, rsp.status_code
Django REST framework 是嚴格區分PUT和PATCH的,這一點和flask-restless 不一樣,需要注意。
OK,就這樣。

更多相關文章
  • javascript 實現checkbox全選和全不選代碼總結,有需要的朋友可參考一下本文章.代碼分析html代碼 代碼如下 <form name="myform" method="post" id="myform"
  • ubuntu安裝好無線網卡後,我們配置好ppp就可以實現無線上網,本文是我們配置ppp的詳細步驟,只要我們按照這些步驟操作就沒問題.我們參考下面步驟配置好ppp後就可以實現無線上網了.第一步:#nano /etc/n
  • 這裏我們使用js來模仿Lightbox效果做的一個彈出對話框效果代碼,原理很簡單:利用DIV的浮動和層的重疊,將對話框的Z-index設置爲最高就可以了另外對于遮罩層來說,只要使遮罩層在對話框層之下,其他頁面元素之上
  • bootstrap+flask+mysql實現網站查詢程序代碼
    小編整理了不少的關于bootstrap+flask+mysql的相關例子,今天我們再來看一個bootstrap+flask+mysql實現網站查詢程序,希望對各位有用.一.需求通過 bootstrap(ajax) + flask + mysql 實現一個簡單的web查詢頁面.當輸出身份ID信息後,可
  • 下面小編來爲各位介紹一篇關于python用TKinter實現的一個簡版HTTP請求模擬器例子,雖然不是很好用我們可以一起來看看.平時開發過程中經常會遇到需要模擬POST或GET請求的時候,當然GET一般直接通過浏覽器也可以,方便快捷.鄭曉看到網上也有不少軟件版的HTTP模擬器,功能也非常強大.鄭曉最 ...
  • Python用rpc實現分布式系統調用的原理及實例
    RPC(Remote Procedure Call Protocol)遠程過程調用協定,它是一種通過網路從遠程計算機程序上請求服務,而不需要了解底層網路技術的協定.本文我們來講講Python用rpc實現分布式系統調用.rpc概念?rpc 一般俗稱,遠程過程調用,把本地的函數,放到遠端去調用.通常我們 ...
  • 蘋果iPhone 5S A1533美版iOS8.3不越獄實現電信4G詳解
    本文章來爲各位介紹蘋果iPhone 5S A1533美版iOS8.3不越獄實現電信4G詳解
  • 本文章來給各位同學介紹一篇關于linux下的mysql安裝(詳細rpm.源碼以及二進制版本安裝) 教程,希望此方法能給大家帶來小小幫助.Linux下的mysql安裝一.mysql 的版本1.二進制版2.源碼版 名字中含有hrc作爲標識=================================
一周排行