似乎您在询问数据模型和领域模型之间的区别——后者是您可以找到最终用户感知到的业务逻辑和实体的地方,而前者是您实际存储数据的地方。
此外,我将你问题的第三部分解释为:如何注意到未能将这些模型分开。
这是两个完全不同的概念,很难把它们分开。但是,有一些常见的模式和工具可用于此目的。
关于领域模型
您需要认识到的第一件事是您的领域模型实际上与数据无关;它是关于“激活该用户”、“禁用该用户”、“当前激活哪些用户?”和“该用户的名称是什么?”等操作和问题。用经典的术语来说:它是关于查询和命令的。
命令思维
让我们从示例中的命令开始:“activate this user”和“deactivate this user”。命令的好处是它们可以很容易地用小的given-when-then场景来表示:
给定一个不活跃的用户
当管理员激活该用户时
然后用户变成活动用户
并向用户发送确认电子邮件
并将一个条目添加到系统日志中
(等等)。
这样的场景有助于了解单个命令如何影响基础设施的不同部分——在这种情况下,您的数据库(某种“活动”标志)、邮件服务器、系统日志等。
这样的场景也能真正帮助你建立一个测试驱动开发环境。
最后,用命令思考确实有助于创建面向任务的应用程序。你的用户会喜欢的:-)
表达命令
Django提供了两种简单的命令表达方式;它们都是有效的选择,混合使用这两种方法并不罕见。
服务层
@Hedde已经描述了服务模块。这里定义了一个单独的模块,每个命令都表示为一个函数。
services.py
def activate_user(user_id):
user = User.objects.get(pk=user_id)
# set active flag
user.active = True
user.save()
# mail user
send_mail(...)
# etc etc
使用形式
另一种方法是为每条命令使用一个Django Form。我更喜欢这种方法,因为它结合了多个密切相关的方面:
命令的执行(它做什么?)
命令参数的验证(它能做到吗?)
命令的表示(我如何做到这一点?)
forms.py
class ActivateUserForm(forms.Form):
user_id = IntegerField(widget = UsernameSelectWidget, verbose_name="Select a user to activate")
# the username select widget is not a standard Django widget, I just made it up
def clean_user_id(self):
user_id = self.cleaned_data['user_id']
if User.objects.get(pk=user_id).active:
raise ValidationError("This user cannot be activated")
# you can also check authorizations etc.
return user_id
def execute(self):
"""
This is not a standard method in the forms API; it is intended to replace the
'extract-data-from-form-in-view-and-do-stuff' pattern by a more testable pattern.
"""
user_id = self.cleaned_data['user_id']
user = User.objects.get(pk=user_id)
# set active flag
user.active = True
user.save()
# mail user
send_mail(...)
# etc etc
在询问中思考
您的示例不包含任何查询,因此我冒昧地创建了一些有用的查询。我更喜欢使用“问题”这个术语,但查询是经典的术语。有趣的查询有:“这个用户的名字是什么?”、“这个用户可以登录吗?”、“显示未激活用户列表”和“未激活用户的地理分布是什么?”
在回答这些问题之前,你应该问自己这个问题,是这样的吗?
一个仅针对模板的表示查询,和/或
绑定到执行我的命令的业务逻辑查询,和/或
报表查询。
表示查询仅仅是为了改进用户界面。业务逻辑查询的答案直接影响命令的执行。报告查询仅用于分析目的,并且具有较宽松的时间限制。这些类别并不相互排斥。
另一个问题是:“我能完全控制答案吗?”例如,当查询用户名时(在这个上下文中),我们对结果没有任何控制,因为我们依赖于外部API。
进行查询
Django中最基本的查询是Manager对象的使用:
User.objects.filter(active=True)
当然,这只有在数据模型中实际表示数据时才有效。但情况并非总是如此。在这些情况下,您可以考虑以下选项。
自定义标记和过滤器
第一种方法对于仅仅是表示的查询很有用:自定义标记和模板过滤器。
template.html
<h1>Welcome, {{ user|friendly_name }}</h1>
template_tags.py
@register.filter
def friendly_name(user):
return remote_api.get_cached_name(user.id)
查询方法
如果你的查询不仅仅是表示的,你可以在services.py中添加查询(如果你正在使用的话),或者引入一个queries.py模块:
queries.py
def inactive_users():
return User.objects.filter(active=False)
def users_called_publysher():
for user in User.objects.all():
if remote_api.get_cached_name(user.id) == "publysher":
yield user
代理模型
代理模型在业务逻辑和报告上下文中非常有用。您基本上定义了模型的一个增强子集。您可以通过覆盖Manager.get_queryset()方法来覆盖Manager的基本QuerySet。
models.py
class InactiveUserManager(models.Manager):
def get_queryset(self):
query_set = super(InactiveUserManager, self).get_queryset()
return query_set.filter(active=False)
class InactiveUser(User):
"""
>>> for user in InactiveUser.objects.all():
… assert user.active is False
"""
objects = InactiveUserManager()
class Meta:
proxy = True
查询模型
对于本质上很复杂,但经常执行的查询,可以使用查询模型。查询模型是一种非规范化的形式,其中单个查询的相关数据存储在单独的模型中。当然,诀窍是保持非规范化模型与原始模型同步。查询模型只能在更改完全在您的控制之下时使用。
models.py
class InactiveUserDistribution(models.Model):
country = CharField(max_length=200)
inactive_user_count = IntegerField(default=0)
第一个选项是在命令中更新这些模型。如果只通过一两个命令更改这些模型,这是非常有用的。
forms.py
class ActivateUserForm(forms.Form):
# see above
def execute(self):
# see above
query_model = InactiveUserDistribution.objects.get_or_create(country=user.country)
query_model.inactive_user_count -= 1
query_model.save()
更好的选择是使用自定义信号。这些信号当然是由您的命令发出的。信号的优点是可以使多个查询模型与原始模型保持同步。此外,信号处理可以使用芹菜或类似的框架卸载到后台任务。
signals.py
user_activated = Signal(providing_args = ['user'])
user_deactivated = Signal(providing_args = ['user'])
forms.py
class ActivateUserForm(forms.Form):
# see above
def execute(self):
# see above
user_activated.send_robust(sender=self, user=user)
models.py
class InactiveUserDistribution(models.Model):
# see above
@receiver(user_activated)
def on_user_activated(sender, **kwargs):
user = kwargs['user']
query_model = InactiveUserDistribution.objects.get_or_create(country=user.country)
query_model.inactive_user_count -= 1
query_model.save()
保持清洁
当使用这种方法时,确定代码是否保持干净变得非常容易。只要遵循这些指导方针:
我的模型是否包含除了管理数据库状态以外的其他方法?您应该提取一个命令。
我的模型是否包含不映射到数据库字段的属性?您应该提取一个查询。
我的模型是否引用了不是数据库的基础设施(比如邮件)?您应该提取一个命令。
视图也是如此(因为视图经常遭受同样的问题)。
视图是否主动管理数据库模型?您应该提取一个命令。
一些参考
Django文档:代理模型
Django文档:信号
架构:领域驱动设计