State

Проблем

Да се разработи клас Ticket, който моделира билет за събитие.

Билетът може да бъде свободен, резервиран или продаден. Върху него могат да се извършват три операции: резервиране, купуване и отказване на резервация.

Решение без използване на шаблона

public class Ticket {

    private String ticketState;
    private int ticketId;

    public Ticket(int ticketId) {
        this.ticketState = "available";
        this.ticketId = ticketId;
    }

    public String book() {
        if (ticketState.equalsIgnoreCase("available")) {
            ticketState = "booked";
            return "Ticket with id = " + this.ticketId + " has been booked";
        } else if (ticketState.equalsIgnoreCase("booked")) {
            return "Ticket with id = " + this.ticketId + " has been already booked";
        } else if (ticketState.equalsIgnoreCase("sold")) {
            return "Ticket with id = " + this.ticketId + " has been already sold";
        }
        return "Unrecognized state";
    }

    public String buy() {
        if (ticketState.equalsIgnoreCase("available") ||
				ticketState.equalsIgnoreCase("booked")) {
            ticketState = "sold";
            return "Ticket with id = " + this.ticketId + " has been sold";
        } else if (ticketState.equalsIgnoreCase("sold")) {
            return "Ticket with id = " + this.ticketId + " has been already sold";
        }
        return "Unrecognized state";
    }

    public String cancel() {
        if (ticketState.equalsIgnoreCase("available")) {
            return "Available ticket cannot be cancelled";
        } else if (ticketState.equalsIgnoreCase("booked")) {
            ticketState = "available";
            return "Ticket with id = " + this.ticketId + " has been cancelled";
        } else if (ticketState.equalsIgnoreCase("sold")) {
            return "Sold ticket cannot be cancelled";
        }
        return "Unrecognized state";
    }

}

Недостатъци на решението

При този подход класът Ticket съдържа логиката за всички възможни състояния. Всеки метод трябва да проверява текущото състояние и да решава какво действие е позволено.

При добавяне на ново състояние или промяна в правилата трябва да бъдат променяни няколко метода в класа Ticket. Това увеличава условната логика и прави класа труден за поддръжка.

Следователно е необходимо решение, при което логиката за всяко състояние да бъде отделена в самостоятелен клас.

Шаблонът като решение

Шаблонът State разделя различните състояния в самостоятелни класове. Вместо контекстният обект да съдържа условна логика, той делегира изпълнението на текущото състояние.

При промяна на състоянието поведението на обекта автоматично се променя чрез използването на друга реализация на интерфейса State.

Дефиниция

State е поведенчески шаблон за проектиране, който позволява на даден обект да променя поведението си при промяна на вътрешното си състояние.

Основните участници в шаблона са:

• Context - Обектът, чието поведение зависи от текущото състояние.
• State - Интерфейсът, който дефинира поведението за различните състояния.
• Concrete State - Конкретна реализация на дадено състояние.

UML диаграма

Примерна реализация

Интерфейс State

public interface TicketState {

    String book(Ticket ticket);

    String buy(Ticket ticket);

    String cancel(Ticket ticket);

}

Concrete State

public class AvailableTicket implements TicketState {

    @Override
    public String book(Ticket ticket) {
        ticket.setTicketState(new BookedTicket());
        return "Ticket " + ticket.getTicketId() + " has been booked.";
    }

    @Override
    public String buy(Ticket ticket) {
        ticket.setTicketState(new SoldTicket());
        return "Ticket " + ticket.getTicketId() + " has been sold.";
    }

    @Override
    public String cancel(Ticket ticket) {
        return "Available ticket cannot be cancelled.";
    }
}

public class BookedTicket implements TicketState {

    @Override
    public String book(Ticket ticket) {
        return "Ticket is already booked.";
    }

    @Override
    public String buy(Ticket ticket) {
        ticket.setTicketState(new SoldTicket());
        return "Ticket " + ticket.getTicketId() + " has been sold.";
    }

    @Override
    public String cancel(Ticket ticket) {
        ticket.setTicketState(new AvailableTicket());
        return "Reservation cancelled.";
    }
}

public class SoldTicket implements TicketState {

    @Override
    public String book(Ticket ticket) {
        return "Sold ticket cannot be booked.";
    }

    @Override
    public String buy(Ticket ticket) {
        return "Ticket is already sold.";
    }

    @Override
    public String cancel(Ticket ticket) {
        return "Sold ticket cannot be cancelled.";
    }
}

Context

public class Ticket {

    private final int ticketId;

    private TicketState ticketState = new AvailableTicket();

    public Ticket(int ticketId) {
        this.ticketId = ticketId;
    }

    public int getTicketId() {
        return ticketId;
    }

    public void setTicketState(TicketState ticketState) {
        this.ticketState = ticketState;
    }

    public String book() {
        return ticketState.book(this);
    }

    public String buy() {
        return ticketState.buy(this);
    }

    public String cancel() {
        return ticketState.cancel(this);
    }

}

Използване

public class Application {

    public static void main(String[] args) {

        Ticket ticket = new Ticket(123);

        System.out.println(ticket.book());
        System.out.println(ticket.cancel());
        System.out.println(ticket.buy());
        System.out.println(ticket.cancel());

    }

}

Резултатът е:

Ticket 123 has been booked.
Reservation cancelled.
Ticket 123 has been sold.
Sold ticket cannot be cancelled.

Класът Ticket представлява контекстния обект (Context). Вместо да съдържа условна логика за всички възможни състояния, той пази референция към текущото състояние чрез поле от тип TicketState.

Интерфейсът TicketState дефинира общото поведение на всички състояния. Всяка конкретна реализация (AvailableTicket, BookedTicket и SoldTicket) определя как трябва да се изпълняват операциите book(), buy() и cancel().

При необходимост от промяна на състоянието конкретният клас извиква метода setTicketState() на контекста и задава ново състояние. След тази промяна всички следващи извиквания автоматично използват поведението на новото състояние.

[!IMPORTANT] Шаблонът State не премахва логиката за преход между състоянията. Вместо това я разпределя между отделните класове, описващи конкретните състояния. Така контекстният обект остава прост и не съдържа множество условни конструкции.

Предимства

• премахва голяма част от условната логика;
• разделя поведението на отделни класове;
• улеснява добавянето на нови състояния;
• подпомага спазването на принципа Open/Closed;
• подобрява четимостта и поддържаемостта на кода.

Недостатъци

• увеличава броя на класовете;
• при голям брой състояния структурата може да стане по-сложна;
• преходите между състоянията трябва да бъдат проектирани внимателно.

Приложение

Шаблонът State е подходящ когато:

• поведението на обекта зависи от неговото текущо състояние;
• има ясно разграничени състояния и преходи между тях;
• условната логика започва да се разраства;
• се цели отделяне на логиката за всяко състояние в самостоятелен клас.