Django路由控制

路由控制之简单配置

mysite文件夹下的urls.py文件(全局的urls.py)

from django.contrib import admin
from django.urls import path, re_path, include
from app01 import views


urlpatterns = [
    path('admin/', admin.site.urls),
    path('timer/', views.timer),  # views.timer(request)
    re_path(r"^articles/2003/$", views.special_case_2003),  # special_case_2003(request)---正则匹配()分组会有单独一个参数
    re_path(r"articles/([0-9]{4})/$", views.year_archive),  # year_archive(request, ([0-9]{4}))---正则匹配的括号()分组会有单独一个参数，所以在视图函数中需要一个形参接收，也就是说year_archive()视图函数需要两个形参
    re_path(r"articles/([0-9]{4})/([0-9]{2})/$", views.month_archive),  # month_archive(request, ([0-9]{4}), ((0-9){2}))---需要三个形参
    re_path(r"articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$", views.article_detail),  # article_detail(request, ([0-9]{4}), ((0-9){2}), ([0-9]+))---需要四个形参
]

注意：

• 若要从URL 中捕获一个值，只需要在它周围放置一对圆括号。
• 不需要添加一个前导的反斜杠，因为每个URL 都有。例如，应该是^articles 而不是 ^/articles。
• 每个正则表达式前面的'r' 是可选的但是建议加上。它告诉Python 这个字符串是“原始的” —— 字符串中任何字符都不应该转义

示例：

　

'''
 一些请求的例子：

/articles/2005/03/ 请求将匹配列表中的第三个模式。Django 将调用函数views.month_archive(request, '2005', '03')。
/articles/2005/3/ 不匹配任何URL 模式，因为列表中的第三个模式要求月份应该是两个数字。
/articles/2003/ 将匹配列表中的第一个模式不是第二个，因为模式按顺序匹配，第一个会首先测试是否匹配。请像这样自由插入一些特殊的情况来探测匹配的次序。
/articles/2003 不匹配任何一个模式，因为每个模式要求URL 以一个反斜线结尾。
/articles/2003/03/03/ 将匹配最后一个模式。Django 将调用函数views.article_detail(request, '2003', '03', '03')。
   
'''

路由控制之有名分组

上面的示例使用简单的、没有命名的正则表达式组（通过圆括号）来捕获URL 中的值并以位置 参数传递给视图。在更高级的用法中，可以使用命名的正则表达式组来捕获URL 中的值并以关键字 参数传递给视图。

在Python 正则表达式中，命名正则表达式组的语法是(?P<name>pattern)，其中name 是组的名称，pattern 是要匹配的模式。

mysite文件夹下的urls.py(全局urls.py)

from django.contrib import admin
from django.urls import path, re_path, include
from app01 import views


urlpatterns = [
    path('admin/', admin.site.urls),
    path('timer/', views.timer),  # views.timer(request)
    re_path(r"articles/(?P<y>[0-9]{4})/(?P<m>[0-9]{2})/(?P<d>[0-9]+)/$", views.article_detail),  # article_detail(request, y=([0-9]{4}), m=((0-9){2}), d=([0-9]+))由位置参数变成了关键字参数
]

这个实现与前面的示例完全相同，只有一个细微的差别：捕获的值作为关键字参数而不是位置参数传递给视图函数。

在实际应用中，这意味你的URLconf 会更加明晰且不容易产生参数顺序问题的错误 —— 你可以在你的视图函数定义中重新安排参数的顺序。当然，这些好处是以简洁为代价。

路由控制之分发

mysite文件夹下的urls.py

from django.contrib import admin
from django.urls import path, re_path, include
from app01 import views


urlpatterns = [
    path('admin/', admin.site.urls),
    path('timer/', views.timer),  # views.timer(request)
    # re_path(r"app01/", include("app01.urls")),
    # 路由分发，先导入include，然后在各个应用中添加urls.py文件，各个urls.py文件各自把路径和视图函数一一对应
    re_path(r"", include("app01.urls")),
    re_path(r"", include("app02.urls")),

]

app01应用文件夹下的urls.py

from django.urls import re_path
from app01 import views


