Используем Fluent Builder

Продолжая тему Fluent interface, решил написать про Fluent builder. Основная цель Fluent builder - упростить процесс конструирования объектов, используя для этого цепочки методов (set-методы).

Разберемся на простом примере, для этого рассмотрим сущность, описываемую классом Post:

partial class Post

{

    public string Title { get; set; }

    public string Author { get; set; }

    public DateTime PublishedAt { get; set; }

    public IList<string> Links { get; set; }

}

Чаще всего, простая инициализация экземпляра объекта Post свелась бы к выполнению следующих нехитрых действий:

// Построим объект Post

// Вариант 1

Post oldpost = new Post();

oldpost.Author = "Вася Петров";

oldpost.Title = "Заголовок";

oldpost.PublishedAt = DateTime.Now;

oldpost.Links = new List<string>               

{

    "http://handcode.ru",

    "http://google.com"

};

//

// ИЛИ

//

// Построим объект Post

// Вариант 2

Post simplepost = new Post

{

    Author = "Вася Петров",

    Title = "Заголовок",

    PublishedAt = DateTime.Now,

    Links = new List<string>

    {

        "http://handcode.ru",

        "http://google.com"

    }

};

Отметьте что второй вариант смотрится гораздо лучше первого, но все равно что-то не то, например: явное DateTime.Now или создание List. Что если переложить обязанность инициализации экземпляра на сторонний класс Builder? И наделить класс Builder fluent-свойством. Попробуем. Для этого реализуем класс PostBuilder:

class PostBuilder

{

    // Все свойства закрыты

    string Title { get; set; }

    string Author { get; set; }

    DateTime PublishedAt { get; set; }

    IList<string> Links { get; set; }

 

    // Здесь можем инициализировать default-значения

    public PostBuilder()

    {

        Links = new List<string>();

    }

 

    public PostBuilder WithTitle(string title)

    {

        Title = title;

        // Возвращаем сами себя

        // Принцип fluent interface

        return this;

    }

 

    // Имя метода задаем как причастие

    // Пост написан %author%

    public PostBuilder WrittenBy(string author)

    {

        Author = author;

        return this;

    }

 

    // Метод, с "говорящим" именем

    // Никаких "лишних" аргументов

    // Подобных функций может быть много

    public PostBuilder WrittenByMe()

    {

        // "Me" определяется в одном месте, здесь.

        return WrittenBy("Я");

    }

 

    public PostBuilder PublishedNow()

    {           

        PublishedAt = DateTime.Now;

        return this;

    }

 

    public PostBuilder AddLink(string link)

    {

        Links.Add(link);

        return this;

    }

 

    // Для неявного приведения типа

    public static implicit operator Post(PostBuilder builder)

    {

        // Само построение объекта. Нечто вроде flush метода.

        return new Post

        {

            Title = builder.Title,

            Author = builder.Author,

            PublishedAt = builder.PublishedAt,

            Links = builder.Links

        };

    }

}

И для удобства использования нашего Builder, не захламляя исходный класс Post, реализуем к нему partial:

// Вот зачем модификатор partial

partial class Post

{

    // Возвращает "билдер" для построения Post

    public static PostBuilder Builder()

    {

        return new PostBuilder();

    }

}

И наконец, пример использования:

// Построим объект Post через

// объект fluent builder:

Post fluentpost = Post.Builder()

    .WrittenBy("Вася Петров")

  //.WrittenByMe()

    .WithTitle("Заголовок")

    .PublishedNow()

    .AddLink("http://handcode.ru")

    .AddLink("http://google.com");

Ссылки:

1. Fluent interface
2. Используем Fluent Filters