Django最適合于所謂的green-field開發(fā),即從頭開始的一個(gè)項(xiàng)目,正如你在一塊還長著青草的未開墾的土地上從零開始建造一棟建筑一般。 然而,盡管Django偏愛從頭開始的項(xiàng)目,將這個(gè)框架和以前遺留的數(shù)據(jù)庫和應(yīng)用相整合仍然是可能的。 本章就將介紹一些整合的技巧。
Django的數(shù)據(jù)庫層從Python代碼生成SQL schemas—但是對于遺留數(shù)據(jù)庫,你已經(jīng)擁有SQL schemas. 這種情況,你需要為已經(jīng)存在的數(shù)據(jù)表創(chuàng)建model. 為此,Django自帶了一個(gè)可以通過讀取您的數(shù)據(jù)表結(jié)構(gòu)來生成model的工具. 該輔助工具稱為inspectdb,你可以通過執(zhí)行manage.py inspectdb
來調(diào)用它.
inspectdb工具自省你配置文件指向的數(shù)據(jù)庫,針對每一個(gè)表生成一個(gè)Django模型,然后將這些Python模型的代碼顯示在系統(tǒng)的標(biāo)準(zhǔn)輸出里面。
下面是一個(gè)從頭開始的針對一個(gè)典型的遺留數(shù)據(jù)庫的整合過程。 兩個(gè)前提條件是安裝了Django和一個(gè)傳統(tǒng)數(shù)據(jù)庫。
通過運(yùn)行django-admin.py startproject mysite (這里 mysite 是你的項(xiàng)目的名字)建立一個(gè)Django項(xiàng)目。 好的,那我們在這個(gè)例子中就用這個(gè) mysite 作為項(xiàng)目的名字。
編輯項(xiàng)目中的配置文件, mysite/settings.py ,告訴Django你的數(shù)據(jù)庫連接參數(shù)和數(shù)據(jù)庫名。 具體的說,要提供 DATABASE_NAME , DATABASE_ENGINE , DATABASE_USER , DATABASE_PASSWORD , DATABASE_HOST , 和DATABASE_PORT 這些配置信息.。 (請注意其中的一些設(shè)置是可選的。 更多信息參見第5章)
通過運(yùn)行 python mysite/manage.py startapp myapp (這里 myapp 是你的應(yīng)用的名字)創(chuàng)建一個(gè)Django應(yīng)用。 這里我們使用myapp 做為應(yīng)用名。
運(yùn)行命令 python mysite/manage.py inspectdb。這將檢查DATABASE_NAME 數(shù)據(jù)庫中所有的表并打印出為每張表生成的模型類。 看一看輸出結(jié)果以了解inspectdb能做些什么。
將標(biāo)準(zhǔn)shell的輸出重定向,保存輸出到你的應(yīng)用的 models.py 文件里:
python mysite/manage.py inspectdb > mysite/myapp/models.py
編輯 mysite/myapp/models.py 文件以清理生成的 models 并且做一些必要的自定義。 針對這個(gè),下一個(gè)節(jié)有些好的建議。
如你可能會(huì)預(yù)料到的,數(shù)據(jù)庫自省不是完美的,你需要對產(chǎn)生的模型代碼做些許清理。 這里提醒一點(diǎn)關(guān)于處理生成 models 的要點(diǎn):
數(shù)據(jù)庫的每一個(gè)表都會(huì)被轉(zhuǎn)化為一個(gè)model類 (也就是說,數(shù)據(jù)庫的表和model 類之間是一對一的映射)。 這意味著你需要為多對多連接的表,重構(gòu)其models 為 ManyToManyField 的對象。
所生成的每一個(gè)model中的每個(gè)字段都擁有自己的屬性,包括id主鍵字段。 但是,請注意,如果某個(gè)model沒有主鍵的話,那么Django會(huì)自動(dòng)為其增加一個(gè)id主鍵字段。 這樣一來,你也許希望移除這樣的代碼行。
id = models.IntegerField(primary_key=True)
這樣做并不是僅僅因?yàn)檫@些行是冗余的,而且如果當(dāng)你的應(yīng)用需要向這些表中增加新記錄時(shí),這些行會(huì)導(dǎo)致某些問題。
每一個(gè)字段類型,如CharField、DateField, 是通過查找數(shù)據(jù)庫列類型如VARCHAR,DATE來確定的。如果inspectdb無法把某個(gè)數(shù)據(jù)庫字段映射到model字段上,它會(huì)使用TextField字段進(jìn)行代替,并且會(huì)在所生成model字段后面加入Python注釋“該字段類型是猜的”。 對這要當(dāng)心,如果必要的話,更改字段類型。
如果你的數(shù)據(jù)庫中的某個(gè)字段在Django中找不到合適的對應(yīng)物,你可以放心的略過它。 Django模型層不要求必須導(dǎo)入你數(shù)據(jù)庫表中的每個(gè)列。
如果數(shù)據(jù)庫中某個(gè)列的名字是Python的保留字(比如pass、class或者for等),inspectdb會(huì)在每個(gè)屬性名后附加上_field,并將db_column屬性設(shè)置為真實(shí)的字段名(也就是pass,class或者for等)。
例如,某張表中包含一個(gè)INT類型的列,其列名為for,那么所生成的model將會(huì)包含如下所示的一個(gè)字段:
for_field = models.IntegerField(db_column='for')
inspectdb 會(huì)在該字段后加注 ‘字段重命名,因?yàn)樗且粋€(gè)Python保留字’ 。
如果數(shù)據(jù)庫中某張表引用了其他表(正如大多數(shù)數(shù)據(jù)庫系統(tǒng)所做的那樣),你需要適當(dāng)?shù)男薷乃蒻odel的順序,以使得這種引用能夠正確映射。 例如,model Book擁有一個(gè)針對于model Author的外鍵,那么后者應(yīng)該先于前者被定義。如果你想創(chuàng)建一個(gè)指向尚未定義的model的關(guān)系,那么可以使用包含model名的字符串,而不是model對象本身。
對于PostgreSQL,MySQL和SQLite數(shù)據(jù)庫系統(tǒng),inspectdb能夠自動(dòng)檢測出主鍵關(guān)系。 也就是說,它會(huì)在合適的位置插入primary_key=True。 而對于其他數(shù)據(jù)庫系統(tǒng),你必須為每一個(gè)model中至少一個(gè)字段插入這樣的語句,因?yàn)镈jango的model要求必須擁有一個(gè)primary_key=True的字段。
外鍵檢測僅對PostgreSQL,還有MySQL表中的某些特定類型生效。 至于其他數(shù)據(jù)庫,外鍵字段將在假定其為INT列的情況下被自動(dòng)生成為IntegerField。
將Django與其他現(xiàn)有認(rèn)證系統(tǒng)的用戶名和密碼或者認(rèn)證方法進(jìn)行整合是可以辦到的。
例如,你所在的公司也許已經(jīng)安裝了LDAP,并且為每一個(gè)員工都存儲(chǔ)了相應(yīng)的用戶名和密碼。 如果用戶在LDAP和基于Django的應(yīng)用上擁有獨(dú)立的賬號,那么這時(shí)無論對于網(wǎng)絡(luò)管理員還是用戶自己來說,都是一件很令人頭痛的事兒。
為了解決這樣的問題,Django認(rèn)證系統(tǒng)能讓您以插件方式與其他認(rèn)證資源進(jìn)行交互。 您可以覆蓋Diango默認(rèn)的基于數(shù)據(jù)庫的模式,您還可以使用默認(rèn)的系統(tǒng)與其他系統(tǒng)進(jìn)行交互。
在后臺(tái),Django維護(hù)了一個(gè)用于檢查認(rèn)證的后臺(tái)列表。 當(dāng)某個(gè)人調(diào)用 django.contrib.auth.authenticate()(如14章中所述)時(shí),Django會(huì)嘗試對其認(rèn)證后臺(tái)進(jìn)行遍歷認(rèn)證。 如果第一個(gè)認(rèn)證方法失敗,Django會(huì)嘗試認(rèn)證第二個(gè),以此類推,一直到嘗試完。
認(rèn)證后臺(tái)列表在AUTHENTICATION_BACKENDS設(shè)置中進(jìn)行指定。 它應(yīng)該是指向知道如何認(rèn)證的Python類的Python路徑的名字?jǐn)?shù)組。 這些類可以在你Python路徑的任何位置。
默認(rèn)情況下,AUTHENTICATION_BACKENDS被設(shè)置為如下:
('django.contrib.auth.backends.ModelBackend',)
那就是檢測Django用戶數(shù)據(jù)庫的基本認(rèn)證模式。
AUTHENTICATION_BACKENDS的順序很重要,如果用戶名和密碼在多個(gè)后臺(tái)中都是有效的,那么Django將會(huì)在第一個(gè)正確匹配后停止進(jìn)一步的處理。
一個(gè)認(rèn)證后臺(tái)其實(shí)就是一個(gè)實(shí)現(xiàn)了如下兩個(gè)方法的類: get_user(id) 和 authenticate(**credentials) 。
方法 get_user 需要一個(gè)參數(shù) id ,這個(gè) id 可以是用戶名,數(shù)據(jù)庫ID或者其他任何數(shù)值,該方法會(huì)返回一個(gè)User 對象。
方法 authenticate 使用證書作為關(guān)鍵參數(shù)。 大多數(shù)情況下,該方法看起來如下:
class MyBackend(object):
def authenticate(self, username=None, password=None):
# Check the username/password and return a User.
但是有時(shí)候它也可以認(rèn)證某個(gè)短語,例如:
class MyBackend(object):
def authenticate(self, token=None):
# Check the token and return a User.
每一個(gè)方法中, authenticate 都應(yīng)該檢測它所獲取的證書,并且當(dāng)證書有效時(shí),返回一個(gè)匹配于該證書的User 對象,如果證書無效那么返回 None 。 如果它們不合法,就返回None。
如14章中所述,Django管理系統(tǒng)緊密連接于其自己后臺(tái)數(shù)據(jù)庫的 User 對象。 實(shí)現(xiàn)這個(gè)功能的最好辦法就是為您的后臺(tái)數(shù)據(jù)庫(如LDAP目錄,外部SQL數(shù)據(jù)庫等)中的每個(gè)用戶都創(chuàng)建一個(gè)對應(yīng)的Django User對象。 您可以提前寫一個(gè)腳本來完成這個(gè)工作,也可以在某個(gè)用戶第一次登陸的時(shí)候在 authenticate 方法中進(jìn)行實(shí)現(xiàn)。
以下是一個(gè)示例后臺(tái)程序,該后臺(tái)用于認(rèn)證定義在 setting.py 文件中的username和password變量,并且在該用戶第一次認(rèn)證的時(shí)候創(chuàng)建一個(gè)相應(yīng)的Django User 對象。
from django.conf import settings
from django.contrib.auth.models import User, check_password
class SettingsBackend(object):
"""
Authenticate against the settings ADMIN_LOGIN and ADMIN_PASSWORD.
Use the login name, and a hash of the password. For example:
ADMIN_LOGIN = 'admin'
ADMIN_PASSWORD = 'sha1$4e987$afbcf42e21bd417fb71db8c66b321e9fc33051de'
"""
def authenticate(self, username=None, password=None):
login_valid = (settings.ADMIN_LOGIN == username)
pwd_valid = check_password(password, settings.ADMIN_PASSWORD)
if login_valid and pwd_valid:
try:
user = User.objects.get(username=username)
except User.DoesNotExist:
# Create a new user. Note that we can set password
# to anything, because it won't be checked; the password
# from settings.py will.
user = User(username=username, password='get from settings.py')
user.is_staff = True
user.is_superuser = True
user.save()
return user
return None
def get_user(self, user_id):
try:
return User.objects.get(pk=user_id)
except User.DoesNotExist:
return None
更多認(rèn)證模塊的后臺(tái), 參考Django文檔。
同由其他技術(shù)驅(qū)動(dòng)的應(yīng)用一樣,在相同的Web服務(wù)器上運(yùn)行Django應(yīng)用也是可行的。 最簡單直接的辦法就是利用Apaches配置文件httpd.conf,將不同的URL類型分發(fā)至不同的技術(shù)。 (請注意,第12章包含了在Apache/mod_python上配置Django的相關(guān)內(nèi)容,因此在嘗試本章集成之前花些時(shí)間去仔細(xì)閱讀第12章或許是值得的。)
關(guān)鍵在于只有在您的httpd.conf文件中進(jìn)行了相關(guān)定義,Django對某個(gè)特定的URL類型的驅(qū)動(dòng)才會(huì)被激活。 在第12章中解釋的缺省部署方案假定您需要Django去驅(qū)動(dòng)某個(gè)特定域上的每一個(gè)頁面。
<Location "/">
SetHandler python-program
PythonHandler django.core.handlers.modpython
SetEnv DJANGO_SETTINGS_MODULE mysite.settings
PythonDebug On
</Location>
這里, <Location "/">
這一行表示用Django處理每個(gè)以根開頭的URL.
精妙之處在于Django將指令值限定于一個(gè)特定的目錄樹上。 舉個(gè)例子,比如說您有一個(gè)在某個(gè)域中驅(qū)動(dòng)大多數(shù)頁面的遺留PHP應(yīng)用,并且您希望不中斷PHP代碼的運(yùn)行而在../admin/位置安裝一個(gè)Django域。 要做到這一點(diǎn),您只需將值設(shè)置為/admin/即可。
<Location "/admin/">
SetHandler python-program
PythonHandler django.core.handlers.modpython
SetEnv DJANGO_SETTINGS_MODULE mysite.settings
PythonDebug On
</Location>
有了這樣的設(shè)置,只有那些以/admin/開頭的URL地址才會(huì)觸發(fā)Django去進(jìn)行處理。 其他頁面會(huì)使用已存在的設(shè)置。
請注意,把Diango綁定到的合格的URL(比如在本章例子中的 /admin/
)并不會(huì)影響其對URL的解析。 絕對路徑對Django才是有效的(例如 /admin/people/person/add/
),而非截?cái)嗪蟮腢RL(例如/people/person/add/
)。這意味著你的根URLconf必須包含前綴 /admin/
。
如果你的母語是英語, 你可能就不會(huì)注意到許多Django admin網(wǎng)站中最酷的特性功能。 它支持超過50種語言! Django 的國際化框架使其成為可能( 還有Django志愿翻譯者的努力 ) 下一章介紹如何使用這個(gè)框架來提供本地化的Django網(wǎng)站。