SpringBoot接收参数的19种方式

本文详细介绍了在SpringBoot应用中,使用Java如何通过Get、Post、Delete请求接收参数,包括使用方法形参、@RequestParam、实体类、HttpServletRequest、@PathVariable以及RequestBody注解的各种场景和注意事项。

1. Get 请求

1.1 以方法的形参接收参数

1.这种方式一般适用参数比较少的情况


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @GetMapping("/detail") public Result<User> getUserDetail(String name,String phone) { log.info("name:{}",name); log.info("phone:{}",phone); return Result.success(null); } }

2.参数用 @RequestParam 标注,表示这个参数需要必传,否则会报错。


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @GetMapping("/detail") public Result<User> getUserDetail(@RequestParam String name,@RequestParam String phone) { log.info("name:{}",name); log.info("phone:{}",phone); return Result.success(null); } }

1.2 以实体类接收参数


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @GetMapping("/detail") public Result<User> getUserDetail(User user) { log.info("name:{}",user.getName()); log.info("phone:{}",user.getPhone()); return Result.success(null); } }

注:Get 请求以实体类接收参数时,不能用 RequestParam 注解进行标注,因为不支持这样的方式获取参数。

1.3 通过 HttpServletRequest 接收参数


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @GetMapping("/detail") public Result<User> getUserDetail(HttpServletRequest request) { String name = request.getParameter("name"); String phone = request.getParameter("phone"); log.info("name:{}",name); log.info("phone:{}",phone); return Result.success(null); } }

1.4 通过 @PathVariable 注解接收参数


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @GetMapping("/detail/{name}/{phone}") public Result<User> getUserDetail(@PathVariable String name,@PathVariable String phone) { log.info("name:{}",name); log.info("phone:{}",phone); return Result.success(null); } }

1.5 接收数组参数


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @GetMapping("/detail") public Result<User> getUserDetail(String[] names) { Arrays.asList(names).forEach(name->{ System.out.println(name); }); return Result.success(null); } }

1.6 接收集合参数

springboot 接收集合参数,需要用 RequestParam 注解绑定参数,否则会报错!!


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @GetMapping("/detail") public Result<User> getUserDetail(@RequestParam List<String> names) { names.forEach(name->{ System.out.println(name); }); return Result.success(null); } }

2. Post 请求

2.1 以方法的形参接收参数


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @PostMapping("/save") public Result<User> getUserDetail(String name,String phone) { log.info("name:{}",name); log.info("phone:{}",phone); return Result.success(null); } }

注:和 Get 请求一样,如果方法形参用 RequestParam 注解标注,表示这个参数需要必传。

2.2 通过 param 提交参数,以实体类接收参数


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @PostMapping("/save") public Result<User> getUserDetail(User user) { log.info("name:{}",user.getName()); log.info("phone:{}",user.getPhone()); return Result.success(null); } }

注:Post 请求以实体类接收参数时,不能用 RequestParam 注解进行标注,因为不支持这样的方式获取参数。

2.3 通过 HttpServletRequest 接收参数


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @PostMapping("/save") public Result<User> getUserDetail(HttpServletRequest httpServletRequest) { log.info("name:{}",httpServletRequest.getParameter("name")); log.info("phone:{}",httpServletRequest.getParameter("phone")); return Result.success(null); } }

2.4 通过 @PathVariable 注解进行接收


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @PostMapping("/save/{name}") public Result<User> getUserDetail(@PathVariable String name) { log.info("name:{}",name); return Result.success(null); } }

2.5 请求体以 form-data 提交参数,以实体类接收参数

form-data 是表单提交的一种方式,比如常见的登录请求。


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @PostMapping("/save") public Result<User> getUserDetail(User user) { log.info("name:{}",user.getName()); log.info("phone:{}",user.getPhone()); return Result.success(null); } }

2.6 请求体以 x-www-form-urlencoded 提交参数,以实体类接收参数

x-www-form-urlencoded 也是表单提交的一种方式,只不过提交的参数被进行了编码,并且转换成了键值对。

例如你用form-data 提交的参数:


makefile

复制代码

name: 知否君 age: 22

用 x-www-form-urlencoded 提交的参数:


perl

复制代码

