# Django文档别名URL设计方法

### 🧑‍💻 User

如何为Django开发的知识库应用里面的文档设计一个别名URL功能？

---

### 🤖 Assistant

# 为Django知识库应用设计文档别名URL功能

为Django知识库应用添加文档别名URL功能是一个实用的改进，可以提高用户体验和SEO优化。下面是实现这一功能的完整方案：

## 1. 创建别名模型

首先，你需要创建一个模型来存储主文档URL与其别名之间的映射关系：

```python
# models.py
from django.db import models
from django.core.exceptions import ValidationError
from django.utils.text import slugify

class Document(models.Model):
    title = models.CharField(max_length=255)
    content = models.TextField()
    slug = models.SlugField(max_length=255, unique=True)
    # 其他文档字段...

class DocumentAlias(models.Model):
    document = models.ForeignKey(Document, on_delete=models.CASCADE, related_name='aliases')
    alias_slug = models.SlugField(max_length=255, unique=True)
    is_primary = models.BooleanField(default=False, 
                                   help_text="将此设为True会使原slug无法访问")
    created_at = models.DateTimeField(auto_now_add=True)

class Meta:
        verbose_name_plural = "Document Aliases"
        constraints = [
            models.UniqueConstraint(
                fields=['document', 'is_primary'],
                condition=models.Q(is_primary=True),
                name='unique_primary_alias_per_document'
            )
        ]

def clean(self):
        # 确保原slug没有被用作别名
        if self.alias_slug == self.document.slug:
            raise ValidationError("Alias cannot be the same as the document's original slug")

def save(self, *args, **kwargs):
        # 确保alias_slug是干净的slug
        self.alias_slug = slugify(self.alias_slug)
        
        # 如果设置为primary，取消其他primary标记
        if self.is_primary:
            DocumentAlias.objects.filter(
                document=self.document, 
                is_primary=True
            ).update(is_primary=False)
            
        super().save(*args, **kwargs)
```

## 2. 创建视图来处理别名重定向

```python
# views.py
from django.shortcuts import get_object_or_404, redirect
from django.views.generic import DetailView
from .models import Document, DocumentAlias

class DocumentDetailView(DetailView):
    model = Document
    template_name = 'documents/document_detail.html'
    context_object_name = 'document'

def get_object(self, queryset=None):
        # 先尝试获取原始slug
        if 'slug' in self.kwargs:
            return get_object_or_404(Document, slug=self.kwargs['slug'])
        
        # 如果不是原始slug，查找别名
        alias = get_object_or_404(DocumentAlias, alias_slug=self.kwargs['slug'])
        return alias.document

def document_alias_redirect(request, slug):
    """处理旧URL的重定向"""
    alias = get_object_or_404(DocumentAlias, alias_slug=slug)
    if alias.is_primary:
        # 如果这是主别名，永久重定向到主URL
        return redirect(alias.document.get_absolute_url(), permanent=True)
    else:
        # 如果是普通别名，临时重定向
        return redirect(alias.document.get_absolute_url(), permanent=False)
```

## 3. 配置URL路由

```python
# urls.py
from django.urls import path
from .views import DocumentDetailView, document_alias_redirect

urlpatterns = [
    # 原始文档URL
    path('docs/<slug:slug>/', DocumentDetailView.as_view(), name='document-detail'),
    
    # 别名重定向URL - 这个应该在原始URL之后！
    path('docs/<slug:slug>/', document_alias_redirect, name='document-alias'),
]
```

注意：由于两个URL模式相同，顺序很重要。Django会按顺序匹配第一个模式。

## 4. 添加管理功能

在admin.py中注册模型并提供管理界面：

```python
# admin.py
from django.contrib import admin
from .models import Document, DocumentAlias

class DocumentAliasInline(admin.TabularInline):
    model = DocumentAlias
    extra = 1

@admin.register(Document)
class DocumentAdmin(admin.ModelAdmin):
    inlines = [DocumentAliasInline]
    prepopulated_fields = {'slug': ('title',)}

@admin.register(DocumentAlias)
class DocumentAliasAdmin(admin.ModelAdmin):
    list_display = ('alias_slug', 'document', 'is_primary')
    list_filter = ('is_primary',)
    search_fields = ('alias_slug', 'document__title')
```

## 5. 处理文档的get_absolute_url方法

修改Document模型以处理主别名：

