Skip to main content

The secret behind "params" keyword

Jucandu-ma putin cu codul din C# am redescoperit "params". Acesta in general poate sa fie gasit intr-o aplicatie consola in Main, dar putem sa il folosim si in alte cazuri.
Prin intermediul acestui keyword putem sa specificam o lista de parametri despartiti prin virgula.
public void MyMethod(params string[] words)
{
    foreach(string word in words)
{
    Console.WriteLine(word);
}
}
Nu este nimic special cu acest keyword. Cand am inceput sa invatam limbajul C#, am vazut ca exista, dar nu l-am vazut niciodata folosit intr-un cod de productie si mi-am pus intrebarea DE CE?
In primul rand vrea sa vedem ce putem face cu acesta. De exemplu avem o metoda care accepta zero, unu sau mai multe elemente de acelasi tip (o lista de elemente). In mod normal am avea urmatorul cod:
public void MyMethod(string[] items)
{
    // Some action.
}
Pentru a putea folosi aceasta metoda am avea urmatoarele apeluri:
MyMethod();    // Eroare la compilare.
MyMethod(new string[0]);    // Nici un element in lista.
MyMethod(new string[]{ "item1" });    // Un singur element in vector.
MyMethod(new string[]{ "item1", item2" });    // Doua elemente in vector.
Ca sa putem avea si un apel de forma "MyMethod();" este nevoie sa schimba definitia metodei, ca sa aibe urmatoarea forma:
public void MyMethod(string[] items = null)
{
    // Some action.
}
Daca ne-am folosii de keyword-ul params am avea urmatoare metoda si apeluri acceptate:
public void MyMethod(params string[] items)
{
    // Some action.
}
MyMethod();   
MyMethod("item1");   
MyMethod("item1", "item2");
MyMethod(new string[0]);
MyMethod(new string[]{ "item1", item2" });
Dupa cum putem observa, putem sa avem diferite apeluri, putem sa specificam un sigur element, fara sa fim obligati sa ne definim un vector cu un singur element. La fel putem sa ne specificam nici un parametru, caz in care vectorul o sa fie un vector cu nici un element. In acez caz ne-am astepta ca vectorul sa fie null, dar acesta nu o sa fie null, nu o sa contina nici un element (aveti grija la acest comportament).
O alta utilizare interesanta a acestui keyword mi s-a parut in contructor. Da, in contructor, il putem folosi fara nici o problema si in constructori.
public class Foo
{
public Foo(paramas string[] items)
{
    // Ceva cod
}
}
params este foarte util cand avem cazui cand elementele din vector pot sa contina 0 sau doar un element, iar aceste valori sunt obtinute din divese surse (nu le obtinem mereu sub forma unui vector).
Am vazut ce putem facem cu acest keyword, unele cazuri cand acesta se poate folosi sunt chiar interesante (nici un element specificat, un singur element fara sa ne declaram un vector sau in contructor). Problema apare ca din cauza ca nu este destul de des folosit in general cel care citeste codul o sa fie nevoit sa caude pe net sa vada ce reprezinta acest keyword sau de ce este folosit intr-un anumit fel. Tot din aceasta cauza s-ar putea sa nu fie folosit la potentialul sau maxim. Din cauza ca o metoda care foloseste params, poate sa fie apelata primind un vector, avem o oarecare compatibilitate cu varianta cand nu folosim keyword-ul params.
Prin folosirea acestui keyword, s-ar putea ca API pe care il expunem sa nu fie usor de inteles sau sa provoace o usoara dezorientare pentru dezvoltator, dar cred ca pot sa existe cazuri cand acesta sa ne simplice putin codul.
Pana acuma nu l-am folosit niciodata in productie, dar in viitor s-ar putea daca o sa gasesc cazuri cand chiar isi are rostul. In acelasi timp o sa am grija sa documentez codul destul de bine incat sa argumentez de ce l-am folosit si sa dau exemple de apeluri. Din cauza ca acest keyword nu este folosit si cunoscut in totalitate, poate sa provoace confuzie, iar acest lucru trebuie evitat.
Totusi parca exista un smell cand vrem sa introducem "params", aveti grija.

Voi l-ati folosit pana acuma? Credeti ca merita folosit?

Comments

  1. Ca și variadic macros din C/C++, params este introdus doar pentru a suporta funcții de tip 'printf' (de logare, de exemplu). Orice alt tip de funcție ar trebui să evite params.

    ReplyDelete
  2. Siderite, daca mai ai mai multe exemple cand crezi ca params se poate folosii cu succes te rog sa imi spui. Exemplu cu XDocument a fost extrem de bun.

    ReplyDelete
  3. Programatorii s-au invatat sa evite (pe cat posibil) variadic functions de pe vremea cand programau in C sau C++, unde poate sa nu fie type safe (se pot pasa parametri de orice tip).

    In C#, VB.Net sau Java, nu e decat un sintactic sugar care permite pasarea unui array mai facil: e ok cat timp e folosit pentru a pasa un numar variabil de valori care au toate acelasi purpose/meaning - daca e folosit doar din lene pentru a evita 2-3 overloads la o functie (deci e vorba de 3-4 parametri maxim, de acelasi tip, dar care fiecare au un meaning diferit, e un code smell).

    ReplyDelete
  4. De cind am parametrii optionali, nu am nevoie de params;-)

    ReplyDelete
    Replies
    1. Cand e vorba de API-uri publice, optional parameters sunt o chestie "delicata": http://haacked.com/archive/2010/08/10/versioning-issues-with-optional-arguments.aspx

      Delete
    2. Personal nu vad nici o legatura intre parametrii optionali si params. Params e un sinctactic sugar, util in absolut toate situatiile unde in mod normal ar trebui creeat array-ul de mana.

      Nu cred ca se pierde nimic din lizibilitate sau intentie prin folosirea lui. Abuzurile se pot face oricum. Nu e nimic sa ma opreasca sa apelez MyMethod(new object[] {"x", 1}) si sa fac pentru fiecare array item un cast sau sa apelez MyMethod("x",1) cu params. E un antipattern in ambele cazuri.

      Utilitatea operatorului params e atunci cand metoda primeste un array (nu parametrii diferiti) si este necesara simplificarea modului in care se apeleaza metoda. Atat. Orice alt exemplu (cum ar fi simularea optional parameters prin utilizarea params) e un antipattern foarte clar.

      Delete

Post a Comment

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(...

How to audit an Azure Cosmos DB

In this post, we will talk about how we can audit an Azure Cosmos DB database. Before jumping into the problem let us define the business requirement: As an Administrator I want to be able to audit all changes that were done to specific collection inside my Azure Cosmos DB. The requirement is simple, but can be a little tricky to implement fully. First of all when you are using Azure Cosmos DB or any other storage solution there are 99% odds that you’ll have more than one system that writes data to it. This means that you have or not have control on the systems that are doing any create/update/delete operations. Solution 1: Diagnostic Logs Cosmos DB allows us activate diagnostics logs and stream the output a storage account for achieving to other systems like Event Hub or Log Analytics. This would allow us to have information related to who, when, what, response code and how the access operation to our Cosmos DB was done. Beside this there is a field that specifies what was th...

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills)

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills) The idea that moving to the cloud reduces the costs is a common misconception. The cloud infrastructure provides flexibility, scalability, and better CAPEX, but it does not guarantee lower costs without proper optimisation and management of the cloud services and infrastructure. Idle and unused resources, overprovisioning, oversize databases, and unnecessary data transfer can increase running costs. The regional pricing mode, multi-cloud complexity, and cost variety add extra complexity to the cost function. Cloud adoption without a cost governance strategy can result in unexpected expenses. Improper usage, combined with a pay-as-you-go model, can result in a nightmare for business stakeholders who cannot track and manage the monthly costs. Cloud-native services such as AI services, managed databases, and analytics platforms are powerful, provide out-of-the-shelve capabilities, and increase business agility and innovation. H...