6.1 Facade

« Terug naar Software Engineering Skills
» Naar de labo opgave

“Facade” - Design Pattern

Begeleidende screencast¹:

Doelstelling

• Scherm een complex stukje software af met behulp van een simpele interface
• Voorzie éénzelfde interface naar een set van verschillende mogelijke subsystemen. Een Facade is een high-level interface die mogelijks low-level systemen aanspreekt.

Dive Into Design Patterns: Facade

Voorbeeld

1. Opzet

Stel dat we gegevens van de klant moeten versturen naar een overheidsinstantie. Die instantie beschikt jammer genoeg niet over voldoende budgetten om ook een cutting-edge server interface en implementatie aan te bieden. Het komt er op neer dat we verplicht zijn om tekst bestanden op een FTP server te plaatsen.

class ClientFtpSender {
    fun upload(client: Client) {
        // create ftp connection, upload, ...
    }
}

public class ClientFtpSender {
    public void upload(Client client) {
        // create ftp connection, upload, ...
    }
}

Deze code gebruiken we als de gebruiker op een knop genaamd export klikt:

class ClientHTTPHandler(val clientRepository: ClientRepository) {
    fun onExport(clientId: Int): HTTPResponse {
        val client = clientRepository.getById(clientId)
        ClientFtpSender().upload(client)
        return HTTPResponse.success()  // 200 OK
    }
}

public class ClientHTTPHandler {
    private ClientRepository clientRepository;
    public HTTPResponse onExport(int clientId) {
        Client client = clientRepository.getById(clientId);
        new ClientFtpSender().upload(client);
        return HTTPResponse.success();  // 200 OK
    }
}

2. Probleemstelling

We verkopen onze software aan een andere partij, die niet alleen met de overheid wenst te communiceren, maar ook met een derde instantie. Deze instantie biedt ons de mogelijkheid aan om de klant in de vorm van XML met een POST HTTPS call op te sturen. Onze ClientFTPSender is dus niet meer genoeg:

class ClientPOSTSender {
    fun upload(client: Client) {
        // secure HTTPS, encode client in XML, post...
    }
}

public class ClientPOSTSender {
    public void upload(Client client) {
        // secure HTTPS, encode client in XML, post...
    }
}

Deze complexe stukjes software, de POST en FTP senders, willen we niet langer rechtstreeks aanspreken in de HTTP handler. Het is zo dat afhankelijk van een bepaalde instelling, het ene of het andere gebruikt kan worden.

3. Oplossing

We hebben dus een facade nodig, die de juiste delegaties voor ons doorvoert, zoals in het volgende schema:

Waarbij de Facade een klasse is die de details “wegstopt” voor onze HTTP handler:

class UploadClientFacade {
    fun upload(client: Client) {
        when {
            settings.isPOST() -> ClientPOSTSender().upload(client)
            settings.isSFTP() -> ClientFtpSender().upload(client)
            else -> throw UnsupportedOperationException("settings incorrect?")
        }
    }
}

public class UploadClientFacade {
    public void upload(Client client) {
        if(settings.isPOST()) {
            new ClientPOSTSender().upload(client);
        } else if(settings.isFTP()) {
            new ClientFtpSender().upload(client);
        } else {
            throw new UnsupportedOperationException("settings incorrect?");
        }
    }
}

Eigenschappen van dit patroon

• Een Facade is een nieuwe interface, niet eentje die oude interfaces herbruikt (Adapter). Beide zijn een soort van “wrappers”, die onderliggende implementaties verbergen voor de hogerliggende interface - in ons geval de ClientHTTPHandler.
• Het verschil tussen een Facade en een Factory is dat de facade alles verbergt en logica uitvoert, terwijl de Factory enkel de juiste instanties aanmaakt en teruggeeft. In dat geval zou de handler nog steeds upload() zelf moeten uitvoeren, inclusief eventuele encoding stappen.

Labo oefeningen

Clone of fork GitHub project https://github.com/KULeuven-Diepenbeek/ses-patterns-facade-template

Opgave 1

Opgave tekst: zie repository bestand README.md!

Opgave 2

sessy library:

1. identificeer waar jij denkt dat een facade nodig zou kunnen zijn. Waar moet logica worden afgeschermd?
2. Pas het patroon toe waar jij denkt dat het nodig is.

Denkvragen

• Op welk moment beslis je dat een Facade écht nodig is? Is het mogelijk om ook een facade te maken zonder bijvoorbeeld nieuwe dieren in oefening 1 of een nieuwe verzendmethode voor de klant bij de probleemstelling?
• Kan een Facade een Facade verbergen? Wanneer is dat nodig, of niet?