Flask – Sijax

Sijax 代表 'Simple Ajax',它是一个 Python/jQuery 库,旨在帮助您轻松使用 Ajax 到您的应用程序。 它使用 jQuery.ajax 发出 AJAX 请求。


安装

Flask-Sijax 的安装很简单。

pip install flask-sijax

配置

  • SIJAX_STATIC_PATH − 您希望镜像 Sijax javascript 文件的静态路径。 默认位置是 static/js/sijax。 在此文件夹中,保留了 sijax.jsjson2.js 文件。

  • SIJAX_JSON_URI − 从中加载 json2.js 静态文件的 URI

Sijax 使用 JSON 在浏览器和服务器之间传递数据。 这意味着浏览器需要原生支持 JSON 或从 json2.js 文件获得 JSON 支持。

以这种方式注册的函数无法提供 Sijax 功能,因为默认情况下无法使用 POST 方法访问它们(而 Sijax 使用 POST 请求)。

要使 View 函数能够处理 Sijax 请求,请使用 @app.route('/url', methods = ['GET' , 'POST']) 或像这样使用 @flask_sijax.route 辅助装饰器 −

@flask_sijax.route(app, '/hello')

每个 Sijax 处理程序函数(如这个函数)都会自动接收至少一个参数,就像 Python 将"self"传递给对象方法一样。 'obj_response' 参数是函数与浏览器对话的方式。

def say_hi(obj_response):
   obj_response.alert('Hi there!')

当检测到 Sijax 请求时,Sijax 是这样处理的 −

g.sijax.register_callback('say_hi', say_hi)
   return g.sijax.process_request()

Sijax 应用程序

一个最小的 Sijax 应用程序代码如下所示 −

import os
from flask import Flask, g
from flask_sijax import sijax

path = os.path.join('.', os.path.dirname(__file__), 'static/js/sijax/')
app = Flask(__name__)

app.config['SIJAX_STATIC_PATH'] = path
app.config['SIJAX_JSON_URI'] = '/static/js/sijax/json2.js'
flask_sijax.Sijax(app)

@app.route('/')
def index():
   return 'Index'
	
@flask_sijax.route(app, '/hello')
def hello():
   def say_hi(obj_response):
      obj_response.alert('Hi there!')
   if g.sijax.is_sijax_request:
      # Sijax request detected - let Sijax handle it
      g.sijax.register_callback('say_hi', say_hi)
      return g.sijax.process_request()
      return _render_template('sijaxexample.html')

if __name__ == '__main__':
   app.run(debug = True)

当 Sijax 请求(一个特殊的 jQuery.ajax() 请求)到服务器时,g.sijax.is_sijax_request() 在服务器上检测到该请求,在这种情况下,您让 Sijax 处理该请求。

所有使用 g.sijax.register_callback() 注册的函数都公开用于从浏览器调用。

调用 g.sijax.process_request() 告诉 Sijax 执行适当的(先前注册的)函数并将响应返回给浏览器。