Tag：PyCharm，Flask，flask_sqlalchemy，Flask-Restless
[TOC]
笔者使用PyCharm来进行开发操作。
一、在PyCharm中新建Flask项目
image
新建项目时，将会联网（外网）下载并安装flask、jinja2等。如果有错误提示，请自行解决网络问题。
二、在PyCharm中的终端，下载所需的包
因为新建项目的时候使用了Virtualenv，所以安装相关依赖，只需要在终端中，正常安装就可以了。此时pip3安装的包，都不是全局的，而只在当前虚拟环境中起作用。
pip3 install flask_sqlalchemy
pip3 install flask_restful
pip3 install flask-cors
pip3 install flask-restless
pip3 install flask-httpauth
pip3 install passlib
本例中，使用flask_sqlalchemy和Flask-Restless
pip3 install flask_sqlalchemy
pip3 install flask-restless
关于
virtualenv的相关信息，可以参考：virtualenv介绍及基本使用
image
三、导入包
在主文件上方，导入相关的包
import os
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_restless import APIManager
image
四、初始配置
# 创建Flask应用
app = Flask(__name__)
# 获取项目的基地址
basedir = os.path.abspath(os.path.dirname(__file__))
# 格式为mysql://{用户名}:{密码}@{host}:{端口}/{数据库名}
app.config['SQLALCHEMY_DATABASE_URI']='mysql://root:@172.17.0.17:3307/flaskdb'
# 或者使用SQLite项目文件下的SQLite数据库。
# app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///' + os.path.join(basedir, 'SQL/testSQL.db')
#这个提示你设为true
app.config['SQLALCHEMY_TRACK_MODIFICATIONS']='true'
# 创建Flask-SQLAlchemy对象
db = SQLAlchemy(app)
这里使用SQLAlchemy来连接一个172.17.0.17上3307端口，用户名是root，密码为空，数据库名是flaskdb的MariaDB数据库。
根据官方教程, Flask中常见Config用法有以下几种。
- 直接赋值。
- 通过config的update方法一次更新多个属性值。
- 部分配置值可以通过属性赋值。
- 通过文件读取初始化config信息。
关于config的部分，可以参考：读Flask源代码学习Python--config原理，这里不多加赘述。
四、创建数据模型
创建Flask-SQLAlchemy模型（亦有成为bean的），但是要遵守下列两点（合理）限制：
1.必须有一个主键类型是sqlalchemy.Integer或sqlalchemy.Unicode；
2.必须有init方法，用来初始化数据（flask.ext.sqlalchemy.SQLAlchemy.Model已经提供）。
class Person(db.Model):
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.Unicode, unique=True)
birth_date = db.Column(db.Date)
class Computer(db.Model):
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.Unicode, unique=True)
vendor = db.Column(db.Unicode)
purchase_time = db.Column(db.DateTime)
owner_id = db.Column(db.Integer, db.ForeignKey('person.id'))
owner = db.relationship('Person', backref=db.backref('computers', lazy='dynamic'))
db.create_all()
flask-sqlalchemy中的SQLAlchemy可以用orm处理数据库，告别繁琐的sql语句。文档链接：http://flask-sqlalchemy.pocoo.org/2.3/
五、创建数据库表
创建API端点，这些端点默认在/api/可获取。指定允许的HTTP方法也能被这样配置。
# 创建Flask-Restless API管理器
manager = APIManager(app, flask_sqlalchemy_db=db)
# 创建api的endpoint，并指定调用方法
manager.create_api(Person, methods=['GET', 'POST', 'DELETE'])
manager.create_api(Computer, methods=['GET'])
更多关于
Flask-Restless的内容，请查阅官方文档，本文不在赘述。文档链接：https://flask-restless.readthedocs.io/en/latest/index.html
六、主程序入口
if __name__ == '__main__':
app.run(host='0.0.0.0', port=6789)
在浏览器中输入地址即ip加端口进行访问验证：
http://127.0.0.1:6789/api/person
http://127.0.0.1:6789/api/computer
或者
http://172.17.0.38:6789/api/person
http://172.17.0.38:6789/api/computer
此时应该得到一个json的response。
{"num_results":2,"objects":[{"birth_date":"2018-08-20","computers":[{"id":1,"name":"tt01","owner_id":1,"purchase_time":"2018-08-20T11:58:17","vendor":"dd"},{"id":3,"name":"tt03","owner_id":1,"purchase_time":"2018-08-20T11:58:12","vendor":"22"}],"id":1,"name":"wolf"},{"birth_date":"2018-08-20","computers":[{"id":2,"name":"tt02","owner_id":2,"purchase_time":"2018-08-20T11:58:21","vendor":"33"}],"id":2,"name":"tst"}],"page":1,"total_pages":1}
七、完整文件
完整的flaskAPI.py如下所示：
import os
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_restless import APIManager
app = Flask(__name__)
'''
根据官方教程, Flask中常见Config用法有以下几种。
1.直接赋值。
2.通过config的update方法一次更新多个属性值。
3.部分配置值可以通过属性赋值。
4.通过文件读取初始化config信息。
'''
# 获取项目的基地址
basedir = os.path.abspath(os.path.dirname(__file__))
# 格式为mysql://{用户名}:{密码}@{host}:{端口}/{数据库名}
# app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql://root:@172.17.0.17:3307/flaskdb'
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///' + os.path.join(basedir, 'SQL/testSQL.db')
# 这个提示你设为true
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = 'true'
# 创建Flask-SQLAlchemy对象
db = SQLAlchemy(app)
# 像往常一样创建Flask-SQLAlchemy模型，但是要遵守下列两点（合理）限制：
# 1.必须有一个主键类型是sqlalchemy.Integer或sqlalchemy.Unicode。
# 2.必须有__init__方法，用来初始化数据（flask.ext.sqlalchemy.SQLAlchemy.Model已经提供）。
class Person(db.Model):
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.Unicode, unique=True)
birth_date = db.Column(db.Date)
class Computer(db.Model):
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.Unicode, unique=True)
vendor = db.Column(db.Unicode)
purchase_time = db.Column(db.DateTime)
owner_id = db.Column(db.Integer, db.ForeignKey('person.id'))
owner = db.relationship('Person', backref=db.backref('computers', lazy='dynamic'))
# 创建数据库表。
manager = APIManager(app, flask_sqlalchemy_db=db)
# 创建API端点，这些端点默认在'/api/'可获取。
# 指定允许的HTTP方法也能被这样配置。
manager.create_api(Person, methods=['GET', 'POST', 'DELETE'])
manager.create_api(Computer, methods=['GET'])
@app.route('/')
def hello_world():
return 'Hello WOLF!'
if __name__ == '__main__':
db.create_all()
app.run(host='0.0.0.0', port=6789)