Python3+Flask实现本地Mock数据

1. 前言

在日常的开发过程中，前端的APP或者H5页面的开发往往需要依赖接口的数据，为了满足前后端并行开发的需求，很多公司都提供了Mock数据的平台，服务端同学将定义好的接口文档维护到Mock数据平台后，前端同学即可通过Mock平台进行接口联调。但很多时候，当无法访问Mock数据平台的场景下，我们依然需要一套本地的Mock环境来支持前端页面的开发和联调。
既然是本地运行，那么简单、小巧就是首要的要求了。这里推荐的Python3+Flask搭建本地网络服务，如果有需要使用域名访问的场景，推荐时候开源软件 SwitchHosts!来将域名映射到本地。

1.1 方案的意义和价值

相信您读到这里一定会奇怪，放着Fidder、Charles这样轻量级的解决方案不使用，为什么要费这么大的劲来搭建这个环境呢？
首先要说明一下Fidder、Charles一类的代理工具软件一般都提供动态的方式Mock数据（不了解的请自行百度），但是对于POST加密数据的请求的Mock就无能为力了，另外在数据的动态添加、删除方面也是Fidder、Charles等轻量级解决方案的短板。

2. 安装Python3

众所周知，Python有两个版本2.x和3.x，Python3已经发布很久了，目前已经更新到了3.7了，在这里也推荐大家与时俱进，安装和使用Python3。

2.1 安装Python3

Python3的安装步骤和其他的软件大同小异，大家可以参考我的历史文章中的步骤安装

1. Python3 Windows平台安装步骤
2. Python3 Linux平台安装步骤
3. Python3 Mac平台安装步骤

3.安装和使用Flask

3.1 Flask简介

Flask框架是Python开发的一个基于Werkzeug和Jinja 2的web开发微框架，它的优势就是极其简洁，但又非常灵活，而且容易学习和应用。因此Flask框架是Python新手快速开始web开发最好的选择，此外，使用Flask框架的另一个好处在于你可以非常轻松地将基于Python的机器学习算法或数据分析算法集成到web应用中。
从第一眼看到就深深的爱上了她，因为简单，从安装到使用，就是那么的简单。

3.2 安装Flask

执行pip安装Flask：

 pip3 install flask

画外音：看吧，就是这么的简单

3.2 轻松编写第一个网络接口

在IDE中创建一个文件app.py，然后只需要以下几行代码，就可以写出Flask版本的Hello World

1. 使用import语句导入Flask类

from flask import Flask

2. 创建Flask对象，我们将使用该对象进行应用的配置和运行：

# name 是Python中的特殊变量，如果文件作为主程序执行，那么__name__变量的值就是__main__，如果是被其他模块引入，那么__name__的值就是模块名称。
app = Flask(__name__)

3. 在主程序中，执行run()来启动应用：

if __name__ =="__main__":
    app.run(debug=True, port=8080)
# 改名启动一个本地服务器，默认情况下其地址是localhost:5000，在上面的代码中，我们使用关键字参数port将监听端口修改为8080。

4. 创建路由，使用app变量的route()装饰器来告诉Flask框架URL如何触发我们的视图函数：

@app.route('/')
def hello_world():
    return 'Hello, World!'
# 上面的标识，对路径'/'的请求，将转为对hello_world()函数的调用

下面我们来看以下完成的代码：

from flask import Flask
app = Flask(__name__)

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

if __name__ =="__main__":
    app.run(debug=True,port=8080)

5. 运行

python app.py

6. 在Pychem中运行的结果如下：

/usr/local/bin/python3.7 /Users/Projects/Python/MockTest/com/jd/mockTest/app.py
 * Serving Flask app "app" (lazy loading)
 * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: on
 * Running on http://127.0.0.1:8080/ (Press CTRL+C to quit)
 * Restarting with stat
 * Debugger is active!
 * Debugger PIN: 149-536-287

7. 打开浏览器访问http://localhost:8080/，运行的结果如下：
   
   运行结果

