Подключиться
Yandex Cloud Functions

Использование интерфейса Function для задания функции-обработчика на С#

Статья создана

Вы можете задать функцию-обработчик на C#, без необходимости наследования от классов SDK.

Важно

Метод-обработчик должен быть публичным, иметь имя FunctionHandler и один входной параметр.

Пример корректного обработчика:

public class Handler {
  public String FunctionHandler(int i) {
    return i.ToString();
  }
}

Пример некорректного обработчика:

// у Handler не должно быть типов-параметров (см. [требования к обработчику](index.md))
public class Handler<T> {
  public int FunctionHandler(T i) {
    return 2;
  }
}

Вы можете использовать любые классы в качестве входного и возвращаемого типов.

Примечание

Поля этих классов могут иметь любые модификаторы доступа. В случае, когда поле непубличное, для него необходим публичный getter. В противном случае поле не попадет в ответ.

Примеры

Вывод структуры HTTP-запроса

Следующая функция получает на вход запрос с двумя полями (строкой и числом) и возвращает отформатированную строку с переданными данными.

Важно

Функцию необходимо вызывать с помощью YC CLI или с помощью HTTP-запроса с параметром integration=raw.

Файл Request.cs:

public class Request {
  public String message { get; set; }
  public int number { get; set; }
}

Файл Handler.cs:

public class Handler {
  public String FunctionHandler(Request r) {
    // на этом этапе в переменной r уже хранится разобранный запрос
    return $"Message is {r.message}, number is {r.number}";
  }
}

Пример входных данных:

{
  "message": "Hello",
  "number": 24
}

Возвращаемая строка:

Message is Hello, number is 24

Разбор HTTP-запроса

Функция вызывается с помощью HTTP-запроса с именем пользователя, записывает в журнал метод и тело запроса и возвращает приветствие.

Важно

Не используйте для вызова функции параметр integration=raw. При применении этого параметра функция не получает данных о методах, заголовках и параметрах исходного запроса.

Файл Request.cs:

public class Request {
  public String httpMethod { get; set; }
  public String body { get; set; }
}

Файл Response.cs:

public class Response {
  public int statusCode { get; set; }
  public String body { get; set; }

  public Response(int statusCode, String body) {
    this.statusCode = statusCode;
    this.body = body;
  }
}

Файл Handler.cs:

using System.Text.Json;

public class Handler {

  public Response FunctionHandler(Request r) {
    var method = r.httpMethod;
    var body = r.body;
    Console.WriteLine($"{method}, {body}");

    using var jsonDoc = JsonDocument.Parse(body);
    var root = jsonDoc.RootElement;

    // здесь из тела запроса достается параметр "name"
    // если не передать его, то выбросится ошибка
    var name = root.GetProperty("name").GetString(); 
    return new Response(200, $"Hello, {name}");
  }
}

Пример входных данных (метод POST):

{
  "name": "Anonymous"
}

В журнале будет напечатано:

POST, { "name": "Anonymous" }

Возвращаемый ответ:

Hello, Anonymous
В этой статье: