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 JSON Java
springboot 如何编写增删改查后端接口,小白极速入门,附完整代码
本文为Spring Boot增删改查接口的小白入门教程,介绍了项目的构建、配置YML文件、代码编写(包括实体类、Mapper接口、Mapper.xml、Service和Controller)以及使用Postman进行接口测试的方法。同时提供了SQL代码和完整代码的下载链接。
springboot 如何编写增删改查后端接口,小白极速入门,附完整代码
|
Java Android开发 p3c
Alibaba Java Coding Guidelines安装使用教程
Alibaba Java Coding Guidelines安装使用教程
9489 0
Alibaba Java Coding Guidelines安装使用教程
|
6月前
|
JavaScript 前端开发 Java
制造业ERP源码,工厂ERP管理系统,前端框架:Vue,后端框架:SpringBoot
这是一套基于SpringBoot+Vue技术栈开发的ERP企业管理系统,采用Java语言与vscode工具。系统涵盖采购/销售、出入库、生产、品质管理等功能,整合客户与供应商数据,支持在线协同和业务全流程管控。同时提供主数据管理、权限控制、工作流审批、报表自定义及打印、在线报表开发和自定义表单功能,助力企业实现高效自动化管理,并通过UniAPP实现移动端支持,满足多场景应用需求。
629 1
|
8月前
|
前端开发 Java 测试技术
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestParam
本文介绍了 `@RequestParam` 注解的使用方法及其与 `@PathVariable` 的区别。`@RequestParam` 用于从请求中获取参数值(如 GET 请求的 URL 参数或 POST 请求的表单数据),而 `@PathVariable` 用于从 URL 模板中提取参数。文章通过示例代码详细说明了 `@RequestParam` 的常用属性,如 `required` 和 `defaultValue`,并展示了如何用实体类封装大量表单参数以简化处理流程。最后,结合 Postman 测试工具验证了接口的功能。
478 0
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestParam
|
5月前
|
前端开发 Java 数据库连接
一个完整 Java 项目常包含的各层次详解与全面解析
本内容介绍了Java项目的典型分层架构,涵盖开放接口层、终端显示层、Web层、Service层、Manager层、Mapper层及常用辅助层次,如实体层、DTO层、VO层等。通过合理划分各层职责,结合Spring Boot等框架,实现系统的高内聚、低耦合,提升可维护性与扩展性,适用于微服务与MVC架构设计。
616 0
|
10月前
|
Java 中间件 调度
SpringBoot整合XXL-JOB【03】- 执行器的使用
本文介绍了如何将调度中心与项目结合,通过配置“执行器”实现定时任务控制。首先新建SpringBoot项目并引入依赖,接着配置xxl-job相关参数,如调度中心地址、执行器名称等。然后通过Java代码将执行器注册为Spring Bean,并声明测试方法使用`@XxlJob`注解。最后,在调度中心配置并启动定时任务,验证任务是否按预期执行。通过这些步骤,读者可以掌握Xxl-Job的基本使用,专注于业务逻辑的编写而无需关心定时器本身的实现。
2321 10
SpringBoot整合XXL-JOB【03】-  执行器的使用
|
XML Java 数据格式
spring复习02,xml配置管理bean
详细讲解了Spring框架中基于XML配置文件管理bean的各种方式,包括获取bean、依赖注入、特殊值处理、属性赋值、集合类型处理、p命名空间、bean作用域及生命周期和自动装配。
spring复习02,xml配置管理bean
|
XML Java 应用服务中间件
springMVC01,springMVC的执行流程【第一个springMVC例子(XML配置版本):HelloWorld】
通过一个HelloWorld实例,介绍了SpringMVC的基本概念、执行流程,并详细讲解了如何创建和配置第一个SpringMVC项目(基于XML)。
springMVC01,springMVC的执行流程【第一个springMVC例子(XML配置版本):HelloWorld】
|
SQL Java 数据库连接
MyBatis-Plus快速入门:从安装到第一个Demo
本文将带你从零开始,快速入门 MyBatis-Plus。我们将首先介绍如何安装和配置 MyBatis-Plus,然后通过一个简单的示例演示如何使用它进行数据操作。无论你是 MyBatis 的新手还是希望提升开发效率的老手,本文都将为你提供清晰的指导和实用的技巧。
2831 0
MyBatis-Plus快速入门:从安装到第一个Demo