SpringBoot(post、get)中获取客户请求信息、消息头、参数;get请求设置参数,使用场景

本文详细介绍SpringBoot中如何处理GET和POST请求的参数,包括使用HttpServletRequest、@RequestParam和@RequestBody注解来获取各种类型的请求参数。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1 HttpServletRequest获取客户请求信息、消息头、参数、IP
在方法中获取入参(get方法)

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletRequest;
import java.util.Map;
@Controller
public class SpringBootTest {
@RequestMapping(value = "/test", params = {"name","age"},method = RequestMethod.GET)
public @ResponseBody
String getString(HttpServletRequest request) {
    //获取一个参数
    String name=request.getParameter("name");
    //获取所有参数
    Map map=request.getParameterMap();
    return name;
}
}

获取请求方的IP地址:HttpServletRequest还有很多其他方法,获取头信息、cookie、session等等等等

@Controller
@RequestMapping(value ="/test")
public class SpringBootTest {
@RequestMapping(value = "/getIP")
public @ResponseBody String getIP(HttpServletRequest httpServletRequest){
    String ip=httpServletRequest.getRemoteAddr();
    return ip;
}
}

springboot请求将请求参数映射到一个对象上
请求能映射到的原因是实体类Animal 有两个参数name、age,浏览器请求时参数key与属性名一一对应,返回的是json格式

//实体类
import lombok.Data;
@Data
public class Animal {
private String name;
private Integer age;
}



import com.longteng.lesson2.my.animal.Animal;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
@RequestMapping(value ="/test")
public class SpringBootTest {
@RequestMapping(value = "/getParam")
public @ResponseBody Animal getParam(Animal animal){
    return animal;
}
}

请求地址为http://127.0.0.1:8080/test/getParam
在这里插入图片描述

请求地址为http://127.0.0.1:8080/test/getParam?name=xx&age=10
在这里插入图片描述

2 注解获取参数get方法

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class SpringBootTest {
//路径映射的参数名要与方法中的参数名一致
@RequestMapping(value = "/test", params = {"name","age"},method = RequestMethod.GET)
public @ResponseBody
String getString(@RequestParam String name,@RequestParam Integer age) {
    System.out.println("姓名"+name+"年龄"+age);
    return "姓名"+name+"年龄"+age;
}
}

3 在post方法请求中获取参数,返回String类型
一般post请求才会用到Body
请求为文本格式时,比用HttpServletRequest 的方式方便很多
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class SpringBootTest {
@RequestMapping(value = “/test”,method = RequestMethod.POST)
public @ResponseBody
String getString(@RequestBody String body) {
return body;
}
}

请求只要是Spring类型就能获取成功,返回也是String类型,这样就不会强制传json格式的参数文件,也不用写Content-Type:application/json
在这里插入图片描述
4 在post方法请求中获取参数,返回json类型

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
import java.util.Map;
@Controller
public class SpringBootTest {
@RequestMapping(value = "/test",method = RequestMethod.POST)
public @ResponseBody
Map getString(@RequestBody Map body) {
    return body;
}
}

请求要用json格式,键值对,返回的也是json格式:方法的返回类型、方法的请求参数类型都要用Map

在这里插入图片描述
post请求要添加头信息
Content-Type=application/json
5 get请求在@RequestParam中设置参数

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class SpringBootTest {
//请求参数的表达式只能用“=”或者“!=”不能使用“<”和“>”
@RequestMapping(value = "/test", params = {"userName","age"},method = RequestMethod.GET)
public @ResponseBody
String getString(@RequestParam (value = "name",defaultValue = "test",required = false)String userName,
                 @RequestParam Integer age) {
    return "姓名"+userName+"年龄"+age;
}
}

请求参数userName用@RequestParam注解设置
@RequestParam有3个参数:
1 value:改变该参数在请求时的实际名称,例如这个参数名是userName,用value设置成了name,那么请求时只能用name请求成功,用userName是请求不成功的,这样就不至于将userName暴露在外
2 defaultValue:在该参数是非必填的时候,页面请求时写了该参数,但是没有给值,就会使用defaultValue的值
3 required:设置该参数是否必填,默认为true,设置为false就可以不填写

post请求参数为文本类型,用HttpServiceRequest实现

import org.apache.catalina.servlet4preview.http.HttpServletRequest;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;

