我正在用Django写一个项目，我看到80%的代码都在models.py文件中。这段代码令人困惑，过了一段时间后，我就不明白到底发生了什么。
这是困扰我的问题:
I find it ugly that my model level (which was supposed to be
responsible only for the work with data from a database) is also
sending email, walking on API to other services, etc.
Also, I find it unacceptable to place business logic in the view, because
this way it becomes difficult to control. For example, in my
application there are at least three ways to create new
instances of User, but technically it should create them uniformly.
I do not always notice when the methods and
properties of my models become non-deterministic and when they develop
side effects.
这里有一个简单的例子。一开始，用户模型是这样的:
class User(db.Models):
def get_present_name(self):
return self.name or 'Anonymous'
def activate(self):
self.status = 'activated'
self.save()
随着时间的推移，它变成了这样:
class User(db.Models):
def get_present_name(self):
# property became non-deterministic in terms of database
# data is taken from another service by api
return remote_api.request_user_name(self.uid) or 'Anonymous'
def activate(self):
# method now has a side effect (send message to user)
self.status = 'activated'
self.save()
send_mail('Your account is activated!', '…', [self.email])
我想要的是在代码中分离实体:
数据库级实体，即数据库级逻辑:我的应用程序存储什么样的数据?
应用程序级实体，即业务级逻辑:我的应用程序做什么?
在Django中实现这样一种方法有哪些好的实践呢?
我通常在视图和模型之间实现一个服务层。这就像你的项目的API，给你一个良好的直升机视图正在发生什么。我从我的一个同事那里继承了这个实践，他在Java项目(JSF)中经常使用这种分层技术，例如:
models.py
class Book:
author = models.ForeignKey(User)
title = models.CharField(max_length=125)
class Meta:
app_label = "library"
services.py
from library.models import Book
def get_books(limit=None, **filters):
""" simple service function for retrieving books can be widely extended """
return Book.objects.filter(**filters)[:limit] # list[:None] will return the entire list
views.py
from library.services import get_books
class BookListView(ListView):
""" simple view, e.g. implement a _build and _apply filters function """
queryset = get_books()
请注意，我通常将模型、视图和服务放在模块级别
根据项目的大小，可以进一步分开
我不得不同意你的看法。django中有很多可能性，但最好的起点是回顾django的设计理念。
Calling an API from a model property would not be ideal, it seems like it would make more sense to do something like this in the view and possibly create a service layer to keep things dry. If the call to the API is non-blocking and the call is an expensive one, sending the request to a service worker (a worker that consumes from a queue) might make sense.
As per Django's design philosophy models encapsulate every aspect of an "object". So all business logic related to that object should live there:
包括所有相关的领域逻辑
模型应该封装“对象”的每个方面，遵循Martin Fowler的活动记录设计模式。
The side effects you describe are apparent, the logic here could be better broken down into Querysets and managers. Here is an example:
models.py
import datetime
from djongo import models
from django.db.models.query import QuerySet
from django.contrib import admin
from django.db import transaction
class MyUser(models.Model):
present_name = models.TextField(null=False, blank=True)
status = models.TextField(null=False, blank=True)
last_active = models.DateTimeField(auto_now=True, editable=False)
# As mentioned you could put this in a template tag to pull it
# from cache there. Depending on how it is used, it could be
# retrieved from within the admin view or from a custom view
# if that is the only place you will use it.
#def get_present_name(self):
# # property became non-deterministic in terms of database
# # data is taken from another service by api
# return remote_api.request_user_name(self.uid) or 'Anonymous'
# Moved to admin as an action
# def activate(self):
# # method now has a side effect (send message to user)
# self.status = 'activated'
# self.save()
# # send email via email service
# #send_mail('Your account is activated!', '…', [self.email])
class Meta:
ordering = ['-id'] # Needed for DRF pagination
def __unicode__(self):
return '{}'.format(self.pk)
class MyUserRegistrationQuerySet(QuerySet):
def for_inactive_users(self):
new_date = datetime.datetime.now() - datetime.timedelta(days=3*365) # 3 Years ago
return self.filter(last_active__lte=new_date.year)
def by_user_id(self, user_ids):
return self.filter(id__in=user_ids)
class MyUserRegistrationManager(models.Manager):
def get_query_set(self):
return MyUserRegistrationQuerySet(self.model, using=self._db)
def with_no_activity(self):
return self.get_query_set().for_inactive_users()
admin.py
# Then in model admin
class MyUserRegistrationAdmin(admin.ModelAdmin):
actions = (
'send_welcome_emails',
)
def send_activate_emails(self, request, queryset):
rows_affected = 0
for obj in queryset:
with transaction.commit_on_success():
# send_email('welcome_email', request, obj) # send email via email service
obj.status = 'activated'
obj.save()
rows_affected += 1
self.message_user(request, 'sent %d' % rows_affected)
admin.site.register(MyUser, MyUserRegistrationAdmin)
这是一个老问题，但我还是想提出我的解决方案。它是基于这样一种接受:模型对象也需要一些额外的功能，而把它放在models.py中是很尴尬的。重业务逻辑可以根据个人喜好单独编写，但我至少喜欢模型做与自身相关的所有事情。该解决方案还支持那些喜欢将所有逻辑置于模型本身中的人。
因此，我设计了一个hack，允许我将逻辑从模型定义中分离出来，并且仍然可以从我的IDE中得到所有的提示。
优点应该是显而易见的，但下面列出了我观察到的一些优点:
DB定义仍然是那样-没有逻辑“垃圾”附加
与模型相关的逻辑都整齐地放在一个地方
所有服务(表单、REST、视图)都有一个逻辑访问点
最棒的是:当我意识到我的models.py变得太杂乱，不得不分离逻辑时，我不需要重写任何代码。分离是平滑和迭代的:我可以一次处理一个函数，也可以一次处理整个类或整个models.py。
我一直在使用Python 3.4及更高版本和Django 1.8及更高版本。
app / models.py
....
from app.logic.user import UserLogic
class User(models.Model, UserLogic):
field1 = models.AnyField(....)
... field definitions ...
应用程序/逻辑/ user.py
if False:
# This allows the IDE to know about the User model and its member fields
from main.models import User
class UserLogic(object):
def logic_function(self: 'User'):
... code with hinting working normally ...
我唯一想不明白的是如何让我的IDE(在这种情况下是PyCharm)识别UserLogic实际上是用户模型。但由于这显然是一种hack，我很乐意接受总是为self参数指定类型的小麻烦。
我通常在视图和模型之间实现一个服务层。这就像你的项目的API，给你一个良好的直升机视图正在发生什么。我从我的一个同事那里继承了这个实践，他在Java项目(JSF)中经常使用这种分层技术，例如:
models.py
class Book:
author = models.ForeignKey(User)
title = models.CharField(max_length=125)
class Meta:
app_label = "library"
services.py
from library.models import Book
def get_books(limit=None, **filters):
""" simple service function for retrieving books can be widely extended """
return Book.objects.filter(**filters)[:limit] # list[:None] will return the entire list
views.py
from library.services import get_books
class BookListView(ListView):
""" simple view, e.g. implement a _build and _apply filters function """
queryset = get_books()
请注意，我通常将模型、视图和服务放在模块级别
根据项目的大小，可以进一步分开
