Построение Progressive Fluent Interface

            В данном посте я бы хотел показать, как  построить Progressive Fluent Interface в применении к паттерну Fluent Builder.

            Применение Fluent Interface с паттерном Builder позволяет создавать выразительное и читабельное  API для построения сложных объектов.

  Подробнее том что такое Fluent Interface и Fluent Builder можно прочесть в статье Martin Fowler Fluent Interface и  здесь.

            Построение Progressive Interface рассмотрим на примере Fluent Builder для построения Email сообщений вот код данного класса

    public class EmailBuilder : IEmailBuilder

    {

        private readonly Message message;

        private EmailBuilder(Message message)

        {

            this.message = message;

        }

        public static IEmailBuilder From(string from)

        {

            return new EmailBuilder(new Message(from));

        }

        public IEmailBuilder To(string to)

        {

            message.To.Add(to);

            return this;

        }

        public IEmailBuilder Subject(string subject)

        {

            message.Subject = subject;

            return this;

        }

        public IEmailBuilder Body(string body)

        {

            message.Body = body;

            return this;

        }

        public IEmailBuilder Cc(string cc)

        {

            message.Cc.Add(cc);

            return this;

        }

        public Message Build()

        {

            return message;

        }

    }

Данный класс и является  Fluent Builder-ом и реализует интерфейс

    public interface IEmailBuilder

    {

        IEmailBuilder To(string to);

        IEmailBuilder Subject(string subject);

        IEmailBuilder Body(string body);

        IEmailBuilder Cc(string cc);

        Message Build();

    }

Вот код класса Message

    public class Message

    {

        public Message(string from)

        {

            From = from;

            To = new List<string>();

            Cc = new List<string>();

        }

        protected string From { get; set; }

        public string Subject { get; set; }

        public string Body { get; set; }

        public List<string> To { get; set; }

        public List<string> Cc { get; set; }

    }

Теперь для построения объекта Message достаточно написать так

            Message message = EmailBuilder.From("one@gmail.com")

                .To("some@gmail.com")

                .Cc("two@gmail.com")

                .Subject("Hello")

                .Body("Hello everyone!")

                .Build();

что достаточно удобно и очень читабельно, в чем собственно и преимущество использования Fluent Interface

Но на данный момент есть небольшое неудобство  после того как мы написали

EmailBuilder.From("one@gmail.com").

становятся доступными все методы класса EmailBuilder, что видно в контекстном окне Intellisense

                  

 например после метода From можно сразу написать вот так

  Message message = EmailBuilder.From("one@gmail.com").Body("some text").Build();

Что не очень хорошо и не удобно при работе с Intellisense, так же хотелось бы иметь определенную последовательность вызовов методов класса построителя. Данная проблема решается путем построения Progressive Interface следующим образом.

            Для начала надо определить в какой очередности будут вызываться методы, так пусть

после From() можно вызвать только To(), а после To() можно опять To() или Cc() или Subject(), далее чтобы это реализовать необходимо исходный интерфейс IEmailBuilder разделить на несколько интерфейсов

    public interface IEmailBuilderPostFrom

    {

        IEmailBuilderPostTo To(string to);

    }

    public interface IEmailBuilderPostTo : IEmailBuilderPostFrom

    {

        IEmailBuilderPostCc Cc(string cc);

        IEmailBuilderPostSubject Subject(string subject);

    }

IEmailBuilderPostTo наследуется от IEmailBuilderPostFrom, для того чтобы после метода To() можно было опять вызывать метод To().

( интерфейсы IEmailBuilderPostCc и IEmailBuilderPostSubject будут описаны ниже)

Соответствующие методы класса EmailBuilder будут выглядеть следующим образом

        public static IEmailBuilderPostFrom From(string from)

        {

            return new EmailBuilder(new Message(from));

        }

        public IEmailBuilderPostTo To(string to)

        {

            message.To.Add(to);

            return this;

        }

Аналогично для следующих методов после Сс() можно вызывать Сс() и Sudject(), а после Subject() метод  Body(), после Body() метод Build() который и вернет объект Message.

    public interface IEmailBuilderPostCc

    {

        IEmailBuilderPostCc Cc(string cc);

        IEmailBuilderPostSubject Subject(string subject);

    }

    public interface IEmailBuilderPostSubject

    {

        IEmailBuilderPostBody Body(string body);

    }

    public interface IEmailBuilderPostBody

    {

        Message Build();

    }

 В общем идея простая и ясная. В итоге получим следующую реализацию класса EmailBuilder

    public class EmailBuilder : IEmailBuilderPostTo, IEmailBuilderPostCc, IEmailBuilderPostSubject, IEmailBuilderPostBody

    {

        private readonly Message message;

        private EmailBuilder(Message message)

        {

            this.message = message;

        }

        public static IEmailBuilderPostFrom From(string from)

        {

            return new EmailBuilder(new Message(from));

        }

        public IEmailBuilderPostTo To(string to)

        {

            message.To.Add(to);

            return this;

        }

        public IEmailBuilderPostSubject Subject(string subject)

        {

            message.Subject = subject;

            return this;

        }

        public IEmailBuilderPostBody Body(string body)

        {

            message.Body = body;

            return this;

        }

        public IEmailBuilderPostCc Cc(string cc)

        {

            message.Cc.Add(cc);

            return this;

        }

        public Message Build()

        {

            return message;

        }

    }

Теперь при создании объектов Message с помощью  EmailBuilder можно будет  вызывать методы только в определенной последовательности.

Надеюсь данный пост будет полезным. Еcли у кого-либо есть замечания или вопросы пишите.