Skip to main content

Fluent interface pattern

Asa cum am promis revin cu un post despre Fluent Interface.
Fara sa vrem am ajuns sa folosim acest patern aproape în fiecare zi. Când scrieți o comanda
LINQ
items
.Where(x => x.Name == "Radu")
.Select(x.CNP);
sau faceți un setup la un MOCK
objMock
.Setup(x => x.GetAge())
.Return(20);
în spate într-o oarecare măsura folosit Fluent Interface Pattern. Unii dezvoltatori ajung sa scrie un API bazat pe acest patern fără sa își dea seama, ajungând la el într-un mod natural.
Îmi este destul de greu sa dau o definiție fixa la acest pattern. Este un mod de a scrie codul a.i. cel care îl va utiliza o sa poată sa execute o anumita acțiune( flow) prin intermediul ".". Utilizatorul ar trebui sa fie constrâns de API sa facă toate setările necesare pentru a executa o acțiune.
De exemplu pentru a putea sa ne deplasam cu o mașina, trebuie:
sa introducem cheile în contact;
sa pornim motorul;
sa ne asiguram ca mașina este în viteza;
sa apăsam pedala de accelerație;
Dupa cum putem observa avem definit un flow care trebuie sa se execute într-o anumita ordine. Ca sa constrângem utilizatorul sa execute acest flow într-o anumita ordine putem sa ne folosi de fluent interface. Una sau mai multe acțiuni de pe același nivel se pot executa doar dacă s-au executat actiniile dinaintea lor.
Pentru a putea face acest lucru fiecare nod din flow poate sa returneze un obiect de un anumit tip. Astfel încât am obține:
car
.InsertKey()
.StartEngine(key)
.SetGear(1) // In aceasta locația am putea face Stop()
.PressThrottle(0.1)
Cea ce este important de știut este faptul ca metodele nu trebuie sa returneze același obiect. Ele pot sa returneze și obiecte de tip diferit.
Ca sa generam un număr foarte mare de obiecte, putem ca obiectul Car sa implementeze toate interfețele implicate pentru fiecare nod din flow, iar fiecare acțiune sa returneze interfața( de fapt se returnează this, doar 'convertit' la interfața respectiva - în acest caz utilizatorul poate sa execute doar un număr limitat de comenzi, în cazul în care nu face conversia).
Un exemplu de API în format fluent interface este următorul:
public interface ICmdCar
{
ICmdCar Go(int dist);
ICmdCar Left();
ICmdCar Right();
ICar Stop();
}
public interface IInitCar
{
IInitCar SetPower(int value);
IInitCar SetGearBox(int type);
}
public interface ICar
{
ICmdCar Start();
IInitCar Setup();
}
Putem sa observam ca s-a strecurat o mica greșeala. Comanda Start() se poate apela fără sa se facă setup-ul la mașina.
O soluție la aceasta problema este ca o instanta a unui obiect de tip IInitCar sa fie transmisa prin constructorul sau sa avem un factory. O soluție puțin mai complicata este sa mutam acțiune de Start() in IInitCar.
Acest pattern ne ajuta sa facem un API mai:
  • accesibil;
  • lizibil;
  • ușor de folosit;
  • restrictiv;
Avantaje:
  • apare un layer de separare;
  • decuplarea și reutilizarea componentelor;
  • definirea unui flow este mult mai usor;
  • eliminarea excepțiilor pentru validare și a gărzilor;
  • intellisense;
Vreau sa explic penultimul avantaj. In general dacă pentru executarea unui acțiuni avem nevoie ca mediul sa fie setat într-un anumit fel, este necesar sa verificam starea mediului înainte sa executam acțiunea. Daca folosim fluent interface nu mai este nevoie sa facem acest lucru deoarece pentru a ajunge în acel punct userul a fost constrâns sa treacă prin niște etape( care l-au obligat sa facă setările necesare). O alta soluție care se folosește pentru a rezolva aceasta problema este validarea prin AOP, dar nu o sa intru în detaliu).
Dezavantaje:
  • metodele luate separat nu au sens;
  • pot sa apară un număr mai mare de clase( cea ce nu este neapărat un lucru rău);
  • designul API-ului este greu de realizat;
Din punctul meu de vedere, un API în acest format nu o poată sa fie scris din momentul în care a început proiectul, deoarece de foarte multe ori flow-urile nu sunt încă definite. Niciodată nu o sa putem spune ca API pe care noi îl oferim în format fluent interface este perfect și nu mai necesita îmbunătățiri deoarece mereu o sa putem schimba ceva ca sa îl facem mai ușor de folosit și mai natural.
Acesta nu are nici o valoare singur. Ca orice alt pattern el trebuie sa fie îmbinat și cu alte pattern-uri.

Comments

Popular posts from this blog

Windows Docker Containers can make WIN32 API calls, use COM and ASP.NET WebForms

After the last post , I received two interesting questions related to Docker and Windows. People were interested if we do Win32 API calls from a Docker container and if there is support for COM. WIN32 Support To test calls to WIN32 API, let’s try to populate SYSTEM_INFO class. [StructLayout(LayoutKind.Sequential)] public struct SYSTEM_INFO { public uint dwOemId; public uint dwPageSize; public uint lpMinimumApplicationAddress; public uint lpMaximumApplicationAddress; public uint dwActiveProcessorMask; public uint dwNumberOfProcessors; public uint dwProcessorType; public uint dwAllocationGranularity; public uint dwProcessorLevel; public uint dwProcessorRevision; } ... [DllImport("kernel32")] static extern void GetSystemInfo(ref SYSTEM_INFO pSI); ... SYSTEM_INFO pSI = new SYSTEM_INFO(...

ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded

Today blog post will be started with the following error when running DB tests on the CI machine: threw exception: System.InvalidOperationException: The Entity Framework provider type 'System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer' registered in the application config file for the ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded. Make sure that the assembly-qualified name is used and that the assembly is available to the running application. See http://go.microsoft.com/fwlink/?LinkId=260882 for more information. at System.Data.Entity.Infrastructure.DependencyResolution.ProviderServicesFactory.GetInstance(String providerTypeName, String providerInvariantName) This error happened only on the Continuous Integration machine. On the devs machines, everything has fine. The classic problem – on my machine it’s working. The CI has the following configuration: TeamCity .NET 4.51 EF 6.0.2 VS2013 It see...

Navigating Cloud Strategy after Azure Central US Region Outage

 Looking back, July 19, 2024, was challenging for customers using Microsoft Azure or Windows machines. Two major outages affected customers using CrowdStrike Falcon or Microsoft Azure computation resources in the Central US. These two outages affected many people and put many businesses on pause for a few hours or even days. The overlap of these two issues was a nightmare for travellers. In addition to blue screens in the airport terminals, they could not get additional information from the airport website, airline personnel, or the support line because they were affected by the outage in the Central US region or the CrowdStrike outage.   But what happened in reality? A faulty CrowdStrike update affected Windows computers globally, from airports and healthcare to small businesses, affecting over 8.5m computers. Even if the Falson Sensor software defect was identified and a fix deployed shortly after, the recovery took longer. In parallel with CrowdStrike, Microsoft provi...