Django pylibmc 缓存后端技术文档

1. 安装指南

安装要求

• 需要 pylibmc 1.4.1 或更高版本。
• 支持 Django 1.8 到 2.0 版本。
• 支持 Python 2.7, 3.4, 3.5, 和 3.6 版本。

安装方式

可以通过 pip 从 PyPI 或 GitHub 安装 django-pylibmc：

• 从 PyPI 安装：

  pip install django-pylibmc
  

• 从 GitHub 安装：

  pip install -e git://github.com/django-pylibmc/django-pylibmc.git#egg=django-pylibmc
  

2. 项目使用说明

配置缓存后端

在 Django 项目的 settings.py 文件中配置缓存后端，示例如下：

CACHES = {
    'default': {
        'BACKEND': 'django_pylibmc.memcached.PyLibMCCache',
        'LOCATION': 'localhost:11211',
        'TIMEOUT': 500,
        'BINARY': True,
        'OPTIONS': {  # 映射到 pylibmc 的 "behaviors"
            'tcp_nodelay': True,
            'ketama': True
        }
    }
}

使用本地 socket 连接

如果希望使用 memcached 的本地 socket 连接，可以将 LOCATION 设置为 socket 文件的路径，例如：

'LOCATION': '/var/run/memcached/memcached.sock'

启用二进制协议

如果希望使用 memcached 的二进制协议，将 BINARY 键的值设置为 True：

'BINARY': True

配置 pylibmc 行为

可以通过 OPTIONS 配置 pylibmc 的行为，例如：

'OPTIONS': {
    'tcp_nodelay': True,
    'ketama': True
}

压缩设置

pylibmc 支持压缩功能，可以通过 Django 设置 PYLIBMC_MIN_COMPRESS_LEN 来设置最小压缩大小（以字节为单位），默认值为 0（禁用压缩）。

压缩级别可以通过 PYLIBMC_COMPRESS_LEVEL 设置，接受与 Python zlib 模块相同的值。

3. 项目API使用文档

缓存超时设置

在设置缓存值时，memcache 允许设置值的过期时间。常见的值是以秒为单位的超时时间，但也支持 Unix 时间戳和 0 表示“永不过期”。Django 则尝试以当前时间后的秒数来处理缓存超时。0 表示立即过期，None 表示永不过期。

为了避免未来的兼容性问题，建议避免使用 0、None 或负数作为超时值，而是使用秒数（小于 30 天）或省略超时参数以使用默认超时。

4. 项目安装方式

通过环境变量配置

可以选择通过环境变量配置 memcached 连接（例如在 Heroku 平台上）。需要声明以下变量：

• MEMCACHE_SERVERS
• MEMCACHE_USERNAME
• MEMCACHE_PASSWORD

测试

安装 tox 并运行测试：

pip install tox
tox

通过以上步骤，您可以成功安装并配置 django-pylibmc，并使用其提供的缓存功能。