Как читать значения из строки запроса с помощью ASP.NET Core?

Я создаю один RESTful API, используя ASP.NET Core MVC, и хочу использовать параметры строки запроса, чтобы указать фильтрацию и разбиение на страницы для ресурса, возвращающего коллекцию.

В этом случае мне нужно прочитать значения, переданные в строке запроса, для фильтрации и выбрать результаты для возврата.

Я уже выяснил, что внутри Getдействия контроллера обращение к нему HttpContext.Request.Queryвозвращает IQueryCollection.

Проблема в том, что я не знаю, как он используется для получения значений. По правде говоря, я думал, что можно использовать, например,

string page = HttpContext.Request.Query["page"]

Проблема в том, что HttpContext.Request.Query["page"]возвращает не строку, а StringValues.

В любом случае, как можно использовать IQueryCollectionдля фактического чтения значений строки запроса?

Вы можете использовать [FromQuery]для привязки конкретной модели к строке запроса:

https://docs.microsoft.com/en-us/aspnet/core/mvc/models/model-binding

например

[HttpGet()]
public IActionResult Get([FromQuery(Name = "page")] string page)
{...}

Вы можете использовать метод ToString, IQueryCollectionкоторый вернет желаемое значение, если pageуказан единственный параметр:

string page = HttpContext.Request.Query["page"].ToString();

если есть несколько значений, например, ?page=1&page=2тогда результат вызова ToString будет1,2

Но, как предположил @ mike-g в своем ответе, вам лучше использовать привязку модели, а не напрямую обращаться к HttpContext.Request.Queryобъекту.

ASP.NET ядро будет автоматически связываться form values, route valuesи query stringsпо имени. Это означает, что вы можете просто сделать это:

[HttpGet()]
public IActionResult Get(int page)
{ ... }

MVC попытается привязать данные запроса к параметрам действия по имени ... ниже приведен список источников данных в том порядке, в котором привязка модели просматривает их.

1. Form values: Это значения формы, которые отправляются в HTTP-запрос с использованием метода POST. (включая запросы JQuery POST).

2. Route values: Набор значений маршрута, предоставляемых Routing.

3. Query strings: Часть строки запроса URI.

Источник: Как работает привязка модели

К вашему сведению, вы также можете комбинировать автоматический и явный подходы:

[HttpGet()]
public IActionResult Get(int page
     , [FromQuery(Name = "page-size")] int pageSize)
{ ... }

Вы можете просто создать такой объект:

public class SomeQuery
{
    public string SomeParameter { get; set; }
    public int? SomeParameter2 { get; set; }
}

А затем в контроллере просто сделайте что-то вроде этого:

[HttpGet]
public IActionResult FindSomething([FromQuery] SomeQuery query)
{
    // Your implementation goes here..
}

Более того, вы можете создать модель API из:

[HttpGet]
public IActionResult GetSomething([FromRoute] int someId, [FromQuery] SomeQuery query)

чтобы:

[HttpGet]
public IActionResult GetSomething(ApiModel model)

public class ApiModel
{
    [FromRoute]
    public int SomeId { get; set; }
    [FromQuery]
    public string SomeParameter { get; set; }
    [FromQuery]
    public int? SomeParameter2 { get; set; }
}

Вот пример кода, который я использовал (с представлением .NET Core):

@{
    Microsoft.Extensions.Primitives.StringValues queryVal;

    if (Context.Request.Query.TryGetValue("yourKey", out queryVal) &&
        queryVal.FirstOrDefault() == "yourValue")
    {
    }
}

StringValuesпредставляет собой массив строк . Вы можете получить строковое значение, указав индекс, например HttpContext.Request.Query["page"][0].

IQueryCollectionимеет TryGetValue()на нем, который возвращает значение с заданным ключом. Итак, если у вас есть параметр запроса someInt, вы можете использовать его так:

var queryString = httpContext.Request.Query;
StringValues someInt;
queryString.TryGetValue("someInt", out someInt);
var daRealInt = int.Parse(someInt);

Обратите внимание: если у вас нет нескольких параметров с одним и тем же именем, StringValuesтип не является проблемой.

в ядре .net, если вы хотите получить доступ к строке запроса в нашем представлении, используйте ее как

@Context.Request.Query["yourKey"]

если мы находимся в месте, где @Context недоступен, мы можем ввести его, например

@inject Microsoft.AspNetCore.Http.IHttpContextAccessor HttpContextAccessor
@if (HttpContextAccessor.HttpContext.Request.Query.Keys.Contains("yourKey"))
{
      <text>do something </text>
}

также для файлов cookie

HttpContextAccessor.HttpContext.Request.Cookies["DeniedActions"]

У меня есть лучшее решение этой проблемы,

• запрос является членом абстрактного класса ControllerBase
• GetSearchParams () - это метод расширения, созданный в следующем вспомогательном классе.

var searchparams = await Request.GetSearchParams();

Я создал статический класс с несколькими методами расширения

public static class HttpRequestExtension
{
  public static async Task<SearchParams> GetSearchParams(this HttpRequest request)
        {
            var parameters = await request.TupledParameters();

            try
            {
                for (var i = 0; i < parameters.Count; i++)
                {
                    if (parameters[i].Item1 == "_count" && parameters[i].Item2 == "0")
                    {
                        parameters[i] = new Tuple<string, string>("_summary", "count");
                    }
                }
                var searchCommand = SearchParams.FromUriParamList(parameters);
                return searchCommand;
            }
            catch (FormatException formatException)
            {
                throw new FhirException(formatException.Message, OperationOutcome.IssueType.Invalid, OperationOutcome.IssueSeverity.Fatal, HttpStatusCode.BadRequest);
            }
        }



public static async Task<List<Tuple<string, string>>> TupledParameters(this HttpRequest request)
{
        var list = new List<Tuple<string, string>>();


        var query = request.Query;
        foreach (var pair in query)
        {
            list.Add(new Tuple<string, string>(pair.Key, pair.Value));
        }

        if (!request.HasFormContentType)
        {
            return list;
        }
        var getContent = await request.ReadFormAsync();

        if (getContent == null)
        {
            return list;
        }
        foreach (var key in getContent.Keys)
        {
            if (!getContent.TryGetValue(key, out StringValues values))
            {
                continue;
            }
            foreach (var value in values)
            {
                list.Add(new Tuple<string, string>(key, value));
            }
        }
        return list;
    }
}

таким образом вы можете легко получить доступ ко всем параметрам поиска. Надеюсь, это поможет многим разработчикам :)

В некоторых комментариях это тоже упоминается, но ядро ​​asp net делает всю эту работу за вас.

Если у вас есть строка запроса, соответствующая имени, она будет доступна в контроллере.

https: //? MyAPI / некоторые конечная точка / 123 someQueryString = YayThisWorks

[HttpPost]
[Route("some-endpoint/{someValue}")]
public IActionResult SomeEndpointMethod(int someValue, string someQueryString)
    {
        Debug.WriteLine(someValue);
        Debug.WriteLine(someQueryString);
        return Ok();
    }

Выходы:

123

YayThisWorks