簡(jiǎn)單介紹Python下自己編寫(xiě)web框架的一些要點(diǎn)

更新時(shí)間：2015年04月29日 17:34:41 作者：廖雪峰

這篇文章主要介紹了簡(jiǎn)單介紹Python下自己編寫(xiě)web框架的一些要點(diǎn),示例代碼基于Python2.x版本,需要的朋友可以參考下

在正式開(kāi)始Web開(kāi)發(fā)前，我們需要編寫(xiě)一個(gè)Web框架。

為什么不選擇一個(gè)現(xiàn)成的Web框架而是自己從頭開(kāi)發(fā)呢？我們來(lái)考察一下現(xiàn)有的流行的Web框架：

Django：一站式開(kāi)發(fā)框架，但不利于定制化；
web.py：使用類(lèi)而不是更簡(jiǎn)單的函數(shù)來(lái)處理URL，并且URL映射是單獨(dú)配置的；
Flask：使用@decorator的URL路由不錯(cuò)，但框架對(duì)應(yīng)用程序的代碼入侵太強(qiáng)；
bottle：缺少根據(jù)URL模式進(jìn)行攔截的功能，不利于做權(quán)限檢查。

所以，我們綜合幾種框架的優(yōu)點(diǎn)，設(shè)計(jì)一個(gè)簡(jiǎn)單、靈活、入侵性極小的Web框架。
設(shè)計(jì)Web框架

一個(gè)簡(jiǎn)單的URL框架應(yīng)該允許以@decorator方式直接把URL映射到函數(shù)上：

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

# 帶參數(shù)的URL:
@get('/user/:id')
def show_user(id):
  user = User.get(id)
  return 'hello, %s' % user.name

有沒(méi)有@decorator不改變函數(shù)行為，也就是說(shuō)，Web框架的API入侵性很小，你可以直接測(cè)試函數(shù)show_user(id)而不需要啟動(dòng)Web服務(wù)器。

函數(shù)可以返回str、unicode以及iterator，這些數(shù)據(jù)可以直接作為字符串返回給瀏覽器。

其次，Web框架要支持URL攔截器，這樣，我們就可以根據(jù)URL做權(quán)限檢查：

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

攔截器接受一個(gè)next函數(shù)，這樣，一個(gè)攔截器可以決定調(diào)用next()繼續(xù)處理請(qǐng)求還是直接返回。

為了支持MVC，Web框架需要支持模板，但是我們不限定使用哪一種模板，可以選擇jinja2，也可以選擇mako、Cheetah等等。

要統(tǒng)一模板的接口，函數(shù)可以返回dict并配合@view來(lái)渲染模板：

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

如果需要從form表單或者URL的querystring獲取用戶(hù)輸入的數(shù)據(jù)，就需要訪(fǎng)問(wèn)request對(duì)象，如果要設(shè)置特定的Content-Type、設(shè)置Cookie等，就需要訪(fǎng)問(wèn)response對(duì)象。request和response對(duì)象應(yīng)該從一個(gè)唯一的ThreadLocal中獲?。?/p>

@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'

最后，如果需要重定向、或者返回一個(gè)HTTP錯(cuò)誤碼，最好的方法是直接拋出異常，例如，重定向到登陸頁(yè)：

raise seeother('/signin')

返回404錯(cuò)誤：

raise notfound()

基于以上接口，我們就可以實(shí)現(xiàn)Web框架了。
實(shí)現(xiàn)Web框架

最基本的幾個(gè)對(duì)象如下：

# transwarp/web.py

# 全局ThreadLocal對(duì)象：
ctx = threading.local()

# HTTP錯(cuò)誤類(lèi):
class HttpError(Exception):
  pass

# request對(duì)象:
class Request(object):
  # 根據(jù)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

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

# response對(duì)象:
class Response(object):
  # 設(shè)置header:
  def set_header(self, key, value):
    pass

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

  # 設(shè)置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的類(lèi)，實(shí)現(xiàn)WSGI接口，然后，通過(guò)配置啟動(dòng)，就完成了整個(gè)Web框架的工作。

設(shè)計(jì)WSGIApplication要充分考慮開(kāi)發(fā)模式（Development Mode）和產(chǎn)品模式（Production Mode）的區(qū)分。在產(chǎn)品模式下，WSGIApplication需要直接提供WSGI接口給服務(wù)器，讓服務(wù)器調(diào)用該接口，而在開(kāi)發(fā)模式下，我們更希望能通過(guò)app.run()直接啟動(dòng)服務(wù)器進(jìn)行開(kāi)發(fā)調(diào)試：

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

  # 添加一個(gè)URL定義:
  def add_url(self, func):
    pass

  # 添加一個(gè)Interceptor定義:
  def add_interceptor(self, func):
    pass

  # 設(shè)置TemplateEngine:
  @property
  def template_engine(self):
    pass

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

  # 返回WSGI處理函數(shù):
  def get_wsgi_application(self):
    def wsgi(env, start_response):
      pass
    return wsgi

  # 開(kāi)發(fā)模式下直接啟動(dòng)服務(wù)器:
  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類(lèi)填充完畢，我們就得到了一個(gè)完整的Web框架。

您可能感興趣的文章: