agoda-com / agoda-com/standards-c-sharp

Add From method pattern recommendation for mapping

Open
#9 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
22
Forks
4
PR merge metrics
No merged PRs in 30d

Description

This technique is mensioned in a few of the articles but never officially documented.

Not sure if this is standards or style though. Maybe it belongs in a different section all together.

What we discussed was we looking at mapping as a concept, having mapping classes or services to map class A to B doesn't lend itself to be very discoverable, and we see times when mapper classes are written multiple times because of this.

Also mappers in general should be pure, so base on our other recommendation about using static for pure methods, we started using a static method called From, in target classes for mapping.

For example

```csharp
public class A
{
}
public class B
{
public static From(A a)
{
// mapping logic here
}
}

```

What this would look like getting used is something like this

```csharp
B.From(new A())
```

- Having the mapping logic in the model itself allows for good discoverability, when you look at the model you see what other model it depends on
- if the methods is pure is should be static
- the code reads like a sentence to describe what's being done "B from A", making it fluent
- Can be used with multiple classes in the From method

Where it is not good is when your mapping is not pure, you don't want to be passing services into the from method.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.