urlpatterns = [
    re_path(r"^articles/2003/$", views.special_case_2003),  # special_case_2003(request)
    re_path(r"articles/([0-9]{4})/$", views.year_archive),  # year_archive(request, ([0-9]{4}))
    re_path(r"articles/([0-9]{4})/([0-9]{2})/$", views.month_archive),  # month_archive(request, ([0-9]{4}), ((0-9){2}))
    # re_path(r"articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$", views.article_detail),  # article_detail(request, ([0-9]{4}), ((0-9){2}), ([0-9]+))
    re_path(r"articles/(?P<y>[0-9]{4})/(?P<m>[0-9]{2})/(?P<d>[0-9]+)/$", views.article_detail),  # article_detail(request, y=([0-9]{4}), m=((0-9){2}), d=([0-9]+))由位置参数变成了关键字参数
]

app02应用文件夹下的urls.py

from django.urls import re_path
from app02 import views


urlpatterns = [
    re_path(r"^func/2003/$", views.func_2003),
]

路由控制之登录验证示例

mysite文件夹下的settings.py文件配置

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    # 下面这一行先注掉，不然登录示例提交表单后无法成功运行
    # 'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

mysite文件夹下的urls.py文件

from django.contrib import admin
from django.urls import path, re_path, include
from app01 import views


urlpatterns = [
    path('admin/', admin.site.urls),
    re_path(r"", include("app01.urls")),


]

app01应用文件夹下的urls.py

from django.urls import re_path
from app01 import views


urlpatterns = [
    re_path(r"login/$", views.login),
]

app01应用文件夹下的views.py

from django.shortcuts import render, HttpResponse


def login(request):
    """
    在settings.py文件中，需要注释一行代码
    :param request:
    :return:
    """
    if request.method == "GET":
        return render(request, "login.html")
    elif request.method == "POST":
        user = request.POST.get("user")
        pwd = request.POST.get("pwd")
        if user == "admin" and pwd == "123":
            return HttpResponse("登录成功...")
        else:
            return HttpResponse("用户名或密码错误...")

templates文件夹下的login.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>登录</title>
</head>
<body>
<h3>登录</h3><form action="http://127.0.0.1:8000/login/" method="post">
    <p>
        姓名：
        <input type="text" name="user">
    </p>
    <p>
        密码：
        <input type="password" name="pwd">
    </p>
    <p>
        <input type="submit" value="提交">
    </p>
</form>
</body>
</html>

路由控制之反向解析

在使用Django 项目时，一个常见的需求是获得URL 的最终形式，以用于嵌入到生成的内容中（视图中和显示给用户的URL等）或者用于处理服务器端的导航（重定向等）。人们强烈希望不要硬编码这些URL（费力、不可扩展且容易产生错误）或者设计一种与URLconf 毫不相关的专门的URL 生成机制，因为这样容易导致一定程度上产生过期的URL。

在需要URL 的地方，对于不同层级，Django 提供不同的工具用于URL 反查：

• 在模板中：使用url 模板标签。
• 在Python 代码中：使用from django.urls import reverse()函数


urls.py

from django.urls import re_path
from app01 import views


urlpatterns = [
    # 反向解析
    re_path(r"login/$", views.login, name="log"),  # 正则匹配没有括号()的时候
    re_path(r"login/([0-9])/$", views.login1, name="log1"),  # 正则匹配有括号()的时候
]

在模板中

