在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提供了灵活和强大的方式来解析查询参数,从而简化了数据传递和接口交互的设计。

相关推荐
Python私教1 分钟前
如意Agent日志系统重构:从 print() 大海捞针到结构化可观测性栈
java·前端·重构
jieyucx6 分钟前
Go 零基础数据结构:顺序表(像「排抽屉」一样学增删改查)
java·数据结构·golang
曦夜日长7 分钟前
C++ STL容器string(一):string的变量细节、默认函数的认识以及常用接口的使用
java·开发语言·c++
北山有鸟14 分钟前
IS_ERR 判断出错后,再用 PTR_ERR 把它强制转换回 int 型的错误码作为函数的返回值。
java·开发语言
phltxy20 分钟前
深度解析:Spring Cloud Gateway 从入门到实战
java·开发语言
HAPPY酷24 分钟前
从Public到Private:UE5 C++类创建路径差异全解析
java·c++·ue5
许彰午32 分钟前
CacheSQL(一):手写数据库的工程化重生
java·数据库·缓存
shjita35 分钟前
记录java执行中的一个错误细节
java·开发语言
空中海36 分钟前
Docker入门到精通
java·docker·eureka
Java成神之路-41 分钟前
多 Filter、多 Interceptor 执行优先级控制方案
spring·java web