Domain-Driven-Design (or DDD) helps us to move away from the anemic model towards a richer behavior. One of the core principles of DDD is to ensure that we lock down the entry-points in our domain model. We do not allow an entity outside our domain to manipulate our data or property directly. That’s why in C# we avoid having public setters on our properties.
However, does the private setters work for collections? Let me try to explain this with a simple example.
For the sake of brevity and focus on the problem statement, I will not talk about the concepts of ValueObject, Entity, or Aggregate in my example and assume that you are already aware of it.
Let us say we have an OrderItem class.
Now, consider we have an
Order class that contains a ReadOnly collection of
As you can see, following the principles of DDD we do not have a public setter on OrderItems. The OrderItems can be only manipulated by calling methods AddOrderItem and RemoveOrderItem.
However, is OrderItems safe? Is there any way we can still manipulate the collection outside of the Order domain? Unfortunately, there is. Consider, below xUnit test.
This test would fail at line number 17. The OrderItems count is 3 instead of 2. That is, we could manipulate the OrderItem collection outside the Order class. This is not ideal and violates one of the Core DDD principles to maintain model integrity.
How can we solve this problem? The answer to that perhaps lies in ImmutableList (or ImmutableArray). From the Microsoft documentation:
ImmutableList represents an immutable list, which is a strongly typed list of objects that can be accessed by index.
The updated Order class after the changes would look something similar to below:
The same xUnit test after this change would throw below runtime exception on line number 15.
System.NotSupportedException : Specified method is not supported.
at System.Collections.Immutable.ImmutableList`1.System.Collections.Generic.ICollection.Add(T item)
Having the ImmutableList for collection helps us to resolve the integrity issue with our domain model. However, the above code still has a couple of issues. Unlike, IReadOnlyCollection ImmutableList has an Add method. That means a user can call order.OrderItems.Add(orderItem) outside the domain. Calling the Add method on ImmutableList will not add an item to the collection, it just returns a copy of the list with specified object added to the list. But, this can still confuse the consumer.
In addition to this, OrderItems is not Serializable without a private setter. If we try to save our domain model in NoSql DBs like RavenDb or CosmosDb the OrderItems collection would not be saved.
Also, if we try to map the domain model to a DTO using mapper libraries like Automapper, the mapping between the two objects would fail.
The fix for these issues is simple. We just need to introduce a private setter and expose the Collection as IReadOnlyCollection.
That’s it! With this one small change, we can now protect our collection in the domain and also ensure that it is saved to our domain in our data-store.
ImmutableList vs ImmutableArray
The above example can also be replaced by ImmutableArray instead of ImmutableList. The Microsoft link here describes different scenarios best suited for either.
TL;DR: If updating the data is rare or number expected elements are less than 16 items, then ImmutableArray is more preferable than an ImmutableList
ReadOnlyCollection or IEnumerable do not guarantee the integrity of a collection in a Domain-Driven Design. To ensure the collection cannot be modified outside of the domain, we can use an ImmutableList or ImmutableArray as explained above.