Django須要注意的10個要點

1，不要將項目名稱包含在引用代碼裏

 

好比你建立了一個名爲"project"的項目，包含一個名爲"app"的應用，那麼以下代碼是很差的：

 

from project.app.models import Author

 

缺點在於：應用和項目變成了緊耦合，沒法將應用輕易變得可重用。若是未來要換一個項目名稱，那你可有得受了。

 

推薦的作法是：

 

from app.models import Author

 

請注意，你須要將項目的路徑配置在PYTHONPATH中。

 

2，不要硬編碼MEDIA_ROOT和TEMPLATE_DIRS

 

項目配置文件settings.py中不要使用以下代碼：

 

TEMPLATE_DIRS = ( "/home/html/project/templates",)
MEDIA_ROOT = "/home/html/project/appmedia/"

 

當你在部署到生產環境，或者遷移服務器的時候，就會發生問題。

 

推薦使用以下方式：

 

SITE_ROOT = os.path.realpath(os.path.dirname(__file__))
MEDIA_ROOT = os.path.join(SITE_ROOT, 'appmedia')
TEMPLATE_DIRS = ( os.path.join(SITE_ROOT, 'templates'),)

 

（也可使用abspath，跟realpath的區別請參考http://rob.cogit8.org/blog/2009/May/05/django-and-relativity-updated/ ）

 

3，不要將靜態文件的路徑硬編碼在模板中

 

模板中連接CSS，javascript或圖片的時候，不建議使用以下方式：

 

<link rel="stylesheet" type="text/css" href="/appmedia/amazing.css" />
<script type="text/javascript" src="/appmedia/jquery.min.js"></script>

 

當你的項目須要將靜態文件用其餘服務器提供的時候，一般會是另一個http地址，那麼你就得把全部的/appmedia/替換成新的地址，作網站寫代碼已經夠乏味的了。

 

沒有後顧之憂的解決方法是使用{{ MEDIA_URL }}代替硬編碼的路徑：

 

<link rel="stylesheet" type="text/css" href="{{ MEDIA_URL }}amazing.css" />
<script type="text/javascript" src="{{ MEDIA_URL }}jquery.min.js"></script>

 

模板上下文變量怎麼獲取到呢？請使用RequestContext便可：

 

return render_to_response("app/template.html", {'var': 'foo'},
context_instance=RequestContext(request))

 

從RequestContext裏還能夠獲取到當前用戶等信息，更詳細的介紹請參考：http://www.b-list.org/weblog/2006/jun/14/django-tips-template-context-processors/

 

4，不要將業務邏輯代碼寫到視圖裏

 

不要迷惑，雖然你可能看過不少書和例子，它們把邏輯都寫在了views.py裏，但請你別這麼作。由於這樣不利於單元測試，不利於重用代碼。

 

那個人業務邏輯應該放哪裏呢？推薦放到模型裏或者單獨創建一個輔助（helper）模塊。

 

固然，從模型獲得一個Author，獲取Author列表的代碼是能夠放到視圖裏面的。

 

5，部署時別忘記將DEBUG設置成False

 

咱們經常忘記在部署時禁用DEBUG，有不少種方法自動來處理這個配置：

 

import socket

if socket.gethostname() == 'productionserver.com':
    DEBUG = False
else:
    DEBUG = True

 

此方法請參考：http://nicksergeant.com/blog/django/automatically-setting-debug-your-django-app-based-server-hostname

 

另外一種途徑是使用不一樣的配置文件：

 

#文件名：settings_debuy.py
#包含調試模式的配置信息
#使用python manage.py runserver settings=settings_debug.py來運行項目

from settings import *

DEBUG = True

#還能夠配置更多在調試時使用的變量：）

 

此方法請參考：http://blog.dpeepul.com/2009/07/02/from-now-you-will-never-forget-to-put-debug-true-in-django-production-environment/

 

6，只加載一次自定義的模板標籤

 

當須要使用自定義或者第三方的模板標籤和模板過濾器時，一般要在模板中使用：

 

{% load template_tags %}

 

實際狀況是，須要在全部用到自定義模板標籤和模板過濾器的模板中都使用上面的代碼，這樣就不DRY了。

 

from django import template

template.add_to_builtins('app.templatetags.custom_tag_module')

 

請將以上代碼放到項目啓動時能加載的模塊中（settings.py, urls.py, models.py等）便可。

 

上面代碼的做用是在項目啓動時就把自定義模板標籤或過濾器加載進來，模板中任何一個地方均可以使用它們，而不須要{% load template_tags %}。

 

7，合理配置和使用URL

 

不要將URL全都配置在一個urls.py文件中，好比：

 

urlpatterns = patterns('',
  url(r'^askalumini/question/$','.....registerInstitution',name='iregister'),
  url(r'^askalumin/answer/$','someview.....',name='newmemberurl'),
  url(r'^institution/member/$','someview.....',name="dashboardurl"),
  url(r'^institution/faculty/$','editInstitute',name="editinstituteurl"),
  url(r'^memeber/editprofile/$','editProfile',name="editprofileurl"),
  url(r'^member/changepassword/$','changePassword',name="changepasswordurl"),
  url(r'^member/forgotpassword/$','forgotPassword',name="forgotpasswordurl"),
  url(r'^member/changepicture/$','changePicture',name="changepictureurl"),
  url(r'^member/logout/$','memeberlogout',name="logouturl"), ,
)

 

