Django 新人開發的十個注意點

      總結一下 Django開發中，注意的事項，特別是新人，由於水平有限，也只能到這個層次，更多模式思想性的東西，還得在開發中慢慢體會。

      1.各個APP獨立，做到項目的模塊分明。說的有點大，列幾個列子優先

    

from project.bookmark.models import Tag

     該例子將項目名稱加入其中是不合適，缺點在於：應用和項目變成了緊耦合，無法將應用輕易變得可重用。如果將來要換一個項目名稱，那你可有得受了。

    推薦的做法是

from bookmark.models import Tag

    還有個例子

bookmark.views.py

from account.models import User
from friend.models import FriendShip
from bookmark.models import Tag

     該例子在bookmark app中耦合了三個模塊 account,friend,bookmark, 應該盡量減少這樣的耦合，account,friend 這兩個模塊聯系比較緊密，可以合成一個。

    推薦的做法:

bookmark.views.py

from account.models import FriendShip,User
from bookmark.models import Tag

      2. 不要硬編碼 MEDIA_ROOT,STATIS_ROOT, 

      在python中關於url的處理，有些原則，比如不要硬編碼，處理成UNIX,WINDOWS兼容的格式，和進行空格的處理等

     

MEDIA_ROOT = 'E:\\test\mugshot\\'
STATIC_ROOT = '/VAR/TEMP/STATIC'

    這種做法有很多問題，比如機器遷移，和 應用的移動都會影響。

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'),)  

這樣的寫法比較可擴展性。

      3.不要將URL硬編碼在HTML中，

 

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

當你的項目需要將靜態文件用其他服務器提供的時候，通常會是另外一個http地址，那么你就得把所有的/appmedia/替換成新的地址，做網站寫代碼已經夠乏味的了。

 

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

 

 

模板上下文變量怎么獲取到呢？請使用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點並不適合於團隊協作