SpringBoot接收参数的19种方式

知否技术2024-03-07 14:24

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);
    }
}
相关推荐
杨二K21 分钟前
认识HertzBeat的第一天
java·hertzbeat
DevilSeagull24 分钟前
JavaScript WebAPI 指南
java·开发语言·javascript·html·ecmascript·html5
期待のcode2 小时前
Spring框架1—Spring的IOC核心技术1
java·后端·spring·架构
葵野寺2 小时前
【RelayMQ】基于 Java 实现轻量级消息队列（七）
java·开发语言·网络·rabbitmq·java-rabbitmq
书院门前细致的苹果3 小时前
JVM 全面详解：深入理解 Java 的核心运行机制
java·jvm
上官浩仁3 小时前
springboot excel 表格入门与实战
java·spring boot·excel
Livingbody4 小时前
10分钟完成 ERNIE-4.5-21B-A3B-Thinking深度思考模型部署
后端
Hello.Reader4 小时前
从零到一上手 Protocol Buffers用 C# 打造可演进的通讯录
java·linux·c#
树码小子4 小时前
Java网络初识（4）：网络数据通信的基本流程 -- 封装
java·网络
稻草人想看远方4 小时前
GC垃圾回收
java·开发语言·jvm
热门推荐
01conda中设置镜像地址（附所有可换的地址）02UV安装并设置国内源03GitHub 镜像站点04保姆级教程：手把手教你用Dify实现完美多轮对话（附Chatflow和提示词）05UV 工具安装与国内镜像源配置指南06A股预测还能更准？开源大模型Kronos带你跑通预测+回测全流程07突破百度网盘的下载限速，两种方法教会你【超详细】08KGG转MP3工具|非KGM文件|解密音频09教你如何认证 Gemini 教育优惠的二次验证，薅个 1年的 Gemini Pro 会员1046个Nano-banana 精选提示词，持续更新中