gränssnittskontrakt

Gränssnittskontrakt är överenskommelsen mellan en leverantör av en tjänst eller komponent och dess användare om hur gränssnittet ska användas och vad som garanteras. Det beskriver vilka operationer som finns, vilka indata som accepteras, vilka utdata som returneras, hur fel hanteras och vilka effekter metoderna kan ha. Ett gränssnittskontrakt kan dokumenteras i txt- eller UML-dokument, men även vara helt formellt uttryckt i design by contract, API-specifikationer eller kontraktstestning.

Kärnelement i ett gränssnittskontrakt är preconditions (förhandsvillkor), postconditions (eftervillkor) och invariants (invarianter). Preconditioner anger vad som måste vara sant innan ett anrop görs (t.ex. giltig parameter), postconditioner vad som garanteras efter ett lyckat anrop (t.ex. returnerad data följer ett visst format) och invariants vad som alltid gäller under objektets livstid. Dessutom reguleras felhantering, undantag och tidsbegränsningar. Data-kontrakt fokusar ofta på struktur och serialisering av data, medan beteende-kontrakt beskriver sekvenser och bieffekter av anrop.

I systemdesign främjar tydliga gränssnittskontrakt låg koppling och möjliggör oberoende utveckling, testning och underhåll. Designprinciper som Liskovsubstitutionen och kontraktsbaserad utveckling betonar att avledda implementeringar inte får bryta klienters förväntningar. I praktiken används gränssnittskontrakt i API-design, mikroservices och bibliotek, ofta med versionering och kontraktstestning (t.ex. kontrakt mellan tjänster) för att möjliggöra evolution utan att bryta befintliga klienter.

Exempel på kontrakt kan vara specifikationer för en lagringstjänst: metoden save(entity) har precondition att entity inte är null och postcondition att entiteten sparas och får ett genererat ID; invariant att inga duplicerade ID faktiskt lagras.