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='', password='', 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('', '')
>>> print data.get('message')
密码错误
>>> data = api.login('', '')
>>> print data.get('message')
成功登录
>>> data = api.user()
>>> print data
{u'phone_number': u'', u'code': , u'nickname': u'\u6d4b\u8bd5\u7528\u62371'}
>>> print nickname
Traceback (most recent call last):
File "<input>", line , 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': }
>>> print message
Traceback (most recent call last):
File "<input>", line , in <module>
NameError: name 'message' is not defined
>>> print data.get('message')
成功注销
登录成功的时候,我们进redis看看redis数据格式,比较直观点。
127.0.0.1:[]> keys *
) "token:bbf73ab651a13a5bc5601cf01add2564"
) "user:12345678901"
127.0.0.1:[]> hgetall user:
) "token"
) "bbf73ab651a13a5bc5601cf01add2564"
) "nickname"
) "\xe6\xb5\x8b\xe8\xaf\x95\xe7\x94\xa8\xe6\x88\xb71"
) "app_online"
) ""
127.0.0.1:[]> get token:bbf73ab651a13a5bc5601cf01add2564
""
127.0.0.1:[]>
嗯,一切都正常,但我们开发不能一切正常,就满足。就这些代码,我们有很多需要改进的地方,尤其是验证token的那边,是不是可以改进呢?redis设置的时候,一连串动作,如果这时候出错,或者redis只设置到一半怎么办?这些问题,我们下一章继续解决。
flask开发restful api系列(1)的更多相关文章
- flask开发restful api系列(8)-再谈项目结构
上一章,我们讲到,怎么用蓝图建造一个好的项目,今天我们继续深入.上一章中,我们所有的接口都写在view.py中,如果几十个,还稍微好管理一点,假如上百个,上千个,怎么找?所有接口堆在一起就显得杂乱无章 ...
- flask开发restful api系列(7)-蓝图与项目结构
如果有几个原因可以让你爱上flask这个极其灵活的库,我想蓝图绝对应该算上一个,部署蓝图以后,你会发现整个程序结构非常清晰,模块之间相互不影响.蓝图对restful api的最明显效果就是版本控制:而 ...
- flask开发restful api系列(6)-配置文件
任何一个好的程序,配置文件必不可少,而且非常重要.配置文件里存储了连接数据库,redis的用户密码,不允许有任何闪失.要有灵活性,用户可以自己配置:生产环境和开发环境要分开,最好能简单的修改一个东西, ...
- flask开发restful api系列(5)-短信验证码
我们现在开发app,注册用户的时候,不再像web一样,发送到个人邮箱了,毕竟个人邮箱在移动端填写验证都很麻烦,一般都采用短信验证码的方式.今天我们就讲讲这方面的内容. 首先,先找一个平台吧.我们公司找 ...
- flask开发restful api系列(4)--七牛图片服务
上一章我们讲到如何利用alembic来更新数据库,这章,我们讲如何通过七牛服务来存储图片. 像我们大多数公司一样,公司资金比较少,如果自己开发图片服务器,代价太大:如果我们用自己的网站服务器来保存图片 ...
- flask开发restful api系列(3)--利用alembic进行数据库更改
上面两章,主要讲基本的配置,今天我们来做一个比较有趣的东西,为每个客户加一个头像图片.如果我们图片保存在自己的服务器,对于服务器要求有点高,每次下载的时候,都会阻塞网络接口,要是1000个人同时访问这 ...
- flask开发restful api系列(2)
继续上一章所讲,上一章我们最后面说道,虽然这个是很小的程序,但还有好几个要优化的地方.先复制一下老的view.py代码. # coding:utf-8 from flask import Flask, ...
- flask开发restful api
flask开发restful api 如果有几个原因可以让你爱上flask这个极其灵活的库,我想蓝图绝对应该算上一个,部署蓝图以后,你会发现整个程序结构非常清晰,模块之间相互不影响.蓝图对restfu ...
- 描述怎样通过flask+redis+sqlalchemy等工具,开发restful api
flask开发restful api系列(8)-再谈项目结构 摘要: 进一步介绍flask的项目结构,使整个项目结构一目了然.阅读全文 posted @ 2016-06-06 13:54 月儿弯弯02 ...
随机推荐
- Android中的手势
Android对两种手势行为提供了支持:1.对于第一种手势行为而言,Android提供了手势检测,并为手势检测提供了相应的监听器.2.对于第二种手势行为,Android允许开发者添加手势,并提供了相应 ...
- bootstrap 动态添加验证项和取消验证项
bootstrap 中的bootstrapValidator可以对前端的数据进行验证,但是有的时候我们需要动态的添加验证,这样需要我们动态的对bootstrapValidator的内容做修改. 传统的 ...
- GF(2^8)乘法
最近在学AES,实现了一下伽罗瓦域(2^8)乘法. 至于什么是伽罗瓦域解释起来比较复杂,我也不一定能解释清楚,自行google.这里只是给出一个简单直观的实现. #include<iostrea ...
- 简单CSS定位瀑布流实现方法
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/ ...
- ORCL_INSTALL_WIN10
0.相关问题 INS-13001环境不满足最低要求: Win10下安装Oracle11g 不满足配置解决方法如下: 原因:Oracle 在发布 11g时,Winodws 10还没有发布.所以Oracl ...
- C#request 请求响应
/// <summary> /// 提交POST请求 /// </summary> /// <param name="url">提交地址< ...
- pods 这两篇就够了
http://www.cnblogs.com/gongyuhonglou/p/5801681.html http://blog.csdn.net/iunion/article/details/1701 ...
- JS中undefined与null的区别
1.概述: 在JavaScript中存在这样两种原始类型:Null与Undefined.这两种类型常常会使JavaScript的开发人员产生疑惑,在什么时候是Null,什么时候又是Undefined? ...
- 查看android进程信息
打开adb shell.直接ps命令 假设查看某特定进程,比方<圣火英雄传>.用grep过滤 各列參数意义: USER 进程当前用户: PID Pro ...
- Socket tips: UDP Echo service - Server code
#include <stdio.h> #include <stdlib.h> #include <sys/types.h> #include <sys/soc ...