Flask的SERVER_NAME解析

SERVER_NAME是Flask中比較容易用錯的一個設置值，本文將介紹如何正確使用SERVER_NAME。

Flask中的SERVER_NAME主要作兩件事：

1. 協助Flask在活動的請求（request）以外生成絕對URL（好比郵件中嵌入網站URL）

2. 用於子域名支持

不少人誤覺得它能夠作這兩件事以外的其它事情。

第一件事：絕對URL

咱們知道，url_for默認狀況下是生成相對URL，它有個參數_external，若是設置爲真，則會生成一個絕對URL（就是HTTP開頭帶域名等信息的）。若不指定SERVER_NAME，默認使用當前活動的請求（request）來生成URL。

下面舉個例子演示一下：

# filename myapp.py
from flask import Flask, url_for

app = Flask(__name__)
@app.route('/')
def index():
    return 'hello flask'
@app.route('/test')
def test():
    return url_for('index', _external=True)
if __name__ == '__main__':
    app.run(debug=True)

【情景1】經過瀏覽器訪問

app運行以後，在本地5000端口監聽。

(env) F:\tmp>python myapp.py
 * Running on http://127.0.0.1:5000/
 * Restarting with reloader

若咱們經過瀏覽器訪問http://127.0.0.1:5000/test，則返回的內容是：http://127.0.0.1:5000/。

能夠看出，在未設置SERVER_NAME的狀況下，url_for生成的絕對URL是依賴於請求的URL的。下面咱們來看看不經過瀏覽器訪問的狀況。

【情景2】非瀏覽器訪問

這個情景是指不存在request請求的狀況。

咱們經過Python Shell來模擬：

>>> from myapp import app
>>> with app.app_context():
...     print url_for('index', _external=True)
...
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
  File "F:\tmp\env\lib\site-packages\flask\helpers.py", line 287, in url_for    raise RuntimeError('Application was not able to create a URL 'RuntimeError: Application was not able to create a URL adapter for request indep
endent URL generation. You might be able to fix this by setting the SERVER_NAME
config variable.

上面的意思是說應用程序不能建立一個用於與request不相關的URL生成的URL適配器，能夠經過設置SERVER_NAME來解決這個問題。

好，下面咱們爲SERVER_NAME設置一個值以後再試試：

>>> app.config['SERVER_NAME'] = 'example.com'
>>> with app.app_context():
...     print url_for('index', _external=True)
...http://example.com/

PS: 通常SERVER_NAME設置爲網站的域名。

在Flask-Mail相關的文章中有這麼一段話：

許多Flask的擴展都是假定本身運行在一個活動的應用和請求上下文中，Flask-Mail
 的send函數使用到current_app這個上下文了，因此當mail.send()函數在一個
 線程中執行的時候須要人爲的建立一個上下文，全部在send_async_email中使用了
app.app_context()來建立一個上下文。

原文以下:

Many Flask extensions operate under the assumption that there are active
 application and request contexts. Flask-Mail's send() function uses
current_app, so it requires the application context to be active.  But
 when the mail.send() function executes in a different thread, the
 application context needs to be created artificially usingapp.app_context().

所以，若要生成不依賴於request的絕對URL（好比異步發送郵件時在郵件中生成網站某個頁面的URL），就必需要設置SERVER_NAME。

第二件事：子域名支持

SERVER_NAME鍵是用於子域名支持。由於 Flask 在得知現有服務器名以前不能猜想出子域名部分，因此若是你想使用子域名，這個選項必要的，而且也用於會話cookie。

請牢記不僅有 Flask 存在不知道子域名的問題，你的瀏覽器一樣存在這樣的問題。 大多數現代 web 瀏覽器不容許服務器名不含有點的跨子域名 cookie。所以若是你的服務器的 名稱爲 localhost，你將不能爲 localhost 和全部它的子域名設置一個 cookie。 請選擇一個合適的服務器名，像 'myapplication.local'， 並添加你想要的服務器名 + 子域名 到你的 host 配置或設置一個本地 bind。

在以前的文章中，咱們講到Flask中的SERVER_NAME主要作兩件事：

1. 協助Flask生成請求上下文以外的URL（好比郵件）

2. 用於子域名支持

今天咱們就來說講子域名這部分。

Flask子域名

通常用於數量比較少的子域名，一個模塊對應一個子域名。先看下面一個例子：

modules.py:

from flask import Blueprint

public = Blueprint('public', __name__)
@public.route('/')
def home():
    return 'hello flask'

app.py:

app = Flask(__name__)
app.config['SERVER_NAME'] = 'example.com'
from modules import public
app.register_blueprint(public, subdomain='public')

如今能夠經過public.example.com/來訪問public模塊了。

通配符子域

通配符子域，即經過一個模塊來匹配不少個子域名。好比某些網站提供的個性化域名功能，就是這種形式。

先來看段示例代碼：

modules.py:

from flask import Blueprint

member = Blueprint('member', __name__)
@member.route('/')
def home():
    return g.subdomain

app.py:

app = Flask(__name__)
app.config['SERVER_NAME'] = 'example.com'
from modules import member
app.register_blueprint(member, subdomain='<subdomain>')

這段代碼和上一節的第像，不一樣之處是這裏的subdomain使用了動態參數<subdomain>（路由中的URL變量也是這種方式）。咱們能夠用這個參數在請求回調函數以前利用的組合的url處理器來獲取相關的用戶。這樣咱們就能夠經過*.example.com的形式來訪問member模塊了。

下面是爲任何Flask或Blueprint對象增長子域名支持的便捷函數：

def add_subdomain_to_global(endpoint, values):
    g.subdomain = values.pop('subdomain', None)
def add_subdomain_to_url_params(endpoint, values):
    if not 'subdomain' in values:
        values['subdomain'] = g.subdomaindef 
add_subdomain_support(app):
    app.url_value_preprocessor(add_subdomain_to_global)
    app.url_defaults(add_subdomain_to_url_params)

而後你可使用before_request回調函數來處理子域名：

add_subdomain_support(blueprint)
@blueprint.before_request
def add_user_to_global():
    g.user = None
    if g.subdomain:
        g.user = User.query.filter_by(username=g.subdomain).first_or_404()

注：這裏的blueprint請改成實際對象。

特別說明：通配符子域調試不是不太方便，須要作泛域名解析才能夠。修改hosts文件來指定域名的方法是不可行 的（子域名較少時能夠逐個添加，子域名多了就不太現實了）。本機調試時，能夠安裝DNS服務器（好比LINUX BIND服務等），並作好泛域名解析，而後再進行調試。固然使用公網域名和服務器來調試也何嘗不可。

英文好的同窗能夠參閱：Getting bigger with Flask