Django datang dengan sebuah pilihan kerangka kerja "sites". Itu adalah pengait untuk obyek-obyek terkait dan kegunaannya untuk situs jaringan tertentu, dan itu adalah tempat menahan untuk nama ranah dan nama-nama "verbose" dari situs-situs anda ditenagai-Django.
\nGunakan itu jika pemasangan Django tunggal anda mentenagai lebih dari satu situs dan anda butuh membedakan diantara situs-situs tersebut dalam beberapa cara.
\nKerangka kerja situs utamanya berdasarkan pada model sederhana:
\nSebuah model untuk menyimpan atribut domain dan name dari situs jaringan.
Nama ranah memenuhi syarat sepenuhnya terkait dengan situs jaringan. Sebagai contoh, www.example.com.
Nama "verbose" dibaca-manusia untuk situ sjaringan.
\nPengaturan SITE_ID menentukan ID basisdata dari obyek Site terkait dengan berkas pengaturan tertentu itu. Jika pengaturan dihilangkan, fungsi get_current_site() akan mencoba untuk mendapatkan situs saat ini dengan membandingkan domain dengan nama rumah dari metode request.get_host().
Bagaimana anda menggunakannya terserah anda, tetapi Django menggunakan itu dalam sepasang cara otomatis melalui kebiasanaan sederhana.
\nMengapa anda menggunakan situs? Ini adalah penjelasan terbaik melalui contoh.
\nSitus-situs ditenagai-Django LJWorld.com dan Lawrence.com dikendalikan oleh organisasi berita yang sama -- surat kabar Lawrence Journal-World di Lawrence, Kansas. LJWorld.com fokus pada berita, selagi Lawrence.com fokus pada hiburan lokal. Tetapi terkadang penyunting ingin menerbitkan sebuah artikel pada kedua situs.
\nCara pemecahan tidak dibuat-buat dari memecahkan masalah yaitu membutuhkan pembuat situs untuk menerbitkan cerita sama dua kali: sekali untuk LJWorld.com dan kembali untuk Lawrence.com. Tetapi itu tidak efesien untuk pembuat situs, dan itu berulang untuk menyimpan banyak salinan dari cerita sama dalam basisdata.
\nPemecahan terbaik adalah sederhana: Kedua situs menggunakanbasisdata artikel yang sama, dan sebuah artikel berhubungan dengan satu atau lebih situs. Dalam istilah model Django, yaitu diwakili oleh sebuah ManyToManyField dalam model Article:
from django.contrib.sites.models import Site\nfrom django.db import models\n\nclass Article(models.Model):\n headline = models.CharField(max_length=200)\n # ...\n sites = models.ManyToManyField(Site)\nIni menyelesaikan beberapa hal cukup baik:
\nItu membiarkan pembuat situs menyunting semua isi -- pada kedua situs -- dalam antarmuka tunggal (admin Django).
Itu berarti cerita sams tidak harus menerbitkan kedua kali di basisdata; itu hanya mempunyai rekaman tunggal di basisdata.
Itu membiarkan pengembang situs menggunakan kode tampilan Django sama untuk kedua situs. Kode tampilan yang memperlihatkan cerita yang diberikan cukup memeriksa untuk memastikan cerita diminta pada situs saat ini. Itu terlihat sesuatu seperti ini:
\nfrom django.contrib.sites.shortcuts import get_current_site\n\ndef article_detail(request, article_id):\n try:\n a = Article.objects.get(id=article_id, sites__id=get_current_site(request).id)\n except Article.DoesNotExist:\n raise Http404("Article does not exist on this site")\n # ...\nDemikian pula, anda dapat menghubungkan sebuah model ke model Site dalam sebuah hubungan many-to-one, menggunakan ForeignKey.
Sebagai contoh, jika sebuah artikel hanya diizinkan pada situs tunggal, anda akan menggunakan model seperti ini:
\nfrom django.contrib.sites.models import Site\nfrom django.db import models\n\nclass Article(models.Model):\n headline = models.CharField(max_length=200)\n # ...\n site = models.ForeignKey(Site, on_delete=models.CASCADE)\nIni mempunyai keuntungan sama seperti digambarkan di bagian terakhir.
\nAnda dapat menggunakan kerangka kerja situs di tampilan Django anda untuk melakukan hal-hal tertentu berdasarkan pada situs dimana tampilan sedang dipanggil. Sebagai contoh:
\nfrom django.conf import settings\n\ndef my_view(request):\n if settings.SITE_ID == 3:\n # Do something.\n pass\n else:\n # Do something else.\n pass\nTentu saja, itu adalah kode-keras buruk ID situs seperti itu. pengkodean-keras semacam ini adalah terbaik untuk diperbaiki yang anda butuh diselesaikan cepat. Cara terbersih dari memenuhi hal sama adalah memeriksa ranah situs saat ini:
\nfrom django.contrib.sites.shortcuts import get_current_site\n\ndef my_view(request):\n current_site = get_current_site(request)\n if current_site.domain == 'foo.com':\n # Do something\n pass\n else:\n # Do something else.\n pass\nIni juga mempunyai keuntungan dari pemeriksaan jika kerangka kerja situs dipasang, dan mengembalikan contoh RequestSite jika itu tidak.
Jika anda tidak mempunyai akses ke obyek diminta, anda dapat menggunakan metode get_current() dari pengelola model Site. Anda harus kemudian memastikan bahwa berkas pengaturan anda mengandung pengaturan SITE_ID. Contoh ini adalah setara pada satu sebelumnya:
from django.contrib.sites.models import Site\n\ndef my_function_without_request():\n current_site = Site.objects.get_current()\n if current_site.domain == 'foo.com':\n # Do something\n pass\n else:\n # Do something else.\n pass\nLJWorld.com dan Lawrence.com keduanya memiliki kegunakan peringatan surel, yang membuat pembaca masuk untuk mendapatkan pemberitahuan ketika berita terjadi. itu adalah dasar: Seorang pembaca masuk pada formulir Jaringan dan segera mendapatkan sebuah surel berkata, "Terima kasih untuk langganan anda."
\nItu sangat tidak efesien dan berulang untuk menerapkan kode pengolahan daftar ini dua kali, jadi situs menggunakan kode sama dibelakang layar. Tetapi pemberitahuan "thank you for signing up" butuh berbeda untuk setiap situs. Dengan menggunakan obyek Site, kami dapat meringkaskan pemberitahuan "thank you" untuk menggunakan nilai dari name dan domain situs saat ini.
Disini adalah contoh dari apa tampilan penanganan formulir kelihatannya:
\nfrom django.contrib.sites.shortcuts import get_current_site\nfrom django.core.mail import send_mail\n\ndef register_for_newsletter(request):\n # Check form values, etc., and subscribe the user.\n # ...\n\n current_site = get_current_site(request)\n send_mail(\n 'Thanks for subscribing to %s alerts' % current_site.name,\n 'Thanks for your subscription. We appreciate it.\\n\\n-The %s team.' % (\n current_site.name,\n ),\n 'editor@%s' % current_site.domain,\n [user.email],\n )\n\n # ...\nPada Lawrence.com, surel ini mempunyai baris judul "peringatan Terima kasih untuk berlanggakan di lawrence.co." Pada LJWorld.com, surel mempunyai judul "peringatan Terima kasih untuk berlangganan di LJWorld.com." Sama seperti badan pesan surel.
\nCatat bahwa bahkan lebih elastis (tetapi lebih kelas berat) cara melakukan ini akan menggunakan sistem cetakan Django. Menganggap Lawrence.com dan LJWorld.com mempunyai direktori cetakan berbeda (DIRS), anda cukup bertani sistem cetakan seperti itu:
from django.core.mail import send_mail\nfrom django.template import Context, loader\n\ndef register_for_newsletter(request):\n # Check form values, etc., and subscribe the user.\n # ...\n\n subject = loader.get_template('alerts/subject.txt').render(Context({}))\n message = loader.get_template('alerts/message.txt').render(Context({}))\n send_mail(subject, message, 'editor@ljworld.com', [user.email])\n\n # ...\nDalam kasus ini, anda harus membuat berkas cetakan subject.txt dan message.txt untuk kedua direktori cetakan LJWorld.com and Lawrence.com. Itu memberikan anda lebih keluwesan, tetapi itu juga lebih rumit.
itu adalah ide bagus membuka obyek Site sebanyak mungkin untuk memindahkan kerumitan dan perulangan yang tidak diperlukan.
Kaidah get_absolute_url() Django baik untuk mendapatkan URL obyek anda tanpa nama ranah, tetapi dalam beberapa kasus anda mungkin ingin menampilkan URL penuh -- dengan http:// dan ranah dan semuanya -- untuk sebuah obyek. Untuk melakukan ini, anda dapat menggunakan kerangka kerja situs. Contoh sederhana:
>>> from django.contrib.sites.models import Site\n>>> obj = MyModel.objects.get(id=3)\n>>> obj.get_absolute_url()\n'/mymodel/objects/3/'\n>>> Site.objects.get_current().domain\n'example.com'\n>>> 'https://%s%s' % (Site.objects.get_current().domain, obj.get_absolute_url())\n'https://example.com/mymodel/objects/3/'\nUntuk mengadakan kerangka situs ini, ikuti langkah-langkah ini:
\nMenambahkan 'django.contrib.sites' ke pengaturan INSTALLED_APPS anda.
Menentukan pengaturan SITE_ID:
SITE_ID = 1\nMenjalankan migrate.
django.contrib.sites mendaftarkan penangan sinyal post_migrate yang membuat situs awalan bernama example.com dengan ranah example.com. Situs ini akan juga dibuat setelah Django basisdata percobaan. Untuk mensetel nama benar dan ranah untuk proyek anda, anda dapat menggunakan data migration.
Untuk melayani situs berbeda dalam produksi, anda aakn membuat berkas pengaturan dengan setiap SITE_ID (mungkin mengimpor dari berkas pengaturan umum untuk menghindari penggandaan pengaturan berbagi) dan kemudian menentukan DJANGO_SETTINGS_MODULE sesuai untuk setiap situs.
Site saat iniLink to this heading#Ketika situs saat ini disimpan dalam basisdata, setiap panggilan pada Site.objects.get_current() dapat menghasilkan sebuah permintaan basisdata. Tetapi Django sedikit lebih pintar pada permintaan pertama, situs saat ini disimpan sementara, dan panggilan selanjutnya apapun mengembalikan data disimpan sementara daripada mengenai basisdata.
Jika untuk alasan apapun anda ingin memaksa permintaan basisdata, anda dapat memberitahu Django untuk membersihkan cache menggunakan Site.objects.clear_cache():
# First call; current site fetched from database.\ncurrent_site = Site.objects.get_current()\n# ...\n\n# Second call; current site fetched from cache.\ncurrent_site = Site.objects.get_current()\n# ...\n\n# Force a database query for the third call.\nSite.objects.clear_cache()\ncurrent_site = Site.objects.get_current()\nCurrentSiteManagerLink to this heading#Jika Site memainkan sebuah peran kunci dalam apliaksi anda, pertimbangkan menggunakan CurrentSiteManager membantu dalam model anda. Itu adalah sebuah model manager yang otomatis menyaring permintaannya untuk menyertakan obyek apapun berkaitan dengan Site saat ini.
Gunakan CurrentSiteManager dengan menambahkan itu ke model anda dengan tegas. Sebagai contoh:
from django.contrib.sites.models import Site\nfrom django.contrib.sites.managers import CurrentSiteManager\nfrom django.db import models\n\nclass Photo(models.Model):\n photo = models.FileField(upload_to='photos')\n photographer_name = models.CharField(max_length=100)\n pub_date = models.DateField()\n site = models.ForeignKey(Site, on_delete=models.CASCADE)\n objects = models.Manager()\n on_site = CurrentSiteManager()\nDengan model ini, Photo.objects.all() akan mengembalikan semua obyek Photo dalam basisdata, tetapi Photo.on_site.all() akan mengembalikan hanya obyek Photo berkaitan dengan situs saat ini, menurut pada pengaturan SITE_ID.
Taruh di jalan lain, dua pernyataan ini adalah sama:
\nPhoto.objects.filter(site=settings.SITE_ID)\nPhoto.on_site.all()\nBagaimana CurrentSiteManager mengetahui bidang mana dari Photo adalah the Site? Secara awalan, CurrentSiteManager mencari salah satu ForeignKey dipanggil site atau ManyToManyField dipanggil sites untuk menyaring. Jika anda menggunakan sebuah bidang bernama sesuatu selain dari site atau sites` untuk mencirikan obyek Site mana terkait, kemudian butuh secara tegas melewatkan nama bidang penyesuaian sebagai parameter pada CurrentSiteManager di model anda. Model berikut, yang mempunyai bidang disebut publish_on, mempertunjukkan ini:
from django.contrib.sites.models import Site\nfrom django.contrib.sites.managers import CurrentSiteManager\nfrom django.db import models\n\nclass Photo(models.Model):\n photo = models.FileField(upload_to='photos')\n photographer_name = models.CharField(max_length=100)\n pub_date = models.DateField()\n publish_on = models.ForeignKey(Site, on_delete=models.CASCADE)\n objects = models.Manager()\n on_site = CurrentSiteManager('publish_on')\nJika anda berusaha menggunakan CurrentSiteManager dan melewatkan sebuah bidang nama yang tidak ada, Django akan memunculkan sebuah ValueError.
Akhirnya, catat bahwa anda mungkin ingin menjaga Manager biasa (bukan-situs-khusus) pada model anda, bahkan jika anda menggunakan CurrentSiteManager. Seperti dijelaskan dalam manager documentation, jika anda menentukan pengelola secara manual, kemudian Django tidak akan membuat pengeloa objects = models.Manager() otomatis untuk anda. Juga catat bahwa bagian tertentu dari Django -- yaitu, situs admin Django dan tampilan umum -- gunakan pengelola mana saja ditentukan pertama dalam model, jadi jika anda ingin situs admin memiliki akses ke semua obyek (bukan hanya satu situs-khusus), taruh objects = models.Manager() dalam model anda, sebelum anda menentukan CurrentSiteManager.
Jika anda sering menggunakan pola ini:
\nfrom django.contrib.sites.models import Site\n\ndef my_view(request):\n site = Site.objects.get_current()\n ...\nada cara sederhana untuk menghindari perulangan. tambah django.contrib.sites.middleware.CurrentSiteMiddleware pada MIDDLEWARE. Middleware menyetel atribut site pada setiap permintaan obyek, jadi anda dapat menggunakan request.site untuk mendapatkan situs saat ini.
Meskipun itu tidak diwajibkan bahwa anda menggunakan kerangka kerja situs, itu sangat dianjurkan, karena Django mengambil keuntungan dari itu dalam sedikit tempat. bahkan jika pemasangan Django anda menenagai hanya situs tunggal, anda harus mengambil dua detik untuk membuat obyek situs dengan domain dan name, dan menunjuk ke ID dalam pengaturan SITE_ID anda.
Ini adalah bagaimana Django menggunakan kerangka situs:
\nDalam redirects framework, setiap obyek pengalihan berkaitan dengan situs stertentu. Ketika Django mencari untuk pengalihan, itu menghitung situs saat ini.
Dalam flatpages framework, setiap flatpage dihubungkan dengan situs tertentu. Ketika sebuah flatpage dibuat, anda menentukan Site nya, dan FlatpageFallbackMiddleware memeriksa situs saat ini dalam mengambil flatpage untuk dimunculkan.
Dalam syndication framework, cetakan untuk title dan description otomatis mempunyai akses ke variabel {{site}}, yaitu obyek which is the Site mewakili situs saat ini. Juga, kaitan untuk menyediakan barang URL akan menggunakan domain dari obyek Site saat ini jika anda tidak menentukan ranah berkualitas-sepenuhnya.
Dalam authentication framework, django.contrib.auth.views.LoginView melewatkan nama Site sat ini ke cetakan sebagai {{ site_name }}.
Tampilan jalan pintas (django.contrib.contenttypes.views.shortcut) menggunakan ranah dari obyek Site saat ini ketika menghitung sebuah URL obyek.
Dalam kerangka kerja admin, tautan "lihat pada situs" menggunakan Site saat ini untuk bekerja ranah untuk situs yang itu akan alihkan.
RequestSiteLink to this heading#Beberapa aplikasi django.contrib mengambil keuntungan dari kerangka kerja situs tetapi dirancang dengan cara yang tidak membutuhkan kerangka kerja situs untuk dipasang dalam basisdata anda. (Beberapa orang tidak ingin, atau hanya tidak dapat memasang tabel tambahan basisdata yang kerangka kera situs butuhkan.) Untuk kasus-kasus itu, kerangka kerja menyediakan sebuah kelas django.contrib.sites.requests.RequestSite,yang dapat digunakan sebagai sebuah fallback ketika dukungan-basisdata kerangka kerja situs tidak tersedia.
Sebuah kelas yang berbagi antarmuka utama dari Site (yaitu, itu memiliki atribut domain dan name) tetapi mendapatkan datanya dari obyek HttpRequest Django daripada dari sebuah basisdata.
Setel atribut name dan domain ke nilai dari get_host().
Sebuah obyek RequestSite mempunyai antarmuka mirip pada obyek Site biasa, kecuali metode __init__() nya mengambil sebuah obyek HttpRequest. Itu dapat menyimpulkan domain dan name dengan mencari domain permintaan. Itu mempunyai metode save() dan delete() untuk mencocokkan antarmuka dari Site, tetapi metode-metode memunculkan NotImplementedError.
get_current_siteLink to this heading#Akhirnya, untuk menghindari kode fallback berulang, kerangka kerja menyediakan sebuah fungsi django.contrib.sites.shortcuts.get_current_site()
Sebuah fungsi yang memeriksa jika django.contrib.sites dipasang dan mengembalikan salah satu obyek Site object saat ini atau obyek RequestSite berdasarkan pada permintaan. Itu mencari situs saat ini berdasarkan pada request.get_host() jika pengaturan SITE_ID tidak ditentukan.
Kedua ranah dan port mungkin dikembalikan oleh request.get_host() ketika kepala Host mempunyai port dengan jelas ditentukan, misalnya example.com:80. Dalam kasus tersebut, jika pencarian gagal karena host tidak cocok dengan sebuah rekaman dalam basisdata, port dihilangkan dan pencarian dicoba kembali dengan hanya bagian ranah. Ini tidak berlaku pada RequestSite yang akan selalu menggunakan hos tidak berubah.