欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Flask-蓝图、模型与CodeFirst

程序员文章站 2022-07-02 14:43:22
应用、蓝图与视图函数 1. 结构,如图: 1. Flask最上层是 ,在这个核心对象上可以插入很多蓝图,这个蓝图是不能单独存在的,必须将app作为插板插入app ,在每一个蓝图上,可以注册很多静态文件,视图函数,模板 ,一个业务模块可以做为一个蓝图,比如book,之前的book.py 放到了app/ ......

应用、蓝图与视图函数

  1. 结构,如图:

    Flask-蓝图、模型与CodeFirst

  2. flask最上层是app核心对象 ,在这个核心对象上可以插入很多蓝图,这个蓝图是不能单独存在的,必须将app作为插板插入app ,在每一个蓝图上,可以注册很多静态文件,视图函数,模板 ,一个业务模块可以做为一个蓝图,比如book,之前的book.py 放到了app/web/路径下,就是考虑到了蓝图,app属于是整个flask应用层,web属于是蓝图

  3. 一些初始化操作应该放入到__init__文件中,比如flask的核心应用app初始化对象,应该放入到在应用层级app包的 __init__.py 中 ,而蓝图的初始化应该放入到蓝图层的web包__init__.py中,如图:

    Flask-蓝图、模型与CodeFirst

  4. flask的核心应用app初始化对象文件app/__init__.py

# -*- coding: utf-8 -*-
from flask import flask

def create_app():
    app = flask(__name__)
    app.config.from_object('config')
    # 要返回回去
    return app
  1. 此时在主文件中
# -*- coding: utf-8 -*-
from app import create_app

app = create_app()

if __name__ == '__main__':
    app.run(debug=app.config['debug'])

用蓝图注册视图函数

  1. 在蓝图中注册试图函数,在app/web/book.py中,记得导入blueprint
# -*- coding: utf-8 -*-
from flask import jsonify, blueprint
from helper import is_isbn_key
from shanqiubook import shanqiubook

# 蓝图 blueprint,进行初始化,蓝图的名字和参数为蓝图所在的模块名一般用__name__
web = blueprint ('web',__name__)

# 此时这里用的就是web了
@web.route('/book/search/<q>/<page>')
def hello(q,page):
    is_or_key = is_isbn_key(q)
    if is_or_key == 'isbn':
        result = shanqiubook.search_by_isbn(q)
    else:
        result = shanqiubook.search_by_keyword(q)

    return jsonify(result)
  1. 在蓝图中注册了试图函数,还需要把蓝图插入到app中,app/__init__.py
# -*- coding: utf-8 -*-
from flask import flask

def create_app():
    app = flask(__name__)
    app.config.from_object('config')
    # 调用一下就可以
    register_blueprint(app)
    return app

# 通过这个方法插入到app中
def register_blueprint(app):
    from app.web.book import web
    # 注册这个蓝图对象
    app.register_blueprint(web)

单蓝图多模块拆分视图函数

  1. 蓝图,就是为了分模块的,比如一个web系统就是属于一个web模块,一个移动端使用的api就是一个api模块,而我们这里的book,user等不同类别的py文件,要是每一个都注册一个蓝图的话就有点小题大作了,所以要进行单蓝图
  2. 在一个模块(web)的初始文件中定义蓝图对象,然后这个模块中的其他的py文件引用的就是这一个蓝图对象来注册路由函数,
  3. 在app/web/book.py文件中
# -*- coding: utf-8 -*-
from flask import jsonify, blueprint
from helper import is_isbn_key
from shanqiubook import shanqiubook
# 导入web模块
from . import web

@web.route('/book/search/<q>/<page>')
def hello(q,page):

    # 调用方法判断用户是根据什么查的
    is_or_key = is_isbn_key(q)
    if is_or_key == 'isbn':
        result = shanqiubook.search_by_isbn(q)
    else:
        result = shanqiubook.search_by_keyword(q)

    return jsonify(result)
  1. 这里先建立一个伪代码user.py,为了多一个模块进行演示
# -*- coding: utf-8 -*-
# 导入web模块
from . import web
@web.route("/user/login")
def login():
    return "success"
  1. 此时在app/web/__init__.py文件中,定义这个蓝图对象
# -*- coding: utf-8 -*-

# 蓝图 blueprint,进行初始化
from flask import blueprint
web = blueprint ('web',__name__)

# 这两个导入之后就可以成功的运行对应模块中相关的代码,注意这个位置,这蓝图实例化之后
from app.web import book
from app.web import user

request对象

  1. 在app/web/book.py文件中,定义的url请求是/book/search/<q>/<page>这种格式的,flask会将<>里的值自动映射成视图函数方法的参数,但是这种格式用着不爽,要把用户输入的参数作为请求参数传入,这个时候就要使用这种格式了http://127.0.0.1:5000/book/search/?q=金庸&page=1
  2. 这个该怎么获取值呢,这个时候就用到flask内置的request了,通过request对象就可以获取http请求中包含的详细信息了,具体的用法看下面的代码
