|
| 1 | +# Introduction |
| 2 | + |
| 3 | +Be sure to read [CQRS Introduction](../) before diving in this chapter. |
| 4 | + |
| 5 | +## Execute your Business Actions via Interface |
| 6 | + |
| 7 | +Business Interface aims to reduce boierplate code and make your domain actions explicit. \ |
| 8 | +In Application we describe an Interface, which executes Business methods. Ecotone will deliver implementation for this interface, which will bind the interface with specific actions. \ |
| 9 | +This way we can get rid of delegation level code and focus on the things we want to achieve. \ |
| 10 | +\ |
| 11 | +For example, if we don't want to trigger action via Command/Query Bus, we can do it directly using our business interface and skip all the Middlewares that would normally trigger during Bus execution.\ |
| 12 | +There are different types of Business Interfaces and in this chapter we will discuss the basics of build our own Business Interface, in next sections we will dive into specific types of business interfaces: [Repositories](repository.md) and [Database Layers](working-with-database/). |
| 13 | + |
| 14 | +## Command Interface |
| 15 | + |
| 16 | +Let's take as an example creating new Ticket |
| 17 | + |
| 18 | +```php |
| 19 | +class TicketService |
| 20 | +{ |
| 21 | + #[CommandHandler("ticket.create")] |
| 22 | + public function createTicket(CreateTicketCommand $command) : void |
| 23 | + { |
| 24 | + // handle create ticket command |
| 25 | + } |
| 26 | +} |
| 27 | +``` |
| 28 | + |
| 29 | +We may define interface, that will call this Command Handler whenever will be executed. |
| 30 | + |
| 31 | +```php |
| 32 | +interface TicketApi |
| 33 | +{ |
| 34 | + #[BusinessMethod('ticket.create')] |
| 35 | + public function create(CreateTicketCommand $command): void; |
| 36 | +} |
| 37 | +``` |
| 38 | + |
| 39 | +This way we don't need to use Command Bus and we can bypass all Bus related interceptors. |
| 40 | + |
| 41 | +The attribute **#\[BusinessMethod]** tells Ecotone that given **Interface** is meant to be used as entrypoint to Messaging and which Message Handler it should send the Message to. \ |
| 42 | +Ecotone will provide implementation of this interface directly in our Dependency Container. |
| 43 | + |
| 44 | +{% hint style="success" %} |
| 45 | +From lower level API `Business Method` is actually a [Message Gateway](../../../messaging/messaging-concepts/messaging-gateway.md). |
| 46 | +{% endhint %} |
| 47 | + |
| 48 | +## Aggregate Command Interface |
| 49 | + |
| 50 | +We may also execute given Aggregate directly using Business Interface. |
| 51 | + |
| 52 | +```php |
| 53 | +#[Aggregate] |
| 54 | +class Ticket |
| 55 | +{ |
| 56 | + #[Identifier] |
| 57 | + private Uuid $ticketId; |
| 58 | + private bool $isClosed; |
| 59 | + |
| 60 | + #[CommandHandler("ticket.close")] |
| 61 | + public function close(): void |
| 62 | + { |
| 63 | + $this->isClosed = true; |
| 64 | + } |
| 65 | +} |
| 66 | +``` |
| 67 | + |
| 68 | +Then we define interface: |
| 69 | + |
| 70 | +```php |
| 71 | +interface TicketApi |
| 72 | +{ |
| 73 | + #[BusinessMethod('ticket.close')] |
| 74 | + public function create(#[Identifier] Uuid $ticketId): void; |
| 75 | +} |
| 76 | +``` |
| 77 | + |
| 78 | +{% hint style="success" %} |
| 79 | +We may of course pass Command class if we need to pass more data to our Aggregate's Command Handler. |
| 80 | +{% endhint %} |
| 81 | + |
| 82 | +## Query Interface |
| 83 | + |
| 84 | +Defining Query Interface works exactly the same as Command Interface and we may also use it with Aggregates. |
| 85 | + |
| 86 | +```php |
| 87 | +class TicketService |
| 88 | +{ |
| 89 | + #[QueryHandler("ticket.get_by_id")] |
| 90 | + public function getTicket(GetTicketById $query) : array |
| 91 | + { |
| 92 | + //return ticket |
| 93 | + } |
| 94 | +} |
| 95 | +``` |
| 96 | + |
| 97 | +Then we may call this Query Handler using Interface |
| 98 | + |
| 99 | +```php |
| 100 | +interface TicketApi |
| 101 | +{ |
| 102 | + #[BusinessMethod("ticket.get_by_id")] |
| 103 | + public function getTicket(GetTicketById $query): array; |
| 104 | +} |
| 105 | +``` |
| 106 | + |
| 107 | +## Result Conversion |
| 108 | + |
| 109 | +If we have registered [Converter](../../../messaging/conversion/) then we let Ecotone do conversion to **Message Handler** specific format: |
| 110 | + |
| 111 | +```php |
| 112 | +class TicketService |
| 113 | +{ |
| 114 | + #[QueryHandler("ticket.get_by_id")] |
| 115 | + public function getTicket(GetTicketById $query) : array |
| 116 | + { |
| 117 | + //return ticket as array |
| 118 | + } |
| 119 | +} |
| 120 | +``` |
| 121 | + |
| 122 | +Then we may call this Query Handler using Interface |
| 123 | + |
| 124 | +```php |
| 125 | +interface TicketApi |
| 126 | +{ |
| 127 | + // return ticket as Class |
| 128 | + #[BusinessMethod("ticket.get_by_id")] |
| 129 | + public function getTicket(GetTicketById $query): TicketDTO; |
| 130 | +} |
| 131 | +``` |
| 132 | + |
| 133 | +Ecotone will use defined Converter to convert **`array`** to **`TicketDTO`**. |
| 134 | + |
| 135 | +{% hint style="success" %} |
| 136 | +Such conversion are useful in order to work with objects and to avoid writing transformation code in our business code. We can build generic queries, and transform them to different classes using different business methods. |
| 137 | +{% endhint %} |
| 138 | + |
| 139 | +## Payload Conversion |
| 140 | + |
| 141 | +If we have registered [Converter](../../../messaging/conversion/) then we let Ecotone do conversion to **Message Handler** specific format: |
| 142 | + |
| 143 | +```php |
| 144 | +class TicketService |
| 145 | +{ |
| 146 | + #[CommandHandler("ticket.create")] |
| 147 | + public function getTicket(CreateTicket $command) : void |
| 148 | + { |
| 149 | + |
| 150 | + } |
| 151 | +} |
| 152 | +``` |
| 153 | + |
| 154 | +Then we may call this Query Handler using Interface |
| 155 | + |
| 156 | +```php |
| 157 | +interface TicketApi |
| 158 | +{ |
| 159 | + #[BusinessMethod("ticket.create")] |
| 160 | + public function getTicket(array $query): void; |
| 161 | +} |
| 162 | +``` |
| 163 | + |
| 164 | +Ecotone will use defined Converter to convert **array** to **CreateTicket** command class. |
| 165 | + |
| 166 | +{% hint style="success" %} |
| 167 | +This type of conversion is especially useful, when we receive data from external source and we simply want to push it to given Message Handler. We avoid doing transformations ourselves, as we simply push what we receive as array. |
| 168 | +{% endhint %} |
0 commit comments