正则匹配没有括号()的时候
login.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>登录</title>
</head>
<body>
<h3>登录</h3>
{#模板语法，会根据urlpatterns中name的值找到对应的路径，所以urls.py中的路径改了的话，html的form表单不需要再改动了#}
<form action="{% url 'log' %}" method="post">
    <p>
        姓名：
        <input type="text" name="user">
    </p>
    <p>
        密码：
        <input type="password" name="pwd">
    </p>
    <p>
        <input type="submit" value="提交">
    </p>
</form>
</body>
</html>



正则匹配有括号()的时候
login1.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>登录</title>
</head>
<body>
<h3>登录</h3>
{#模板语法，会根据urlpatterns中name的值找到对应的路径，所以urls.py中的路径改了的话，html的form表单不需要再改动了#}
<form action="{% url 'log1' 1 %}" method="post">
    <h4>{{ page }}页</h4>
    <p>
        姓名：
        <input type="text" name="user">
    </p>
    <p>
        密码：
        <input type="password" name="pwd">
    </p>
    <p>
        <input type="submit" value="提交">
    </p>
</form>
</body>
</html>

在Python中

# 视图函数的路由反向解析需要先导入reverse
from django.urls import reverse


def login(request):
    """
    在settings.py文件中，需要注释一行代码
    :param request:
    :return:
    """
    if request.method == "GET":
        url = reverse("log")
        print(url)
        return render(request, "login.html")
    elif request.method == "POST":
        user = request.POST.get("user")
        pwd = request.POST.get("pwd")
        if user == "admin" and pwd == "123":
            return HttpResponse("登录成功...")
        else:
            return HttpResponse("用户名或密码错误...")


def login1(request, page):
    """
    在settings.py文件中，需要注释一行代码
    :param request:
    :param page:
    :return:
    """
    if request.method == "GET":
        url = reverse("log1", args=(1,))  # 如果路由匹配有分组，那么需要加上参数args
        print(url)
        return render(request, "login1.html", {"page": page})
    elif request.method == "POST":
        user = request.POST.get("user")
        pwd = request.POST.get("pwd")
        if user == "admin" and pwd == "123":
            return HttpResponse("登录成功...")
        else:
            return HttpResponse("用户名或密码错误...")

 路由控制之名称空间

命名空间（英语：Namespace）是表示标识符的可见范围。一个标识符可在多个命名空间中定义，它在不同命名空间中的含义是互不相干的。这样，在一个新的命名空间中可定义任何标识符，它们不会与任何已有的标识符发生冲突，因为已有的定义都处于其它命名空间中。

由于name没有作用域，Django在反解URL时，会在项目全局顺序搜索，当查找到第一个name指定URL时，立即返回

我们在开发项目时，会经常使用name属性反解出URL，当不小心在不同的app的urls中定义相同的name时，可能会导致URL反解错误，为了避免这种事情发生，引入了命名空间。

 

mysite文件夹下的urls.py

from django.contrib import admin
from django.urls import path, re_path, include
from app01 import views


urlpatterns = [
    path('admin/', admin.site.urls),
    re_path(r"app01/", include(("app01.urls", "app_01"))),  # 用到命名空间的时候，include参数变为元组类型，第一个为urlconf，第二为命名空间的名字
    re_path(r"app02/", include(("app02.urls", "app_02"))),
]

app01应用文件夹下的urls.py

from django.urls import re_path
from app01 import views


urlpatterns = [
    re_path(r"index/$", views.index, name="index"),  # 这个name和app02的name相同
]

app02应用文件夹下的urls.py

from django.urls import re_path
from app02 import views


urlpatterns = [
    re_path(r"index/$", views.index, name="index"),  # 这个name和app01相同
]

app01应用文件夹下的views.py

from django.shortcuts import render, HttpResponse
# 视图函数的路由反向解析需要先导入reverse
from django.urls import reverse


def index(request):
    """
    :param request:
    :return:
    """
    return HttpResponse(reverse("app_01:index"))  # 反向解析的时候，格式为"命名空间名:name"

app02应用文件夹下的views.py

from django.shortcuts import render, HttpResponse
from django.urls import reverse


def index(request):
    """
    :param request:
    :return:
    """
    return HttpResponse(reverse("app_02:index"))  # 反向解析的时候，格式为"命名空间名:name"

 Django2.0版的path

思考情况如下：

urlpatterns = [  
    re_path('articles/(?P<year>[0-9]{4})/', year_archive),  
    re_path('article/(?P<article_id>[a-zA-Z0-9]+)/detail/', detail_view),  
    re_path('articles/(?P<article_id>[a-zA-Z0-9]+)/edit/', edit_view),  
    re_path('articles/(?P<article_id>[a-zA-Z0-9]+)/delete/', delete_view),  
]

考虑下这样的两个问题：

第一个问题，函数 year_archive 中year参数是字符串类型的，因此需要先转化为整数类型的变量值，当然year=int(year) 不会有诸如如TypeError或者ValueError的异常。那么有没有一种方法，在url中，使得这一转化步骤可以由Django自动完成？

第二个问题，三个路由中article_id都是同样的正则表达式，但是你需要写三遍，当之后article_id规则改变后，需要同时修改三处代码，那么有没有一种方法，只需修改一处即可？

在Django2.0中，可以使用 path 解决以上的两个问题。

基本示例：

urls.py

from django.urls import re_path, path, include
from app02 import views


urlpatterns = [
    # django2.0版path
    path("articles/2003/", views.atl_003),
    path("articles/<int:id>/history/", views.history),
    path("articles/<int:id>/edit/", views.edit),
    path("articles/<int:id>/discuss/", views.discuss),
    path("articles/<int:id>/permissions/", views.permissions),
]

# 将前缀一样的URL通过include解决冗余
urlpatterns = [
    path("articles/2003/", views.atl_003),
    path("articles/<int:id>/", include([
        path("history/", views.history),
        path("edit/", views.edit),
        path("discuss/", views.discuss),
        path("permissions/", views.permissions),
    ]))
]

views.py

def atl_003(request):
    """
    :param request:
    :return:
    """
    return HttpResponse("ok1")


def history(request, id):
    """
    :param request:
    :param id:
    :return:
    """
    print(type(id))
    return HttpResponse("history{}".format(id))


def edit(request, id):
    """
    :param request:
    :param id:
    :return:
    """
    return HttpResponse("edit{}".format(id))


def discuss(request, id):
    """
    :param request:
    :param id:
    :return:
    """
    return HttpResponse("discuss{}".format(id))


def permissions(request, id):
    """
    :param request:
    :param id:
    :return:
    """
    return HttpResponse("permissions{}".format(id))

基本规则：

• 使用尖括号(<>)从url中捕获值。
• 捕获值中可以包含一个转化器类型（converter type），比如使用 <int:name> 捕获一个整数变量。若果没有转化器，将匹配任何字符串，当然也包括了 / 字符。
• 无需添加前导斜杠。

以下是根据 2.0官方文档 而整理的示例分析表：

path转化器

文档原文是Path converters，暂且翻译为转化器。

Django默认支持以下5个转化器：

• str,匹配除了路径分隔符（/）之外的非空字符串，这是默认的形式
• int,匹配正整数，包含0。
• slug,匹配字母、数字以及横杠、下划线组成的字符串。
• uuid,匹配格式化的uuid，如 075194d3-6885-417e-a8a8-6c931e272f00。
• path,匹配任何非空字符串，包含了路径分隔符

注册自定义转化器

对于一些复杂或者复用的需要，可以定义自己的转化器。转化器是一个类或接口，它的要求有三点：

• regex 类属性，字符串类型

• to_python(self, value) 方法，value是由类属性 regex 所匹配到的字符串，返回具体的Python变量值，以供Django传递到对应的视图函数中。
• to_url(self, value) 方法，和 to_python 相反，value是一个具体的Python变量值，返回其字符串，通常用于url反向引用。

url_conversion.py

class MonConversion(object):
    regex = "[0-9]{2}"

    def to_python(self, value):
        return int(value)

    def to_url(self, value):
        return "%04d" % value

urls.py

from django.urls import re_path, path, register_converter
from app01 import views, url_conversion

register_converter(url_conversion.MonConversion, "mon")  # 不要忘记了对其进行注册

urlpatterns = [
    # 自定义path转换器
    path("articles/<mon:month>/", views.mon_articles)
]

views.py

def mon_articles(request, month):
    """
    :param request:
    :param month:
    :return:
    """
    return HttpResponse("月份:{}".format(month))

url控制总结

"""
路由简单配置：路径对应视图函数

路由有名分组：将路径正则匹配到的参数取别名，相当于视图函数的关键字传参

路由分发：
    from django.urls import include
    urlpatterns = [
        re_path(r"app01/", include("app01.urls"))
    ]

路由反向解析：
    urlpatterns = [
        re_path(r"login/$", views.login, name="log"),
        re_path(r"login/([0-9])/$", views.login1, name="log1"),
    ]
    # python反向解析
    from django.urls import reverse
    url = reverse("log")
    url = reverse("log1", args=(1,))
    # 模板反向解析
    <form action="{% url 'log' %}" method="post"></form>
    <form action="{% url 'log1' 1 %}" method="post"></form>

路由名称空间：
    from django.urls import path, re_path, include
    urlpatterns = [
        re_path(r"app01/", include(("app01.urls", "app_01"))),  # include参数为一个元组()，第一个参数和之前一样，是匹配应用的urls路径，第二个参数为命名空间名
        re_path(r"app02/", include(("app02.urls", "app_02"))),
    ]
    # app01下的urls.py
    urlpatterns = [
        re_path(r"index/$", views.index, name="index"),  # 这个name和app02的name相同
    ]
    # app02下的urls.py
    urlpatterns = [
        re_path(r"index/$", views.index, name="index"),  # 这个name和app01相同
    ]
    # app01下的views.py
    def index(request):
        """
        :param request:
        :return:
        """
        return HttpResponse(reverse("app_01:index"))  # 反向解析的时候，格式为"命名空间名:name"
    # app02下的views.py
    def index(request):
        """
        :param request:
        :return:
        """
        return HttpResponse(reverse("app_02:index"))  # 反向解析的时候，格式为"命名空间名:name"
　　# 注意
　　# 如果用了路由名称空间，模板中的反向解析也要加上名称空间，即："{% url 'app_01:index' %}"


"""