# -*- coding: utf-8 -*-

# 导入这个request模块,
from flask import jsonify, blueprint,request
from helper import is_isbn_key
from shanqiubook import shanqiubook
from . import web

# http://127.0.0.1:5000/book/search/?q=金庸&page=1
@web.route('/book/search/')
def hello():
    # 通过request对象拿到对应值的信息,但是这个并不是py中原始的字典,而是dict的子类immutabledict
    q = request.args['q']
    page = request.args['page']
    # ip = request.remote_addr

    # 通过这个方法把它转换为普通的dict
    # a = request.args.to_dict()
    # print(a)

    is_or_key = is_isbn_key(q)
    if is_or_key == 'isbn':
        result = shanqiubook.search_by_isbn(q)
    else:
        result = shanqiubook.search_by_keyword(q)

    return jsonify(result)
  1. flask的request是基于代理模式实现的,想让request正常使用,必须确保是http请求触发的函数或视图函数中使用

wtforms参数验证

  1. 上面我们把url改了,但是如果用户输入了一些特殊的符号该怎么办?这个时候就要使用到参数验证,而wtforms框架就是一个优秀的参数验证框架,首先在对应的环境中进行安装(flask--yqglgu4) e:\py\qiyue\flask>pipenv install wtforms
  2. 这个参数验证写在哪里好呢,直接写在book.py中,这样是最不妥的,为了方便调用,应该写成一个类,所以写在app/forms/book.py文件中
# -*- coding: utf-8 -*-

# 导入需要使用的模块
from wtforms import form,stringfield,integerfield
from wtforms.validators import length,numberrange

class searchform(form):
    # 直接调用内置对象
    # 参数校验规则:
    # 1.定义的属性名q,page要与要校验的参数同名
    # 2.根据要传入的参数类型选择不同的field类进行实例化
    # 3.传入一个数组,作为校验规则validators
    # 4.可以设置默认值
    q = stringfield(validators=[datarequired(),length(min=1,max=30)])

    page = integerfield(validators=[numberrange(min=1,max=10)],default=1)
  1. 此时在app/web/book.py文件中就可以直接调用就行了
# -*- coding: utf-8 -*-
from flask import jsonify, blueprint,request
from helper import is_isbn_key
from shanqiubook import shanqiubook
from . import web
# 导入参数校验
from app.forms.book import searchform

# http://127.0.0.1:5000/book/search/?q=金庸&page=1
@web.route('/book/search/')
def hello():

    # 验证层
    # 实例化我们自定义的searchform,需要传入一个字典作为要校验的参数
    form  = searchform(request.args)
    # validate()方法返回true/false来标示是否校验通过
    if form.validate():

        # 从form中取出校验后的q与page,并且清除空格
        q = form.q.data.strip()
        page = form.page.data

        is_or_key = is_isbn_key(q)
        if is_or_key == 'isbn':
            result = shanqiubook.search_by_isbn(q)
        else:
            result = shanqiubook.search_by_keyword(q)
        return jsonify(result)
    else:
        return jsonify({'msg':'参数校验失败'})

拆分配置文件

  1. 之前访问数据的时候,count和start都是写死的,现在来进行重构,之前的代码
   @classmethod
    def search_by_key(cls, q, count=15, start=0):
        # count:每页显示的数量
        # start:每页的第一条数据的下标
        url = cls.search_by_key_url.format(q, count, start)
        return http.get(url)
  1. 这样写非常的不妥

    • 在视图函数中接收到的参数是page,代码的封装性,我们应该把count和start的计算过程放到shanqiubook.py的 search_by_key方法中来写

    • count的值为了方便日后的管理,这个应该放入到配置文件中,之前的配置文件是config.py,在根目录下,而这个应该放入到app目录下,而关于一些比较隐私的配置信息要妥善处理,所以在app目录下建立两个文件,secure.py用来存放私密的配置信息,setting.py用于存放一些不重要的配置信息,如下

    • app/secure.py

      # -*- coding: utf-8 -*-
      
      # 存放比较机密的配置文件,在上传git的时候不应该上传此文件
      debug = true
    • app/setting.py

      # -*- coding: utf-8 -*-
      
      # 生产环境和开发环境几乎一样的,不怎么机密的配置文件
      
      # 每页显示的数据量
      per_page = 15
    • start的计算是一个单独的逻辑,应该用封装成一个方法,使用的时候直接调用

      # 获取每一页的起始下标
          @staticmethod
          def calculate_start(page):
              # 获取配置信息中的每页显示的数量
              return (page -1 ) * current_app.config['per_page']
  2. 重构后的shanqiubook.py

   -*- coding: utf-8 -*-
   from httper import httper
