简单介绍Python下自己编写web框架的一些要点


Posted in Python onApril 29, 2015

在正式开始Web开发前,我们需要编写一个Web框架。

为什么不选择一个现成的Web框架而是自己从头开发呢?我们来考察一下现有的流行的Web框架:

  • Django:一站式开发框架,但不利于定制化;
  • web.py:使用类而不是更简单的函数来处理URL,并且URL映射是单独配置的;
  • Flask:使用@decorator的URL路由不错,但框架对应用程序的代码入侵太强;
  • bottle:缺少根据URL模式进行拦截的功能,不利于做权限检查。

所以,我们综合几种框架的优点,设计一个简单、灵活、入侵性极小的Web框架。
设计Web框架

一个简单的URL框架应该允许以@decorator方式直接把URL映射到函数上:

# 首页:
@get('/')
def index():
  return '<h1>Index page</h1>'

# 带参数的URL:
@get('/user/:id')
def show_user(id):
  user = User.get(id)
  return 'hello, %s' % user.name

有没有@decorator不改变函数行为,也就是说,Web框架的API入侵性很小,你可以直接测试函数show_user(id)而不需要启动Web服务器。

函数可以返回str、unicode以及iterator,这些数据可以直接作为字符串返回给浏览器。

其次,Web框架要支持URL拦截器,这样,我们就可以根据URL做权限检查:

@interceptor('/manage/')
def check_manage_url(next):
  if current_user.isAdmin():
    return next()
  else:
    raise seeother('/signin')

拦截器接受一个next函数,这样,一个拦截器可以决定调用next()继续处理请求还是直接返回。

为了支持MVC,Web框架需要支持模板,但是我们不限定使用哪一种模板,可以选择jinja2,也可以选择mako、Cheetah等等。

要统一模板的接口,函数可以返回dict并配合@view来渲染模板:

@view('index.html')
@get('/')
def index():
  return dict(blogs=get_recent_blogs(), user=get_current_user())

如果需要从form表单或者URL的querystring获取用户输入的数据,就需要访问request对象,如果要设置特定的Content-Type、设置Cookie等,就需要访问response对象。request和response对象应该从一个唯一的ThreadLocal中获取:

@get('/test')
def test():
  input_data = ctx.request.input()
  ctx.response.content_type = 'text/plain'
  ctx.response.set_cookie('name', 'value', expires=3600)
  return 'result'

最后,如果需要重定向、或者返回一个HTTP错误码,最好的方法是直接抛出异常,例如,重定向到登陆页:

raise seeother('/signin')

返回404错误:

raise notfound()

基于以上接口,我们就可以实现Web框架了。
实现Web框架

最基本的几个对象如下:

# transwarp/web.py

# 全局ThreadLocal对象:
ctx = threading.local()

# HTTP错误类:
class HttpError(Exception):
  pass

# request对象:
class Request(object):
  # 根据key返回value:
  def get(self, key, default=None):
    pass

  # 返回key-value的dict:
  def input(self):
    pass

  # 返回URL的path:
  @property
  def path_info(self):
    pass

  # 返回HTTP Headers:
  @property
  def headers(self):
    pass

  # 根据key返回Cookie value:
  def cookie(self, name, default=None):
    pass

# response对象:
class Response(object):
  # 设置header:
  def set_header(self, key, value):
    pass

  # 设置Cookie:
  def set_cookie(self, name, value, max_age=None, expires=None, path='/'):
    pass

  # 设置status:
  @property
  def status(self):
    pass
  @status.setter
  def status(self, value):
    pass

# 定义GET:
def get(path):
  pass

# 定义POST:
def post(path):
  pass

# 定义模板:
def view(path):
  pass

# 定义拦截器:
def interceptor(pattern):
  pass

# 定义模板引擎:
class TemplateEngine(object):
  def __call__(self, path, model):
    pass

# 缺省使用jinja2:
class Jinja2TemplateEngine(TemplateEngine):
  def __init__(self, templ_dir, **kw):
    from jinja2 import Environment, FileSystemLoader
    self._env = Environment(loader=FileSystemLoader(templ_dir), **kw)

  def __call__(self, path, model):
    return self._env.get_template(path).render(**model).encode('utf-8')

把上面的定义填充完毕,我们就只剩下一件事情:定义全局WSGIApplication的类,实现WSGI接口,然后,通过配置启动,就完成了整个Web框架的工作。

设计WSGIApplication要充分考虑开发模式(Development Mode)和产品模式(Production Mode)的区分。在产品模式下,WSGIApplication需要直接提供WSGI接口给服务器,让服务器调用该接口,而在开发模式下,我们更希望能通过app.run()直接启动服务器进行开发调试:

wsgi = WSGIApplication()
if __name__ == '__main__':
  wsgi.run()
else:
  application = wsgi.get_wsgi_application()

因此,WSGIApplication定义如下:

