Skip to main content

Translating a bit of the idea behind domain driven design into code architecture

I've often participated in arguments discussions about whether thin models or thin controllers should be preferred. 

The wisdom of a thin controller is that if you need to test your controller in isolation then you need to stub the dependencies of your request and response. It also violates the single responsibility principal because the controller could have multiple reasons to change. 

 Seemingly, the alternative is to settle on having fat models. This results in having domain logic right next to your persistence logic. If you ever want to change your persistence layer you're going to be in for a painful time. That's a bit of a cargo cult argument because honestly who does that, but it's also a violation of the single responsibility principal. 

 One way to decouple your domain logic from both persistence and controller is to use the "repository pattern". 

 Here we encapsulate domain logic into a data service. This layer deals exclusively with implementing your domain logic and is entirely reliant on using the repository layer to fetch data. 

The repository layer takes care of sorting, aggregating, and filtering your data. It doesn't have intelligence beyond these basic functions. It is unable to make a call directly to the actual data store but rather uses an entity to do so. This keeps the mechanism of retrieving data from storage separate from the logic required to massage it into a shape that is useful to your data service. 

 In code I usually namespace the domain to keep it clear what I'm trying to do. So I'd end up with namespaces something like this: 

 \App\Domain\Service
 \App\Domain\Repository
 \App\Domain\Entity
 \App\Domain\Contract 

 The "Contract" namespace is where I keep my interfaces. I personally like grouping them up like that, but your mileage may vary. 

 If you're looking for more concrete code examples, I blogged about this many years ago (here). I'm not sure that adding code to the explanation actually helps to improve understanding though. The principal of what we're trying to do is to decouple our domain logic from our persistence mechanism and our controller logic. We want to adhere to SOLID principals and have code that we can test and maintain without swearing.

Comments

Popular posts from this blog

Using Fail2Ban to protect a Varnished site from scrapers

I'm using Varnish to cache a fairly busy property site.  Varnish works like a bomb for normal users and has greatly improved our page load speed. For bots that are scraping the site, presumably to add the property listings to their own site, though the cache is next to useless since the bots are sequentially trawling through the whole site. I decided to use fail2ban to block IP's who hit the site too often. The first step in doing so was to enable a disk based access log for Varnish so that fail2ban will have something to work with. This means setting up varnishncsa.  Add this to your /etc/rc.local file: varnishncsa -a -w /var/log/varnish/access.log -D -P /var/run/varnishncsa.pid This starts up varnishncsa in daemon mode and appends Varnish access attempts to /var/log/varnish/access.log Now edit or create /etc/logrotate.d/varnish and make an entry to rotate this access log: /var/log/varnish/*log { create 640 http log compress ...

Grokking PHP monolog context into Elastic

An indexed and searchable centralized log is one of those tools that once you've had it you'll wonder how you managed without it.    I've experienced a couple of advantages to using a central log - debugging, monitoring performance, and catching unknown problems. Debugging Debugging becomes easier because instead of poking around grepping text logs on servers you're able to use a GUI to contrast and compare values between different time ranges. A ticket will often include sparse information about the problem and observed error, but if you know more or less when a problem occurred then you can check the logs of all your systems at that time. Problem behaviour in your application can occur as a result of the services you depend on.  A database fault will produce errors in your application, for example. If you log your database errors and your application errors in the same central platform then it's much more convenient to compare behaviour between...