django 实现简单的搜索功能

搜索是一个复杂的功能，但对于一些简单的搜索任务，我们可以使用 django model 层提供的一些内置方法来完成。本文将结合 django 模型管理器的 filter 方法和 icontains 查询表达式来实现一个简单的搜索功能。

以博客为例，博客文章通常包含标题和正文两个部分。当用户输入某个关键词进行搜索后，我们希望为用户显示标题中含有被搜索关键词的全部文章。整个搜索的过程如下：

1. 用户在搜素框中输入搜索关键词，假设为 “django”，然后用户点击了搜索按钮提交其输入的结果到服务器
2. 服务器接收到用户输入的搜索关键词 “django” 后去数据库查找文章标题中含有该关键词的全部文章
3. 服务器将查询结果返回给用户

整个过程就是这样，下面来看看 django 如何用实现这些过程。

假设我们的 django 博客应用有如下的文章模型：

blog/models.py

class Post(models.Model):
    # 标题
    title = models.CharField(max_length=70)
    # 正文
    body = models.TextField()

    # 其他属性

    def __str__(self):
        return self.title

先看到第 1 步，用户在搜索框输入搜索关键词，因此我们要在博客上为用户提供一个搜索表单，html 表单代码大概像这样：

<form method="get" action="/search/">
  {% csrf_token %}
  <input type="search" placeholder="搜索" required>
  <button type="submit">搜索</button>
</form>

特别注意在 form 标签下有一个 {% csrf_token %}，这是 django 用来防御跨站请求伪造（CSRF）攻击的机制。如果不知道什么是 CSRF 的话也没有关系，只要记住在使用 django 时，前端的表单代码里一定要加上 {% csrf_token %} 。

用户输入了搜索关键词并点击了搜索按钮后，数据就被发送给了 django 后台服务器。表单的 action 属性的值为 /search/，表明用户提交的结果将被发送给 /search/ 这个 URL。我们为这个 URL 绑定一个 django 视图函数，在这个视图函数里完成前面第 2 步提到的过程。假设我们把视图函数的代码写在 blog/views.py 里：

blog/views.py

def search(request):
    q = request.GET.get('q')
    error_msg = ''

    if not q:
        error_msg = '请输入关键词'
        return render(request, 'blog/errors.html', {'error_msg': error_msg})

    post_list = Post.objects.filter(title__icontains=q)
    return render(request, 'blog/results.html', {'error_msg': error_msg,
                                               'post_list': post_list})

首先我们使用 request.GET.get('q') 获取到用户提交的搜索关键词。用户通过表单提交的数据 django 为我们保存在 request.GET 里，这是一个类似于 Python 字典的对象，所以我们使用 get 方法从字典里取出键 q 对应的值，即用户的搜索关键词。这里字典的键之所以叫 q 是因为我们的表单中搜索框 input 的 name 属性的值是 q，如果修改了 name 属性的值，那么这个键的名称也要相应修改。

接下来我们做了一个小小的校验，如果用户没有输入搜索关键词而提交了表单，我们就无需执行查询，而是渲染一个错误页面提示用户请输入关键词。

如果用户输入了搜索关键词，我们就通过 filter 方法从数据库里过滤出符合条件的所有文章。这里的过滤条件是 title__icontains=q，即 title 中包含（contains）关键字 q，前缀 i 表示不区分大小写。这里 icontains 是查询表达式（Field lookups），其用法是在模型需要筛选的属性后面跟上两个下划线。django 内置了很多查询表达式，建议过一遍 django 官方留个印象，了解每个表达式的作用，以后碰到相关的需求就可以快速定位到文档查询其用途：Field lookups

接下来就是渲染搜索结果页面，显示符合搜索条件的文章列表，下面是一个模板的简单示例：

results.html

{% if error_msg %}
    <p>{{ error_msg }}</p>
{% endif %}

{% for post in post_list %}
  <div>
    在这里显示文章的相应信息
  </div>
{% empty %}
  <div class="no-post">
    没有搜索到符合条件的文章
  </div>
{% endfor %}

有了视图函数后记得把视图函数映射到相应了 URL，前面我们表单数据提交的 URL 为 /search/，因此将视图函数 search 绑定到该 URL 上。

blog/urls.py

urlpatterns = [
    # 其他 url 配置
    url(r'^search/$', views.search, name='search'),
]

以上示例写的比较通用，并不是针对某个具体项目。但如果你稍微了解一点 django 的话，肯定能够看懂文章的内容，并且稍作修改就能应用于自己的项目。如果你对 django 还不是很了解，这里有一篇从零开始学习 django 的入门指南，能够帮助你找到高质量的学习教程，以最快的速度入门 django 开发：django 入门学习规划与资料推荐。

也许你前面已经学习了 django 博客开发入门教程，针对这个教程里的具体项目，我们修改上述代码的一些细节，就可以在项目里顺利运行。

首先是修改表单，打开 templates/base.html，在 header 标签里找到搜索表单部分的代码并修改，即添加 {% csrf_token %} 模板标签、修改搜索框的 name 属性和表单的 action 属性：

templates/base.html

<header id="site-header">
  ...
  <div id="header-search-box">
    ...
    <form role="search" method="get" id="searchform" action="{% url 'blog:search' %}">
      {% csrf_token %}
      <input type="search" name="q" placeholder="Search" required>
      <button type="submit"><span class="ion-ios-search-strong"></span></button>
    </form>
    ...
  </div>
</header>

然后是编写视图函数：

blog/views.py

def search(request):
    q = request.GET.get('q')
    error_msg = ''

    if not q:
        error_msg = '请输入关键词'
        return render(request, 'blog/index.html', {'error_msg': error_msg})

    post_list = Post.objects.filter(title__icontains=q)
    return render(request, 'blog/index.html', {'error_msg': error_msg,
                                               'post_list': post_list})

这里我们直接渲染了 index.html 页面，因为这个页面就是用来显示文章列表的。我们对 index.html 稍作一点修改，让它能够显示 error_msg。

templates/blog/index.html

{% extends 'base.html' %}
{% block main %}
  {% if error_msg %}
    <p>{{ error_msg }}</p>
  {% endif %}

  {% for post in post_list %}
    ...
  {% empty %}
    <div class="no-post">暂时还没有发布的文章！</div>
  {% endfor %}
{% endblock main %}

最后就是配置 URL：

blog/urls.py

urlpatterns = [
    # 其他 url 配置
    url(r'^search/$', views.search, name='search'),
]

当然这样的搜索功能是非常简略的，难以满足一些复杂的搜索需求。编写一个搜索引擎是一个大工程，好在 django-haystack 这款第三方 app 为我们完成了全部工作。使用它我们可以实现更加复杂的搜索功能，比如全文检索、按搜索相关度排序、关键字高亮等等类似于百度搜索的功能，功能十分强大。当然其使用也会复杂一些，以后有机会我再写文章向大家介绍 django-haystack 的使用方法。

-- EOF --