首页
/ Django-Mobile 项目技术文档

Django-Mobile 项目技术文档

2024-12-20 10:33:57作者:薛曦旖Francesca

1. 安装指南

前提条件

在使用 django_mobile 之前,请确保 Django 的会话框架已启用并正常工作。

安装步骤

  1. 使用你喜欢的 Python 工具安装 django_mobile,例如:

    easy_install django_mobile
    

    或者

    pip install django_mobile
    
  2. django_mobile 添加到 settings.py 文件中的 INSTALLED_APPS 设置中。

  3. django_mobile.middleware.MobileDetectionMiddleware 添加到 MIDDLEWARE_CLASSES 设置中。

  4. django_mobile.middleware.SetFlavourMiddleware 添加到 MIDDLEWARE_CLASSES 设置中,并确保它位于 MobileDetectionMiddleware 之后,且在 SessionMiddleware 之后。

  5. django_mobile.loader.Loader 作为第一个项目添加到 TEMPLATES 设置中的 loaders 列表中。

  6. django_mobile.context_processors.flavour 添加到 TEMPLATES 设置中的 context_processors 列表中。

注意: 如果你使用的是 Django 1.7 或更早版本,你需要将步骤 5 和 6 中的 TEMPLATES 设置替换为 TEMPLATE_LOADERSTEMPLATE_CONTEXT_PROCESSORS

2. 项目使用说明

概念

django-mobile 的核心概念是基于不同的“风格”(flavour)来为你的网站提供不同的版本。例如,移动版和桌面版就是两种不同的风格。

使用方法

  1. 风格选择:中间件会根据用户的浏览器偏好选择合适的风格。默认情况下,django-mobile 只区分“full”和“mobile”两种风格。

  2. 模板选择:选择的风格会透明地影响模板的选择。例如,当使用 render_to_response('index.html', ...) 时,如果当前风格是“mobile”,则会使用 mobile/index.html 模板。如果该模板不存在,则会回退到默认的 index.html 模板。

  3. 手动更改风格:你可以在视图中通过调用 django_mobile.set_flavour(flavour, permanent=True) 来手动更改当前风格。用户也可以通过在请求中添加 flavour GET 参数来选择他们喜欢的风格。

示例

<html>
<head>
    <title>My site {% if flavour == "mobile" %}(mobile version){% endif %}</title>
</head>
<body>
    ...
</body>
</html>

3. 项目API使用文档

主要API

  • django_mobile.get_flavour([request,] [default]):获取当前活动的风格。如果没有风格被确定,则返回默认值。
  • django_mobile.set_flavour(flavour, [request,] [permanent]):设置当前请求的风格。如果风格不在 FLAVOURS 设置中,则会引发 ValueError
  • django_mobile.context_processors.flavour:上下文处理器,将当前风格作为 flavour 添加到上下文中。
  • django_mobile.context_processors.is_mobile:上下文处理器,如果当前风格等于 DEFAULT_MOBILE_FLAVOUR 设置,则添加 is_mobile 变量。

缓存相关API

  • django_mobile.cache.cache_page:与 Django 的 cache_page 装饰器相同,但增加了对风格的处理。
  • django_mobile.cache.middleware.FetchFromCacheFlavourMiddleware:在请求处理前添加 X-Flavour 头。
  • django_mobile.cache.middleware.UpdateCacheFlavourMiddleware:在响应处理后添加 X-Flavour 头。

4. 项目安装方式

通过 pip 安装

pip install django_mobile

通过 easy_install 安装

easy_install django_mobile

手动安装

你也可以从 GitHub 下载源码并手动安装:

git clone https://github.com/yourusername/django-mobile.git
cd django-mobile
python setup.py install

通过以上步骤,你可以成功安装并配置 django-mobile,开始为你的 Django 项目提供移动端优化。

登录后查看全文
热门项目推荐