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. Nu sint de acord ca params ar fi un code smell. O metoda care foloseste params este de exemplu string.Format pe care o folosim peste tot. Functia Main pe care ai prezentat-o tu este de asemenea un bun exemplu, pentru ca nu putem limita un program la un numar fix de parameteri. Un alt caz unde params rezolva multe este in cazul XDocument si XElement, cu care este muuuult mai usor de lucrat decit in cazul XmlDocument si XmlElement. Ca sa instantiezi un element, ii dai ca parametri la constructor toate atributele si copii pe care vrei sa ii bagi.

    Parerea mea este ca atunci cind ai nevoie de doi parametri la care ai pune params sau cind simti nevoia sa faci mai multe semnaturi la o metoda, dar sa lasi la final un params la toate, atunci e probabil cazul sa refactorizezi, fie cu un obiect ca parametru care sa aiba toata complexitatea in el, ori creind un obiect separat care sa aiba proprietatile dupa parametrii metodei si metoda care le foloseste.

    ReplyDelete
    Replies
    1. 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.

      Delete
    2. Adevarul e ca sint putine exemple. Unul care imi vine in minte acum ar fi o implementare a functiilor SQL pe seturi, cum ar fi Min, Max, Concatenate, Coalesce, etc, ca sa scapam de oribilul Math.Max(a,Math.Max(b,c)) cind vrem maximul dintre trei valori, nu doar doua.
      Sau string.Split, unde pentru folosirea a mai multe caractere (si mai noi in .Net 4 si stringuri, ca sa nu mai fim fortati sa folosim Regex) folosesti mai multe caractere nu, cum am vazut anumite implementari, "a,b-c".Split(",-".ToCharArray())

      Dar Tudor are dreptate: params poate fi abuzat. Ma gindesc la un params de object care apoi este castat la citeva tipuri si daca nu corespunde unul se arunca o exceptie. Asta indica mai mult necesitatea unei schimbari in design, in asa fel incit sa nu fie nevoie nici de casturi si nici de exceptii, folosind un params de o interfata sau chiar renuntind la params cu totul. String.Format nu are code smell pentru ca el de fapt foloseste interfata Object, care contine ToString. As spune ca mai peste tot unde o sa vezi params object[] (nu un tip mai precis) exista probabil o problema.

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

Azure AD and AWS Cognito side-by-side

In the last few weeks, I was involved in multiple opportunities on Microsoft Azure and Amazon, where we had to analyse AWS Cognito, Azure AD and other solutions that are available on the market. I decided to consolidate in one post all features and differences that I identified for both of them that we should need to take into account. Take into account that Azure AD is an identity and access management services well integrated with Microsoft stack. In comparison, AWS Cognito is just a user sign-up, sign-in and access control and nothing more. The focus is not on the main features, is more on small things that can make a difference when you want to decide where we want to store and manage our users.  This information might be useful in the future when we need to decide where we want to keep and manage our users.  Feature Azure AD (B2C, B2C) AWS Cognito Access token lifetime Default 1h – the value is configurable 1h – cannot be modified

What to do when you hit the throughput limits of Azure Storage (Blobs)

In this post we will talk about how we can detect when we hit a throughput limit of Azure Storage and what we can do in that moment. Context If we take a look on Scalability Targets of Azure Storage ( https://azure.microsoft.com/en-us/documentation/articles/storage-scalability-targets/ ) we will observe that the limits are prety high. But, based on our business logic we can end up at this limits. If you create a system that is hitted by a high number of device, you can hit easily the total number of requests rate that can be done on a Storage Account. This limits on Azure is 20.000 IOPS (entities or messages per second) where (and this is very important) the size of the request is 1KB. Normally, if you make a load tests where 20.000 clients will hit different blobs storages from the same Azure Storage Account, this limits can be reached. How we can detect this problem? From client, we can detect that this limits was reached based on the HTTP error code that is returned by HTTP