讲师中心 微信公众号
AI工具推荐 视频效率加速

如何正确通过查询参数调用带搜索功能的 ASP.NET Core Web API

轻明吖_6591

轻明吖_6591

发布时间:2026-10-01 16:35:03

|

391人浏览过

|

来源于php中文网

原创

如何正确通过查询参数调用带搜索功能的 ASP.NET Core Web API

本文解决 mvc 前端调用 api 时“无数据返回但无报错”的典型问题:因 url 路由参数误用(将查询参数当作路径段传递),导致 api 接收空字符串搜索值,最终返回空结果集。

本文解决 mvc 前端调用 api 时“无数据返回但无报错”的典型问题:因 url 路由参数误用(将查询参数当作路径段传递),导致 api 接收空字符串搜索值,最终返回空结果集。

在 ASP.NET Core 项目中,API 端点设计与客户端调用方式必须严格匹配——尤其是参数绑定方式。您当前的问题根源在于 MVC 端 Ajax 请求的 URL 构造错误,导致 search 参数未被正确传递至 API。

? 问题定位:路由参数 vs 查询参数

您的 API 控制器使用的是 路径参数(Route Parameter):

[HttpGet("ListExpenseByAccountingSearch/{search}")]
public async Task<IActionResult> ListExpenseByAccountingSearch(string search)

这表示框架会尝试从 URL 路径中提取 {search},例如:
✅ 正确路径格式:/api/Expense/ListExpenseByAccountingSearch/office
❌ 错误理解:认为 /ListExpenseByAccountingSearch?search=office 也能匹配该路由(实际不能——此为查询参数,不匹配 {search} 占位符)

而您的 MVC 控制器和前端 Ajax 均按 查询参数(Query String) 方式构造请求:

// ❌ 错误:将 searchText 拼接进路径,但后端路由未定义该路径段
url: "/Management/Accounting/ListExpenseByAccountingSearch/" + searchText,

此时若 searchText 为空(如用户刚输入、或输入框为空),URL 变为:
/Management/Accounting/ListExpenseByAccountingSearch/
→ MVC Controller 的 string search 参数接收空字符串 "";
→ 进而调用 client.GetAsync("https://localhost:7198/api/Expense/ListExpenseByAccountingSearch/");
→ API 端收到空路径段,search = "",查询逻辑可能返回空集合(如 .Where(x => x.Name.Contains("")) 在 EF 中常被优化为恒真,但业务逻辑可能主动过滤空值);
→ 最终前端 console.log(value) 输出空数组,且无错误提示,造成“静默失败”。

✅ 正确解决方案:统一使用查询参数(推荐)

更灵活、更安全、更符合 REST 实践:将 API 改为接收查询参数,避免路径编码/空值/特殊字符问题。

1. 修改 API Controller(推荐)

// ✅ 使用 [FromQuery] 明确声明查询参数
[HttpGet("ListExpenseByAccountingSearch")]
public async Task<IActionResult> ListExpenseByAccountingSearch([FromQuery] string search)
{
    var values = await _expenseService.itemListExpenseByAccountingSearch(search ?? "");
    return Ok(values);
}

2. 更新 MVC Controller(保持一致)

[HttpGet]
public async Task<IActionResult> ListExpenseByAccountingSearch(string search) // 参数名需与 query key 一致
{
    var client = _httpClientFactory.CreateClient();
    // ✅ 正确拼接查询参数(自动处理 URL 编码)
    var url = $"https://localhost:7198/api/Expense/ListExpenseByAccountingSearch?search={Uri.EscapeDataString(search ?? "")}";
    var responseMessage = await client.GetAsync(url);

    if (responseMessage.IsSuccessStatusCode)
    {
        var jsonData = await responseMessage.Content.ReadAsStringAsync();
        var values = JsonConvert.DeserializeObject<List<ResultExpenseByAccountingDto>>(jsonData);
        return Json(values);
    }
    return Json(new List<ResultExpenseByAccountingDto>());
}

3. 修正前端 Ajax 请求

function listExpenseBySearch() {
    var searchText = $("#txtSearch").val().trim(); // ✨ 建议增加 trim()

    // ✅ 正确:使用 ?search=xxx 查询参数格式
    $.ajax({
        type: "GET",
        url: "/Management/Accounting/ListExpenseByAccountingSearch?search=" + encodeURIComponent(searchText),
        success: function (value) {
            console.log("API 返回数据:", value); // ✨ 添加调试日志
            $("#tableExpense tbody").empty();
            // ...(原有表格渲染逻辑保持不变)
        },
        error: function (xhr, status, error) {
            console.error("AJAX 请求失败:", status, error, xhr.responseText);
        }
    });
}

⚠️ 注意事项与最佳实践

  • 永远对用户输入进行 URL 编码:使用 encodeURIComponent()(前端)或 Uri.EscapeDataString()(C# 后端),防止空格、&、/ 等破坏 URL 结构。
  • 空值/空白值处理:在 API 服务层明确判断 string.IsNullOrWhiteSpace(search),避免无效查询或数据库全表扫描。
  • 避免路径参数传递搜索词:路径参数适用于有限、结构化、语义明确的标识符(如 /users/123),不适用于自由文本搜索。
  • 启用 CORS(如跨域):若前端与 API 不同源(如 http://localhost:5000 → https://localhost:7198),需在 API 的 Program.cs 中配置:
    builder.Services.AddCors(options =>
        options.AddPolicy("AllowFrontend", policy => 
            policy.WithOrigins("http://localhost:5000")
                  .AllowAnyMethod()
                  .AllowAnyHeader()));
    app.UseCors("AllowFrontend");
  • 添加加载状态与空态提示:提升用户体验,例如在 success 前显示“搜索中…”,无结果时显示“未找到匹配项”。

通过以上调整,您的搜索功能将稳定返回预期数据,控制台日志可清晰验证数据流,彻底告别“无声失败”。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

4406

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

1109

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

4324

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

880

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

1776

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

3185

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

4133

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2660

2023.09.20

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

20

2026.09.30

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn