SpringBoot 接收参数的方式

最编程 2024-07-01 20:49:48

...

Get 请求
1.1 以方法的形参接收参数
1.这种方式一般适用参数比较少的情况

@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 标注，表示这个参数需要必传，否则会报错。

@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 以实体类接收参数

@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 接收参数
@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 注解接收参数

@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 接收数组参数

@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 注解绑定参数，否则会报错！！

@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 以方法的形参接收参数

@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 提交参数，以实体类接收参数

@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 接收参数

@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 注解进行接收

@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 是表单提交的一种方式，比如常见的登录请求。

@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 提交的参数：
name: 知否君
age: 22
用 x-www-form-urlencoded 提交的参数：

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

@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 接收实体类参数

@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 接收数组和集合
接收数组

@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);
    }
}

接收集合

@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 注解接收参数

@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 注解接收参数

@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 接收一个参数

@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 方式传参，以方法形参接收参数

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

在这里插入图片描述

上一篇：流中的过滤方法可自定义过滤方法

下一篇： Java Café (5) - Java 语言基础

SpringBoot 接收参数的方式

SpringBoot 从前端接收参数

详解Ty2y平台配置参数的JavaScript混淆加密方式

ARM处理器函数中的参数传递方式

函数的参数传递方式是怎样的？

使用cursor方式在MySQL中读取数据：理解useCursorFetch和FetchSize参数的作用

vue路由传参以及接收参数的几种方法

深入理解Vue Router中的路由参数传递方式

在Vue应用里，实现页面间传递数据的两种常用路由参数传递法及其组件内接收入参方式详解

django路由url传递参数的几种方式

探索传递参数的三种方法：第三种 - 通过查询字符串（Query Parameters）的方式