springbootWeb常用注解使用

简介: 本文概述了Spring Boot Web中处理HTTP请求的常用注解,包括`@PathVariable`、`@RequestHeader`、`@RequestParam`、`@RequestBody`、`@ModelAttribute`和`@CookieValue`的用法及其示例。

@PathVariable 路径变量注解

可以通过使用@PathVariable注解,来获取绑定到URI模板路径变量上的值。一般都是结合着@RequestMapping注解来使用,用于在参数传递的过程中,规范前端发送请求的格式,和数据的验证。

注意的点:@PathVarible注解,如果方法参数为Map,则映射将填充所有路径变量名称和值 @PathVariable Map<String,String> map。

@PathVariable注解源码:

package org.springframework.web.bind.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.core.annotation.AliasFor;

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface PathVariable {
   

    @AliasFor("name")
    String value() default "";

    @AliasFor("value")
    String name() default "";

    boolean required() default true;

}

使用:

    @ResponseBody
    @RequestMapping("/role/{name}/{age}")
    public Map getParam01(@PathVariable("name") String name,
                          @PathVariable("age") String age,
                          @PathVariable Map<String,String> map){
   
        Map<Object, Object> map1 = new HashMap<>();
        map1.put("name",name);
        map1.put("age",age);
        map1.put("map",map);
        return map1;
    }

在这里插入图片描述


@RequestHeader 请求标头注解

可以通过@RequestHeader注解来获取请求标头的一些信息,如果方法参数是Map、MultiValueMap或HttpHeaders,则映射将填充所有标头名称和值。

@RequestHeader注解源码:


package org.springframework.web.bind.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.core.annotation.AliasFor;

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestHeader {
   

    @AliasFor("name")
    String value() default "";

    @AliasFor("value")
    String name() default "";

    boolean required() default true;

    String defaultValue() default ValueConstants.DEFAULT_NONE;

}

注意如果获取请求标头的单个信息,或者部分信息的话@RequestHeader(value=“xxxx”),其中xxx需要是请求标头中有的信息,比如host,connection,user-agent…

使用:

    @ResponseBody
    @RequestMapping("/headerMap01")
    public Map<String, String> getParam02(@RequestHeader Map<String,String> mapHeader){
   
        return mapHeader;
    }

    @ResponseBody
    @RequestMapping("/headerMap02")
    public String getParam03(@RequestHeader("host") String host){
   
        return host;
    }

在这里插入图片描述
在这里插入图片描述


@RequestParam 请求域注解

@RequestParam注解,作用和原生的request.getParameter()一样,也是获取请求域对象中的参数值。

@RequestParam注解源码:


package org.springframework.web.bind.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.Map;

import org.springframework.core.annotation.AliasFor;

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestParam {
   

    @AliasFor("name")
    String value() default "";

    @AliasFor("value")
    String name() default "";

    boolean required() default true;

    String defaultValue() default ValueConstants.DEFAULT_NONE;

}

对比@RequestParam注解和request.getParameter() 【基本一样】:

编写表单页面:

    <hr>
    <form action="/reqParam01" method="post">
        <input type="text" name="userName"><br>
        <input type="number" name="userAge"><br>
        <input type="submit" value="提交--使用注解方式">
    </form>
    <hr>
    <form action="/reqParam02" method="post">
        <input type="text" name="userName"><br>
        <input type="number" name="userAge"><br>
        <input type="submit" value="提交--使用request域对象方式">
    </form>

编写请求映射:

     @ResponseBody
    @RequestMapping("/reqParam01")
    public String getParam04(@RequestParam String userName,@RequestParam int userAge){
   
        return "用户名:"+userName+"  用户年龄:"+userAge;
    }

    @ResponseBody
    @RequestMapping("/reqParam02")
    public String getParam05(HttpServletRequest request){
   
        String userName = request.getParameter("userName");
        String userAge = request.getParameter("userAge");
        return "用户名:"+userName+"  用户年龄:"+userAge;
    }

运行测试:
在这里插入图片描述
在这里插入图片描述

在这里插入图片描述


@RequestBody 请求体注解

@RequestBody注解用来获取完整的请求体对象并返回。

@RequestBody注解源码:


package org.springframework.web.bind.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.http.converter.HttpMessageConverter;

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestBody {
   

    boolean required() default true;

}

