{"id":1846,"date":"2016-11-24T18:22:07","date_gmt":"2016-11-24T17:22:07","guid":{"rendered":"https:\/\/www.entropywins.wtf\/blog\/?p=1846"},"modified":"2019-02-23T06:11:21","modified_gmt":"2019-02-23T05:11:21","slug":"implementing-the-clean-architecture","status":"publish","type":"post","link":"https:\/\/www.entropywins.wtf\/blog\/2016\/11\/24\/implementing-the-clean-architecture\/","title":{"rendered":"Implementing the Clean Architecture"},"content":{"rendered":"

Both Domain Driven Design and architectures such as the Clean Architecture and Hexagonal are often talked about. It’s hard to go to a conference on software development and not run into one of these topics. However it can be challenging to find good real-world examples. In this blog post I’ll introduce you to an application following the Clean Architecture and incorporating a lot of DDD patterns. The focus is on the key concepts of the Clean Architecture, and the most important lessons we learned implementing it.<\/p>\n

The application<\/h3>\n

The real-world application we’ll be looking at is the Wikimedia Deutschland fundraising software. It is a PHP application written in 2016, replacing an older legacy system. While the application is written in PHP, the patterns followed are by and large language agnostic, and are thus relevant for anyone writing object orientated software.<\/p>\n

I’ve outlined what the application is and why we replaced the legacy system in a blog post titled Rewriting the Wikimedia Deutschland fundraising<\/a>. I recommend you have a look at least at its “The application” section, as it will give you a rough idea of the domain we’re dealing with.<\/p>\n

A family of architectures<\/h3>\n

Architectures such as Hexagonal and the Clean Architecture are very similar. At their core, they are about separation of concerns. They decouple from mechanisms such as persistence and used frameworks and instead focus on the domain and high level policies. A nice short read on this topic is Unclebob’s blog post on the Clean Architecture<\/a>. Another recommended post is Hexagonal != Layers<\/a>, which explains that how just creating a bunch of layers is missing the point.<\/p>\n

The Clean Architecture<\/h3>\n

\"cleanarchitecture\"<\/a><\/p>\n

The arrows crossing the circle boundaries represent the allowed direction of dependencies. At the core is the domain. “Entities” here means Entities such as in Domain Driven Design, not to be confused by ORM entities. The domain is surrounded by a layer containing use cases (sometimes called interactors) that form an API that the outside world, such as a controller, can use to interact with the domain. The use cases themselves only bind to the domain and certain cross cutting concerns such as logging, and are devoid of binding to the web, the database and the framework.<\/p>\n

class CancelDonationUseCase {\n    private \/* DonationRepository *\/ $repository;\n    private \/* Mailer *\/ $mailer;\n\n    public function cancelDonation( CancelDonationRequest $r ): CancelDonationResponse {\n        $this->validateRequest( $r );\n\n        $donation = $this->repository->getDonationById( $r->getDonationId() );\n        $donation->cancel();\n        $this->repository->storeDonation( $donation );\n\n        $this->sendConfirmationEmail( $donation );\n\n        return new CancelDonationResponse( \/* ... *\/ );\n    }\n}\n<\/pre>\n
In this example you can see how the UC for canceling a donation gets a request object, does some stuff, and then returns a response object. Both the request and response objects are specific to this UC and lack both domain and presentation mechanism binding. The stuff that is actually done is mainly interaction with the domain through Entities, Aggregates and Repositories.<\/p>\n
$app->post(\n    '\/cancel-donation',\n    function( Request $httpRequest ) use ( $factory ) {\n        $requestModel = new CancelDonationRequest(\n            $httpRequest->request->get( 'donation_id' ),\n            $httpRequest->request->get( 'update_token' )\n        );\n\n        $useCase = $factory->newCancelDonationUseCase();\n        $responseModel = $useCase->cancelDonation( $requestModel );\n\n        $presenter = $factory->newNukeLaunchingResultPresenter();\n        return new Response( $presenter->present( $responseModel ) );\n    }\n);\n<\/pre>\n
This is a typical way of invoking a UC. The framework we’re using is Silex, which calls the function we provided when the route matches. Inside this function we construct our framework agnostic request model and invoke the UC with it. Then we hand over the response model to a presenter to create the appropriate HTML or other such format. This is all the framework bound code we have for canceling donations. Even the presenter does not bind to the framework, though it does depend on Twig.<\/p>\n
If you are familiar with Silex, you might already have noticed that we’re constructing our UC different than you might expect. We decided to go with our own top level factory, rather than using the dependency injection mechanism provided by Silex: Pimple. Our factory internally actually uses Pimple, though this is not visible from the outside. With this approach we gain a nicer access to service construction, since we can have a getLogger()<\/code> method with LoggerInterface<\/code> return type hint, rather than accessing $app['logger']<\/code> or some such, which forces us to bind to a string and leaves us without type hint.<\/p>\n
\"use-case-list\"<\/p>\n
This use case based approach makes it very easy to see what our system is capable off at a glance.<\/p>\n
\"use-case-directory\"<\/p>\n
And it makes it very easy to find where certain behavior is located, or to figure out where new behavior should be put.<\/p>\n
All code in our src\/<\/code> directory is framework independent, and all code binding to specific persistence mechanisms resides in src\/DataAccess<\/code>. The only framework bound code we have are our very slim “route handlers” (kinda like controllers), the web entry point and the Silex bootstrap.<\/p>\n
For more information on The Clean Architecture I can recommend Robert C Martins NDC 2013 talk<\/a>. If you watch it, you will hopefully notice how we slightly deviated from the UseCase structure like he presented it. This is due to PHP being an interpreted language, and thus does not need certain interfaces that are beneficial in compiled languages.<\/p>\n
Lesson learned: bounded contexts<\/h3>\n
By and large we started with the donation related use cases and then moved on to the membership application related ones. At some point, we had a Donation<\/code> entity\/aggregate in our domain, and a bunch of value objects that it contained.<\/p>\n
class Donation {\n    private \/* int|null *\/            $id\n    private \/* PersonalInfo|null *\/   $personalInfo\n    \/* ... *\/\n}\n<\/pre>\n
class PersonalInfo {\n    private \/* PersonName *\/          $name\n    private \/* PhysicalAddress *\/     $address\n    private \/* string *\/              $emailAddress\n}<\/pre>\n
As you can see, one of those value objects is PersonalInfo<\/code>. Then we needed to add an entity for membership applications. Like donations, membership applications require a name, a physical address and an email address. Hence it was tempting to reuse our existing PersonalInfo<\/code> class.<\/p>\n
class MembershipApplication {\n    private \/* int|null *\/            $id\n    private \/* PersonalInfo|null *\/   $personalInfo\n    \/* ... *\/\n}\n<\/pre>\n
Luckily a complication made us realize that going down this path was not a good idea. This complication was that membership applications also have a phone number and an optional date of birth. We could have forced code sharing by doing something hacky like adding new optional fields to PersonalInfo<\/code>, or by creating a MorePersonalInfo<\/code> derivative.<\/p>\n
Approaches such as these, while resulting in some code sharing, also result in creating binding between Donation<\/code> and MembershipApplication<\/code>. That’s not good, as those two entities don’t have anything to do with each other. Sharing what happens to be the same at present is simply not a good idea. Just imagine that we did not have the phone number and date of birth in our first version, and then needed to add them. We’d either end up with one of those hacky solutions, or need to refactor code that has nothing to do (apart from the bad coupling) with what we want to modify.<\/p>\n
What we did is renaming PersonalInfo<\/code> to Donor<\/code> and introduce a new Applicant<\/code> class.<\/p>\n
class Donor {\n    private \/* PersonName *\/          $name\n    private \/* PhysicalAddress *\/     $address\n    private \/* string *\/              $emailAddress\n}<\/pre>\n
class Applicant {\n    private \/* PersonName *\/          $name\n    private \/* PhysicalAddress *\/     $address\n    private \/* EmailAddress *\/        $email\n    private \/* PhoneNumber *\/         $phone\n    private \/* DateTime|null *\/       $dateOfBirth\n}<\/pre>\n
These names are better since they are about the domain (see ubiquitous language<\/a>) rather than some technical terms we needed to come up with.<\/p>\n
Amongst other things, this rename made us realize that we where missing some explicit boundaries in our application. The donation related code and the membership application related code where mostly independent from each other, and we agreed this was a good thing. To make it more clear that this is the case and highlight violations of that rule, we decided to reorganize our code to follow the strategic DDD pattern of Bounded Contexts<\/a>.<\/p>\n
\"contexts-directory\"<\/p>\n
This mainly consisted out of reorganizing our directory and namespace structure, and a few instances of splitting some code that should not have been bound together.<\/p>\n
Based on this we created a new diagram to reflect the high level structure of our application. This diagram, and a version with just one context<\/a>, are available for use under CC-0.<\/p>\n
\"Clean<\/p>\n
Lesson learned: validation<\/h3>\n
A big question we had near the start of our project was where to put validation code. Do we put it in the UCs, or in the controller-like code that calls the UCs?<\/p>\n
One of the first UCs we added was the one for adding donations. This one has a request model that contains a lot of information, including the donor’s name, their email, their address, the payment method, payment amount, payment interval, etc. In our domain we had several value objects for representing parts of donations, such as the donor or the payment information.<\/p>\n
class Donation {\n    private \/* int|null *\/            $id\n    private \/* Donor|null *\/          $donor\n    private \/* DonationPayment *\/     $payment\n    \/* ... *\/\n}\n\nclass Donor {\n    private \/* PersonName *\/          $name\n    private \/* PhysicalAddress *\/     $address\n    private \/* string *\/              $emailAddress\n}<\/pre>\n
Since we did not want to have one object with two dozen fields, and did not want to duplicate code, we used the value objects from our domain in the request model.<\/p>\n
class AddDonationRequest {\n    private \/* Donor|null *\/          $donor\n    private \/* DonationPayment *\/     $payment\n    \/* ... *\/\n}<\/pre>\n
If you’ve been paying attention, you’ll have realized that this approach violates one of the earlier outlined rules: nothing outside the UC layer is supposed to access anything from the domain. If value objects from the domain are exposed to whatever constructs the request model, i.e. a controller, this rule is violated. Loose from the this abstract objection, we got into real trouble by doing this.<\/p>\n
Since we started doing validation in our UCs, this usage of objects from the domain in the request necessarily forced those objects to allow invalid values. For instance, if we’re validating the validity of an email address in the UC (or a service used by the UC), then the request model cannot use an EmailAddress<\/code> which does sanity checks in its constructor.<\/p>\n
We thus refactored our code to avoid using any of our domain objects in the request models (and response models), so that those objects could contain basic safeguards.<\/p>\n
We made a similar change by altering which objects get validated. At the start of our project we created a number of validators that worked on objects from the domain. For instance a DonationValidator<\/code> working with the Donation<\/code> Entity. This DonationValidator<\/code> would then be used by the AddDonationUseCase<\/code>. This is not a good idea, since the validation that needs to happen depends on the context. In the AddDonationUseCase<\/code> certain restrictions apply that don’t always hold for donations. Hence having a general looking DonationValidator<\/code> is misleading. What we ended up doing instead is having validation code specific to the UCs, be it as part of the UC, or when too complex, a separate validation service in the same namespace. In both cases the validation code would work on the request model, i.e. AddDonationRequest<\/code>, and not bind to the domain.<\/p>\n
After learning these two lessons, we had a nice approach for policy-based validation. That’s not all validation that needs to be done though. For instance, if you get a number via a web request, the framework will typically give it to you as a string, which might thus not be an actual number. As the request model is supposed to be presentation mechanism agnostic, certain validation, conversion and error handling needs to happen before constructing the request model and invoking the UC. This means that often you will have validation in two places: policy based validation in the UC, and presentation specific validation in your controllers or equivalent code. If you have a string to integer conversion, number parsing or something internationalization specific, in your UC, you almost certainly messed up.<\/p>\n
Closing notes
\n<\/strong><\/h3>\n
You can find the Wikimedia Deutschland fundraising application on GitHub<\/a> and see it running in production<\/a>. Unfortunately the code of the old application is not available for comparison, as it is not public. If you have questions, you can leave a comment, or contact me<\/a>. If you find an issue or want to contribute, you can create a pull request<\/a>. If you are looking for my presentation on this topic, view the slides<\/a>.<\/p>\n
As a team we learned a lot during this project, and we set a number of firsts at Wikimedia Deutschland<\/a>, or the wider Wikimedia movement for that matter. The new codebase is the cleanest non-trivial application we have, or that I know of in PHP world. It is fully tested, contains less than 5% framework bound code, has strong strategic separation between both contexts and layers, has roughly 5% data access specific code and has tests that can be run without any real setup. (I might write another blog post on how we designed our tests and testing environment.)<\/p>\n
Many thanks for my colleagues\u00a0Kai Nissen<\/a> and Gabriel Birke<\/a> for being pretty awesome during our rewrite project.<\/p>\n
Further reading<\/h3>\n
Sign up below to receive news on my upcoming Clean Architecture book, including a discount.<\/p>\n
\n
\n
\n
<\/div>\n
\n
<\/div>\n
<\/div>\n<\/div>\n
<\/div>\n
<\/div>\n<\/div>\n<\/form>\n<\/div>\n
Other things to look at:<\/p>\n