Comment utiliser les paramètres facultatifs en C# ?

Question

Note : Cette question a été posée à une époque où C# ne prenait pas encore en charge les paramètres facultatifs (c'est-à-dire avant C# 4).

Nous construisons une API web qui est générée de manière programmatique à partir d'une classe C#. La classe possède une méthode GetFooBar(int a, int b) et l'API a une méthode GetFooBar en prenant des paramètres d'interrogation comme &a=foo &b=bar .

Les classes doivent supporter les paramètres optionnels, ce qui n'est pas supporté par le langage C#. Quelle est la meilleure approche ?

Answer 1

Il est surprenant que personne n'ait mentionné les paramètres optionnels de C# 4.0 qui fonctionnent de cette manière :

public void SomeMethod(int a, int b = 0)
{
   //some code
}

Editar: Je sais qu'au moment où la question a été posée, C# 4.0 n'existait pas. Mais cette question se classe toujours au premier rang dans Google pour "C# optional arguments", alors j'ai pensé que cette réponse méritait d'être ici. Désolé.

Answer 2

Une autre option consiste à utiliser le mot clé params

public void DoSomething(params object[] theObjects)
{
  foreach(object o in theObjects)
  {
    // Something with the Objects…
  }
}

Appelé comme...

DoSomething(this, that, theOther);

Answer 3

En C#, j'utiliserais normalement plusieurs formes de la méthode :

void GetFooBar(int a) { int defaultBValue;  GetFooBar(a, defaultBValue); }
void GetFooBar(int a, int b)
{
 // whatever here
}

UPDATE : Ce qui est mentionné ci-dessus était la façon dont je faisais les valeurs par défaut avec C# 2.0. Les projets sur lesquels je travaille actuellement utilisent le C# 4.0 qui supporte maintenant directement les paramètres optionnels. Voici un exemple que je viens d'utiliser dans mon propre code :

public EDIDocument ApplyEDIEnvelop(EDIVanInfo sender, 
                                   EDIVanInfo receiver, 
                                   EDIDocumentInfo info,
                                   EDIDocumentType type 
                                     = new EDIDocumentType(EDIDocTypes.X12_814),
                                   bool Production = false)
{
   // My code is here
}

Answer 4

De ce site :

http://www.tek-tips.com/viewthread.cfm?qid=1500861&page=1

Le C# permet l'utilisation de l'attribut [Optional] (de VB, mais non fonctionnel en C#). Vous pouvez donc avoir une méthode comme celle-ci :

using System.Runtime.InteropServices;
public void Foo(int a, int b, [Optional] int c)
{
  ...
}

Dans notre wrapper API, nous détectons les paramètres optionnels (ParameterInfo p.IsOptional) et définissons une valeur par défaut. L'objectif est de marquer les paramètres comme facultatifs sans avoir recours à des astuces comme l'ajout de "optional" dans le nom du paramètre.

Answer 5

Vous pourriez utiliser la surcharge des méthodes...

GetFooBar()
GetFooBar(int a)
GetFooBar(int a, int b)

Cela dépend de la signature des méthodes. Dans l'exemple que j'ai donné, il manque la méthode "int b" uniquement car elle aurait la même signature que la méthode "int a".

Vous pourriez utiliser des types Nullables...

GetFooBar(int? a, int? b)

Vous pouvez ensuite vérifier, à l'aide de a.HasValue, si un paramètre a été défini.

Une autre option serait d'utiliser un paramètre "params".

GetFooBar(params object\[\] args)

Si vous vouliez utiliser des paramètres nommés, il faudrait créer un type pour les gérer, bien que je pense qu'il existe déjà quelque chose de ce genre pour les applications web.