SpringBoot接收参数使用的注解实例讲解

2024-10-28 09:08:00

1.基本介绍

SpringBoot 接收客户端提交数据/参数会使用到相关注解

详解 @PathVariable 、 @RequestHeader 、 @ModelAttribute 、 @RequestParam 、 @MatrixVariable、@CookieValue、@RequestBody

2.接收参数相关注解应用实例

1.需求: 演示各种方式提交数据/参数给服务器，服务器如何使用注解接收

2.应用实例演示

需求: 演示各种方式提交数据/参数给服务器，服务器如何使用注解接收

创建src\main\resources\static\index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>index</title>
</head>
<body>
<h1>hello, llp</h1>
基本注解：
<hr/>
<a href="/monster/200/jack" rel="external nofollow" >@PathVariable-路径变量 monster/200/jack</a><br/><br/>
</body>
</html>

@PathVariable 使用

演示@PathVariable 使用，创建src\main\java\com\llp\springboot\controller\ParameterController.java，完成测试

@RestController
public class ParameterController {
    /**
     * /monster/{id}/{name} 解读
     * 1. /monster/{id}/{name} 构成完整请求路径
     * 2. {id} {name} 就是占位变量
     * 3. @PathVariable("name"): 这里name 和{name} 命名保持一致
     * 4. String name_ 这里自定义，和{name}命名无关
     * 5. @PathVariable Map<String, String> map 把所有传递的值传入map
     * 6. 可以看下@PathVariable源码
     */
    @GetMapping("/monster/{id}/{name}")
    public String pathVariable(@PathVariable("id") Integer id,
                               @PathVariable("name") String name,
                               @PathVariable Map<String, String> map) {
        System.out.println("id-" + id);
        System.out.println("name-" + name);
        System.out.println("map-" + map);
        return "success";
    }
}

@RequestHeader 使用

演示@RequestHeader 使用，修改 ParameterController.java ，完成测试

√ 修改 index.html

<a href="/requestHeader" rel="external nofollow" >@RequestHeader-获取Http请求头 </a><br/><br/>

√ 修改 ParameterController.java

/**
 * @RequestHeader("Host") 获取http请求头的 host信息
 * @RequestHeader Map<String, String> header: 获取到http请求的所有信息
 */
@GetMapping("/requestHeader")
public String requestHeader(@RequestHeader("host") String host,
                            @RequestHeader Map<String, String> header,
                            @RequestHeader("accept") String accept) {
    System.out.println("host-" + host);
    System.out.println("header-" + header);
    System.out.println("accept-" + accept);
    return "success";
}

@RequestParam 使用

演示@RequestParam 使用，修改 ParameterController.java ，完成测试

√ 修改 index.html

<a href="/hi?name=wukong&fruit=apple&fruit=pear&id=300&address=北京" rel="external nofollow" >@RequestParam-获取请求参数</a><br/><br/>

√ 修改 ParameterController.java

/**
 * @param username wukong
 * @param fruits  List<String> fruits 接收集合 [apple, pear]
 * @param paras Map<String, String> paras 如果我们希望将所有的请求参数的值都获取到，
 *              可以通过@RequestParam Map<String, String> paras这种方式
 *             一次性的接收所有的请求参数 {name=wukong, fruit=apple, id=300, address=北京}
 *             如果接收的某个参数中有多个之值比如这里fruits是一个集合，从map中只能拿到一个
 *              可以理解map底层会将相同的key的value值进行覆盖
 * @return
 * @RequestParam
 */
@GetMapping("/hi")
public String hi(@RequestParam(value = "name") String username,
                 @RequestParam("fruit") List<String> fruits,
                 @RequestParam Map<String, String> paras) {
    //username-wukong
    System.out.println("username-" + username);
    //fruit-[apple, pear]
    System.out.println("fruit-" + fruits);
    //paras-{name=wukong, fruit=apple, id=300, address=北京}
    System.out.println("paras-" + paras);
    return "success";
}

@CookieValue 使用

演示@CookieValue 使用，修改 ParameterController.java ，完成测试

√ 修改 index.html

<a href="/cookie" rel="external nofollow" >@CookieValue-获取cookie值</a><br/><br/>

√ 修改 ParameterController.java