class WSGIApplication(object):
  def __init__(self, document_root=None, **kw):
    pass

  # 添加一个URL定义:
  def add_url(self, func):
    pass

  # 添加一个Interceptor定义:
  def add_interceptor(self, func):
    pass

  # 设置TemplateEngine:
  @property
  def template_engine(self):
    pass

  @template_engine.setter
  def template_engine(self, engine):
    pass

  # 返回WSGI处理函数:
  def get_wsgi_application(self):
    def wsgi(env, start_response):
      pass
    return wsgi

  # 开发模式下直接启动服务器:
  def run(self, port=9000, host='127.0.0.1'):
    from wsgiref.simple_server import make_server
    server = make_server(host, port, self.get_wsgi_application())
    server.serve_forever()
Try

把WSGIApplication类填充完毕,我们就得到了一个完整的Web框架。

Python 相关文章推荐
使用Python编写简单的端口扫描器的实例分享
Dec 18 Python
初步剖析C语言编程中的结构体
Jan 16 Python
Python连接DB2数据库
Aug 27 Python
Python学习笔记之解析json的方法分析
Apr 21 Python
Python登录并获取CSDN博客所有文章列表代码实例
Dec 28 Python
pandas将DataFrame的列变成行索引的方法
Apr 10 Python
python selenium 对浏览器标签页进行关闭和切换的方法
May 21 Python
简单了解Python3里的一些新特性
Jul 13 Python
Flask项目中实现短信验证码和邮箱验证码功能
Dec 05 Python
python3连接kafka模块pykafka生产者简单封装代码
Dec 23 Python
python开发实例之python使用Websocket库开发简单聊天工具实例详解(python+Websocket+JS)
Mar 18 Python
仅用几行Python代码就能复制她的U盘文件?
Jun 26 Python
编写Python的web框架中的Model的教程
Apr 29 #Python
python获取本地计算机名字的方法
Apr 29 #Python
Python中编写ORM框架的入门指引
Apr 29 #Python
python获取本机mac地址和ip地址的方法
Apr 29 #Python
在Python中编写数据库模块的教程
Apr 29 #Python
Python的gevent框架的入门教程
Apr 29 #Python
在Python中使用HTML模版的教程
Apr 29 #Python
You might like
在IIS上安装PHP4.0正式版
2006/10/09 PHP
PHP中使用crypt()实现用户身份验证的代码
2012/09/05 PHP
PHP+Mysql实现多关键字与多字段生成SQL语句的函数
2014/11/05 PHP
完美解决thinkphp验证码出错无法显示的方法
2014/12/09 PHP
PHP策略模式定义与用法示例
2017/07/27 PHP
php使用pecl方式安装扩展操作示例
2019/08/12 PHP
统一接口:为FireFox添加IE的方法和属性的js代码
2007/03/25 Javascript
js中格式化日期时间型数据函数代码
2010/11/08 Javascript
Javascript学习笔记-详解in运算符
2011/09/13 Javascript
THREE.JS入门教程(2)着色器-上
2013/01/24 Javascript
解析JSON对象与字符串之间的相互转换
2013/12/18 Javascript
javascript实现简单的进度条
2015/07/02 Javascript
基于Javascript实现弹出页面效果
2016/01/01 Javascript
JS正则匹配URL网址的方法(可匹配www,http开头的一切网址)
2017/01/06 Javascript
JavaScript中闭包的详解
2017/04/01 Javascript
vue项目中添加单元测试的方法
2018/07/21 Javascript
详解mpvue小程序中怎么引入iconfont字体图标
2018/10/01 Javascript
解决layer弹出层自适应页面大小的问题
2019/09/16 Javascript
[01:03]悬念揭晓 11月26日DOTA2完美盛典不见不散
2017/11/23 DOTA
python实现外卖信息管理系统
2018/01/11 Python
tensorflow实现加载mnist数据集
2018/09/08 Python
Python3实现对列表按元组指定列进行排序的方法分析
2018/12/22 Python
python 读写文件包含多种编码格式的解决方式
2019/12/20 Python
基于Tensorflow使用CPU而不用GPU问题的解决
2020/02/07 Python
BIBLOO捷克:购买女装、男装、童装、鞋和配件
2017/01/27 全球购物
输入N,打印N*N矩阵
2012/02/20 面试题
27个经典Linux面试题及答案,你知道几个?
2013/01/10 面试题
优秀应届毕业生自荐信
2013/11/16 职场文书
社区学雷锋活动策划方案
2014/01/30 职场文书
酒店秘书求职信范文
2014/02/17 职场文书
大学同学会活动方案
2014/08/20 职场文书
学校2014年度工作总结
2014/12/06 职场文书
小学优秀学生评语
2014/12/29 职场文书
2019年关于小学生课外阅读情况的分析报告
2019/12/02 职场文书
《思路决定出路》读后感3篇
2019/12/11 职场文书
Python保存并浏览用户的历史记录
2022/04/29 Python