flask開發restful api系列(1)

　　在此之前，向大家說明的是，我們整個框架用的是flask + sqlalchemy + redis。如果沒有開發過web，還是先去學習一下，這邊只是介紹如果從開發web轉換到開發移動端。如果flask還不是很熟悉，我建議先到這個網站簡單學習一下，非常非常簡單。http://dormousehole.readthedocs.org/en/latest/ 

　　一直想寫一些特別的東西，能讓大家學習討論的東西。但目前網上的很多博客，老么就按照官方文檔照本宣讀，要么直接搬代碼，什么都不說明。我寫這個系列的博客，讓大家由淺入深，一步一步走向復雜結構，以及為啥要這么走，其他方式可不可以等等。

　　目前看來，移動開發最火，而我們python最適合開發移動的就是flask web框架，這款web框架非常清晰，可以簡單用，可以復雜用。最簡單的時候，一個py文件，就可以做一個項目；復雜的時候，利用藍圖，做各種版本控制，代碼結構自己完全控制，非常自由。

　　首先，我們要知道，目前我們移動開發基本都在用restful api，什么是restful api呢？百度百科一下：Web 應用程序最重要的 REST 原則是，客戶端和服務器之間的交互在請求之間是無狀態的。從客戶端到服務器的每個請求都必須包含理解請求所必需的信息。如果服務器在請求之間的任何時間點重啟，客戶端不會得到通知。此外，無狀態請求可以由任何可用服務器回答，這十分適合雲計算之類的環境。客戶端可以緩存數據以改進性能。

　　說白了我們不能使用cookie，不能使用session了。如果稍微有點http經驗的人，都知道，很多時候，我們都把一些基本內容放在cookie里面，服務器每次讀取或者寫入的時候，服務器端就直接設置session就可以了，這樣，每次，客戶端直接攜帶自己的cookie值上來，我們就知道它是誰，怎么把數據給它。但restful api的風格不允許這樣，那服務器應該采取何種方案呢？

　　目前網上大多數做法是token方式，第一次登錄的時候，先提交用戶名密碼，服務器收集到以后，先驗證一下，如果驗證通過了，這時候服務器端基於用戶名、密碼、當前時間戳等內容，用md5或者des或者aes等加密方式，生成一個token值，然后把token值存放到redis里面，記錄它對應哪個用戶，然后把這個token值發給客戶端。客戶端收到token值以后，下次訪問服務器端任何接口的時候，直接攜帶這個token，服務器端就知道它是誰了，該給它什么數據。哪以何種方式給服務器端呢？通常的做法就是把token值放在header里面。當然這個不是絕對，你也可以放在body里面，這個都是仁者見仁智者見智的事。好了，我們就先放在header頭里面。

　　以上說了這么多，大家也煩了，直接上代碼，再解釋吧。

　　首先，創建整個工程，為了最簡單，方便，我們直接就保留以下的py文件。

　　 

　　看model.py里面的代碼：

　　

# coding:utf-8
from sqlalchemy import create_engine, ForeignKey, Column, Integer, String, Text, DateTime,\
    and_, or_, SmallInteger, Float, DECIMAL, desc, asc, Table, join, event
from sqlalchemy.orm import relationship, backref, sessionmaker, scoped_session, aliased, mapper
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.ext.hybrid import hybrid_property, hybrid_method
from sqlalchemy.orm.collections import attribute_mapped_collection
import datetime

engine = create_engine("mysql://root:a12345678@127.0.0.1:3306/blog01?charset=utf8", pool_recycle=7200)

Base = declarative_base()

db_session = scoped_session(sessionmaker(autocommit=False,
                                         autoflush=False,
                                         bind=engine))

Base.query = db_session.query_property()


class User(Base):
    __tablename__ = 'user'

    id = Column('id', Integer, primary_key=True)
    phone_number = Column('phone_number', String(11), index=True)
    password = Column('password', String(30))
    nickname = Column('nickname', String(30), index=True, nullable=True)
    register_time = Column('register_time', DateTime, index=True, default=datetime.datetime.now)


if __name__ == '__main__':
    Base.metadata.create_all(engine)

運行一下，就創建user表了。

user表中，有電話號碼，phone_number；密碼，password；昵稱，nickname；register_time，注冊時間

　　下面是view.py代碼

