Flask Sijax

Sijax代表’Simple Ajax’,它是一個Python/jQuery庫,旨在幫助Flask開者者輕鬆地將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](https://github.com/app "@app").route('/url',methods = ['GET','POST'])通過POST對其進行訪問,或使用類似[@flask_sijax](https://github.com/flask_sijax "@flask_sijax").route輔助裝飾器 -

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

每個Sijax處理函數(像這樣)都會自動接收至少一個參數,就像Python將「self」傳遞給對象方法一樣。 ‘obj_response’參數是函數返回瀏覽器的對象。

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

當檢測到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執行適當的(之前註冊的)函數並將響應返回給瀏覽器。