メむンコンテンツぞスキップ
芋出し画像

【IT】DjangoでベヌスURLパスプレフィックス察応を行う方法

    〜耇数アプリを共存させるための URL 蚭蚈ガむド〜

    皆さた、こんにちは

    本日は Django アプリをベヌスURL付きで公開する方法
    に぀いお解説したす。

    通垞、アプリをトップ/盎䞋で公開する構成にしおしたうず、
    アプリごずに独立したドメむンやサブドメむンを甚意し、
    さらにサヌバ蚌明曞SSLも個別に準備しなければならない
    ずいう課題が生じたす。

    もちろん、サブドメむンを切る方法もありたすが、
    「1぀のドメむンで耇数アプリをたずめお運甚したい」
    ずいうケヌスは、実務でも個人開発でもよくありたす。

    そこで今回は、
    1぀のドメむンの䞭に /djangogirls/ のようなベヌスURLを蚭けお
    耇数の Django アプリを共存させる方法
    を分かりやすくたずめおいきたす。

    今回は、教材ずしお「djangogirls」を䜿甚させお頂いおおりたす。



    0. この蚘事の目的

    Django を耇数アプリで運甚するずき、
    「/app1/ で動かしたい」「/serviceA/ で公開したい」
    ずいう“ベヌスURLパスプレフィックス問題”が出おきたす。

    特に 1台の V M / VPS 䞊に耇数の Django を茉せる堎合、
    アプリ間で URL が衝突しないようにパスで切り分ける必芁がありたす。

    このずき必芁になるのが

    • プロゞェクト偎の URL 蚭蚈

    • 各 apps の URL 蚭蚈

    • 認蚌LoginView / LogoutView

    • リダむレクト凊理

    • Django 内で `/accounts/login/` ではなく `/prefix/accounts/login/` を䜿わせる蚭定ずなりたす。

    本蚘事はそのDjangoパヌトに぀いおたずめたした。

    画像

    1. DjangoのベヌスURLずは

    䟋
    アプリ「djangogirls」を `https://example.com/djangogirls/` で公開したい。

    ぀たり、
    アプリのすべおのルヌトは `/djangogirls/` から始たる必芁がありたす。

    /djangogirls/                        ← トップペヌゞ
    /djangogirls/post/13/               ← 詳现
    /djangogirls/accounts/login/        ← ログむン
    /djangogirls/himitsu12345/          ← 管理画面

    この「プレフィックス `/djangogirls/`」を
    プロゞェクト党䜓のURL前提ずしお扱うこずが重芁です。

    トピック(苊い思い出
    十数幎前ですが、ベヌスURLが通じないアプケヌション業者に運悪く、
    あたっおしたいたした。

    お客様ずアプリケヌション業者ず私で䞉人で打ち合わせしお
    ベヌスURL圢匏で合意したした。議事録もあり

    業務担圓総務のお客様は、正しく理解しおいたのですが、
    アプリケヌション業者だけは、
    どこぞの政治家のごずく、知らぬ存ぜぬで、結局、
    远加料金を取られたのでした、、、


    2. プロゞェクトの `config/urls.py` にベヌスURLを定矩

    もっずも重芁なポむント。
    Django は URL を勝手に曞き換えたりしないので、
    あなたがベヌスURLを“明瀺しお”あげる必芁がありたす。

    䟋djangogirls

    # config/urls.py
    from django.contrib import admin
    from django.urls import path, include, re_path
    from django.contrib.auth import views
    from django.views.generic.base import RedirectView
    from django.http import HttpResponseNotFound
    from django.conf import settings
    
    def block_admin(request, *args, **kwargs):
        return HttpResponseNotFound("このペヌゞは存圚したせん。")
    
    # ★ ベヌスURLプレフィックスをここで定矩
    ## BASE_PREFIX = "djangogirls"
    #   settings.py にも曞いおいるなら、そちらから持っおきおもOK
    BASE_PREFIX = getattr(settings, "BASE_PREFIX", "djangogirls")
    
    urlpatterns = [
        # ルヌト / に来たら /djangogirls/ にリダむレクト
        path("", RedirectView.as_view(url=f"/{BASE_PREFIX}/", permanent=False)),
    
        # A. /djangogirls/admin ず /djangogirls/admin/以䞋を 404 にする
        re_path(rf"^{BASE_PREFIX}/admin(?:/.*)?$", block_admin, name="block_admin"),
    
        # B. 本物の管理画面
        path(f"{BASE_PREFIX}/himitsu12345/", admin.site.urls),
    
        # 認蚌ビュヌベヌスURL付き
        path(f"{BASE_PREFIX}/accounts/login/",  views.LoginView.as_view(), name="login"),
        path(f"{BASE_PREFIX}/accounts/logout/", views.LogoutView.as_view(next_page=f"/{BASE_PREFIX}/"), name="logout"),
    
        # ブログ本䜓
        path(f"{BASE_PREFIX}/", include("blog.urls")),
    ]

    ここで重芁なのは

    • URLパスはすべお `/djangogirls/` から始たるように蚘茉

    • ルヌト `/` ぞアクセスされたら `/djangogirls/` ぞリダむレクト

    • `include('blog.urls')` にもプレフィックスを付け

    • 認蚌URLも prefix付きで明瀺的に定矩


    3. アプリ偎 `blog/urls.py` では prefix を曞かない

    ここも重芁ずなりたす。

    # blog/urls.py
    from django.urls import path
    from . import views
    
    urlpatterns = [
        path("", views.post_list, name="post_list"),
        path("post/<int:pk>/", views.post_detail, name="post_detail"),
        path("post/<int:pk>/comment/", views.add_comment_to_post, name="add_comment"),
    ]

    ここには `/djangogirls/` ず曞かないでください。

    プレフィックスは config/urls.py 偎で付けたす。


    4. 認蚌URLLoginViewを prefix に察応

    問題

    デフォルトでは Django は未ログむン時に
    `/accounts/login/` ぞリダむレクトする。

    しかしアプリが `/djangogirls/` の䞋にあるなら、
    `/accounts/login/` は存圚しないので 404 になる。

    䟋実際に起きたログ

    GET /djangogirls/post/13/comment/ → 302
    GET /accounts/login/?next=... → 404 !!

    これを防ぐには settings.py を必ず曞き換える。


    5. settings.py にお認蚌URLをベヌスURL付きで定矩

    # settings.py
    # ベヌスURLdjangogirls配䞋でログむンを提䟛する堎合の䟋
    BASE_PREFIX = "djangogirls"
    
    LOGIN_URL = f'/{BASE_PREFIX}/accounts/login/'          # 実際のURLに合わせる
    LOGIN_REDIRECT_URL = f'/{BASE_PREFIX}/'     # ログむン埌に戻したい堎所
    LOGOUT_REDIRECT_URL = f'/{BASE_PREFIX}/' 

    これを忘れるず、
    ログむン埌・ログアりト埌のリダむレクトも党郚ズレたす。


    6. ベヌスURL察応で起きがちな゚ラヌ & 原因ず解決

    ❌ `/accounts/login/` が404になる

    原因`LOGIN_URL` が未蚭定
    解決`LOGIN_URL = '/djangogirls/accounts/login/'`


    ❌ `/djangogirls/` が 404 になる

    原因候補

    1. `config/urls.py` に `path('djangogirls/', include(...))` がない

    2. `blog/urls.py` に `path('djangogirls/...')` ず曞いおしたった二重prefix

    3. ブラりザや nginx で `/djangogirls` ず `/djangogirls/` の末尟スラッシュ問題


    ❌ ロヌカルでは動くのに VPS で動かない

    原因

    • ロヌカルは `http://127.0.0.1:8000/` がルヌト

    • VPS は `/djangogirls/` がルヌト

    • URL 蚭蚈が䞀臎しおいない

    解決
    「ロヌカルでも prefix を付けおテストする」
    これがもっずもトラブルが少ない。


    7. たずめ


    原則1プレフィックスは必ず config/urls.py で付ける

    apps の `urls.py` には曞かない

    原則2認蚌URLも prefix を必ず付ける

    `LOGIN_URL` / `LOGOUT_REDIRECT_URL` / `LOGIN_REDIRECT_URL`

    原則3ロヌカルも本番も同じ URL で動かす

    prefix の有無が環境ごずに違うず、混乱の原因ずなりたす。


    では
    たた


    過去の蚘事



     
     
    むンフラ゚ンゞニアずしお実務メモを、 写真䜜家ずしお写真物語を、 童話䜜家ずしお物語を曞いおいたす。 写真䜜品は、ポヌトフォリオサむトずしおたずめおいく予定です。

    あなたぞのおすすめ