/**
 * 因为我的浏览器目前没有cookie，我们可以自己设置cookie[技巧还是非常有用]
 * 如果要测试，可以先写一个方法，在浏览器创建对应的cookie
 * 说明 1. value = "cookie_key" 表示接收名字为 cookie_key的cookie
 * 2. 如果浏览器携带来对应的cookie , 那么 后面的参数是String ,则接收到的是对应对value
 * 3. 后面的参数是Cookie ,则接收到的是封装好的对应的cookie
 */
@GetMapping("/cookie")
public String cookie(@CookieValue(value = "cookie_key", required = false) String cookie_value,
                     HttpServletRequest request,
                     @CookieValue(value = "username", required = false) Cookie cookie) {
    System.out.println("cookie_value-" + cookie_value);
    if (cookie != null) {
        System.out.println("username-" + cookie.getName() + "-" + cookie.getValue());
    }
    System.out.println("-------------------------");
    Cookie[] cookies = request.getCookies();
    for (Cookie cookie1 : cookies) {
        System.out.println(cookie1.getName() + "=>" + cookie1.getValue());
    }
    return "success";
}

@RequestBody 使用

演示@RequestBody 使用，修改 ParameterController.java ，完成测试

√ 修改 index.html

<hr/>
<h1>测试@RequestBody获取数据: 获取POST请求体</h1>
<form action="/save" method="post">
    姓名: <input name="name"/> <br>
    年龄: <input name="age"/> <br/>
    <input type="submit" value="提交"/>
</form>

√ 修改 ParameterController.java

/**
 * @RequestBody 是整体取出Post请求内容
 */
@PostMapping("/save")
public String postMethod(@RequestBody String content) {
    System.out.println("content-" + content);
    return "success";
}

@RequestAttribute 和 @SessionAttribute使用

演示@RequestAttribute @SessionAttribute使用，创建 com/hspedu/web/controller/RequestController.java ，完成测试

√ 修改 index.html

<a href="/login" rel="external nofollow" >@RequestAttribute、@SessionAttribute-获取request域、session属性-</a>

√ 创建 RequestController.java

    @GetMapping("/login")
    public String login(HttpServletRequest request) {
        request.setAttribute("user", "llp");
        //向session中添加数据
        request.getSession().setAttribute("website", "http://www.baidu.com");
        //这里需要使用forward关键字，如果不适用则会走视图解析器，这
        //里视图解析器前缀配置的是/  后缀配置的.html  ---> /ok.html
        //而请求转发在服务器端执行，/被解析成 ip:port/工程路径
        //进而最终得到的完整路径是 ip:port/工程路径/ok.html
        //但是我们这里希望访问的是 ip:port/工程路径/ok这个请求路径
        //因此这里手动的设置forward:/ok ，底层会根据我们设置的路径进行请求转发
        return "forward:/ok";
    }
    @GetMapping("ok")
    //返回字符串，不走视图解析器
    @ResponseBody
    public String ok(@RequestAttribute(value = "user", required = false) String username,
                     @SessionAttribute(value = "website",required = false) String website, HttpServletRequest request) {
        System.out.println("username= " + username);
        System.out.println("通过servlet api 获取 username-" +  request.getAttribute("user"));
        System.out.println("website = " + website);
        System.out.println("通过servlet api 获取 website-"+request.getSession().getAttribute("website"));
        return "success";
    }
}

3.复杂参数

1.基本介绍

在开发中，SpringBoot 在响应客户端请求时，也支持复杂参数
Map、Model、Errors/BindingResult、RedirectAttributes、ServletResponse、SessionStatus、 UriComponentsBuilder、ServletUriComponentsBuilder、HttpSession
Map、Model 数据会被放在 request 域，底层 request.setAttribute()
RedirectAttributes 重定向携带数据

2.复杂参数应用实例

####1.说明 : 演示复杂参数的使用，重点: Map、Model、ServletResponse

2.代码实现

//响应一个注册请求
@GetMapping("/register")
public String register(Map<String,Object> map,
                       Model model,
                       HttpServletResponse response) {
    //如果一个注册请求,会将注册数据封装到map或者model
    //map中的数据和model的数据，会被放入到request域中
    map.put("user","llp");
    map.put("job","码农");
    model.addAttribute("sal", 2500);
    //一会我们再测试response使用
    //我们演示创建cookie,并通过response 添加到浏览器/客户端
    Cookie cookie = new Cookie("email", "123@sohu.com");
    response.addCookie(cookie);
    //请求转发
    return "forward:/registerOk";
}
@ResponseBody
@GetMapping("/registerOk")
public String registerOk(HttpServletRequest request) {
    System.out.println("user-" + request.getAttribute("user"));
    System.out.println("job-" + request.getAttribute("job"));
    System.out.println("sal-" + request.getAttribute("sal"));
    return "success";
}

4.自定义对象参数-自动封装

1.基本介绍

在开发中，SpringBoot 在响应客户端请求时，也支持自定义对象参数
完成自动类型转换与格式化
支持级联封装

2.自定义对象参数-应用实例

1.需求说明 : 演示自定义对象参数使用，完成自动封装，类型转换

2.代码实现

1.创建src\main\resources\static\save.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>添加妖怪</title></head>
<body><h1>添加妖怪-坐骑[测试封装 POJO；]</h1>
<form action="/savemonster" method="post">
    编号： <input name="id" value="100"><br/>
    姓名： <input name="name" value="牛魔王"/><br/>
    年龄： <input name="age" value="120"/> <br/>
    婚否： <input name="isMarried" value="true"/> <br/>
    生日： <input name="birth" value="2000/11/11"/> <br/>
    <!--注意这里car对象是monster的属性，给对象属性赋值时需要以对象名.字段名的方式-->
    坐骑：<input name="car.name" value="法拉利"/><br/>
    价格：<input name="car.price" value="99999.9"/>
    <input type="submit" value="保存"/>
</form>
</body>
</html>

2.修改src\main\java\com\llp\springboot\controller\ParameterController.java

@PostMapping("/savemonster")
public String saveMonster(Monster monster) {
    System.out.println("monster= " + monster);
    return "success";
}

到此这篇关于SpringBoot接收参数使用的注解实例讲解的文章就介绍到这了,更多相关SpringBoot接收参数内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

详解SpringBoot Controller接收参数的几种常用方式

第一类:请求路径参数 1.@PathVariable 获取路径参数.即url/{id}这种形式. 2.@RequestParam 获取查询参数.即url?name=这种形式例子 GET http://localhost:8080/demo/123?name=suki_rong 对应的java代码: @GetMapping("/demo/{id}") public void demo(@PathVariable(name = "id") String id, @Re
SpringBoot实现前后端、json数据交互以及Controller接收参数的几种常用方式

目录前言获取参数的几种常用注解一.请求路径参数get请求二.Body参数POST请求四.HttpServletRequest 五.参数校检最终选择交互方式参考文献总结前言现在大多数互联网项目都是采用前后端分离的方式开发,前端人员负责页面展示和数据获取,后端负责业务逻辑处理和接口封装.当与前端交互的过程当中,常用json数据与前端进行交互,这样想取出前端传送过来的json数据的时候,就需要用到@RequestBody这个注解.@RequestBody注解用于读取http请求的内
Springboot 接口需要接收参数类型是数组问题

目录接口需要接收参数类型是数组多个参以“,”拼接传递即可那么除了这样,我们还能怎么协调呢? springboot接口接收数组及多个参数问题若接口中需要接受数组,那接口应该如何写呢? 在body中用json格式传参数不就好了吗! 问题解决- 接口需要接收参数类型是数组如题,一般我们普遍采用的协调方式: 多个参以“,”拼接传递即可如: 那么除了这样,我们还能怎么协调呢? 其实对应get请求,springmvc内部是已经支持了这种以“,”逗号拼接的方式,也就是说,传参方式不变,但是我们后台
SpringBoot开发详解之Controller接收参数及参数校验

目录 Controller 中注解使用传输参数的几种Method 获取参数的几种常用注解使用对象直接获取参数使用@Valid对参数进行校验总结 Controller 中注解使用接受参数的几种传输方式以及几种注解: 在上一篇中,我们使用了JDBC链接数据库,完成了简单的后端开发.但正如我在上文中抛出的问题,我们能不能更好的优化我们在Controller中接受参数的方式呢?这一篇中我们就来聊一聊怎么更有效的接收Json参数. 传输参数的几种Method 在定义一个Rest接口时,我们通常会
SpringBoot接收参数使用的注解实例讲解