使用:

做一个表单用来封装请求体:

    <hr>
    <form action="/reqBody" method="post">
        <input type="text" name="user"><br>
        <input type="password" name="upwd"><br>
        男:<input type="radio" name="sex" value="男">
        女:<input type="radio" name="sex" value="女"><br>
        <select name="address">
            <option value="-----请选择-----" disabled selected>-----请选择-----</option>
            <option value="内蒙古">内蒙古</option>
            <option value="山西">山西</option>
            <option value="湖北">湖北</option>
        </select>
        <input type="submit" value="提交">
    </form>

编写请求映射:

    @ResponseBody
    @RequestMapping("/reqBody")
    public String getParam06(@RequestBody String reqBody){
   
        return reqBody;
    }

在这里插入图片描述

post方式提交所以不是明文。

在这里插入图片描述


@ModelAttribute

@ModelAttribute注解用于将方法的参数或方法的返回值绑定到指定的模型属性上,并返回给Web视图。

@ModelAttribute可用于通过注释@RequestMapping方法的相应参数,使用特定属性名称向web视图显示命令对象。

@ModelAttribute还可以用于通过使用@RequestMapping方法注释控制器类中的访问器方法来向web视图公开引用数据。

@ModelAttribute注解源码:


package org.springframework.web.bind.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.core.annotation.AliasFor;
import org.springframework.ui.Model;