```python
# models.py中添加
class Document(models.Model):
    # ... 之前字段 ...
    
    def get_absolute_url(self):
        # 检查是否有主别名
        primary_alias = self.aliases.filter(is_primary=True).first()
        if primary_alias:
            return reverse('document-detail', kwargs={'slug': primary_alias.alias_slug})
        return reverse('document-detail', kwargs={'slug': self.slug})
```

## 6. 添加中间件处理旧URL访问

如果你想确保旧URL不再被访问（当设置了主别名时），可以添加中间件：

```python
# middleware.py
from django.http import Http404
from .models import Document, DocumentAlias

class DocumentAliasMiddleware:
    def __init__(self, get_response):
        self.get_response = get_response

def __call__(self, request):
        response = self.get_response(request)
        return response

def process_view(self, request, view_func, view_args, view_kwargs):
        if 'document-detail' in request.resolver_match.view_name and 'slug' in view_kwargs:
            slug = view_kwargs['slug']
            # 如果这个slug是原slug但文档有主别名
            if Document.objects.filter(slug=slug).exists():
                doc = Document.objects.get(slug=slug)
                if doc.aliases.filter(is_primary=True).exists():
                    raise Http404("This URL is no longer available")
```

在settings.py中添加中间件：

```python
MIDDLEWARE = [
    # ...
    'yourapp.middleware.DocumentAliasMiddleware',
    # ...
]
```

## 7. 使用信号保持数据一致性

添加信号以确保数据一致性：

```python
# signals.py
from django.db.models.signals import pre_save, post_save
from django.dispatch import receiver
from .models import Document

@receiver(pre_save, sender=Document)
def handle_document_slug_change(sender, instance, **kwargs):
    if instance.pk:
        original = Document.objects.get(pk=instance.pk)
        if original.slug != instance.slug:
            # 如果原始slug被更改，创建一个自动别名
            DocumentAlias.objects.create(
                document=instance,
                alias_slug=original.slug,
                is_primary=False
            )
```

在apps.py中注册信号：

```python
# apps.py
from django.apps import AppConfig

class DocumentsConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'documents'

def ready(self):
        import documents.signals
```

## 8. 使用表单添加别名

创建一个表单供用户添加别名：

```python
# forms.py
from django import forms
from .models import DocumentAlias

class DocumentAliasForm(forms.ModelForm):
    class Meta:
        model = DocumentAlias
        fields = ['alias_slug', 'is_primary']
```

## 9. 创建视图和模板

创建视图和模板来管理别名：

```python
# views.py 添加
from django.contrib.auth.mixins import LoginRequiredMixin
from django.views.generic import CreateView
from .forms import DocumentAliasForm

class DocumentAliasCreateView(LoginRequiredMixin, CreateView):
    model = DocumentAlias
    form_class = DocumentAliasForm
    template_name = 'documents/add_alias.html'
    
    def get_initial(self):
        initial = super().get_initial()
        initial['document'] = get_object_or_404(Document, pk=self.kwargs['pk'])
        return initial
    
    def form_valid(self, form):
        form.instance.document_id = self.kwargs['pk']
        return super().form_valid(form)
```

## 10. 添加测试

最后，为这个功能添加测试用例：

```python
# tests.py
from django.test import TestCase
from django.urls import reverse
from .models import Document, DocumentAlias

class DocumentAliasTests(TestCase):
    def setUp(self):
        self.doc = Document.objects.create(title="Test Doc", slug="test-doc", content="Test")
        
    def test_alias_redirect(self):
        DocumentAlias.objects.create(document=self.doc, alias_slug="test-alias")
        response = self.client.get(reverse('document-alias', kwargs={'slug': 'test-alias'}))
        self.assertRedirects(response, reverse('document-detail', kwargs={'slug': 'test-doc'}))
    
    def test_primary_alias(self):
        DocumentAlias.objects.create(document=self.doc, alias_slug="primary-alias", is_primary=True)
        response = self.client.get(reverse('document-detail', kwargs={'slug': 'primary-alias'}))
        self.assertEqual(response.status_code, 200)
        
        # 原URL应该不再可用
        response = self.client.get(reverse('document-detail', kwargs={'slug': 'test-doc'}))
        self.assertEqual(response.status_code, 404)
```

这样就为你的Django知识库应用实现了一个完整的文档别名URL系统。这个实现包括了：
- 多种类型别名的支持（重定向和主别名）
- 数据一致性维护
- 管理界面支持
- 适当的URL路由和重定向
- SEO友好的永久重定向
- 防止URL冲突的安全措施