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;

}
AI 代码解读

使用:

    @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;
    }
AI 代码解读

在这里插入图片描述


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

}
AI 代码解读

注意如果获取请求标头的单个信息,或者部分信息的话@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;
    }
AI 代码解读

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


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

}
AI 代码解读

对比@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>
AI 代码解读

编写请求映射:

     @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;
    }
AI 代码解读

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

在这里插入图片描述


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

}
AI 代码解读

使用:

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

    <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>
AI 代码解读

编写请求映射:

    @ResponseBody
    @RequestMapping("/reqBody")
    public String getParam06(@RequestBody String reqBody){
   
        return reqBody;
    }
AI 代码解读

在这里插入图片描述

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;

}
AI 代码解读

使用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";
    }
AI 代码解读

在获得请求/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>
AI 代码解读

请求映射:

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

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


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

}
AI 代码解读

它将一个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;
    }
AI 代码解读

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

在这里插入图片描述

将上面的例子修改如下:

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

成功访问了:

在这里插入图片描述


目录
打赏
0
0
0
0
83
分享
相关文章
springboot 如何编写增删改查后端接口,小白极速入门,附完整代码
本文为Spring Boot增删改查接口的小白入门教程,介绍了项目的构建、配置YML文件、代码编写(包括实体类、Mapper接口、Mapper.xml、Service和Controller)以及使用Postman进行接口测试的方法。同时提供了SQL代码和完整代码的下载链接。
springboot 如何编写增删改查后端接口,小白极速入门,附完整代码
SpringBoot项目打war包流程
本文介绍了将Spring Boot项目改造为WAR包并部署到外部Tomcat服务器的步骤。主要内容包括:1) 修改pom.xml中的打包方式为WAR;2) 排除Spring Boot内置的Tomcat依赖;3) 添加Servlet API依赖;4) 改造启动类以支持WAR部署;5) 打包和部署。通过这些步骤,可以轻松地将Spring Boot应用转换为适合外部Tomcat服务器的WAR包。
389 64
SpringBoot项目打war包流程
微服务架构下的接口性能优化策略####
在当今快速迭代的软件开发领域,微服务架构以其灵活性和可扩展性成为众多企业的首选。然而,随着系统复杂性的增加,接口性能问题日益凸显,成为制约用户体验与系统稳定性的关键因素。本文旨在探讨微服务架构下接口性能优化的有效策略,通过具体案例分析,揭示从代码层面到系统架构层面的全方位优化路径,为开发者提供实战指南。 ####
MyBatis-Plus快速入门:从安装到第一个Demo
本文将带你从零开始,快速入门 MyBatis-Plus。我们将首先介绍如何安装和配置 MyBatis-Plus,然后通过一个简单的示例演示如何使用它进行数据操作。无论你是 MyBatis 的新手还是希望提升开发效率的老手,本文都将为你提供清晰的指导和实用的技巧。
2537 0
MyBatis-Plus快速入门:从安装到第一个Demo
Java注解,元注解,自定义注解的使用
本文讲解了Java中注解的概念和作用,包括基本注解的用法(@Override, @Deprecated, @SuppressWarnings, @SafeVarargs, @FunctionalInterface),Java提供的元注解(@Retention, @Target, @Documented, @Inherited),以及如何自定义注解并通过反射获取注解信息。
Java注解,元注解,自定义注解的使用
|
11月前
重磅!高颜值好看的登录页面(附源码)
重磅!高颜值好看的登录页面(附源码)
自定义校验注解,优雅的实现手机号,身份证号的格式校验!
本文介绍了如何创建自定义校验注解来实现手机号和身份证号的格式校验,包括定义注解、实现校验逻辑、将注解应用于模型类,以及常用的校验器库和框架,旨在提高代码的可维护性和减少重复的校验逻辑。
【多线程面试题 七】、 说一说Java多线程之间的通信方式
Java多线程之间的通信方式主要有:使用Object类的wait()、notify()、notifyAll()方法进行线程间协调;使用Lock接口的Condition的await()、signal()、signalAll()方法实现更灵活的线程间协作;以及使用BlockingQueue作为线程安全的队列来实现生产者和消费者模型的线程通信。
【Python】已解决:(from docx import Document导包报错)ModuleNotFoundError: No module named ‘exceptions’
【Python】已解决:(from docx import Document导包报错)ModuleNotFoundError: No module named ‘exceptions’
1088 0
经验大分享:SpringCloud之Feign
经验大分享:SpringCloud之Feign
179 0
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等

登录插画

登录以查看您的控制台资源

管理云资源
状态一览
快捷访问