DEV Community

Cover image for Code Smell 40 - DTOs
Maxi Contieri
Maxi Contieri

Posted on • Edited on • Originally published at maximilianocontieri.com

1

Code Smell 40 - DTOs

DTOs are widely used and they 'solve' real problems, do they?

Problems

  • Anemic Object

  • Inconsistent Data

  • Duplicated logic

  • Duplicated structure

  • Class Polluting

  • Information Hiding Violation

  • Code repeated among mutators, accessors, serializers, parsers

  • Ripple Effect

  • Data integrity

Solutions

  1. Transfer anemic data on arrays.

  2. Use real business objects.

  3. If we want to transfer partial objects: use proxies or null objects to break the reference graph.

Sample Code

Wrong

<?
final class SocialNetworkProfile {
private $userName;
private $friends;
// friends is a reference to a large collection
private $feed;
// feed references the whole user feed
public function __construct(
$userName,
$friends,
UserFeed $feed) {
$this->assertUsernameIsValid($userName);
$this->assertNoFriendDuplicates($friends);
$this->userName = $userName;
$this->friends = $friends;
$this->feed = $feed;
$this->assertNoFriendOfMyself($friends);
}
// Lots of protocol
}
// If you need to transfer
// to an external system you need
// to duplicate (and maintain) the structure
final class SocialNetworkProfileDTO {
private $userName; // duplicated to be synchronized
private $friends; // duplicated to be synchronized
private $feed; // duplicated to be synchronized
public function __construct() {
// Empty constructor without validations
}
// No protocol, just serializers
}
// If you need to transfer to an external system
// you create an anemic DTO
$janesProfileToTransfer = new SocialNetworkProfileDTO();
view raw dto.php hosted with ❤ by GitHub

Right

<?
final class SocialNetworkProfile {
private $userName;
private $friends;
// friends is a reference to a large collection
private $feed;
// feed references the whole user feed
public function __construct(
$userName,
FriendsCollection $friends,
UserFeedBehavior $feed)
{
$this->assertUsernameIsValid($userName);
$this->assertNoFriendDuplicates($friends);
$this->userName = $userName;
$this->friends = $friends;
$this->feed = $feed;
$this->assertNoFriendOfMyself($friends);
}
// lots of protocol associated with the profile
// No serialization protocol
// No behavior or attribute duplication
}
interface FriendsCollectionProtocol { }
final class FriendsCollection
implements FriendsCollectionProtocol { }
final class FriendsCollectionProxy
implements FriendsCollectionProtocol {
// proxy protocol
// travels as a lightweight object
// and can get contents when requested
}
abstract class UserFeedBehavior { }
final class UserFeed extends UserFeedBehavior { }
final class NullFeed extends UserFeedBehavior {
// throws an error when requested for behavior
}
// If you need to transfer to an external system
// you create a valid object
$janesProfileToTransfer = new SocialNetworkProfile(
'jane',
new FriendCollectionProxy(),
new NullFeed()
);
view raw fullObjects.php hosted with ❤ by GitHub

Detection

We can use the same anemic object detectors.

We can check for anemic classes with no business object behavior (removing serializes, constructors, mutators etc).

# Tags

  • Anemic

Conclusion

DTOs are a tool and an established practice in some languages. We should use them with care and responsibility.

If we need to disassemble our objects in order to send them away from our realms, we need to be extremely cautioned. Since dismembered objects have no integrity considerations.

His author warns us about its actual abuse.

Relations

More info

Martin Fowler's

Refactoring.Guru

Stack Exchange


The best smells are something that's easy to spot and most of time lead you to really interesting problems. Data classes (classes with all data and no behavior) are good examples of this. You look at them and ask yourself what behavior should be in this class.

Martin Fowler

Top comments (0)

nextjs tutorial video

Youtube Tutorial Series 📺

So you built a Next.js app, but you need a clear view of the entire operation flow to be able to identify performance bottlenecks before you launch. But how do you get started? Get the essentials on tracing for Next.js from @nikolovlazar in this video series 👀

Watch the Youtube series