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代碼

 1 # coding:utf-8
 2 from flask import Flask, request, jsonify
 3 from model import User, db_session
 4 import hashlib
 5 import time
 6 import redis
 7 
 8 app = Flask(__name__)
 9 redis_store = redis.Redis(host='localhost', port=6380, db=4, password='dahai123')
10 
11 
12 @app.route('/')
13 def hello_world():
14     return 'Hello World!'
15 
16 
17 @app.route('/login', methods=['POST'])
18 def login():
19     phone_number = request.get_json().get('phone_number')
20     password = request.get_json().get('password')
21     user = User.query.filter_by(phone_number=phone_number).first()
22     if not user:
23         return jsonify({'code': 0, 'message': '沒有此用戶'})
24 
25     if user.password != password:
26         return jsonify({'code': 0, 'message': '密碼錯誤'})
27 
28     m = hashlib.md5()
29     m.update(phone_number)
30     m.update(password)
31     m.update(str(int(time.time())))
32     token = m.hexdigest()
33 
34     redis_store.hmset('user:%s' % user.phone_number, {'token': token, 'nickname': user.nickname, 'app_online': 1})
35     redis_store.set('token:%s' % token, user.phone_number)
36     redis_store.expire('token:%s' % token, 3600*24*30)
37 
38     return jsonify({'code': 1, 'message': '成功登陸', 'nickname': user.nickname, 'token': token})
39 
40 
41 @app.route('/user')
42 def user():
43     token = request.headers.get('token')
44     if not token:
45         return jsonify({'code': 0, 'message': '須要驗證'})
46     phone_number = redis_store.get('token:%s' % token)
47     if not phone_number or token != redis_store.hget('user:%s' % phone_number, 'token'):
48         return jsonify({'code': 2, 'message': '驗證信息錯誤'})
49 
50     nickname = redis_store.hget('user:%s' % phone_number, 'nickname')
51     return jsonify({'code': 1, 'nickname': nickname, 'phone_number': phone_number})
52 
53 
54 @app.route('/logout')
55 def logout():
56     token = request.headers.get('token')
57     if not token:
58         return jsonify({'code': 0, 'message': '須要驗證'})
59     phone_number = redis_store.get('token:%s' % token)
60     if not phone_number or token != redis_store.hget('user:%s' % phone_number, 'token'):
61         return jsonify({'code': 2, 'message': '驗證信息錯誤'})
62 
63     redis_store.delete('token:%s' % token)
64     redis_store.hmset('user:%s' % phone_number, {'app_online': 0})
65     return jsonify({'code': 1, 'message': '成功註銷'})
66 
67 
68 @app.teardown_request
69 def handle_teardown_request(exception):
70     db_session.remove()
71 
72 if __name__ == '__main__':
73     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有很好的測試軟件；其次用小腳本方式測試，既然咱們之後要不停的寫例子，就用小腳本測試吧，過程也很是簡單。

 1 # coding:utf-8
 2 import requests
 3 import json
 4 
 5 
 6 class APITest(object):
 7     def __init__(self, base_url):
 8         self.base_url = base_url
 9         self.headers = {}
10         self.token = None
11 
12     def login(self, phone_number, password, path='/login'):
13         payload = {'phone_number': phone_number, 'password': password}
14         self.headers = {'content-type': 'application/json'}
15         response = requests.post(url=self.base_url + path, data=json.dumps(payload), headers=self.headers)
16         response_data = json.loads(response.content)
17         self.token = response_data.get('token')
18         return response_data
19 
20     def user(self, path='/user'):
21         self.headers = {'token': self.token}
22         response = requests.get(url=self.base_url + path, headers=self.headers)
23         response_data = json.loads(response.content)
24         return response_data
25 
26     def logout(self, path='/logout'):
27         self.headers = {'token': self.token}
28         response = requests.get(url=self.base_url + path, headers=self.headers)
29         response_data = json.loads(response.content)
30         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只設置到一半怎麼辦？這些問題，咱們下一章繼續解決。