# 通过这种方式来导入当前的app对象,方便调用配置而文件

   from flask import current_app

   class shanqiubook:

   isbn_url = 'http://t.yushu.im/v2/book/search/isbn/{}'
   keyword_url = 'http://t.yushu.im/v2/book/search?q={}&count={}&start={}'
   
   @classmethod
   def search_by_isbn(cls,isbn):
       url = cls.isbn_url.format(isbn)
       result = httper.get(url)
       return result
   
   @classmethod
   def search_by_keyword(cls,keyword,page=1):
       # 每页显示的数据(通过这种方式从配置文件中获取到),每一页的起始下标
       url = cls.keyword_url.format(keyword,current_app.config['per_page'],cls.calculate_start(page))
       result = httper.get(url)
       return result

# 获取每一页的起始下标
   @staticmethod
   def calculate_start(page):
       return (page -1 ) * current_app.config['per_page']​
  1. 这个时候在app/__init__.py文件中把配置文件添加到app中
#-- coding: utf-8 --

from flask import flask

def create_app():

    app = flask(name)

    # app.config.from_object('config')

    # 把配置文件装载进来

    app.config.from_object('app.secure')

    app.config.from_object('app.setting')

    register_blueprint(app)

    return app

def register_blueprint(app):

    from app.web.book import web

    app.register_blueprint(web)

定义第一个模型类

  1. 我们现在把文件进行整理,如下:

Flask-蓝图、模型与CodeFirst

  1. 首先在本地创建一个数据库,如下:

Flask-蓝图、模型与CodeFirst

  1. 在app/models/book.py文件中建立模型,这里使用到sqlalchemy来实现自动化映射,在flask框架中对这个进行了改良flask_sqlalchemy,这个更加人性化,安装(flask--yqglgu4) e:\py\qiyue\flask>pipenv install flask-sqlalchemy

  2. 建立模型,这样就建立好了模型

# -*- coding: utf-8 -*-

# 首先导入
from sqlalchemy import column,integer,string

# sqlalchemy,自动化映射
# flask_sqlalchemy,这个是flask封装后的api,更加人性化

class book():
    # 需要把这些属性的默认值写成sqlalchemy提供的固定的类型
    # column()传入参数:数据类型,主键,自增
    id = column(integer,primary_key=true,autoincrement=true)
    # 数据类型,不为空
    title = column(string(50),nullable=false)
    author = column(string(30),default='未名')
    binding = column(string(20))
    publisher = column(string(50))
    price = column(string(20))
    pages = column(integer)
    pubdate = column(string(20))
    # 唯一:unique=true
    isbn = column(string(15),nullable=false,unique=true)
    summary = column(string(1000))
    image = column(string(50))
    
    # 定义一些方法
    def sample(self):
        pass


将模型映射到数据库中

  1. 在模型类app/models/book.py中引入导入核心对象,并实例化,继承
# -*- coding: utf-8 -*-
from sqlalchemy import column,integer,string

# 将模型映射到数据库中
# 首先导入核心的对象
from flask_sqlalchemy import sqlalchemy

# 初始化
db = sqlalchemy()

# 继承db.model
class book(db.model):
    id = column(integer,primary_key=true,autoincrement=true)
    title = column(string(50),nullable=false)
    author = column(string(30),default='未名')
    binding = column(string(20))
    publisher = column(string(50))
    price = column(string(20))
    pages = column(integer)
    pubdate = column(string(20))
    isbn = column(string(15),nullable=false,unique=true)
    summary = column(string(1000))
    image = column(string(50))

  1. app/__init__.py中进行模型与flask关联
# -*- coding: utf-8 -*-
from flask import flask
# 导入这个db
from app.models.book import db

def create_app():
    app = flask(__name__)
    app.config.from_object('app.secure')
    app.config.from_object('app.setting')
    register_blueprint(app)


    # 把这个db和核心对象关联起来了
    db.init_app(app)
    # 注意这里,这样写的话会报错
    db.create_all() # 把所有的数据模型映射到数据库中
    return app

def register_blueprint(app):
    from app.web.book import web
    app.register_blueprint(web)
  1. 配置数据库连接的配置文件在app/secure.py文件中
# -*- coding: utf-8 -*-

# 存放比较机密的配置文件
debug = true

# 数据库连接url,固定格式
# 要连接的数据库类型,数据库驱动(这里还要进行安装:pipenv install cymysql)
sqlalchemy_database_uri = 'mysql+cymysql://root:123456@localhost:3306/book'
  1. 之后运行项目,就会创建在指定的数据库中创建一个数据表了,但是运行项目会出现下面的这种错误
    'no application found. either work inside a view function or push'
这个是因为在flask中,不是实例化了app核心对象,其他代码就可以直接使用,要在上面的第二步的注意事项中` db.create_all()`方法中,把app核心对象传入即可

db.create_all(app=app),这样就可以了,在数据库中就可以看到表了

Flask-蓝图、模型与CodeFirst