# coding:utf-8
from flask import Flask, request, jsonify
from model import User, db_session
import hashlib
import time
import redis

app = Flask(__name__)
redis_store = redis.Redis(host='localhost', port=6380, db=4, password='dahai123')


@app.route('/')
def hello_world():
    return 'Hello World!'


@app.route('/login', methods=['POST'])
def login():
    phone_number = request.get_json().get('phone_number')
    password = request.get_json().get('password')
    user = User.query.filter_by(phone_number=phone_number).first()
    if not user:
        return jsonify({'code': 0, 'message': '沒有此用戶'})

    if user.password != password:
        return jsonify({'code': 0, 'message': '密碼錯誤'})

    m = hashlib.md5()
    m.update(phone_number)
    m.update(password)
    m.update(str(int(time.time())))
    token = m.hexdigest()

    redis_store.hmset('user:%s' % user.phone_number, {'token': token, 'nickname': user.nickname, 'app_online': 1})
    redis_store.set('token:%s' % token, user.phone_number)
    redis_store.expire('token:%s' % token, 3600*24*30)

    return jsonify({'code': 1, 'message': '成功登錄', 'nickname': user.nickname, 'token': token})


@app.route('/user')
def user():
    token = request.headers.get('token')
    if not token:
        return jsonify({'code': 0, 'message': '需要驗證'})
    phone_number = redis_store.get('token:%s' % token)
    if not phone_number or token != redis_store.hget('user:%s' % phone_number, 'token'):
        return jsonify({'code': 2, 'message': '驗證信息錯誤'})

    nickname = redis_store.hget('user:%s' % phone_number, 'nickname')
    return jsonify({'code': 1, 'nickname': nickname, 'phone_number': phone_number})


@app.route('/logout')
def logout():
    token = request.headers.get('token')
    if not token:
        return jsonify({'code': 0, 'message': '需要驗證'})
    phone_number = redis_store.get('token:%s' % token)
    if not phone_number or token != redis_store.hget('user:%s' % phone_number, 'token'):
        return jsonify({'code': 2, 'message': '驗證信息錯誤'})

    redis_store.delete('token:%s' % token)
    redis_store.hmset('user:%s' % phone_number, {'app_online': 0})
    return jsonify({'code': 1, 'message': '成功注銷'})


@app.teardown_request
def handle_teardown_request(exception):
    db_session.remove()

if __name__ == '__main__':
    app.run(debug=True, host='0.0.0.0', port=5001)

 

下面來逐個解釋一下，

首先，幾個import不用解釋了，注意把User和db_session 都import過來，然后定義一個redis的connection。

再接下來就login接口，直接post方法，獲取json格式數據，里面有phone_number和password，接下來，數據庫查詢，如果沒有這個用戶，返回一個json格式，再接下來對比password，如果phone_number和password都正確，就用md5函數，生成一個token，這個token包含由phone_number、password、當前時間戳str(int(time.time()))生成，再返回。

看我每個返回的東西，首先，都是json格式，這個是目前大多數移動開發默認返回的格式；其次，每個返回，必定有個code，目前這邊有2個值，是0和1，其實可以看出來，0代表失敗，1代表成功，有0的地方必定要有message。每個返回一個code是必須的，但是值，可以自己定義。很多開發把http的code直接拿來用，也可以，比如成功返回，就200，沒有就404，禁止就403。這些都可以，只要服務器端開發和客戶端開發開始就約定一個值就好，具體的值，只要能快速開發，都可以。

好了，返回格式先解釋到這，我們以后會繼續擴展。再看接下來的redis。

第一行，先用 user:13765505223 這種類型的作為每個用戶的key，值是一些基本的東西，其中app_online，代表上線了，這個app_online，其實很重要的，因為移動端開發跟web不同，要記錄移動端在登錄狀態，還是登出狀態。如果在登錄狀態，我們就可以從服務器推送了，關於推送，我們以后會逐步講，這個先放在這邊。

第二行，用token:token 作為key，key里面的值是具體的用戶電話號碼

第三行，把這個token設置一個過期時間，超過這個時間，就刪除，這個有需要的app可以設置一下。如果你的app的token想永遠不變，這行代碼可以注釋掉。

好了，目前login函數基本完成。

接下來看驗證函數user，和注銷函數logout，