到此为止我们已经实现了第一个网络接口，下面的章节我们开始正式编写Mock数据接口。

4.编写本地Mock服务

4.1 不同API接口返回对应的Mock数据

from flask import Flask
app = Flask(__name__)

# 接口studentInfo支持GET和POST两种请求方式，收到请求后直接返回Mock数据
@app.route('/studentInfo/', methods = ["GET","POST"])
def student_info():
    return '{"name": "Kitty","age": 16,"gender": 1,"isStudent": true}'
# 接口schoolInfo同样支持GET和POSt两个请求方式，收到请求直接返回Mock数据
@app.route('/schoolInfo', methods = ["GET","POST"])
def school_info():
    return '{"school": "Lycee Louis Le Grand","grade":2,"class": 1}'

if __name__ =="__main__":
    app.run(debug=True, port=8080)
# 改名启动一个本地服务器，默认情况下其地址是localhost:5000，在上面的代码中，我们使用关键字参数port将监听端口修改为8080。

如上所见studentInfo和schoolInfo两个接口同时支持GET和POST两种请求方式，收到请求后直接返回Mock数据。运行后的结果如下：

StudentInfo运行结果示例

SchoolInfo运行结果示例

我们定义一个新的接口只需要重新写一个Router即可

# 声明Mock数据的接口以及请求方式
@app.route('/schoolInfo', methods = ["GET","POST"])
def school_info(): #声明新的方法名称
   return mock data   #返回对应的Mock数据即可

有没有感觉到很简单，没有一点挑战 ？

4.2 不同的请求参数返回对应的Mock数据

有些时候我们会需要根据接口中不同的参数的返回相应的Mock数据，是时候讲解一下如何解析请求的参数了。下面分别讲解解析GET和POST两种请求参数的方法：

1）解析GET请求参数

• 首先需要导入flask提供的工具包：

from flask import request
from flask import jsonify

• 使用request.method判断当前请求是否是GET请求：

 if request.method == 'GET':

• 使用request.args.get获取网络请求的参数

 user_id = request.args.get("uid")
 name = request.args.get("name")

下面我们来看以下完成的代码：

from flask import Flask
from flask import request
from flask import jsonify

app = Flask(__name__)

@app.route('/studentInfo', methods=["GET", "POST"])
def student_info():
    #判断是否是GET请求
    if request.method == 'GET':
        user_id = request.args.get("uid")
        name = request.args.get("name")
        print("Request Param [uid]:%s  [name]:%s" % (user_id, name))
        return jsonify({"uid": user_id, "name": name, "age": 18})
    return '{"name": "Kitty","age": 16,"gender": 1,"isStudent": true}'


if __name__ == "__main__":
    app.run(debug=True, port=8080)

• 下面是用PostMan发送GET请求：
  
  PostMan发送网络请求

• 请求结果如下：

  
  
  PostMan请求结果展示

2）解析POST请求参数

由于POST请求的数据都放在Body中，支持的数据格式也多种多样，常用的数据请求格式有两种FORM表单和JSON，下面以这两种数据格式为例讲解如何获取请求参数。

• 和解析GET请求参数一样，首先需要导入flask提供的工具包：

from flask import request
from flask import jsonify

• 使用request.method判断当前请求是否是POST请求：

 if request.method == 'POST':

• 解析FORM表单格式数据
  使用request.form.get获取网络请求的参数：

user_id = request.form.get("uid")
name = request.form.get("name")

下面我们来看以下完成的代码：

from flask import Flask
from flask import request
from flask import jsonify

app = Flask(__name__)


@app.route('/studentInfo', methods=["GET", "POST"])
def student_info():
    if request.method == 'POST':
        user_id = request.form.get("uid")
        name = request.form.get("name")
        print("Request Param [uid]:%s  [name]:%s" % (user_id, name))
        return jsonify({"uid": user_id, "name": name, "age": 18})
    return '{"name": "Kitty","age": 16,"gender": 1,"isStudent": true}'