@Controller
@RequestMapping(value ="/test")
public class SpringBootTest {
@RequestMapping(value = "/getParam",method = RequestMethod.POST)
public @ResponseBody Object getParam(HttpServletRequest request){
    String body=null;
    try {
        /**
         * 用HttpServletRequest类型的参数属性request获取输入流(读)
         * 赋值给BufferedReader类型的bufferedReader(缓冲区读取)读取数据
         * 将获取到的转为json
         **/
        BufferedReader bufferedReader=
                new BufferedReader
                        (new InputStreamReader(request.getInputStream()));
        body=org.apache.commons.io.IOUtils.toString(bufferedReader);
    } catch (IOException e) {
        e.printStackTrace();
    }
    return body;
}
}

请求参数为文本类型的时候就要通过这种输入流获取参数内容,请求的参数非json格式

post请求类型为自定义的实体类

实体类
import lombok.Data;
@Data
public class Animal {
private String name;
private Integer age;
private char sex;
}

import com.longteng.lesson2.my.animal.Animal;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
@RequestMapping(value ="/test")
public class SpringBootTest {
@RequestMapping(value = "/getParam",method = RequestMethod.POST)
public @ResponseBody
Animal getParam(@RequestBody Animal animal) {
    return animal;
}
}

请求的返回类型为自定义的实体类的类型时,实体类的类属性就是请求的参数,并且都是必传
下面这个是没有传sex参数的返回

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

6 使用场景
get、post获取请求的参数使用场景
1 两个接口调用时使用
2 从页面请求时使用

@RequestBody注解的3个必须
1 这个注解必须用post方法请求才可以
2 请求参数必须放在body体里
3 请求必须配置Content-Type: application/json

@ResponseBody是做序列化处理的
@RequestBody是做反序列化处理的

