Làm thế nào để đọc các giá trị từ chuỗi truy vấn với ASP.NET Core?

Tôi đang xây dựng một API RESTful bằng ASP.NET Core MVC và tôi muốn sử dụng các tham số chuỗi truy vấn để chỉ định lọc và phân trang trên tài nguyên trả về một bộ sưu tập.

Trong trường hợp đó, tôi cần đọc các giá trị được truyền trong chuỗi truy vấn để lọc và chọn kết quả để trả về.

Tôi đã phát hiện ra rằng bên trong bộ điều khiển Gethành động truy cập HttpContext.Request.Querytrả về một IQueryCollection.

Vấn đề là tôi không biết làm thế nào nó được sử dụng để lấy các giá trị. Trong thực tế, tôi nghĩ rằng cách để làm là bằng cách sử dụng, ví dụ

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

Vấn đề là HttpContext.Request.Query["page"]không trả về một chuỗi, nhưng a StringValues.

Dù sao, làm thế nào để người ta sử dụng IQueryCollectionđể thực sự đọc các giá trị chuỗi truy vấn?

Bạn có thể sử dụng [FromQuery]để liên kết một mô hình cụ thể với chuỗi truy vấn:

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

ví dụ

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

Bạn có thể sử dụng phương thức ToString IQueryCollectionsẽ trả về giá trị mong muốn nếu một pagetham số duy nhất được chỉ định:

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

nếu có nhiều giá trị như thế ?page=1&page=2thì kết quả của lệnh gọi ToString sẽ là1,2

Nhưng như @ mike-g đã đề xuất trong câu trả lời của anh ấy, bạn nên sử dụng ràng buộc mô hình và không truy cập trực tiếp vào HttpContext.Request.Queryđối tượng.

ASP.NET Core sẽ tự động ràng buộc form values, route valuesvà query stringstheo tên. Điều này có nghĩa là bạn có thể chỉ cần làm điều này:

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

MVC sẽ cố gắng liên kết dữ liệu yêu cầu với các tham số hành động theo tên ... bên dưới là danh sách các nguồn dữ liệu theo thứ tự mà mô hình ràng buộc nhìn qua chúng

1. Form values: Đây là các giá trị biểu mẫu đi trong yêu cầu HTTP bằng phương thức POST. (bao gồm các yêu cầu POST của jQuery).

2. Route values: Tập hợp các giá trị tuyến được cung cấp bởi Định tuyến

3. Query strings: Phần chuỗi truy vấn của URI.

Nguồn: Làm thế nào mô hình ràng buộc hoạt động

FYI, bạn cũng có thể kết hợp các phương pháp tự động và rõ ràng:

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

Bạn chỉ có thể tạo một đối tượng như thế này:

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

Và sau đó trong bộ điều khiển chỉ cần làm một cái gì đó như thế:

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

Thậm chí tốt hơn, bạn có thể tạo mô hình API từ:

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

đến:

[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; }
}

Đây là mẫu mã tôi đã sử dụng (với chế độ xem .NET Core):

@{
    Microsoft.Extensions.Primitives.StringValues queryVal;

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

StringValueslà một chuỗi các chuỗi . Bạn có thể nhận được giá trị chuỗi của bạn bằng cách cung cấp một chỉ số, ví dụ HttpContext.Request.Query["page"][0].

IQueryCollectioncó một TryGetValue()giá trị trả về một giá trị với khóa đã cho. Vì vậy, nếu bạn có một tham số truy vấn được gọi someInt, bạn có thể sử dụng nó như vậy:

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

Lưu ý rằng trừ khi bạn có nhiều tham số cùng tên, StringValuesloại không phải là vấn đề.

trong lõi .net nếu bạn muốn truy cập chuỗi truy vấn trong chế độ xem của chúng tôi, hãy sử dụng nó như

@Context.Request.Query["yourKey"]

nếu chúng tôi ở vị trí mà @Context không có sẵn, chúng tôi có thể tiêm như thế

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

cũng cho cookie

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

Tôi có một giải pháp tốt hơn cho vấn đề này,

• request là thành viên của lớp trừu tượng ControllerBase
• GetSearchParams () là một phương thức mở rộng được tạo trong lớp người trợ giúp dưới đây.

var searchparams = await Request.GetSearchParams();

Tôi đã tạo một lớp tĩnh với một vài phương thức mở rộng

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;
    }
}

bằng cách này bạn có thể dễ dàng truy cập tất cả các thông số tìm kiếm của bạn. Tôi hy vọng điều này sẽ giúp nhiều nhà phát triển :)

Một số ý kiến ​​cũng đề cập đến điều này, nhưng asp net core thực hiện tất cả công việc này cho bạn.

Nếu bạn có một chuỗi truy vấn khớp với tên, nó sẽ có sẵn trong bộ điều khiển.

https: // myapi / some-endpoint / 123? someQueryString = Yay ThisWorks

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

Ouputs:

123

Yay ThisWorks