if __name__ == "__main__":
    app.run(debug=True, port=8080)

使用PostMan发送POST请求，注意Body选择x-www-form-urlencoded选项：

设置Form格式请求参数

请求返回结果同GET请求的返回结果，这里不做赘述。

• 解析JSON格式数据
  先使用request.is_json判断一下当前的请求数据是否是JSON格式（请求的Content-Type是application/json才会被认识是JSON格式），然后使用request.get_json()获取请求的JSON对象，示例代码如下文：

params = request.get_json()
user_id = params['uid']
name = params['name']

下面我们来看以下完成的代码：

from flask import Flask
from flask import request
from flask import jsonify

app = Flask(__name__)


@app.route('/studentInfo', methods=["GET", "POST"])
def student_info():
    if request.method == 'POST':
        if request.is_json:
            params = request.get_json()
            user_id = params['uid']
            name = params['name']
            print("Request Param [uid]:%s  [name]:%s" % (user_id, name))
            return jsonify({"uid": user_id, "name": name, "age": 18})
    return '{"name": "Kitty","age": 16,"gender": 1,"isStudent": true}'


if __name__ == "__main__":
    app.run(debug=True, port=8080)

下面是使用PostMan发送请求测试，需要注意的是，需要先在Header中设置Content-Type，如下图：

设置请求的Content-Type

设置请求的Body，注意选择raw选项输入JSON请求参数，如下图：

设置JSON格式请求参数

请求返回结果同GET请求的返回结果，这里不做赘述。

• 解析其他格式数据
  flask提供了request.data、request.get_data()和request.stream获取网络请求原始数据，大家可以根据需要选择调用对应的接口获取数据，这里不做赘述。

4.3 返回模板数据

flask框架还提供了强大的模板功能，可以事先编辑好带有占位符的模板，在程序运行的过程中，通过简单的代码将数据动态替换占位符，感兴趣的同学可以查看python轻量框架--Flask(模板详细版） 详细了解学习。
下面我们讲解如何返回模板数据：

• 首先导入flask提供的工具库render_template：

from flask import render_template

• 创建templates文件夹和模板文件user.json
  
  创建templates文件夹和模板文件user.json
  
  模板文件user.json的内容如下：

{
  "uid": "1001",
  "name": "Richard",
  "age": 18
}

• 设置templates的目录：

app = Flask(__name__, template_folder='templates')

• 在网络请求中返回模板数据

@app.route('/studentInfo', methods=["GET", "POST"])
def student_info():
    return render_template("user.json")

下面我们来看以下完成的代码：

from flask import Flask
from flask import render_template

app = Flask(__name__, template_folder='templates')


@app.route('/studentInfo', methods=["GET", "POST"])
def student_info():
    return render_template("user.json")


if __name__ == "__main__":
    app.run(debug=True, port=8080)

4.4 不需要Mock的接口如何处理

在开发新需求的时候，并不是所有的接口都需要Mock，难么对于已上线的功能接口能不能直接调用线上接口呢？答案是可以，那么该如何实现呢？
我们都知道当访问的接口不存在时，一定会触发404网络错误，那么我们能不能拦截接管404错误的处理呢？幸运的是，答案也是肯定的，我们可以使用@app.errorhandler()拦截处理对应的错误，请参考下面的示例：

from flask import Flask
from flask import request
from flask import render_template
import requests

app = Flask(__name__, template_folder='template')

@app.errorhandler(404)
def error(e):
    if request.method == 'GET':
        response = requests.get("http://YourUrl/" + request.path)
        return response.text
    elif request.method == 'POST':
        response = requests.post("http://YourUrl/" + request.path, data=request.data)
        return response.text
    return render_template("404.json")

if __name__ == "__main__":
    app.run(debug=True, port=8080)

在拦截到404错误后，可以结合requests网络库再次发起网络请求，并将结果返回。

5.结语

到此为止教程终于完成了，感谢您的阅读，如果您在实现的过程中遇到任何问题，欢迎在留言区留言交流。