一、Flask介绍
(轻量级的框架,非常快速的就能把程序搭建起来)
Flask是一个基于Python开发并且依赖jinja2模板和Werkzeug WSGI服务的一个微型框架,对于Werkzeug本质是Socket服务端,其用于接收http请求并对请求进行预处理,然后触发Flask框架,开发人员基于Flask框架提供的功能对请求进行相应的处理,并返回给用户,如果要返回给用户复杂的内容时,需要借助jinja2模板来实现对模板的处理,即:将模板和数据进行渲染,将渲染后的字符串返回给用户浏览器。
“微”(micro) 并不表示你需要把整个 Web 应用塞进单个 Python 文件(虽然确实可以 ),也不意味着 Flask 在功能上有所欠缺。微框架中的“微”意味着 Flask 旨在保持核心简单而易于扩展。Flask 不会替你做出太多决策——比如使用何种数据库。而那些 Flask 所选择的——比如使用何种模板引擎——则很容易替换。除此之外的一切都由可由你掌握。如此,Flask 可以与您珠联璧合。
默认情况下,Flask 不包含数据库抽象层、表单验证,或是其它任何已有多种库可以胜任的功能。然而,Flask 支持用扩展来给应用添加这些功能,如同是 Flask 本身实现的一样。众多的扩展提供了数据库集成、表单验证、上传处理、各种各样的开放认证技术等功能。Flask 也许是“微小”的,但它已准备好在需求繁杂的生产环境中投入使用。
pip install flask
#Flask依赖一个实现wsgi协议的模块:werkzeug
from werkzeug.wrappers import Request, Response @Request.application def hello(request): return Response('Hello World!') if __name__ == '__main__': from werkzeug.serving import run_simple run_simple('localhost', 4000, hello)
flask依赖wsgi,实现wsgi模块:wsgiref,werkzeug,uwsgi
与Django的简单比较
Django:无socket,依赖第三方模块wsgi,中间件,路由系统(CBV,FBV),视图函数,ORM。cookie,session,Admin,Form,缓存,信号,序列化。。
Flask:无socket,中间件(需要扩展),路由系统,视图(CBV)、第三方模块(依赖jinja2),cookie,session弱爆了
二、基本使用
from flask import Flask app = Flask(__name__) @app.route('/') def hello_world(): return 'Hello World!' if __name__ == '__main__': app.run()
1.实例化Flask对象时,可选的参数
app = Flask(name) # 这是实例化一个Flask对象,最基本的写法
但是Flask中还有其他参数,以下是可填的参数,及其默认值
def __init__(self, import_name, static_path=None, static_url_path=None, static_folder='static', template_folder='templates', instance_path=None, instance_relative_config=False, root_path=None):
template_folder:模板所在文件夹的名字
root_path:可以不用填,会自动找到,当前执行文件,所在目录地址
在return render_template时会将上面两个进行拼接,找到对应的模板地址
static_folder:静态文件所在文件的名字,默认是static,可以不用填
static_url_path:静态文件的地址前缀,写成什么,访问静态文件时,就要在前面加上这个
app = Flask(__name__,template_folder='templates',static_url_path='/xxxxxx')
如:在根目录下创建目录,templates和static,则return render_template时,可以找到里面的模板页面;如在static文件夹里存放11.png,在引用该图片时,静态文件地址为:/xxxxxx/11.png
instance_path和instance_relative_config是配合来用的、
这两个参数是用来找配置文件的,当用
app.config.from_pyfile('settings.py')这种方式导入配置文件的时候会用到 instance_relative_config:默认为False,当设置为True时,from_pyfile会从instance_path指定的地址下查找文件。 instsnce_path:指定from_pyfile查询文件的路径,不设置时,默认寻找和app.run()的执行文件同级目录下的instance文件夹;如果配置了instance_path(注意需要是绝对路径),就会从指定的地址下里面的文件
绑定路由关系的两种方式
#方式一
@app.route('/index.html',methods=['GET','POST'],endpoint='index') def index(): return 'Index'
#方式二
def index(): return "Index" self.add_url_rule(rule='/index.html', endpoint="index", view_func=index, methods=["GET","POST"]) #endpoint是别名 or app.add_url_rule(rule='/index.html', endpoint="index", view_func=index, methods=["GET","POST"]) app.view_functions['index'] = index
添加路由关系的本质:将url和视图函数封装成一个Rule对象,添加到Flask的url_map字段中
2.Flask中装饰器应用
from flask import Flask,render_template,request,redirect,session app = Flask(__name__) app.secret_key = "sdsfdsgdfgdfgfh" # 设置session时,必须要加,否则报错 def wrapper(func): def inner(*args,**kwargs): if not session.get("user_info"): return redirect("/login") ret = func(*args,**kwargs) return ret return inner @app.route("/login",methods=["GET","POST"]) # 指定该路由可接收的请求方式,默认为GET def login(): if request.method=="GET": return render_template("login.html") else: # print(request.values) #这个里面什么都有,相当于body username = request.form.get("username") password = request.form.get("password") if username=="haiyan" and password=="123": session["user_info"] = username # session.pop("user_info") #删除session return redirect("/index") else: # return render_template("login.html",**{"msg":"用户名或密码错误"}) return render_template("login.html",msg="用户名或者密码错误") @app.route("/index",methods=["GET","POST"]) @wrapper #自己定义装饰器时,必须放在路由的装饰器下面 def index(): # if not session.get("user_info"): # return redirect("/login") return render_template("index.html") if __name__ == '__main__': app.run(debug=True)
debug = True 是指进入调试模式,服务器会在 我们的代码修改后, 自动重新载入,有错误的话会提醒,每次修改代码后就不需要再手动重启
3.请求响应相关
1.获取请求数据,及相应 - request - request.form #POST请求的数据 - request.args #GET请求的数据,不是完全意义上的字典,通过.to_dict可以转换成字典 - request.querystring #GET请求,bytes形式的 - response - return render_tempalte() - return redirect() - return "" v = make_response(返回值) #可以把返回的值包在了这个函数里面,然后再通过.set_cookie绑定cookie等 - session - 存在浏览器上,并且是加密的 - 依赖于:secret_key
2.flask中获取URL后面的参数(from urllib.parse import urlencode,quote,unquote)
GET请求:
URL为: http://127.0.0.1:5000/login?name=%27%E8%83%A1%E5%86%B2%27&nid=2
from urllib.parse import urlencode,quote,unquote def login(): if request.method == 'GET': s1 = request.args s2 = request.args.to_dict() s3 = urlencode(s1) s4 = urlencode(s2) s5 = unquote(s3) s6 = unquote(s4) s7 = quote("胡冲") print('s1',s1) print('s2',s2) print('s3',s3) print('s4',s4) print('s5',s5) print('s6',s6) print('s7',s7) return render_template('login.html') #############结果如下#################### s1 ImmutableMultiDict([('name', "'胡冲'"), ('nid', '2')]) s2 {'name': "'胡冲'", 'nid': '2'} s3 name=%27%E8%83%A1%E5%86%B2%27&nid=2 s4 name=%27%E8%83%A1%E5%86%B2%27&nid=2 s5 name='胡冲'&nid=2 s6 name='胡冲'&nid=2 s7 %E8%83%A1%E5%86%B2
三、配置文件
flask中的配置文件是一个flask.config.Config对象(继承字典),默认配置为: { 'DEBUG': get_debug_flag(default=False), 是否开启Debug模式 'TESTING': False, 是否开启测试模式 'PROPAGATE_EXCEPTIONS': None, 'PRESERVE_CONTEXT_ON_EXCEPTION': None, 'SECRET_KEY': None, 'PERMANENT_SESSION_LIFETIME': timedelta(days=31), 'USE_X_SENDFILE': False, 'LOGGER_NAME': None, 'LOGGER_HANDLER_POLICY': 'always', 'SERVER_NAME': None, 'APPLICATION_ROOT': None, 'SESSION_COOKIE_NAME': 'session', 'SESSION_COOKIE_DOMAIN': None, 'SESSION_COOKIE_PATH': None, 'SESSION_COOKIE_HTTPONLY': True, 'SESSION_COOKIE_SECURE': False, 'SESSION_REFRESH_EACH_REQUEST': True, 'MAX_CONTENT_LENGTH': None, 'SEND_FILE_MAX_AGE_DEFAULT': timedelta(hours=12), 'TRAP_BAD_REQUEST_ERRORS': False, 'TRAP_HTTP_EXCEPTIONS': False, 'EXPLAIN_TEMPLATE_LOADING': False, 'PREFERRED_URL_SCHEME': 'http', 'JSON_AS_ASCII': True, 'JSON_SORT_KEYS': True, 'JSONIFY_PRETTYPRINT_REGULAR': True, 'JSONIFY_MIMETYPE': 'application/json', 'TEMPLATES_AUTO_RELOAD': None, } 方式一: app.config['DEBUG'] = True PS: 由于Config对象本质上是字典,所以还可以使用app.config.update(...) 方式二: app.config.from_pyfile("python文件名称") 如: settings.py DEBUG = True app.config.from_pyfile("settings.py") app.config.from_envvar("环境变量名称") 环境变量的值为python文件名称名称,内部调用from_pyfile方法 app.config.from_json("json文件名称") JSON文件名称,必须是json格式,因为内部会执行json.loads app.config.from_mapping({'DEBUG':True}) 字典格式 app.config.from_object("python类或类的路径") app.config.from_object('pro_flask.settings.TestingConfig') settings.py class Config(object): DEBUG = False TESTING = False DATABASE_URI = 'sqlite://:memory:' class ProductionConfig(Config): DATABASE_URI = 'mysql://user@localhost/foo' class DevelopmentConfig(Config): DEBUG = True class TestingConfig(Config): TESTING = True PS: 从sys.path中已经存在路径开始写 PS: settings.py文件默认路径要放在程序root_path目录,如果instance_relative_config为True,则就是instance_path目录
四、路由系统
1.可传入参数:
@app.route(‘/user/’) #常用的 不加参数的时候默认是字符串形式的
@app.route(‘/post/int:post_id’) #常用的 #指定int,说明是整型的
@app.route(‘/post/float:post_id’)
@app.route(‘/post/path:path’)
@app.route(‘/login’, methods=[‘GET’, ‘POST’])
DEFAULT_CONVERTERS = { 'default': UnicodeConverter, 'string': UnicodeConverter, 'any': AnyConverter, 'path': PathConverter, 'int': IntegerConverter, 'float': FloatConverter, 'uuid': UUIDConverter,
2.反向生成URL: url_for
endpoint(“name”) #别名,相当于django中的name
from flask import Flask, url_for @app.route('/index',endpoint="xxx") #endpoint是别名 def index(): v = url_for("xxx") print(v) return "index" @app.route('/zzz/<int:nid>',endpoint="aaa") #endpoint是别名 def zzz(nid): v = url_for("aaa",nid=nid) print(v) return "index2"
3. @app.route和app.add_url_rule参数 @app.route和app.add_url_rule参数: rule, URL规则 view_func, 视图函数名称 defaults=None, 默认值,当URL中无参数,函数需要参数时,使用defaults={'k':'v'}为函数提供参数 endpoint=None, 名称,用于反向生成URL,即: url_for('名称') methods=None, 允许的请求方式,如:["GET","POST"] strict_slashes=None, 对URL最后的 / 符号是否严格要求, 如: @app.route('/index',strict_slashes=False), #当为False时,url上加不加斜杠都行 访问 http://www.xx.com/index/ 或 http://www.xx.com/index均可 @app.route('/index',strict_slashes=True) #当为True时,url后面必须不加斜杠 仅访问 http://www.xx.com/index redirect_to=None, 由原地址直接重定向到指定地址,原url有参数时,跳转到的新url也得传参,注意:新url中不用指定参数类型,直接用旧的参数的类型 如: @app.route('/index/<int:nid>', redirect_to='/home/<nid>') # 访问index时,会直接自动跳转到home,执行home的函数, 不执行index的 或 def func(adapter, nid): return "/home/888" @app.route('/index/<int:nid>', redirect_to=func) subdomain=None, 子域名访问 from flask import Flask, views, url_for app = Flask(import_name=__name__) app.config['SERVER_NAME'] = 'haiyan.com:5000' @app.route("/", subdomain="admin") def static_index(): """Flask supports static subdomains This is available at static.your-domain.tld""" return "admin.xxx.com" #动态生成 @app.route("/dynamic", subdomain="<username>") def username_index(username): """Dynamic subdomains are also supported Try going to user1.your-domain.tld/dynamic""" return username + ".your-domain.tld" if __name__ == '__main__': app.run() 所有的域名都得与IP做一个域名解析: 如果你想通过域名去访问,有两种解决方式: 方式一: 1、租一个域名 haiyan.lalala 2、租一个公网IP 49.8.5.62 3、域名解析: haiyan.com 49.8.5.62 4、吧代码放在49.8.5.62这个服务器上,程序运行起来 用户可以通过IP进行访问 方式二:如果是自己测试用的就可以用这种方式。先在自己本地的文件中找 C:\Windows\System32\drivers\etc 找到HOST,修改配置 然后吧域名修改成自己的本地服务器127.0.0.1 加上配置:app.config["SERVER_NAME"] = "haiyan.com:5000"
4.自定制正则路由匹配
扩展Flask的路由系统,让他支持正则,这个类必须这样写,必须去继承BaseConverter
from flask import Flask,url_for from werkzeug.routing import BaseConverter app = Flask(__name__) # 定义转换的类 class RegexConverter(BaseConverter): """ 自定义URL匹配正则表达式 """ def __init__(self, map, regex): super(RegexConverter, self).__init__(map) self.regex = regex def to_python(self, value): """ 路由匹配时,匹配成功后传递给视图函数中参数的值 :param value: :return: """ return int(value) def to_url(self, value): """ 使用url_for反向生成URL时,传递的参数经过该方法处理,返回的值用于生成URL中的参数 :param value: :return: """ val = super(RegexConverter, self).to_url(value) return val # 添加到converts中 app.url_map.converters['regex'] = RegexConverter # 进行使用 @app.route('/index/<regex("\d+"):nid>',endpoint='xx') def index(nid): url_for('xx',nid=123) return "Index" if __name__ == '__main__': app.run()
五、视图函数
2.Flask中的CBV和FBV
def auth(func): def inner(*args, **kwargs): result = func(*args, **kwargs) return result return inner class IndexView(views.MethodView): # methods = ['POST'] #只允许POST请求访问 decorators = [auth,] # 如果想给所有的get,post请求加装饰器,就可以这样来写,也可以单个指定 def get(self): #如果是get请求需要执行的代码 v = url_for('index') print(v) return "GET" def post(self): #如果是post请求执行的代码 return "POST" app.add_url_rule('/index', view_func=IndexView.as_view(name='index')) #name即FBV中的endpoint,指别名 if __name__ == '__main__': app.run()
类视图及其使用
视图函数不能面向对象编程,利用类视图来代替视图函数来解决这个问题
导入视图类 View
from flask.views import View
编写一个视图子类
class MyView(View): # MyView继承于View def test(self): # 自定义的方法 return '测试类视图' def dispatch_request(self): # 必须重写这个方法 resp = self.test() return resp
利用View子类获取到一个视图方法
MyView.as_view(‘test’)
注意:.as_view方法的放回值是一个方法,而且该方法的名字就是传进去的参数
将获取到的视图方法和路径对应起来
app.add_url_rule(‘/test/’, view_func=MyView.as_view(‘test’)) # MyView.as_view(‘test’) 返回的是一个方法
类视图的原理
把as_view方法返回的结果赋值给view_func
as_view方法返回的是一个方法(注意:as_view方法传入的参数就是as_view返回的那个方法的名字),该方法会调用dispatch_request方法
一旦路由进来,就会调用 dispatch_request 方法
类视图的目的就是实现逻辑分离、方便管理
View Code
方法视图及其使用
利用视图函数实现不同的请求执行不同的逻辑时比较复杂,需要在视图函数函数中进行判断;如果利用方法视图实现就比较简单
@app.route('/test/', methods=['GET', 'POST']) def test(): if request.method == 'GET': # 做GET的事情 pass elif request.method == 'POST': # 做POST的事情 pass return '测试'
导入方法试图类
from flask.views import MethodView 创建方法视图子类 class TestMethodView(MethodView): def get(self): # 处理Get请求 return 'GET请求' def post(self): # 处理post请求 return 'POST请求' 注意:视图类中的方法就是支持的请求类型
利用方法视图子类创建一个视图函数
TestMethodView.as_view(‘testMethodView’)
注意:as_view返回的是一个视图函数,而且该视图函数逇名称就是传进去的参数
将获取到的视图方法和路径对应起来
app.add_url_rule(‘/test02/’, view_func=TestMethodView.as_view(‘testMethodView’))
View Code
虽然在方法视图中定义的函数就是支持的请求类型,但是我们可以在配置路径时指定哪个路径对应哪中类型的请求
利用方法视图子类获取一个名字为testMethodView02的视图函数,该视图函数只能支持GET请求,而且支持转换器
method02 = TestMethodView.as_view('testMethodView02'); app.add_url_rule('/test02/<name>/', view_func=method02, methods=['GET'])
利用利用方法视图子类获取一个名字为testMethodView03的视图函数,该视图函数只能支持POST请求
method03 = TestMethodView.as_view('testMethodView03') app.add_url_rule('/test03/', view_func=method03, methods=['POST'])
六、请求与响应
from flask import Flask from flask import request from flask import render_template from flask import redirect from flask import make_response app = Flask(__name__) @app.route('/login.html', methods=['GET', "POST"]) def login(): # 请求相关信息 # request.method # request.args # request.form # request.values # request.cookies # request.headers # request.path # request.full_path # request.script_root # request.url # request.base_url # request.url_root # request.host_url # request.host # request.files # obj = request.files['the_file_name'] # obj.save('/var/www/uploads/' + secure_filename(f.filename)) # 响应相关信息 # return "字符串" # return render_template('html模板路径',**{}) # return redirect('/index.html') # response = make_response(render_template('index.html')) # response是flask.wrappers.Response类型 # response.delete_cookie('key') # response.set_cookie('key', 'value') # response.headers['X-Something'] = 'A value' # return response return "内容" if __name__ == '__main__': app.run() from flask import Flask,url_for,request,redirect,render_template,jsonify,make_response from urllib.parse import urlencode,quote,unquote app = Flask(__name__) @app.route('/index',endpoint='xx') def index(): from werkzeug.datastructures import ImmutableMultiDict ================= # get_data = request.args # get_dict = get_data.to_dict() # get_dict['xx'] = '18' # url = urlencode(get_dict) # print(url) ==================== # print(request.query_string) # print(request.args) ========================== # val = "%E6%8A%8A%E5%87%A0%E4%B8%AA" # print(unquote(val)) #把上面这样的数据转换成中文 # # return "Index" # return "Index" # return redirect() # return render_template() # return jsonify(name='alex',age='18') #相当于JsonResponse ======================= response = make_response('xxxxx') ##如果是返回更多的值,cookie,headers,或者其他的就可用它 response.headers['xxx'] = '123123' return response if __name__ == '__main__': # app.__call__ app.run()
七、Session
除请求对象之外,还有一个 session 对象。它允许你在不同请求间存储特定用户的信息。它是在 Cookies 的基础上实现的,并且对 Cookies 进行密钥签名要使用会话,你需要设置一个密钥。
设
置:session['username'] = 'xxx' 删除:session.pop('username', None) from flask import Flask,url_for,session app = Flask(__name__) app.secret_key = "sdsfdgdgdgd" app.config['SESSION_COOKIE_NAME'] = 'session_lvning' #设置session的名字 @app.route('/index/') def index(nid): #session本质上操作的是字典, 所有对session操作的方法与字典方法相同 #session的原理:如果下一次访问的时候带着随机字符串,会把session里面对应的 # 值拿到内存,假设session保存在数据库,每执行一次链接一次数据库,每次都要时时更新的话,会非常损耗数据库的效率 session["xxx"] = 123 session["xxx2"] = 123 session["xxx3"] = 123 session["xxx4"] = 123 del session["xxx2"] #在这删除了,真正存储的时候是没有xxx2的 return "ddsf" if __name__ == '__main__': app.run()
关于session的配置
app.config['SESSION_COOKIE_NAME'] = 'session_lvning' - session超时时间如何设置? 'PERMANENT_SESSION_LIFETIME': timedelta(days=31) 以下是跟session相关的配置文件 """ 'SESSION_COOKIE_NAME': 'session', 'SESSION_COOKIE_DOMAIN': None, 'SESSION_COOKIE_PATH': None, 'SESSION_COOKIE_HTTPONLY': True, 'SESSION_COOKIE_SECURE': False, 'SESSION_REFRESH_EACH_REQUEST': True, #是否每次都跟新 'PERMANENT_SESSION_LIFETIME': timedelta(days=31)
八、蓝图(flask中多py文件拆分都要用到蓝图)
如果代码非常多,要进行归类。不同的功能放在不同的文件,吧相关的视图函数也放进去。蓝图也就是对flask的目录结构进行分配(应用于小,中型的程序)
蓝图用于为应用提供目录划分:
manage.py
import fcrm if __name__ == '__main__': fcrm.app.run()
init.py(只要一导入fcrm就会执行__init__.py文件)
from flask import Flask #导入accout 和order from fcrm.views import accout from fcrm.views import order app = Flask(__name__) print(app.root_path) #根目录 app.register_blueprint(accout.accout) #把蓝图注册到app里面,accout.accout是创建的蓝图对象 app.register_blueprint(order.order)
accout.py
from flask import Blueprint,render_template accout = Blueprint("accout",__name__) @accout.route('/accout') def xx(): return "accout" @accout.route("/login") def login(): return render_template("login.html")
order.py
from flask import Blueprint order = Blueprint("order",__name__) @order.route('/order') def register(): return "order
注意:
蓝图中的视图函数的名字不能和蓝图对象的名字一样!!!
其他:
蓝图URL前缀:xxx = Blueprint('account', __name__,url_prefix='/xxx') 蓝图子域名:xxx = Blueprint('account', __name__,subdomain='admin')
九、中间件
在函数执行之前或函数执行之后想做点事情,有2种方式
第一种:装饰器
第二种:flask里面的扩展,相当于django中的中间件
from flask import Flask,session,Session,flash,get_flashed_messages,redirect,render_template,request app = Flask(__name__) app.secret_key ='sdfsdfsdf' @app.before_request def process_request1(): print('process_request1') @app.after_request def process_response1(response): print('process_response1') return response @app.before_request def process_request2(): print('process_request2') @app.after_request def process_response2(response): #参数也得有 print('process_response2') return response #必须有返回值 @app.route('/index') def index(): print('index') return 'Index' @app.route('/order') def order(): print('order') return 'order' @app.route('/test') def test(): print('test') return 'test' if __name__ == '__main__': app.run()
还有一个@app.before_first_request:表示,当程序运行起来,第一个请求来的时候就只执行一次,下次再来就不会在执行了