<think>嗯,我现在要了解SpringBootGET请求参数的解析规则。之前学过一点SpringBoot,但具体到参数解析可能还不太清楚。首先,GET请求参数一般是在URL的查询字符串里,对吧?比如`/user?id=1&name=Tom`这样的。那SpringBoot是怎么把这些参数映射到控制器方法的参数上的呢? 记得SpringMVC中有处理请求参数的注解,比如@RequestParam。可能SpringBoot也沿用了这些机制。比如说,如果控制器方法有一个参数用@RequestParam注解,那么应该会绑定对应的查询参数。那如果没有用这个注解,SpringBoot会不会自动根据参数名来匹配呢?比如方法参数名和URL中的参数名一致的话,是否自动绑定? 还有,如果参数是基本类型,比如int或者String,应该直接转换。但如果参数是对象,比如一个User对象,里面有id和name属性,这时候是不是需要用@ModelAttribute?或者SpringBoot有没有自动绑定对象属性的功能? 另外,参数是可选的还是必须的?比如,如果URL中没有某个参数,会不会报错?这时候可能需要用到required属性,比如@RequestParam(required=false)。默认情况下,@RequestParam是不是required为true? 还有数组或列表的情况,比如多选框传多个值,参数名相同,如`hobbies=reading&hobbies=music`,这时候在方法参数里用List<String> hobbies是不是就能自动接收? 还有关于参数的类型转换,比如日期格式,可能需要自定义转换器,或者用@DateTimeFormat注解来指定格式。SpringBoot默认支持哪些类型的转换呢?比如String转Date是否会自动处理? 还有URL中的路径参数,比如@GetMapping("/user/{id}"),这时候用@PathVariable来获取,这部分是不是属于路径参数解析,和查询参数分开处理? 还有编码的问题,比如参数里有中文或特殊字符,SpringBoot会自动解码吗?是否需要配置字符编码过滤器? 可能还有多级参数的情况,比如对象里面包含另一个对象,参数名类似`user.address.city=Beijing`,这时候能否自动绑定到嵌套属性?可能需要用@ModelAttribute或者直接用一个DTO对象来接收。 还有,如果参数名和方法参数名不一致,必须用@RequestParam指定名称对吧?比如@RequestParam("user_id") String userId。 总结一下,可能需要涉及的注解有@RequestParam、@PathVariable、@ModelAttribute,以及对象绑定、类型转换、默认值设置、可选参数处理、数组/列表处理、嵌套属性绑定等。同时,SpringBoot在背后可能使用了一些Converter和Formatter来处理类型转换,还有WebDataBinder来进行数据绑定。 可能需要举几个例子来说明不同的情况,比如基本类型参数、对象参数、数组、可选参数、默认值、日期格式等。这样用户就能更清楚不同的使用场景该怎么处理。 不过,有没有可能漏掉某些情况?比如处理Map类型的参数,或者使用@RequestParam Map<String, String> params来接收所有参数?或者是否支持复杂类型的嵌套,比如JSON格式的查询参数,但一般GET请求参数不太会用JSON,可能更多是POST请求的body里用JSON。 另外,关于参数的验证,比如用@Valid注解配合JSR-303验证,可能在参数绑定之后进行校验,但这可能属于另一个话题,参数解析之后的部分。 总之,需要系统化地整理SpringBoot处理GET请求参数的规则,分点说明不同的情况和对应的处理方式,确保覆盖常见的用法和注意事项。</think>SpringBootGET 请求参数的解析规则主要通过以下机制实现,按使用场景分类: --- ### 一、**基础参数绑定** 1. **`@RequestParam` 注解** - **作用**:将 URL 的查询参数绑定到方法参数。 - **默认规则**: - 参数名与 URL 参数名一致时,可省略注解。 示例: ```java // URL: /user?name=Tom public String getUser(String name) { ... } // 自动绑定 ``` - 参数名不一致时需显式指定: ```java public String getUser(@RequestParam("user_name") String name) { ... } ``` - **属性**: - `required`:是否必传(默认 `true`),缺失会抛出异常。 - `defaultValue`:设置默认值(自动将 `required` 设为 `false`)。 2. **基本类型自动转换** - SpringBoot 自动将字符串参数转换为 `int`、`boolean` 等基本类型。 示例: ```java // URL: /user?id=100 public String getUser(@RequestParam int id) { ... } ``` --- ### 二、**对象参数绑定** - **自动绑定对象属性**:若方法参数是一个对象,SpringBoot 会按**属性名**自动匹配 URL 参数。 示例: ```java // URL: /user?name=Tom&age=20 public String getUser(User user) { ... } // User 类需有 name 和 age 的 setter 方法 ``` - **嵌套对象绑定**:使用 `.` 分隔符绑定嵌套属性。 示例: ```java // URL: /user?address.city=Beijing public String getUser(User user) { ... } ``` --- ### 三、**数组/集合参数** - **同名参数传递多个值**:直接绑定到数组或 `List` 类型。 示例: ```java // URL: /hobbies?hobby=reading&hobby=music public String getHobbies(@RequestParam List<String> hobby) { ... } ``` --- ### 四、**路径参数 `@PathVariable`** - **从 URL 路径中获取参数**:需与 `@GetMapping` 路径占位符匹配。 示例: ```java @GetMapping("/user/{id}") public String getUser(@PathVariable Long id) { ... } ``` --- ### 五、**可选参数与默认值** - **可选参数**:通过 `required=false` 允许参数缺失。 示例: ```java public String getUser(@RequestParam(required = false) String role) { ... } ``` - **默认值**:直接设置 `defaultValue`。 示例: ```java public String getUser(@RequestParam(defaultValue = "guest") String role) { ... } ``` --- ### 六、**日期/自定义类型转换** 1. **`@DateTimeFormat` 注解** 指定日期格式: ```java public String getEvent(@RequestParam @DateTimeFormat(pattern = "yyyy-MM-dd") Date date) { ... } ``` 2. **自定义转换器** 实现 `Converter<String, T>` 接口,注册为 Spring Bean。 --- ### 七、**编码处理** - **默认编码**:SpringBoot 使用 UTF-8 解码 URL 参数,需确保容器(如 Tomcat)的编码配置一致。 --- ### 八、**完整示例** ```java @GetMapping("/user") public String getUser( @RequestParam String name, // 必传参数 @RequestParam(required = false) Integer age, // 可选参数 @RequestParam(defaultValue = "1") int page, // 默认值 @DateTimeFormat(pattern = "yyyy-MM-dd") Date birth, @RequestParam List<String> hobbies, // 接收多个值 UserFilter filter // 自动绑定对象属性 ) { ... } ``` --- ### 九、**注意事项** 1. 避免在 GET 请求中传递复杂嵌套对象(推荐用 POST + JSON)。 2. 参数名匹配区分大小写。 3. 类型转换失败会抛出 `TypeMismatchException`。 通过上述规则,SpringBoot 灵活地简化了 GET 参数的解析,开发者只需关注业务逻辑。
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值