目录 1.基本介绍 2.接收参数相关注解应用实例 @PathVariable 使用 @RequestHeader 使用 @RequestParam 使用 @CookieValue 使用 @RequestBody 使用 3.复杂参数 1.基本介绍 2.复杂参数应用实例 4.自定义对象参数-自动封装 1.基本介绍 2.自定义对象参数-应用实例 1.基本介绍 SpringBoot 接收客户端提交数据/参数会使用到相关注解详解 @PathVariable . @RequestHeader . @Mo
SpringMVC 传日期参数到后台的实例讲解

1.注解方式,在controller层通过initBinder注解实现 @InitBinder public void initBinder(HttpServletRequest request,ServletRequestDataBinder binder)throws Exception { DateFormat fmt = new SimpleDateFormat("yyyy-MM-dd"); CustomDateEditor dateEditor = new CustomDat
SpringBoot RestTemplate GET POST请求的实例讲解

一)RestTemplate简介 RestTemplate是HTTP客户端库提供了一个更高水平的API.主要用于Rest服务调用. RestTemplate方法: 方法组描述 getForObject 通过GET检索表示形式. getForEntity ResponseEntity通过使用GET 检索(即状态,标头和正文). headForHeaders 通过使用HEAD检索资源的所有标头. postForLocation 通过使用POST创建新资源,并Location从响应中返回标头. po
Mybatis和orcale update语句中接收参数为对象的实例代码

Mybatis的 mapper.xml 中 update 语句使用 if 标签判断对像属性是否为空值. UserDTO是传过来参数的类型,userDTO是在mapperDao接口中给更新方法的参数起的别名. mapperDao.java int updata(@Param("userDTO") UserDTO userDTO); mapper.xml <update id="updata" parameterType="UserDTO"&g
SpringBoot 请求参数忽略大小写的实例

我就废话不多说了,大家还是直接看代码吧~ import java.io.IOException; import java.util.Collections; import java.util.Enumeration; import java.util.Map; import javax.servlet.FilterChain; import javax.servlet.ServletException; import javax.servlet.annotation.WebFilter; imp
springboot自定义starter方法及注解实例

目录 SpringBoot starter 自定义starter 自定义starter步骤实现打包测试注解解释 SpringBoot starter 用了springboot 那么久了居然都还没自定义过starter,想想都觉得羞愧,所以今天来玩一下. SpringBoot中的starter是一种非常重要的机制,能够抛弃以前繁杂的配置,将其统一集成进starter,应用者只需要在maven中引入starter依赖,SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置.star
Shell脚本中的位置变量参数（特殊字符）实例讲解

$# : 传递到脚本的参数个数 $* : 以一个单字符串显示所有向脚本传递的参数.与位置变量不同,此选项参数可超过 9个 $$ : 脚本运行的当前进程 ID号 $! : 后台运行的最后一个进程的进程 ID号 $@ : 与$#相同,但是使用时加引号,并在引号中返回每个参数 $- : 显示shell使用的当前选项,与 set命令功能相同 $? : 显示最后命令的退出状态. 0表示没有错误,其他任何值表明有错误. 复制代码代码如下: #!/bin/sh #param.sh # $0:文件完整路径名
实例讲解spring boot 多线程

Spring 通过任务执行器(TaskExecutor)来实现多线程和并发编程.使用ThreadPoolTaskExecutor可实现一个基于线程池的TaskExecutor.而实际开发中任务一般是非阻塞的,即异步的,所有我们在配置类中通过@EnableAsync开启对异步任务的支持,并通过在实际执行的Bean的方法中使用@Async注解来声明其是一个异步任务. 一.配置类 package com.cenobitor.taskxecutor.config; import org.springfr
Spring boot route Controller接收参数常用方法解析

Controller接收参数的常用方式总体可以分为三类.第一类是Get请求通过拼接url进行传递,第二类是Post请求通过请求体进行传递,第三类是通过请求头部进行参数传递. 1 @PathVariable接收参数请求方式:localhost:7001/param/123 请求示例: 代码示例: @GetMapping("{id}") public String getPathVariable(@PathVariable String id){ return "id=&quo