django-imagekit 5.0.0

在模型中定义规格

使用模型中的ImageSpecField定义图片规格是最简单的方法

from django.db import models
from imagekit.models import ImageSpecField
from imagekit.processors import ResizeToFill

class Profile(models.Model):
    avatar = models.ImageField(upload_to='avatars')
    avatar_thumbnail = ImageSpecField(source='avatar',
                                      processors=[ResizeToFill(100, 50)],
                                      format='JPEG',
                                      options={'quality': 60})

profile = Profile.objects.all()[0]
print(profile.avatar_thumbnail.url)    # > /media/CACHE/images/982d5af84cddddfd0fbf70892b4431e4.jpg
print(profile.avatar_thumbnail.width)  # > 100

正如你可能已经注意到的，ImageSpecFields与Django的ImageFields非常相似。区别在于它们是ImageKit根据你提供的说明自动生成的。在上面的例子中，头像缩略图是头像图片的一个缩放版本，以60的质量保存为JPEG。

然而，有时你不需要保留原始图片（如上例中的头像）；当用户上传图片时，你只需要处理它并保存结果。在这种情况下，你可以使用ProcessedImageField类

from django.db import models
from imagekit.models import ProcessedImageField
from imagekit.processors import ResizeToFill

class Profile(models.Model):
    avatar_thumbnail = ProcessedImageField(upload_to='avatars',
                                           processors=[ResizeToFill(100, 50)],
                                           format='JPEG',
                                           options={'quality': 60})

profile = Profile.objects.all()[0]
print(profile.avatar_thumbnail.url)    # > /media/avatars/MY-avatar.jpg
print(profile.avatar_thumbnail.width)  # > 100

这与我们之前的例子非常相似。我们不再需要指定“源”，因为我们不是处理另一个图片字段，但我们确实需要传递一个“upload_to”参数。这正好与Django ImageFields的行为一致。

在模型外部定义规格

将规格作为模型字段定义是处理图片的一种非常方便的方法，但这并不是唯一的方法。有时你无法（或不想）向模型添加字段，这是完全可以的。你可以定义图片规格类，并直接使用它们。这对于在视图中进行图片处理特别有用——尤其是当处理操作取决于用户输入时。

from imagekit import ImageSpec
from imagekit.processors import ResizeToFill

class Thumbnail(ImageSpec):
    processors = [ResizeToFill(100, 50)]
    format = 'JPEG'
    options = {'quality': 60}

这个类能够以与上面的ImageSpecField完全相同的方式处理图片，可能并不令人惊讶。然而，与图片规格模型字段不同，这个类没有定义规格作用在哪个源上，或者应该对结果执行什么操作；这取决于你。

source_file = open('/path/to/myimage.jpg', 'rb')
image_generator = Thumbnail(source=source_file)
result = image_generator.generate()

调用图片规格上的generate()的结果是一个包含我们已缩放的图片的文件-like对象，你可以用它做任何你想要的事情。例如，如果你想将其保存到磁盘

dest = open('/path/to/dest.jpg', 'wb')
dest.write(result.read())
dest.close()

在模板中使用规格

如果你有一个带有ImageSpecField或ProcessedImageField的模型，你可以轻松地像使用正常的图片字段一样使用这些已处理的图片

<img src="{{ profile.avatar_thumbnail.url }}" />

（这假设你有一个视图，将名为“profile”的上下文变量设置为我们的Profile模型的一个实例。）

但您也可以直接在模板中生成处理后的图像文件——从任何图像开始——而不需要添加任何内容到您的模型中。为了做到这一点，您首先需要在您的应用程序的某个地方定义一个图像生成器类（记住，规范是一种生成器），就像我们在上一节中所做的那样。您还需要一种在模板中引用生成器的方法，所以您需要注册它。

from imagekit import ImageSpec, register
from imagekit.processors import ResizeToFill

class Thumbnail(ImageSpec):
    processors = [ResizeToFill(100, 50)]
    format = 'JPEG'
    options = {'quality': 60}

register.generator('myapp:thumbnail', Thumbnail)

现在我们已经创建了一个图像生成器类，并使用ImageKit注册了它，我们可以在模板中使用它了！

{% load imagekit %}

{% generateimage 'myapp:thumbnail' source=source_file %}

<img src="/media/CACHE/images/982d5af84cddddfd0fbf70892b4431e4.jpg" width="100" height="50" />

{% load imagekit %}

{% generateimage 'myapp:thumbnail' source=source_file -- alt="A picture of Me" id="mypicture" %}

{% load imagekit %}

{% generateimage 'myapp:thumbnail' source=source_file as th %}
<a href="{{ th.url }}">Click to download a cool {{ th.width }} x {{ th.height }} image!</a>

{% load imagekit %}

{% thumbnail '100x50' source_file %}

<img src="/media/CACHE/images/982d5af84cddddfd0fbf70892b4431e4.jpg" width="100" height="50" />

{% load imagekit %}

{% thumbnail '100x50' source_file -- alt="A picture of Me" id="mypicture" %}
{% thumbnail '100x50' source_file as th %}

在表单中使用规范

除了上面的模型字段外，还有一个ProcessedImageField类的表单字段版本。其功能基本上相同（它处理一次图像并保存结果），但它在表单类中使用。

from django import forms
from imagekit.forms import ProcessedImageField
from imagekit.processors import ResizeToFill

class ProfileForm(forms.Form):
    avatar_thumbnail = ProcessedImageField(spec_id='myapp:profile:avatar_thumbnail',
                                           processors=[ResizeToFill(100, 50)],
                                           format='JPEG',
                                           options={'quality': 60})

使用imagekit.forms.ProcessedImageField（而不是上面的imagekit.models.ProcessedImageField）的好处是，它将创建图像的逻辑保留在模型之外（您会在其中使用正常的Django ImageField）。您甚至可以创建多个表单，每个表单都有自己的ProcessedImageField，并将它们的结果都存储在同一个图像字段中。