在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

非必需参数和默认值

有时候,查询字符串参数并不是必须的。在这种情况下,可以设置 @RequestParamrequired属性为 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;
}
​

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

参数类型转换

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

处理复杂对象

如果需要将查询参数绑定到对象上,可以使用 @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对象的 nameage属性将自动填充为 John30

总结

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

相关推荐
YXWik64 小时前
java 使用 spring AI 实战 RAG (Chroma 向量数据库+Advisor)
java·人工智能·spring
间彧4 小时前
Stream.collect(Collectors.toList())和Stream.toList()
java
We....4 小时前
Java集合---Collection接口和Map接口
java·开发语言
程序员鱼皮4 小时前
Java 8 终于要被淘汰了!带你速通 Java 8~24 新特性 | 又能跟面试官吹牛皮了
java·后端·程序员
蓝倾9764 小时前
1688拍立淘接口对接实战案例
java·开发语言·数据库·python·电商开放平台·开放api接口
渣哥5 小时前
为什么 StringBuilder 这么快?带你看懂底层实现
java
怀旧,5 小时前
【C++】17. AVL树实现
java·开发语言·c++
上官浩仁5 小时前
springboot jackson json入门与实战
java·spring boot·json
曾经的三心草5 小时前
微服务的编程测评系统19-我的消息功能-竞赛排名功能
java·数据库·微服务