Day 5 - 编写Web框架

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

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

Django：一站式开发框架，但不利于定制化；

web.py：使用类而不是更简单的函数来处理URL，并且URL映射是单独配置的；

Flask：使用@decorator的URL路由不错，但框架对应用程序的代码入侵太强；

bottle：缺少根据URL模式进行拦截的功能，不利于做权限检查。

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

设计Web框架

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

  1. # 首页:
  2. @get('/')
  3. def index():
  4.     return '<h1>Index page</h1>'
  6. # 带参数的URL:
  7. @get('/user/:id')
  8. def show_user(id):
  9.     user = User.get(id)
  10.     return 'hello, %s' % user.name

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

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

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

  1. @interceptor('/manage/')
  2. def check_manage_url(next):
  3.     if current_user.isAdmin():
  4.         return next()
  5.     else:
  6.         raise seeother('/signin')

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

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

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

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

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

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

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

  1. raise seeother('/signin')

返回404错误：

  1. raise notfound()

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

实现Web框架

最基本的几个对象如下：

  1. # transwarp/web.py
  3. # 全局ThreadLocal对象：
  4. ctx = threading.local()
  6. # HTTP错误类:
  7. class HttpError(Exception):
  8.     pass
  10. # request对象:
  11. class Request(object):
  12.     # 根据key返回value:
  13.     def get(self, key, default=None):
  14.         pass
  16.     # 返回key-value的dict:
  17.     def input(self):
  18.         pass
  20.     # 返回URL的path:
  21.     @property
  22.     def path_info(self):
  23.         pass
  25.     # 返回HTTP Headers:
  26.     @property
  27.     def headers(self):
  28.         pass
  30.     # 根据key返回Cookie value:
  31.     def cookie(self, name, default=None):
  32.         pass
  34. # response对象:
  35. class Response(object):
  36.     # 设置header:
  37.     def set_header(self, key, value):
  38.         pass
  40.     # 设置Cookie:
  41.     def set_cookie(self, name, value, max_age=None, expires=None, path='/'):
  42.         pass
  44.     # 设置status:
  45.     @property
  46.     def status(self):
  47.         pass
  48.     @status.setter
  49.     def status(self, value):
  50.         pass
  52. # 定义GET:
  53. def get(path):
  54.     pass
  56. # 定义POST:
  57. def post(path):
  58.     pass
  60. # 定义模板:
  61. def view(path):
  62.     pass
  64. # 定义拦截器:
  65. def interceptor(pattern):
  66.     pass
  68. # 定义模板引擎:
  69. class TemplateEngine(object):
  70.     def __call__(self, path, model):
  71.         pass
  73. # 缺省使用jinja2:
  74. class Jinja2TemplateEngine(TemplateEngine):
  75.     def __init__(self, templ_dir, **kw):
  76.         from jinja2 import Environment, FileSystemLoader
  77.         self._env = Environment(loader=FileSystemLoader(templ_dir), **kw)
  79.     def __call__(self, path, model):
  80.         return self._env.get_template(path).render(**model).encode('utf-8')

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

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

  1. wsgi = WSGIApplication()
  2. if __name__ == '__main__':
  3.     wsgi.run()
  4. else:
  5.     application = wsgi.get_wsgi_application()

因此，WSGIApplication定义如下：

  1. class WSGIApplication(object):
  2.     def __init__(self, document_root=None, **kw):
  3.         pass
  5.     # 添加一个URL定义:
  6.     def add_url(self, func):
  7.         pass
  9.     # 添加一个Interceptor定义:
  10.     def add_interceptor(self, func):
  11.         pass
  13.     # 设置TemplateEngine:
  14.     @property
  15.     def template_engine(self):
  16.         pass
  18.     @template_engine.setter
  19.     def template_engine(self, engine):
  20.         pass
  22.     # 返回WSGI处理函数:
  23.     def get_wsgi_application(self):
  24.         def wsgi(env, start_response):
  25.             pass
  26.         return wsgi
  28.     # 开发模式下直接启动服务器:
  29.     def run(self, port=9000, host='127.0.0.1'):
  30.         from wsgiref.simple_server import make_server
  31.         server = make_server(host, port, self.get_wsgi_application())
  32.         server.serve_forever()

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

原文: https://wizardforcel.gitbooks.io/liaoxuefeng/content/py2/99.html