user這個函數，這是來驗證登錄以后，有沒有數據，沒多少意義。

逐行分析，首先在header里找到這個token，如果沒有token，就返回失敗；其次，驗證redis，如果token所在的key value對里面沒有值或者值錯誤，則返回失敗。然后返回具體的數據。非常簡單的一個函數。

下面的logout函數也差不多，也是這樣，也是驗證，然后刪除token的key value對，再設置app_online為0，表示當前是注銷狀態。

最后一個很重要，這邊一定要記住，把這個函數寫上。如果沒有這個函數，每一個會話以后，db_session都不會清除，很多時候，數據庫改變了，前台找不到，或者明明已經提交，數據庫還是沒有更改，或者長時間沒有訪問接口，mysql gong away，這樣的錯誤。總之，一定要加上。

好了，整個過程已經完成，下面進入驗證狀態。首先我們在外面新建一個用戶，存到數據庫，然后寫個小腳本驗證一下。

>>> from model import User, db_session
>>> new_user = User(phone_number='12345678901', password='123456', nickname=u'測試用戶1')
>>> db_session.add(new_user)
>>> db_session.commit()

一個用戶已經創建好，接下來就是測試，這邊測試有2種方式，一個用IDE自帶的測試軟件測試，pycharm有很好的測試軟件；其次用小腳本方式測試，既然我們以后要不停的寫例子，就用小腳本測試吧，過程也非常簡單。

# coding:utf-8
import requests
import json


class APITest(object):
    def __init__(self, base_url):
        self.base_url = base_url
        self.headers = {}
        self.token = None

    def login(self, phone_number, password, path='/login'):
        payload = {'phone_number': phone_number, 'password': password}
        self.headers = {'content-type': 'application/json'}
        response = requests.post(url=self.base_url + path, data=json.dumps(payload), headers=self.headers)
        response_data = json.loads(response.content)
        self.token = response_data.get('token')
        return response_data

    def user(self, path='/user'):
        self.headers = {'token': self.token}
        response = requests.get(url=self.base_url + path, headers=self.headers)
        response_data = json.loads(response.content)
        return response_data

    def logout(self, path='/logout'):
        self.headers = {'token': self.token}
        response = requests.get(url=self.base_url + path, headers=self.headers)
        response_data = json.loads(response.content)
        return response_data

 

寫一個很簡單的小腳本，就可以拉到命令行測試了，我們試試吧。

>>> from client import APITest
>>> api = APITest('http://127.0.0.1:5001')
>>> data = api.login('12345678901', '1234567')
>>> print data.get('message')
密碼錯誤
>>> data = api.login('12345678901', '123456')
>>> print data.get('message')
成功登錄
>>> data = api.user()
>>> print data
{u'phone_number': u'12345678901', u'code': 1, u'nickname': u'\u6d4b\u8bd5\u7528\u62371'}
>>> print nickname
Traceback (most recent call last):
  File "<input>", line 1, in <module>
NameError: name 'nickname' is not defined
>>> print data.get('nickname')
測試用戶1
>>> data = api.logout()
>>> print data
{u'message': u'\u6210\u529f\u6ce8\u9500', u'code': 1}
>>> print message
Traceback (most recent call last):
  File "<input>", line 1, in <module>
NameError: name 'message' is not defined
>>> print data.get('message')
成功注銷

 登錄成功的時候，我們進redis看看redis數據格式，比較直觀點。

127.0.0.1:6380[4]> keys *
1) "token:bbf73ab651a13a5bc5601cf01add2564"
2) "user:12345678901"
127.0.0.1:6380[4]> hgetall user:12345678901
1) "token"
2) "bbf73ab651a13a5bc5601cf01add2564"
3) "nickname"
4) "\xe6\xb5\x8b\xe8\xaf\x95\xe7\x94\xa8\xe6\x88\xb71"
5) "app_online"
6) "1"
127.0.0.1:6380[4]> get token:bbf73ab651a13a5bc5601cf01add2564
"12345678901"
127.0.0.1:6380[4]> 

 

嗯，一切都正常，但我們開發不能一切正常，就滿足。就這些代碼，我們有很多需要改進的地方，尤其是驗證token的那邊，是不是可以改進呢？redis設置的時候，一連串動作，如果這時候出錯，或者redis只設置到一半怎么辦？這些問題，我們下一章繼續解決。