Flask 是一种很赞的Python web框架。它极小,简单,最棒的是它很容易学。
今天我来带你搭建你的第一个Flask web应用!和官方教程 一样,你将搭建你自己的微博客系统:Flaskr。和官方Flask教程不同的是——我们通过使用Stormpath来创建并管理用户账户和数据,你的工作效率会更高。开发进程会显著地加快!
我们这就开始吧。
注意:这篇教程面向Flask开发新人,帮助他们理解如何使用Flask和Stormpath建立一个简单的网站。本文是Flask官方教程的改版。
Flaskr 应用的目标很简单:
最终的网站应该看起来像这样:
开始之前,我们需要先安装一些Python包才能干活!我们通过?Python包管理器pip来完成这件事。
1 | $ pip install flask flask–stormpath |
上述命令会安装两个包:Flask, 和?Flask-Stormpath,这两个包在整篇教程都会用到。
接着,你需要创建一个Stormpath账户。你可以在Stormpath网站注册:https://api.stormpath.com/register
当你创建了一个Stormpath账户并登入后,你还需要创建一个API 密钥。你可以在操作页面上点击创建API密钥按钮来完成:https://api.stormpath.com/ui/dashboard
创建了API密钥后,你会被提示要去下载一个名为apiKey.properties的文件,稍后我们将用到它。
注意:不要把apiKey.properties文件检入你的版本控制系统(如果你在用的话)!这个文件存储着你的Stormpath证书,应该被妥善保管。
接着,你会想要创建新的Stormpath应用,请访问应用网页:https://api.stormpath.com/v#!applications?,点击注册应用。创建一个名为flaskr的新应用,选项按默认的来。
最后,访问账户页面:https://api.stormpath.com/ui/accounts/create? ,在flaskr Directory创建新用户账户。所有在这儿创建的账户都可以用来登入你将搭建的微博客。
你要做的第一件事就是创建一个存放你应用代码的目录结构。你需要创建若干目录,然后把你的apiKey.properites
?放到新建的项目目录:
12345678 | $ mkdir –p flaskr/{static,templates}; cp ~/path/to/apiKey.properties flaskr/$ tree flaskrflaskr├── apiKey.properties├── static└── templates 2 directories, 1 file |
flaskr目录将是你应用的根目录。static目录用于存放你的静态文件(css,javascript, 和图像文件).templates目录用于存放你的Jinja模板(用于渲染HTML)。
现在你的目录结构搭好了,我们开始配置应用了!
首先,在你flaskr目录下创建名为flaskr.py的新文件。你的应用代码放在这个文件里。
一切将从这里开始:
12345678910111213141516171819202122232425262728293031 | from datetime import datetime from flask import ( Flask, abort, flash, redirect, render_template, request, url_for,)from flask.ext.stormpath import ( StormpathError, StormpathManager, User, login_required, login_user, logout_user, user,) app = Flask(__name__)app.config[\’DEBUG\’] = Trueapp.config[\’SECRET_KEY\’] = \’some_really_long_random_string_here\’app.config[\’STORMPATH_API_KEY_FILE\’] = \’apiKey.properties\’app.config[\’STORMPATH_APPLICATION\’] = \’flaskr\’ stormpath_manager = StormpathManager(app) if __name__ == \’__main__\’: app.run() |
需要关注的:
STORMPATH_API_KEY_FILE
? 变量应该指向你的apiKey.properties 文件位置。更多信息参见:http://flask-stormpath.readthedocs.org/en/latest/setup.htmlSTORMPATH_APPLICATION 变量应该是你之前创建的
Stormpath 应用名。app.run()
。它告诉Flask以开发模式运行你的网站以便于测试。运行下述命令之后,你就可以看到你的Flask应用开始在端口5000运行:
123 | $ python flaskr.py * Running on http://127.0.0.1:5000/ * Restarting with reloader |
不过当你访问http://127.0.0.1:5000, 你会看到一个404 not found 信息。这是因为你还没有定义任何视图或者URL路由 。
现在安装的部分你已经做完了,我们来定义视图。下面的代码应该放在flaskr.py 文件中,在这个上面:
12 | if __name__ == ‘__main__\’: app.run() |
代码如下:
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051 | @app.route(\’/\’)def show_posts(): posts = [] for account in stormpath_manager.application.accounts: if account.custom_data.get(\’posts\’): posts.extend(account.custom_data[\’posts\’]) posts = sorted(posts, key=lambda k: k[\’date\’], reverse=True) return render_template(\’show_posts.html\’, posts=posts) @app.route(\’/add\’, methods=[\’POST\’])@login_requireddef add_post(): if not user.custom_data.get(\’posts\’): user.custom_data[\’posts\’] = [] user.custom_data[\’posts\’].append({ \’date\’: datetime.utcnow().isoformat(), \’title\’: request.form[\’title\’], \’text\’: request.form[\’text\’], }) user.save() flash(\’New post successfully added.\’) return redirect(url_for(\’show_posts\’)) @app.route(\’/login\’, methods=[\’GET\’, \’POST\’])def login(): error = None if request.method == \’POST\’: try: _user = User.from_login( request.form[\’email\’], request.form[\’password\’], ) login_user(_user, remember=True) flash(\’You were logged in.\’) return redirect(url_for(\’show_posts\’)) except StormpathError, err: error = err.message return render_template(\’login.html\’, error=error) @app.route(\’/logout\’)def logout(): logout_user() flash(\’You were logged out.\’) return redirect(url_for(\’show_posts\’)) |
我们来讨论一下上面的代码。
你可能注意到首先定义的函数是show_posts。这个函数用于在网站前端页面显示发布的博文。如你可能已经猜到的,装饰器@app.route(‘/’)告诉Flask如何运行这个函数。
每次用户请求 URL “/”,Flask就会运行show_posts,把输出返回给用户。
show_posts 就只是:
12345 | { \’date\’: \’2014-04-01T22:50:49.762475\’, \’text\’: \’Blog content.\’, \’title\’: \’Post title\’} |
add_posts 视图用于登入用户向网站发布新博文。这个视图带来下面几样东西:
@login_required的视图都可以访问user变量。这是一个存放了用户账户细节的对象。
它的工作机制很简单:
show_posts
?视图,让新添加的博文可以展现出来。login视图就是简单地从用户POST请求中提取电子邮件地址和密码,然后从Stormpath抓取user对象,尝试登录,并创建一个本地会话。
logout视图就是销毁用户会话。
下一样要加入的东西就是模板代码。Flask使用Jinja模板语言,它让编写HTML模板变得非常简单。
让我们定义一个布局模板templates/layout.html作为开始。后面我们写的其他模板都将从这个基础模板而来。这个策略很有用,因为它允许你在一个地方定义会被多次引用的模板代码。
把下面的代码添加到你的layout.html模板文件:
123456789101112131415 |