@Target({
   ElementType.PARAMETER, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ModelAttribute {
   

    @AliasFor("name")
    String value() default "";

    @AliasFor("value")
    String name() default "";

    boolean binding() default true;

}

使用1,将其置于方法上:

被@ModelAttribute注解注释的方法会在此controller每个方法执行前被执行,因此对于一个controller映射多个URL的用法来说,要谨慎使用。

比如:

     @ModelAttribute
    public void populateModel(@RequestParam String abc, Model model) {
   
        model.addAttribute("attributeName", abc);
    }

    @ResponseBody
    @RequestMapping(value = "/helloWorld")
    public String helloWorld() {
   
        return "helloWorld";
    }

在获得请求/helloWorld后,populateModel方法在helloWorld方法之前先被调用,它把请求参数(/helloWorld?abc=text)加入到一个名为attributeName的model属性中,在它执行后helloWorld被调用,返回视图名helloWorld和model已由@ModelAttribute方法生产好了。

此时,直接访问helloWolrd请求会出错, Resolved [org.springframework.web.bind.MissingServletRequestParameterException: Required request parameter 'abc' for method parameter type String is not present].

在这里插入图片描述

必须在其请求上添加一个名为abc值为任意的请求参数(例如:http://localhost:8080/helloWorld?abc=text)

在这里插入图片描述

使用2,将其置于方法参数上:

将@ModelAttribute放在方法参数上,会获取到对应的参数的值 @ModelAttribute("xxx") 返回方法参数

html表单:

    <hr>
    <form action="/model01" method="post">
        标题:<input type="text" name="title" ><br><br>
        内容:<textarea rows="10" cols="40" name="content"></textarea><br>
        <input type="submit" value="提交">
    </form>

请求映射:

    @ResponseBody
    @RequestMapping("/model01")
    public String getParam07(@ModelAttribute("content") String content,@ModelAttribute("title") String title){
   
        return content+"\n"+title;
    }

在这里插入图片描述
在这里插入图片描述


@CookieValue

@CookieValue注解主要是将请求的Cookie数据,映射到功能处理方法的参数上。

@CookieValue注解源码:


package org.springframework.web.bind.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.core.annotation.AliasFor;

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface CookieValue {
   

    @AliasFor("name")
    String value() default "";

    @AliasFor("value")
    String name() default "";

    boolean required() default true;

    String defaultValue() default ValueConstants.DEFAULT_NONE;

}

它将一个HTTP cookie绑定于方法的一个参数。

1、value:绑定的参数名称,String类型。

2、required:是否必须包含value,boolean类型,默认为 true,表示请求参数中必须包含对应的参数;若不存在,将抛出异常。

3、defaultValue:默认值,String类型。当没有传参时将使用此值赋值。

使用@CookieValue注解获取sessionId信息:

    @ResponseBody
    @RequestMapping("/cookieMap")
    public String getParam08(@CookieValue("JSESSIONID")String sessionId) {
   
        return sessionId;
    }

启动服务报错了,原因是jsessionId,应该填写实际存在的jsessionid才行(大意了)

在这里插入图片描述

将上面的例子修改如下:

    @ResponseBody
    @RequestMapping("/cookieMap")
    public String getParam08(@CookieValue("Idea-37e99455")String sessionId) {
   
        return sessionId;
    }

成功访问了:

在这里插入图片描述


相关文章
|
SQL 存储 缓存
Mybatis的一级缓存,二级缓存过期时间分析
Mybatis的一级缓存,二级缓存过期时间分析
1272 0
|
SQL JSON Java
springboot 如何编写增删改查后端接口,小白极速入门,附完整代码
本文为Spring Boot增删改查接口的小白入门教程,介绍了项目的构建、配置YML文件、代码编写(包括实体类、Mapper接口、Mapper.xml、Service和Controller)以及使用Postman进行接口测试的方法。同时提供了SQL代码和完整代码的下载链接。
springboot 如何编写增删改查后端接口,小白极速入门,附完整代码
|
JSON 前端开发 Java
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestMapping
@RequestMapping 是 Spring MVC 中用于请求地址映射的注解,可作用于类或方法上。类级别定义控制器父路径,方法级别进一步指定处理逻辑。常用属性包括 value(请求地址)、method(请求类型,如 GET/POST 等,默认 GET)和 produces(返回内容类型)。例如:`@RequestMapping(value = &quot;/test&quot;, produces = &quot;application/json; charset=UTF-8&quot;)`。此外,针对不同请求方式还有简化注解,如 @GetMapping、@PostMapping 等。
1091 0
|
虚拟化 数据安全/隐私保护
VMware Workstation Pro - 最新版
VMware是一款强大的虚拟机软件,可在单台计算机上模拟完整硬件系统,实现多系统运行。2024年5月推出最新版Workstation Pro 17.5.2,个人用户可免费使用。用户可通过官网下载并注册账户,按指引完成安装,适用于开发、测试及部署应用,具备高效灵活的虚拟化技术。
45522 1
|
安全 算法 Java
在Spring Boot中应用Jasypt以加密配置信息。
通过以上步骤,可以在Spring Boot应用中有效地利用Jasypt对配置信息进行加密,这样即使配置文件被泄露,其中的敏感信息也不会直接暴露给攻击者。这是一种在不牺牲操作复杂度的情况下提升应用安全性的简便方法。
1705 10
|
消息中间件 JSON Java
Spring Boot、Spring Cloud与Spring Cloud Alibaba版本对应关系
Spring Boot、Spring Cloud与Spring Cloud Alibaba版本对应关系
37102 1
|
小程序 JavaScript 前端开发
微信小程序开发全流程:从注册到上线的完整指南
这篇文章详细记录了微信小程序的完整开发到最终上线的每一个步骤。适合对小程序开发感兴趣的个人开发者或希望了解完整流程的学习者,涵盖了云开发、事件绑定、生命周期管理、组件使用等关键内容。
25426 14
|
JavaScript 前端开发 Java
TypeScript【接口】超简洁教程!再也不用看臭又长的TypeScript文档了!
【10月更文挑战第10天】TypeScript【接口】超简洁教程!再也不用看臭又长的TypeScript文档了!
|
安全 NoSQL 网络协议
SSRF内网打穿相关姿势
本文详细介绍了服务器端请求伪造(SSRF)漏洞,包括其定义、漏洞场景、常见漏洞函数、URL伪协议及其利用方法。通过具体的靶机示例,展示了如何利用SSRF漏洞进行内网探测、命令执行、SQL注入、命令注入、XXE注入、Tomcat任意文件上传和Redis未授权访问等攻击。文章还提供了相关工具和参考资料,帮助读者更好地理解和应对SSRF漏洞。
2445 0
SSRF内网打穿相关姿势
|
Java Maven Spring
如何在idea中创建Springboot项目? 手把手带你创建Springboot项目,稳!
文章详细介绍了在IDEA中创建Spring Boot项目的过程,包括选择Spring Initializr、配置项目属性、选择Spring Boot版本、导入依赖、等待依赖下载以及项目结构简介。
23867 1

热门文章

最新文章