Як можна використовувати необов'язкові параметри в C #?

^{Примітка. Це запитання задавали в той момент, коли C # ще не підтримував необов'язкові параметри (тобто перед C # 4).}

Ми будуємо веб-API, програмно створений із класу C #. У класі є метод, GetFooBar(int a, int b)а в API є метод, що GetFooBarприймає параметри запитів &a=foo &b=bar.

Класи повинні підтримувати необов'язкові параметри, які не підтримуються мовою C #. Який найкращий підхід?

Здивував, що ніхто не згадав додаткові параметри C # 4.0, які працюють так:

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

Редагувати: Я знаю, що на момент запитання, C # 4.0 не існувало. Але це питання все ще займає №1 в Google за "C # необов'язковими аргументами", тому я подумав - ця відповідь варта бути тут. Вибачте.

Інший варіант - використовувати ключове слово params

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

Називається як ...

DoSomething(this, that, theOther);

У C # я зазвичай використовую кілька форм методу:

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

ОНОВЛЕННЯ: Це згадане вище було тим, що я робив значення за замовчуванням за допомогою C # 2.0. Проекти, над якими я зараз працюю, використовують C # 4.0, який зараз безпосередньо підтримує необов’язкові параметри. Ось приклад, який я щойно використав у власному коді:

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

З цього сайту:

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

C # дозволяє використовувати атрибут [Необов’язково] (від VB, хоча і не функціонує в C #). Тож у вас може бути такий метод:

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

У нашій обгортці API ми виявляємо необов’язкові параметри (ParameterInfo p.IsO optional) і встановлюємо значення за замовчуванням. Мета полягає в тому, щоб позначити параметри як необов'язкові, не вдаючись до помилок, як-от "імператор" у назві параметра.

Ви можете використовувати метод перевантаження ...

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

Це залежить від підписів методу, у прикладі, який я дав, відсутній лише метод "int b", оскільки він матиме такий самий підпис, що і метод "int a".

Ви можете використовувати типи Nullable ...

GetFooBar (int? A, int? B)

Потім ви можете перевірити, використовуючи a.HasValue, щоб побачити, чи встановлено параметр.

Іншим варіантом буде використання параметра "params".

GetFooBar (params object [] args)

Якщо ви хочете перейти з названими параметрами, потрібно було б створити тип для їх обробки, хоча я думаю, що для веб-додатків вже є щось подібне.

Ви можете використовувати необов'язкові параметри в C # 4.0 без будь-яких турбот. Якщо у нас є такий метод, як:

int MyMetod(int param1, int param2, int param3=10, int param4=20){....}

коли ви викликаєте метод, ви можете пропустити такі параметри:

int variab = MyMethod(param3:50; param1:10);

C # 4.0 реалізує функцію під назвою "названі параметри", ви можете фактично передавати параметри за їхніми іменами, і, звичайно, ви можете передавати параметри в будь-якому порядку :)

Привіт, необов'язковий світ

Якщо ви хочете, щоб час виконання давав значення параметра за замовчуванням, вам потрібно використовувати відображення для здійснення дзвінка. Не так приємно, як інші пропозиції щодо цього питання, але сумісні з VB.NET.

using System;
using System.Runtime.InteropServices;
using System.Reflection;

namespace ConsoleApplication1
{
    class Class1
    {
        public static void sayHelloTo(
            [Optional,
            DefaultParameterValue("world")] string whom)
        {
            Console.WriteLine("Hello " + whom);
        }

        [STAThread]
        static void Main(string[] args)
        {
            MethodInfo mi = typeof(Class1).GetMethod("sayHelloTo");
            mi.Invoke(null, new Object[] { Missing.Value });
        }
    }
}

Простий спосіб, який дозволяє опускати будь-які параметри в будь-якій позиції , - це скористатись зведеними нижче типами :

public void PrintValues(int? a = null, int? b = null, float? c = null, string s = "")
{
    if(a.HasValue)
        Console.Write(a);
    else
        Console.Write("-");

    if(b.HasValue)
        Console.Write(b);
    else
        Console.Write("-");

    if(c.HasValue)
        Console.Write(c);
    else
        Console.Write("-");

    if(string.IsNullOrEmpty(s)) // Different check for strings
        Console.Write(s);
    else
        Console.Write("-");
}

Рядки - це вже зведені типи, тому вони не потребують ? .

Після використання цього методу всі наступні дзвінки дійсні :

PrintValues (1, 2, 2.2f);
PrintValues (1, c: 1.2f);
PrintValues(b:100);
PrintValues (c: 1.2f, s: "hello");
PrintValues();

Коли ви визначаєте метод таким чином, у вас є свобода встановлювати лише потрібні параметри, називаючи їх їх. Дивіться наступне посилання для отримання додаткової інформації про названі та необов'язкові параметри:

Іменні та необов'язкові аргументи (Посібник з програмування C #) @ MSDN

Я згоден зі Стефанбайєром. Але оскільки це веб-сервіс, кінцевому користувачеві легше використовувати лише одну форму веб-методу, ніж використовувати кілька версій одного методу. Я думаю, що в цій ситуації Nullable Type ідеально підходить для необов'язкових параметрів.

public void Foo(int a, int b, int? c)
{
  if(c.HasValue)
  {
    // do something with a,b and c
  }
  else
  {
    // do something with a and b only
  }  
}

необов'язкові параметри призначені для методів. якщо вам потрібні необов'язкові аргументи для класу, і ви:

• використовуючи c # 4.0: використовувати необов'язкові аргументи в конструкторі класу, я вважаю за краще рішення, оскільки це ближче до того, що робиться з методами, тому простіше запам'ятати. ось приклад:

  class myClass
  {
      public myClass(int myInt = 1, string myString =
                             "wow, this is cool: i can have a default string")
      {
          // do something here if needed
      }
  }

• використовуючи версії c #, попередні до c # 4.0: слід використовувати ланцюжок конструкторів (використовуючи: це ключове слово), де більш прості конструктори призводять до "головного конструктора". приклад:

  class myClass
  {
      public myClass()
      {
      // this is the default constructor
      }
  
      public myClass(int myInt)
          : this(myInt, "whatever")
      {
          // do something here if needed
      }
      public myClass(string myString)
          : this(0, myString)
      {
          // do something here if needed
      }
      public myClass(int myInt, string myString)
      {
          // do something here if needed - this is the master constructor
      }
  }

Типовим способом, яким це обробляється в C #, як згадував Стівен, є перевантаження методу. Створюючи кілька версій методу з різними параметрами, ви ефективно створюєте необов’язкові параметри. У формах з меншою кількістю параметрів, як правило, виклик форми методу з усіма параметрами, що встановлюють значення за замовчуванням у виклику цього методу.

Ви можете перевантажувати свій метод. Один метод містить один параметр, GetFooBar(int a)а інший містить обидва параметри,GetFooBar(int a, int b)

Використання перевантажень або використання C # 4.0 або вище

 private void GetVal(string sName, int sRoll)
 {
   if (sRoll > 0)
   {
    // do some work
   }
 }

 private void GetVal(string sName)
 {
    GetVal("testing", 0);
 }

Для більшої кількості необов'язкових параметрів за допомогою методу ContainsKey може використовуватися один параметр словника. Мені подобається такий підхід, тому що він дозволяє мені передавати список або Т окремо, без необхідності створювати зовсім інший метод (приємно, якщо параметри використовуються, наприклад, як фільтри).

Приклад (новий словник <рядок, об'єкт> () буде переданий, якщо не потрібні необов'язкові параметри):

public bool Method(string ParamA, Dictionary<string,Object> AddlParams) {
    if(ParamA == "Alpha" && (AddlParams.ContainsKey("foo") || AddlParams.ContainsKey("bar"))) {
        return true;
    } else {
        return false;
    }
}

Замість параметрів за замовчуванням, чому б просто не побудувати клас словника з переданого запиту .. реалізація, майже ідентична тому, як форми asp.net працюють з запитами.

тобто Request.QueryString ["a"]

Це від'єднає клас аркуша від коду фабрики / котла.

Ви також можете перевірити веб-служби за допомогою ASP.NET . Веб-сервіси - це веб-api, що генерується автоматично за допомогою атрибутів на класах C #.

Трохи запізнювався на вечірку, але я шукав відповідь на це питання і, врешті-решт, придумав ще один спосіб зробити це. Оголосіть типи даних для необов'язкових аргументів вашого веб-методу типу XmlNode. Якщо необов'язковий аргумент пропущено, це буде встановлено на нульове значення, а якщо він присутній, ви можете отримати значення рядка за допомогою виклику arg.Value, тобто,

[WebMethod]
public string Foo(string arg1, XmlNode optarg2)
{
    string arg2 = "";
    if (optarg2 != null)
    {
        arg2 = optarg2.Value;
    }
    ... etc
}

Що також достойно в цьому підході - це створена .NET домашня сторінка для ws все ще показує список аргументів (хоча ви втрачаєте зручні поля введення тексту для тестування).

У мене є веб-сервіс для запису, який займає 7 параметрів. Кожен - необов'язковий атрибут запиту до заяви sql, обгорнутого цією веб-службою. Тож приходять до уваги два обхідні шляхи до необов'язкових парам ... обидва досить бідні:

метод1 (param1, param2, param 3, param 4, param 5, param 6, param7) method1 (param1, param2, param3, param 4, param5, param 6) метод 1 (param1, param2, param3, param4, param5, param7 ) ... почніть бачити картину. Таким чином криється божевілля. Шлях занадто багато комбінацій.

Тепер для більш простого способу, який виглядає незручно, але він повинен працювати: method1 (param1, bool useParam1, param2, bool useParam2 тощо)

Це один виклик методу, значення для всіх параметрів необхідні, і він буде обробляти кожен випадок всередині нього. Також зрозуміло, як ним користуватися через інтерфейс.

Це хак, але це спрацює.

Мені довелося це зробити у веб-службі VB.Net 2.0. Я, нарешті, вказав параметри як рядки, потім перетворив їх у все, що мені потрібно. Необов’язковий параметр був вказаний з порожнім рядком. Не найчистіше рішення, але воно спрацювало. Будьте обережні, щоб ви потрапили на всі винятки, які можуть статися.

На всякий випадок, якщо хтось хоче передати зворотний дзвінок (або delegate) як необов'язковий параметр, це можна зробити так.

Необов’язковий параметр зворотного виклику:

public static bool IsOnlyOneElement(this IList lst, Action callbackOnTrue = (Action)((null)), Action callbackOnFalse = (Action)((null)))
{
    var isOnlyOne = lst.Count == 1;
    if (isOnlyOne && callbackOnTrue != null) callbackOnTrue();
    if (!isOnlyOne && callbackOnFalse != null) callbackOnFalse();
    return isOnlyOne;
}

необов'язкові параметри - це не що інше, як параметри за замовчуванням! Я пропоную вам дати обом параметрам за замовчуванням. GetFooBar (int a = 0, int b = 0) якщо у вас немає перевантаженого методу, це призведе до a = 0, b = 0, якщо ви не передасте жодних значень, якщо ви передасте 1 значення, це призведе до , передане значення для a, 0, і якщо ви передасте 2 значення, 1-й буде призначений a, а другий b.

сподіваємось, що відповість на ваше запитання.

У випадку, коли значення за замовчуванням недоступні, способом додавання необов'язкового параметра є використання .NET OptionalAttribute класу - https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.optionalattribute ? view = netframework-4.8

Приклад коду наведено нижче:

namespace OptionalParameterWithOptionalAttribute
{
    class Program
    {
        static void Main(string[] args)
        {
            //Calling the helper method Hello only with required parameters
            Hello("Vardenis", "Pavardenis");
            //Calling the helper method Hello with required and optional parameters
            Hello("Vardenis", "Pavardenis", "Palanga");
        }
        public static void Hello(string firstName, string secondName, 
            [System.Runtime.InteropServices.OptionalAttribute] string  fromCity)
        {
            string result = firstName + " " + secondName;
            if (fromCity != null)
            {
                result += " from " + fromCity;
            }
            Console.WriteLine("Hello " + result);
        }

    }
}

Ви також можете спробувати це
Тип 1
public void YourMethod(int a=0, int b = 0) { //some code }

Тип 2
public void YourMethod(int? a, int? b) { //some code }