了解Flask并实现简单的HTTP请求

结合我们822实验室开源的图像处理平台(http://822lab.top)介绍Flask后端开发,供后续学弟学妹参考,整个平台的从零搭建记录在这里,后端仓库在这里,前端仓库在这里,欢迎大家为平台做贡献。


Flask是一个python web微框架,也是刚开始接触,入门服务器端框架并能快速搭建好一个简单的服务器端程序是有套路的,当然,服务器开发并不那么简单,是需要持续更新的,到底好不好,还有哪些地方需要重构需要加强,是需要把烂项目放到线上跑一跑才知道的。

快速入门和搭建简单服务器端的套路如下:

  • 找到文档中的hello world demo
  • 看如何接收http请求(路由)
  • 看如何连接数据库
  • 看如何部署

如果不是前后端分离的应用,则还需要看:

  • 静态文件管理

找到文档中的hello world demo

框架的官方网站一定都有文档,一般user guide里都能找到hello world demo。
Flask的英文版文档在这里,中文版在这里,其实文档都已经写的非常全了,这里会结合平台的需求写一下实现。

  • 安装
    Linux或Mac都有系统自带的python,但是不建议把依赖都装在系统中,如果玩坏了系统可能就瘫了,而且每个项目的依赖都不一样,因此建议在电脑上安装Anaconda或者virtualenv,它们都可以为每个项目创建一个虚拟环境,在环境内安装所需要的依赖,这种环境管理迁移之类的都很方便。Anaconda直接到官网下载,virtualenv安装如下:
    pip install virtualenv
    

然后创建一个项目环境,进入到环境并安装依赖。

  • Anaconda
    #创建环境
    conda create -n py2 python=2.7  # py2替换为自己的环境名称
    #激活环境
    source activate py2 # windows不用加source
    #安装依赖
    conda install Flask #或者用pip,如:
    pip install Flask 
    #退出环境
    source deactivate # windows不用加source
    
  • virtualenv
#创建环境
mkdir myproject
cd myproject
python3 -m venv venv
py -3 -m venv venv #windows
#在老版本的 Python 中要使用下面的命令创建虚拟环境:

virtualenv venv
#在 Windows 下:
\Python27\Scripts\virtualenv.exe venv
#激活相应环境:
. venv/bin/activate
#在 Windows 下:
venv\Scripts\activate
# 安装依赖
pip install Flask
# 退出环境
deactivate
  • 在pycharm中创建一个Flask项目
    create a project

    创建好后会看到
    hello world

    直接点箭头运行,在http://127.0.0.1:5000/就可以看到hello world。
    如果开启debug模式,则将app.run()改为app.run(debug=True)

看如何接收http请求(路由)

跑起来hello world就说明安装之类的不存在问题了,下面就需要看路由和http方法如何接收。
一般会看

  • url怎么绑定
  • 带变量的url怎么解析
  • HTTP方法怎么接收

hello world的例子中,前端的请求url是http://127.0.0.1:5000/,最后一个/对应@app.route('/'),如果想请求http://127.0.0.1:5000/hello出现hello world,则将@app.route('/')改为@app.route('/hello')

@app.route('/')
def index():
    return 'Index Page'

@app.route('/hello')
def hello():
    return 'Hello, World'

带有变量的url怎么解析呢

@app.route('/user/<username>')
def show_user_profile(username):
    # show the user profile for that user
    return 'User %s' % username

@app.route('/post/<int:post_id>')
def show_post(post_id):
    # show the post with the given id, the id is an integer
    return 'Post %d' % post_id

HTTP方法怎么接收呢

一般前后端通信约定的数据格式都是json,服务器端返回json需要用jsonify(),如果是post请求,需要获取请求体,可以用json.loads(request.get_data()),如下例:

POST请求为

  • url: /imgproc/lab
  • request:
{
  operations: [{
    code: 'string',
    params: [],
    image: 'string'
  }]
}
  • response:
{
  result: 1,
  message: {
    image:'string',
    log: 'string'
   }
}

代码为

@app.route('/imgproc/lab', methods=['GET', 'POST'])
def img_proc_lab():
    if request.method == 'GET':
        messages = [{'type':1, subType:2},{'type':2, subType:3}]
        return jsonify({'result': 1, 'message': messages})
    else:
        request_body = json.loads(request.get_data())
        operation = request_body['operations'][0]

        o_code = operation['code']
        o_params = operation['params']
        image_base64 = request_body['image']
        """do something"""
        message = dict({'image': 'base64_data', 'log': 'log'})
        return jsonify({'result': 1, 'message': message})

flask连接mongodb数据库

项目使用的数据库是mongodb,通过mongoengine连接数据,需要先安装mongoengine,文档在这里

pip install flask-mongoengine

然后在app创建语句后加入下面代码:

from flask_mongoengine import MongoEngine

app.config['MONGODB_SETTINGS'] = {
    'db': 'lab822',
    'host': '127.0.0.1',
    'port': 27017
}
db = MongoEngine(app)

在另一个文件中写数据库的model,更多的字段类型可以查看文档

from app import db
class ImgOperation(db.Document):
    name = db.StringField(required=True)
    code = db.StringField(required=True)
    type = db.ListField(db.EmbeddedDocumentField('ImgType'))
    params = db.ListField(db.EmbeddedDocumentField('ImgParam'))
class ImgType(Document):
    name = StringField(required=True)
class ImgParam(Document):
    type = StringField(required=True)
    name = StringField(required=True)
    value = ListField()
    limit = StringField()
    pName = StringField()

数据的增删查改操作代码如下:

  • 增:
type = ImgType(name='图像平滑').save()
  • 查:
type = ImgType.objects(name='图像平滑')
  • 改:
    改操作需要先查询再修改
ImgType.objects(name="图像平滑").update(name='形态学处理')
  • 删:
    ImgType.delete()

如何部署

我选择部署到gunicorn上,很简单,但是当时找资料也是花了很大功夫。需要做以下操作。

  1. 分离app.run()语句
    最好将app.py分为app.py和run.py,新建一个python package,名为app,在init.py中粘贴app.py的代码,把if __name__ == '__main__': app.run(debug=True)一句放在run.py里,调试和本地可以用run.py启动服务器,部署时候就不用了。
    最后run.py的内容为:
from app import app

if __name__ == '__main__':
    app.run(debug=True)

app package的init.py文件内容为:

app = Flask(__name__)
"""some config"""
if __name__ != '__main__':
    gunicorn_logger = logging.getLogger('gunicorn.error') #设置logger
    app.logger.handlers = gunicorn_logger.handlers
    app.logger.setLevel(gunicorn_logger.level)
  1. 到服务器上进到项目目录,运行下面语句:
gunicorn -w 4 -b 0.0.0.0:5000 --logger-level=debug --error-file ../error.log app:app

推荐阅读更多精彩内容