在Spring MVC中使用查询字符串与参数

在Spring MVC中,控制器通过特定的路径进行访问,而查询字符串参数的使用则允许传递额外信息给服务器。这些参数通常用于过滤结果、指导资源的特定呈现或其它各种用途。

获取查询字符串参数

为了让Spring MVC控制器处理查询字符串,可以使用 @RequestParam注解。这个注解将HTTP请求中的查询参数绑定到控制器方法的参数上。以下是具体的使用方法:

复制代码
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class QueryStringController {

    @GetMapping("/search")
    @ResponseBody
    public String search(@RequestParam(name = "query") String searchQuery) {
        // 这里处理查询逻辑
        return "Search results for: " + searchQuery;
    }
}
​

在上述示例中,当访问路径 /search 并提供一个如 ?query=keyword 的查询字符串时,searchQuery 变量将会自动赋值为请求中的 keyword。

非必需参数和默认值

有时候,查询字符串参数并不是必须的。在这种情况下,可以设置 @RequestParam的 required属性为 false以及一个默认值。

复制代码
@GetMapping("/search")
@ResponseBody
public String searchWithOptionalParam(
    @RequestParam(name = "query", required = false, defaultValue = "none") String searchQuery
) {
    return "Search results for: " + searchQuery;
}
​

在这个更新的例子中,即使没有提供 query 参数,方法也将正常执行,并且 searchQuery 将会使用默认值 "none"。

多个查询参数

方法也可以设定接收多个查询参数:

复制代码
@GetMapping("/filter")
@ResponseBody
public String filterResults(
    @RequestParam String category,
    @RequestParam(required = false, defaultValue = "0") int page
) {
    return "Filtered results for category: " + category + " on page " + page;
}
​

在此示例中,两个参数 category和 page都通过查询字符串传递。如果 page参数未被提供,它将使用默认值 0。

参数类型转换

Spring MVC会自动将查询参数从String转换到控制器参数的适当类型,只要这样的转换是可能的。例如,如果有一个查询参数应该是整数,只需将控制器方法的参数声明为 int或 Integer即可。

处理复杂对象

如果需要将查询参数绑定到对象上,可以使用 @ModelAttribute注解:

复制代码
public class UserCriteria {
    private String name;
    private int age;

    // getters and setters
}

@GetMapping("/users")
@ResponseBody
public String findUsers(@ModelAttribute UserCriteria criteria) {
    return "Users found with criteria: Name - " + criteria.getName() + ", age - " + criteria.getAge();
}
​

当用户访问 /users?name=John&age=30时,UserCriteria对象的 name和 age属性将自动填充为 John和 30。

总结

利用Spring MVC中 @RequestParam与 @ModelAttribute的使用,可以方便地处理HTTP请求中的查询字符串参数。不论是简单的数值或字符串,还是复杂的对象绑定,Spring MVC提供了灵活和强大的方式来解析查询参数,从而简化了数据传递和接口交互的设计。

相关推荐
Baron X12 分钟前
Eclipse Temurin 21 (JRE) Alpine 镜像获取、离线导入与推送操作
java·docker·eclipse·temurin
孙浩君25 分钟前
我用 Spring Boot + xterm.js 写了个终端风格互动叙事游戏引擎:游戏即文件,上传一个 JSON 就能玩
java
jose33 分钟前
URL 里多写了一个端口,为什么请求还能调通?
java·后端
孙浩君36 分钟前
我用 Spring Boot 写了个「终端风格模拟经营游戏引擎」:引擎 + JSON 游戏文件,开箱即玩
java
y1su1 小时前
Leetcode 动态规划 模板
java·数据结构·算法·leetcode·动态规划
Wang's Blog1 小时前
Java 项目实战: 交友项目 - JWT 概述:为什么要用 Token 换掉 Session
java·ui·交友
SL_staff2 小时前
低代码选型避坑指南:为什么‘能拖拽’不等于‘能交付’?——基于JVS八大引擎的四维交付能力评估框架
java·低代码·spring cloud
李福春2 小时前
技术思考问题6:技术演讲该晒成功架构,还是交代失败与取舍?
java·开发语言·架构·computer use·深圳同盟·腾讯云架构师技术同盟·反演思维