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);
    }
}
相关推荐
代码匠心3 分钟前
从零开始学Flink：状态管理与容错机制
java·大数据·后端·flink·大数据处理
分享牛4 分钟前
LangChain4j从入门到精通-11-结构化输出
后端·python·flask
zhougl99612 分钟前
Java内部类详解
java·开发语言
茶本无香19 分钟前
设计模式之十二：模板方法模式Spring应用与Java示例详解
java·设计模式·模板方法模式
灯火不休ᝰ1 小时前
[kotlin] 从Java到Kotlin：掌握基础语法差异的跃迁指南
java·kotlin·安卓
KoiHeng1 小时前
Java的文件知识与IO操作
java·开发语言
czlczl200209251 小时前
Spring Data Redis
java·redis·spring
知识即是力量ol1 小时前
在客户端直接上传文件到OSS
java·后端·客户端·阿里云oss·客户端直传
闻哥1 小时前
深入理解 Spring @Conditional 注解：原理与实战
java·jvm·后端·python·spring
煜磊1 小时前
MD5加盐值-注册与登录
java·开发语言
热门推荐
01GitHub 镜像站点02OpenCode 入门教程：介绍 · 安装 · 配置第三方 API (如 Claude)03Claude Code Skills 实用使用手册042025 年大语言模型发展回顾：关键突破、意外转折与 2026 年展望05一文了解国产算子编程语言 TileLang，TileLang 对国产开源生态的影响与启示06Clawdbot 中文汉化版 接入微信、飞书07Vue-skills的中文文档08在Trae中使用Pencil MCP09Claude Code + GLM4.7 避坑指南：解决 Unable to connect to Anthropic services10UV安装并设置国内源