美文网首页
第2章 程序的基本结构

第2章 程序的基本结构

作者: 李多鱼8 | 来源:发表于2020-03-26 22:25 被阅读0次

    本章将会了解Flask程序各部分的作用,编写并运行第一个Flask Web程序。

    2.1 初始化

    所有Flask程序都必须创建一个程序实例web服务器使用一种名为Web服务器网管接口的协议,把接受自客户端的所有请求都转交给这个对象处理。程序实例是Flask类的对象,经常使用下述代码创建:

    from flask import Flask
    app = Flask(__name__)
    #Flask类的构造函数只有一个必须制定的参数,即程序主模块或包含包名字,
    #在大多数程序中,Python的__name__变量就是所需要的值。
    

    将构造函数的name参数传给Flask程序,这一点可能会让Flask开发新手心生迷惑。Flask用这个参数决定程序的根目录。以便稍后能够找到相对于程序根目录的资源文件位置。

    2.2 路由和试图函数

    客户端(如web浏览器)把请求发送给web服务器,web服务器再把请求发送给Flask程序实例。程序实例需要知道对每个URL请求运行那些代码,所有保存了一个URL到python函数的映射关系。处理URL和函数之间关系的程序成为路由
    在Flask程序中定义路由的最简便方式,使用程序实例提供的app.route装饰器,把修饰的函数注册为路由。如下:

    @app.route('/')
    def index():
      return '<h1>Hello World</h1>'
    

    修饰器是python语言的标准特性,可以使用不同的方式修改函数的行为,惯常用法是使用修饰器把函数注册为时间的处理程序。

     前例把index()函数注册为程序艮地址的处理程序,如果部署程序的服务器哦域名为duoyuwz.com,在浏览器中访问duoyuwz.com后,会触发服务器执行index()函数。这个函数的返回值成为响应,是客户端接收到的内容,如果客户端是web浏览器,响应就是显示给用户查看的文档。
     像index()这样的函数称为视图函数。视图函数返回的响应可以是包含HTML的简单字符串,也可以是复杂的表单,后文会介绍。

    在python代码中嵌入响应字符串会导致代码难以维护,此处这么做只是为了介绍响应的概念。将在第3章了解生成响应的正确方法。

    如果您自信观察日常所用服务的某些url格式,会发现该很多地址中都包含可变部分。例如,你的Facebook资料页面的地址是http://www.facebook.com/<your-name>,用户名<your-name>是地址的一部分,flask支持这种形式的URL,只需在route修饰器中使用特殊的语句即可。下例定义的路由中就有一部分是动态的名字:

    @app.route('/user/<name>')
    def user(name):
      return '<h1>Hello,%s!<h1>' % name
    

    尖括号中的内容就是动态部分,任何能匹配静态部分的URL都会映射到这个路由上,调用视图函数时,Flask会将动态部分作为参数传入函数,在这个视图函数中,参数用于生成针对个人的欢迎消息。
     路由中的动态部分默认使用的是字符串,不过也可使用类型定义,如路由/user/<int:id>只会匹配动态片段id为正数的URL,flask支持在路由中使用int、float和path类型。path类型也是字符串,但不把斜线视作分隔符,而将其当做动态片段的一部分。

    2.3 启动服务器

     程序实例用run方法启动Flask集成的开发WEb服务器:

    if __name__ =='__main__':
      app.run(debug=True)
    #接下来是一个完整的实例
    from flask import Flask
    app = Flask(__name__)
    @app.route('/')
    def index():
      return '<h1>Hello World</h1>'
    if __name__ =='__main__':
      app.run(debug=True)
    
    效果图
    __name__ =='__main__' 是python的惯常用法,在这里确保直接执行这个脚本时才启动开发Web服务器。如果这个脚本由其他脚本引入,程序假定父级脚本会启动不同的服务器,因此不会执行app.run().
     服务器启动后,会进入轮询,等待并处理请求,轮询会一直运行,直到程序停止,比如按CTRL+C键。
     由一些选项参数可被app.run()函数接收用于设置web服务器操作模式,在开发过过程中调试会带来一些便利,不如说激活调试器重载程序。要想启用调试模式,我们需要把debug参数设为True.

    Flask提供web服务器不适合在生产环境中使用。第17章会介绍生产环境WEB服务器。

    2.4 一个完整的程序

     前几节介绍了Flask Web程序的不同组成部分,现在是时候开发一个程序了。整个hello.py程序脚本就是把前面介绍的三部分合并到一个文件中。代码如下:

    # hello.py 一个完整的Flask程序
    from flask import Flask
    app = Flask(__name__)
    @app.route('/')
    def index():
      return '<h1>Hello World</h1>'
    if __name__ =='__main__':
      app.run(debug=True)
    

    要想运行这个程序,请确保激活了你之前创建的虚拟环境,并在其中安装了Flask。现在打开web浏览器,在地址栏中输入127.0.0.1:5000/ 下图就是运行的结果示意图

    hello.py Flask程序
    • 接下来我们添加一个动态路由
    from flask import Flask
    app = Flask(__name__)
    @app.route('/')
    def index():
      return '<h1>Hello World12</h1>'
    
    @app.route('/user/<name>')
    def user(name):
        return '<h1>Hello,%s!</h1>' % name
    
    if __name__ =='__main__':
      app.run(debug=True)
    
    123为动态参数
    • web服务开启的一直是之前第一个程序,后续看看如何解决

    2.5 请求-响应循环

    现在你已经开发一个简单的flask程序,获取希望进一步了解Flask的工作方式。下面几节介绍这个框架的一些设计理念。

    2.5.1 程序和请求上下文

    Flask从客户端收到请求时,要让视图函数能访问一些对象,这样才能处理请求,请求对象就是一个很好的例子,它分封装了客户端发送的HTTP请求。
    要想让视图函数能够访问请求对象,一个显而易见的方式是将其作为参数传入视图函数,不过这回导致程序中的每个视图函数都增加一个参数,除了访问请求对象,如果视图函数在处理请求时还要访问其他对象,情况会变得更糟糕。
     为了避免大量可有可无的参数,把视图函数弄得一团糟,Flask使用上下文临时把某些对象变为全局可访问,由了上下文,就可以学出下面的视图函数:

    from flask import Flask
    app = Flask(__name__)
    
    from flask import request
    @app.route('/')
    def index():
      user_agent = request.headers.get('User-Agent')
      return '<p>Your Browser is %s </p>'% user_agent
    
    
    if __name__ =='__main__':
      #app.run(debug=True)
      app.run()
    #显示 Your Browser is Mozilla/5.0 (Windows NT 10.0; Win64; x64) 
    #AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.149 Safari/537.36
    

    注意在这个视图函数中我们如何把request当做全局变量使用,事实上,request不可能是全局变量,试想在多线程服务器中,多个线程同时处理不同客户端发送的不同请求时,每个线程看到的request对象必然不同。Flask使用上下文让特定的变量在一个线程中全局可访问,与此同时却不会干扰其他线程。

    线程是可单独管理的最小指令集,进程经常使用多个活动线程,有时还会共享内存或句柄等资源。多线程web服务器会创建一个线程池,在从线程池中选择一个线程用于处理接收到的请求。

    Flask中有两种上下文,程序上下文和请求上下文。如下图

    变量名 上下文 说 明
    current_app 程序上下文 当前激活程序的程序实例
    g 程序上下文 处理请求时用作临时存储的对象,每次请求都会重设这个变量
    request 请求上下文 请求对象,封装了客户端发出的HTTP请求中的内容
    session 请求上下文 用户会话,用于存储请求之间需要记住的值得词典

    Flask在分发请求之前激活程序和请求上下文,请求处理完成后再将其删除,程序上下文被推送后,就可以在线程中使用current_app和g变量。类似,请求上下文被推送后,就可以使用request和session变量。如果使用这些变量时我们没有激活程序上的上下文或请求上下文,就会导致错误,如果你不知道为什么这4个上下文变量如此有用,先别担心,后面会说。
    下面这个python shell会话演示了程序上下文的使用方法:


    还看不懂什么意思

    2.5.2 请求调度

    程序收到客户端发来的请求时,要找到处理该请求的视图函数。为了完成这个任务,Flask会在程序的URL映射中查找请求的URL。URL映射是URL和视图函数之间的对应关系,Flask使用app.route修饰器或者非修饰器形式的app.add_url_rule()生成映射。
    要想查看Flask程序中的URL映射是什么样子,我们可以在PYTHON shell中检查为hello.py生成的映射,测试之前,情确保您激活了圩您环境:

    from hello import app
    app.url_map
    
    查看uRL映射

    / 和 /user/<name>路由在程序中使用app.route修饰器定义。/static/<filename>路由是Flask添加的特殊路由,用于访问静态文件。第3章会有介绍静态文件。
    URL映射中的HEAD、Options、GET是请求方法,由路由进行处理。Flask为每个路由都指定了请求方法,这样就不同的请求方法发送到相同的URL上时,会使用不同的视图函数进行处理。HEAD和Optins方法由FLASK自动处理,因此可以这么说,在这个程序中,URL映射中的3个路由都是使用GET方法,第4章会介绍如何使用路由指定不同的请求方法。

    2.5.3请求钩子

    有时在处理请求之间或之后执行代码会很有用,例如,在请求开始时,我们可能需要创建数据库或者认证发起请求的用户,为了避免在每个视图函数中使用重复的代码,Flask提供了注册通用函数的功能,注册的函数可在请求被分发到视图函数之前或之后调用。
    请求钩子使用修饰器实现,flask支持一下4种钩子:

    • before_first_request:注册一个函数,在处理第一个请求之前运行
    • before_request:注册一个函数,在每次请求之前运行
      -after_request:注册一个函数,如果没有未处理的异常抛出,在每次请求之后运行。
    • teardown_request:注册一个函数,即使有未处理的异常抛出,也在每次请求之后运行。
      在请求钩子函数和视图函数之间共享数据一般使用上下文全局变量g。例如,before_request处理程序可以从数据库中加载已登录用户,并将其保存到g.user中,随后调用视图函数时,视图函数再使用g.user获取用户。
      请求钩子的用法会在后续章节中介绍。如果现在不太理解,也不用担心。

    2.5.4响应

    Flask调用视图函数后,会将其返回值作为响应的内容,大多数情况下,想用就是一个简单的字符串,作为HTML页面回送客户端。
    但HTTP协议需要的不仅是作为请求想用的字符串,HTTP响应中一个很重要的部分是状态码,Flask默认设为200,这个代码表明请求已经被成功处理。
    如果视图函数返回的响应需要使用不同的状态码,那么可以把数字代码作为第二个返回值,添加到响应文本之后。例如,下述视图函数返回一个400状态码,表示请求无效:

    @app.route('/')
    def index():
      return '<h1>Bad Request</h1>', 400
    

    视图函数返回的响应还可接收第三个参数,这是一个由首部(header)组成的字典,可以添加到HTTP响应中,一般情况下并不需要这么做。不过你会在第14章看到一个例子。
    如果不想返回由1个、2个或3个值组成的元组,Flask视图函数还可以返回Response对象。make_response()函数可以接收1个、2个或3个参数(和视图函数的返回值一样),并返回一个Response对象,有时我们需要在视图函数中进行这种转换,然后在响应对象上调用各种方法,进一步设置响应,下例创建了一个响应对象,然后设置了cookie:

    from flask import make_response
    @app.route('/')
    def index():
      response = make_response('<h1>THis document cookie!</h1>')
      response.set_cookie('answer','42')
      return response
    

    有一种名为重定向的特殊响应类型,这种响应没有页面文档,只告诉浏览器一个新地址用以加载新页面。重定向经常在web表单中使用,第3章会进行介绍。
    重定向经常使用302状态码表示,指向的地址由Location首部提供,重定向响应可以使用3个值形式的返回值生成,也可在Response对象中设定。不过,由于使用频繁,Flask提供了redirect()辅助函数,用于生成这种响应:

    from flask import redirect
    @app.route('/')
    def index():
      return redirect('http://www.example.com')
    

    还有一种特殊的响应由abort函数生成,用于处理错误。在下面这个例子中,如果URL中动态参数id对应的用户不存在,就返回状态码404:

    from flask import abort
    @app.route('/user/<id>')
    def get_user(id):
      user = load_user(id)
      if not user:
        abort(404)
      return '<h1>Hello,%s</h1>' % user.name
    

    注意,abort不会把控制权交还给调用它的函数,而是抛出异常控制权交给服务器。

    2.6 Flask扩展

    Flask被设计为可扩展形式,故而没有提供一些重要的功能,例如数据库和用户认证,所以开发者可以自由选择最适合程序的包,或者按需求自行开发。

    使用Flask-Script支持命令行选项

    Flask的开发Web服务器支持很多启动设置选项,但只能在脚本中作为参数传给app.run()函数,这种方式并不十分方便。传递设置选项的理想方式是使用命令行参数。
    Flask-Script是一个Flask扩展,为Flask程序添加了一个命令行解析器。Flask-Script自带了一组常用选项,而且还支持自定义命令。
    Flask-Script扩展使用pip安装:

    (venv) pip install flask-script
    

    显示了把命令行解析功能添加到hello.py程序中时需要修改的地方。

    from flask.ext.script import Manager
    manager = Manager(app)
    #...
    if __name__ == '__main__':
      manager.run()
    

    专为Flask开发的扩展都暴露在flask.ext命名空间下,Flask-Script输出一个名为Manager的类,可从flask.ext.script中引入。
    这个扩展的初始化方法也使用与其它很多扩展:把程序实例作为参数传给构造函数,初始化主类的实例。创建的对象可以在各个扩展中使用,在这里,服务器由manager.run()启动,启动后就能解析命令行了。
    这样修改之后,程序可以使用一组基本命令行选项,现在运行hello.py 会显示一个用法消息:

    这个地方没有看懂
    现在,Web服务器可使用http://a.b.c.d:5000/网络中的任一台电脑进行访问,其中,a.b.c.d是服务器所在计算机的外网ip地址。
    本章介绍了请求响应的概念,不过响应的知识还有很多,对于使用模板生成响应,Flask提供了良好支持,这是个很重要的话题,下一章我们还要专门介绍模板。

    相关文章

      网友评论

          本文标题:第2章 程序的基本结构

          本文链接:https://www.haomeiwen.com/subject/ckzcuhtx.html