建議的方式是將各應用的URL配置在各自的urls.py中，這樣可使應用更容易重複使用到不一樣項目裏：

 

urlpatterns = patterns('',
  (r'^$', include('institution.urls')),
  (r'^institution/', include('institution.urls')),
  (r'^askalumini/', include('askalumini.urls')),
  (r'^member/', include('member.urls')),
)

 

以下是應用askalumini的urls.py：

 

urlpatterns = patterns('askalumini.views',
  url(r'^$','askHome',name='askaluminiurl'),
  url(r'^questions/(?P<questionno>/d+)/$','displayQuestion',name='askquestiondisplay'),
  url(r'^askquestions/$','askQuestion',name='askquestionurl'),
  url(r'^postcomment/$','postComment',name="askquestioncomment")
)

 

剛纔提到靜態文件路徑不要硬編碼，url的處理方式也儘可能不要硬編碼，不然當你更改一個地址時會牽涉到多處的修改，可使用一些url函數來處理。

 

在/project/askalumini/urls.py中，爲每個url定義了name，它能夠幫助咱們有效地在視圖、模板和模型中處理url，而不是硬編碼。

 

爲保證名稱的惟一，請遵守將url命名爲<appname>/<somelabel>的習慣用法。

 

舉例來講，在views.py文件中有以下代碼：

 

HttpResponseRedirect("/askalumini/questions/54")

 

請改成：

 

from django.core.urlresolvers import reverse
HttpResponseRedirect(reverse('askquestiondisplay',kwargs={'questionno':q.id}))

 

在模型中使用models.permalink裝飾器來格式url：

 

@models.permalink
def get_absolute_url(self):
    return ('profileurl2',(),{'userid': self.user.id})

 

在模板中使用url標籤代替硬編碼：

 

{% url askquestiondisplay 345 %}
<a href="{% url askquestiondisplay 345 %}"> Ask Question </a>

 

8，調試

 

調試一般會藉助一些第三方工具來得到更多的運行時信息。

 

一個請求執行了多少句SQL？花了多長時間？

 

調用的哪一個模板？客戶端設置了什麼COOKIE？SESSION呢？。。。

 

你可使用django-debug-toolbar查看上面甚至更多的信息：http://github.com/robhudson/django-debug-toolbar

 

另外一個工具是Werkzeug debugger，它能夠在錯誤頁面打開python shell，讓你更方便的跟蹤錯誤信息，請訪問：http://blog.dpeepul.com/2009/07/14/python-shell-right-on-the-django-error-page/ 得到更多信息。

 

還有pdb，一個強大的調試工具：http://ericholscher.com/blog/2008/aug/31/using-pdb-python-debugger-django-debugging-series-/

 

9，瞭解pinax備用

 

django最大的優勢是代碼重用，DRY，pinax就是這樣一個平臺，包含了許多可拿來直接使用的代碼，好比openid，電子郵件驗證等等。請訪問：http://pinaxproject.com/

 

10，瞭解一些著名的第三方應用

 

1）數據庫升級工具

 

什麼是數據庫升級工具？你運行了syncdb，運行了一年以後，對模型作了更改，添加了字段，刪除了字段，要再運行syncdb嗎？或者ALTER TABLE ...？

 

django-evolutions能夠幫你完成上面的事情，但它好像不夠強壯：http://code.google.com/p/django-evolution/

 

South能很強壯地完成上面的事情，可是須要學學怎麼用：http://south.aeracode.org/

 

2）模板系統

 

django自帶的模板系統是能夠替換的，而且各自有優缺點。

 

template-utils加強了模板的比較標籤等功能 ，並提供其餘的一些實用特性：http://django-template-utils.googlecode.com/svn/trunk/docs/

 

Jinja是一個完整的第三方模板系統，能夠替換默認模板系統，它提供了許多優越的特性：http://jinja.pocoo.org/2/

 

3）第三方應用

 

django command extensions提供了不少實用的命令行功能：

 

shell_plus加載全部django模型

 

runserver_plus整合了Werkzeug調試工具

 

生成模型圖表，你能夠展現給你的老闆

 

……

 

請參考：http://ericholscher.com/blog/2008/sep/12/screencast-django-command-extensions/

 

Sorl能夠生成縮略圖：http://code.google.com/p/sorl-thumbnail/

 

…………

 

---END---

 

另外，從原文的評論裏也有很多發現：

• 用django.shortcuts的redirect代替HttpResponseRedirect：http://docs.djangoproject.com/en/dev/topics/http/shortcuts/#redirect
• 使用VirtualEnv部署django項目
• django項目規範：http://ericholscher.com/projects/django-conventions/project/ 
• 上面提到的10點中，第2和第4是最容易在新手中發生的。
• 第6點並不適合於團隊協做