name=%E5%BC%A0%E4%B8%89&age=22


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @PostMapping("/save") public Result<User> getUserDetail(User user) { log.info("name:{}",user.getName()); log.info("phone:{}",user.getPhone()); return Result.success(null); } }

2.7 通过 @RequestBody 注解接收参数

注:RequestBody 注解主要用来接收前端传过来的 body 中 json 格式的参数。

2.7.1 接收实体类参数

java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @PostMapping("/save") public Result<User> getUserDetail(@RequestBody User user) { log.info("name:{}",user.getName()); log.info("phone:{}",user.getPhone()); return Result.success(null); } }

2.7.2 接收数组和集合

接收数组


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @PostMapping("/save") public Result<User> getUserDetail(@RequestBody String[] names) { Arrays.asList(names).forEach(name->{ System.out.println(name); }); return Result.success(null); } }

接收集合


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @PostMapping("/save") public Result<User> getUserDetail(@RequestBody List<String> names) { names.forEach(name->{ System.out.println(name); }); return Result.success(null); } }

2.8 通过 Map 接收参数

1.以 param 方式传参, RequestParam 注解接收参数


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @PostMapping("/save") public Result<User> getUserDetail(@RequestParam Map<String,Object> map) { System.out.println(map); System.out.println(map.get("name")); return Result.success(null); } }

2.以 body json 格式传参,RequestBody 注解接收参数


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @PostMapping("/save") public Result<User> getUserDetail(@RequestBody Map<String,Object> map) { System.out.println(map); System.out.println(map.get("name")); return Result.success(null); } }

2.9 RequestBody 接收一个参数


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @PostMapping("/save") public Result<User> getUserDetail(@RequestBody String name) { System.out.println(name); return Result.success(null); } }

3. Delete 请求

3.1 以 param 方式传参,以方法形参接收参数


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @DeleteMapping("/delete") public Result<User> getUserDetail(@RequestParam String name) { System.out.println(name); return Result.success(null); } }

3.2 以 body json 方式传参,以实体类接收参数

注:需要用 RequestBody 注解,否则接收的参数为 null


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @DeleteMapping("/delete") public Result<User> getUserDetail(@RequestBody User user) { System.out.println(user); return Result.success(null); } }

3.3 以 body json 方式传参,以 map 接收参数

注:需要用 RequestBody 注解,否则接收的参数为 null


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @DeleteMapping("/delete") public Result<User> getUserDetail(@RequestBody Map<String,Object> map) { System.out.println(map); return Result.success(null); } }

3.4 PathVariable 接收参数


java

复制代码

@RestController @RequestMapping("/user") @Slf4j public class UserController { @DeleteMapping("/delete/{name}") public Result<User> getUserDetail(@PathVariable String name) { System.out.println(name); return Result.success(null); } }

Spring Boot 中,可使用 `RestTemplate` 来发送 GET 请求,以下是其实现步骤和示例代码: #### 1. 配置 `RestTemplate` 创建 `RestTemplateConfig` 配置类,来创建 `RestTemplate` 的 Bean: ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.web.client.RestTemplate; @Configuration public class RestTemplateConfig { @Bean public RestTemplate restTemplate() { return new RestTemplate(); } } ``` #### 2. 发送 GET 请求 在服务类或者控制器中注入 `RestTemplate`,并使用其 `getForObject` 或者 `getForEntity` 方法发送 GET 请求: ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; import org.springframework.web.client.RestTemplate; @Service public class RestTemplateTest { @Autowired private RestTemplate restTemplate; public String sendGetRequest(String url) { return restTemplate.getForObject(url, String.class); } } ``` #### 3. 使用示例 在控制器中调用 `RestTemplateTest` 类的方法: ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController @RequestMapping("/api") public class TestController { @Autowired private RestTemplateTest restTemplateTest; @GetMapping("/test") public String test() { String url = "https://example.com/api/data"; return restTemplateTest.sendGetRequest(url); } } ``` 上述代码通过 `RestTemplate` 发送了一个 GET 请求,并将响应结果以字符串形式返回。`getForObject` 方法会直接返回响应的实体内容,而 `getForEntity` 方法会返回一个 `ResponseEntity` 对象,该对象包含了响应的状态码、头信息和实体内容。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值