Spring MVC常用注解及用法

已于 2024-08-28 14:43:10 修改
阅读量938 收藏 14
点赞数 26
文章标签： java 前端 后端 spring mvc
于 2024-08-28 14:41:07 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Lotus_zyz/article/details/141573960
版权

目录

1.建立连接--@RequestMapping

2.请求

2.1 传递单个参数

2.2 传递多个参数

 2.3 传递对象

2.4 参数重命名--@RequestParam

2.5 传递数组

2.6 传递集合

2.7 传递json数据--@RequestBody

2.8 获取URL中参数--@PathVariable

2.9 上传文件--@RequestPart

 2.10 获取Cookie--@CookieValue

2.11 存储和获取Session--@SessionAttribute

2.12 获取Header--@RequestHeader

3.响应

3.1 返回静态页面--@Controller

3.2 返回数据--@ResponseBody

3.3 返回HTML代码片段

3.4 返回json数据

3.5 设置状态码

作为Web框架，学习Spring MVC主要就是了解如何通过浏览器和用户程序进行交互，在这里我就来简单介绍一下Spring MVC中的常见注解以及它们各自的用法。

首先，我们将交互的过程大致分为三个部分：

• 建立连接：将用户(浏览器)和Java程序连接起来

• 请求：用户请求时会带一些参数，在程序中需要想办法获取这些参数，所以请求这块主要是获取参数的功能

• 响应：执行了业务逻辑后，把程序执行的结果返回给用户

1.建立连接--@RequestMapping

在Spring MVC中，使用@RequestMapping来实现URL路由映射，即浏览器连接Java程序(路由映射：当用户访问一个URL时，将用户的请求对应到程序中的某个类的某个方法)

package org.example.mvcdemo;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class UserController {
    @RequestMapping("/hello")
    public String hello(){//方法名称无需与@RequestingMapping括号内的名称相同
        return "Hello,Spring MVC";
    }
}

执行这段代码后访问http://127.0.0.1:8080/hello(/hello就是@RequestMapping括号中内容)就能看到程序返回的数据

除了@RequestMapping外，我们会发现上述代码中还有另外一个注解@RestController，当我们去掉它时，上面的网页就无法正常访问，在这里它的作用可以简单理解为给类加上特定的标识，从而让Spring更快知道哪些类中的方法可能要执行，当然，这个注解的功能不止一点，这里先不做过多的介绍

@RequestingMapping既可以修饰方法，也可以修饰类。当同时修饰类和方法时，访问的地址是类路径+方法路径

package org.example.mvcdemo;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/test")
public class UserController {
    @RequestMapping("/hello")
    public String hello(){
        return "Hello,Spring MVC";
    }
}

执行这段代码后访问的地址是http://127.0.0.1:8080/test/hello(类路径/test+方法路径/hello)

@RequestingMapping既支持GET请求，也支持POST请求，PUT请求等，我们可以通过设置参数来指定请求的类型，或者使用特定的注解

@RequestMapping(value = "/hello",method = RequestMethod.GET)//仅支持GET请求
@RequestMapping(value = "hello",method = RequestMethod.POST)//仅支持POST请求
@RequestMapping(value = "hello",method = {RequestMethod.DELETE,RequestMethod.GET,RequestMethod.POST})//支持多种请求
@GetMapping("hello")//仅支持GET请求
@PostMapping("hello")//仅支持POST请求

注：当多个URL相同时(同一个访问路径下有多个方法)，如果支持的请求类型不同，那么访问网页时不会报错，反之，如果支持的请求类型相同，那么访问网页时就会报错

2.请求

访问不同的网页路径，其实就是在发送不同的请求。在发送请求的时候，可能会带有一些参数，这里我们使用Postman这个软件来传递参数(发送带参数的请求)

2.1 传递单个参数

当传递单个参数时，Postman中的key值与对应方法中参数的名称相同(可以不相同，但是需要使用注解，后面会说到)，Spring MVC就会将key值对应的value赋值给该参数

package org.example.mvcdemo;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/test")
public class UserController {
    @RequestMapping("demo1")
     public String method1(String name){
         return "接收到参数:"+name;
     }
}

传递参数会出现几种特殊情况

• key值与对应参数名称不同：获取不到参数，接收到的参数为null

• 传递参数类型不匹配：访问网页报错

• 参数为基本类型时不传递参数：当参数类型为基本类型(int，char等)，由于基本类型不能转换为空值null，访问网页会报错，而包装类型(Integer等)可以为空值null，所以可以使用包装类型去声明参数

2.2 传递多个参数

传递多个参数和传递单个参数过程类似，在Postman中要使用多个key传递参数

package org.example.mvcdemo;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/test")
public class UserController {
    @RequestMapping("demo1")
     public String method1(String name,Integer age){
         return "name:"+name+" age:"+age;
     }
}

 2.3 传递对象

当参数比较多时，方法声明时就需要很多形参，并且后续每次增加一个参数时都需要修改方法声明，我们就可以把这些参数封装成一个对象，Spring MVC会自动实现对对象参数的赋值

package org.example.mvcdemo;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/test")
public class UserController {
    @RequestMapping("demo1")
     public UserInfo method1(UserInfo userInfo){
         return userInfo;
     }
}

2.4 参数重命名--@RequestParam

在有些特殊情况中，前端传递的参数key和后端接收的key可以不相同(即上面讲到的key和参数名称不相同的情况)，这时我们可以使用@RequestParam这个注释来重命名参数

package org.example.mvcdemo;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/test")
public class UserController {
    @RequestMapping("demo1")
     public String method1(@RequestParam(value = "name1",required = false) String name,Integer age){
        //required参数决定了name这个参数是否可以为空值，默认为true(不能为空值)
         return "name:"+name+" age:"+age;
     }
}

2.5 传递数组

Spring MVC可以自动绑定数组参数的赋值

package org.example.mvcdemo;
import org.springframework.web.bind.annotation.*;
import java.util.Arrays;
@RestController
@RequestMapping("/test")
public class UserController {
    @RequestMapping("demo1")
     public String method1(String[] str){
         return Arrays.toString(str);
     }
}

2.6 传递集合

当使用Postman传递多个参数时，会默认封装成一个数组进行传递，需要使用@RequestParam注释来绑定参数关系，从而确保传递的参数是集合类

package org.example.mvcdemo;
import org.springframework.web.bind.annotation.*;
import java.util.List;
@RestController
@RequestMapping("/test")
public class UserController {
    @RequestMapping("demo1")
     public String method1(@RequestParam List<String> list){
         return list.toString();
     }
}

2.7 传递json数据--@RequestBody

在传递参数时，主要通过正文Body中的键值对与后端参数进行绑定赋值，而当传递json数据时，后端参数没有识别到键值对，就会默认赋值为null，这时候就需要使用@RequestBody注释将请求正文中的数据与后端参数进行绑定

package org.example.mvcdemo;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/test")
public class UserController {
    @RequestMapping("demo1")
    public UserInfo method1(@RequestBody UserInfo userInfo){
        return userInfo;
    }
}

2.8 获取URL中参数--@PathVariable

@PathVariable主要作用于请求URL路径上的数据绑定

package org.example.mvcdemo;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/test")
public class UserController {
    @RequestMapping("demo1/{name1}/{age}")
    //@PathVariable修饰的参数不能为空值
    //如果方法参数名称和需要绑定的URL中的变量名称一致，可以不用给@PathVariable的属性赋值
    //反之，如果不一致，需要给@PathVariable的属性赋值
    public String method1(@PathVariable("name1") String name,@PathVariable Integer age){
        return "name:"+name+" age:"+age;
    }
}

2.9 上传文件--@RequestPart

package org.example.mvcdemo;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import java.io.File;
import java.io.IOException;
@RestController
@RequestMapping("/test")
public class UserController {
    @RequestMapping("demo1")
    public String method1(@RequestPart MultipartFile file) throws IOException {
        String fileName= file.getOriginalFilename();
        file.transferTo(new File("D:/"+fileName));
        return "接受到文件:"+fileName;
    }
}

 2.10 获取Cookie--@CookieValue

package org.example.mvcdemo;
import jakarta.servlet.http.Cookie;
import jakarta.servlet.http.HttpServletRequest;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/test")
public class UserController {
    @RequestMapping("demo1")
    //获取Cookie的第一种方式
    public String method1(HttpServletRequest request) {
        Cookie[] cookies=request.getCookies();
        if(cookies != null) {
            for(Cookie cookie : cookies) {
                System.out.println(cookie.getName()+":"+cookie.getValue());
            }
        }
        return "获取cookie成功";
    }
    @RequestMapping("demo2")
    //获取Cookie的第二种方式
    public String method2(@CookieValue("name") String name) {
        return name;
    }
}

2.11 存储和获取Session--@SessionAttribute

存储Session：

package org.example.mvcdemo;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpSession;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/test")
public class UserController {
    @RequestMapping("demo1")
    public String method1(HttpServletRequest request) {
        //参数为true 如果session对象不存在，则创建一个session对象，反之直接返回
        HttpSession session=request.getSession(true);
        session.setAttribute("name","zhangsan");
        session.setAttribute("age",20);
        return "session设置成功";
    }
}

 获取Session：

package org.example.mvcdemo;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpSession;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/test")
public class UserController {
    @RequestMapping("demo1")
    //获取session的第一种方式
    public String method1(HttpServletRequest request) {
        //参数为false 如果不存在session,则返回null
        HttpSession session=request.getSession(true);
        if(session!=null){
            System.out.println(session.getAttribute("name"));
            System.out.println(session.getAttribute("age"));
        }
        return "session获取成功";
    }
    @RequestMapping("demo2")
    //获取session的第二种方式
    public String method2(HttpSession session) {
        System.out.println(session.getAttribute("name"));
        System.out.println(session.getAttribute("age"));
        return "session获取成功";
    }
    @RequestMapping("demo3")
    //获取session的第三种方式
    //与@RequestParam相同，required参数决定了name这个参数是否可以为空值，默认为true(不能为空值)
    public String method3(@SessionAttribute(value = "name",required = false) String name) {
        return "name:"+name;
    }
}

2.12 获取Header--@RequestHeader

package org.example.mvcdemo;
import jakarta.servlet.http.HttpServletRequest;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/test")
public class UserController {
    @RequestMapping("demo1")
    //获取Header的第一种方式
    public String method1(HttpServletRequest request) {
        String userAgent=request.getHeader("User-Agent");
        return userAgent;
    }
    @RequestMapping("demo2")
    //获取Header的第二种方式
    public String method2(@RequestHeader("User-Agent") String userAgent) {
        return userAgent;
    }
}

3.响应

HTTP的响应结果可以是数据，也可以是静态页面，我们可以针对响应去设置状态码，Header信息等。

3.1 返回静态页面--@Controller

@Controller用于返回页面，而一开始讲到的@RestController，是@Controller和@ResponseBody(返回数据)的结合，最终返回的是数据，所以在访问静态页面时，需要使用@Controller注释

package org.example.mvcdemo;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;
@Controller
@RequestMapping("/response")
//访问static/response(类路径)/index.html(返回页面)
public class UserController {
    @RequestMapping("demo1")
    public String method1() {
        return "/index.html";
    }
}

3.2 返回数据--@ResponseBody

@ResponseBody用于返回数据。它既是类注解，也是方法注解，当作用在类上时，表示类中的所有方法返回的都是数据，当作用在方法上时，表示该方法返回的是数据

package org.example.mvcdemo;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;
@Controller
@RequestMapping("/response")
public class UserController {
    @RequestMapping("demo1")
    @ResponseBody//method1方法返回数据
    public String method1() {
        return "/index.html";//返回字符串/index.html
    }
}

3.3 返回HTML代码片段

后端返回数据时，如果含有HTML代码，会被浏览器解析

package org.example.mvcdemo;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/response")
public class UserController {
    @RequestMapping("demo1")
    public String method1() {
        return "<h1>Hello,Spring MVC</h1>";
    }
}

3.4 返回json数据

当我们返回对象，map等数据时，Spring MVC会将其转换成json数据返回

package org.example.mvcdemo;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/response")
public class UserController {
    @RequestMapping("demo1")
    public UserInfo method1() {
        UserInfo userInfo=new UserInfo("zhangsan",18,"123456");
        return userInfo;
    }
}

3.5 设置状态码

通常Spring MVC会根据方法的返回结果自动设置响应状态码，但是我们也可以通过HttpServletResponse提供的方法手动指定状态码

package org.example.mvcdemo;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/response")
public class UserController {
    @RequestMapping("demo1")
    public String method1(HttpServletResponse response) {
        response.setStatus(400);
        return "设置状态码成功";
    }
}
椅子哥
关注
Spring Boot和Spring MVC常用注解
翱翔-蓝天
02-27 926
Spring Boot和Spring MVC的注解大大简化了配置和启动流程，使得开发者可以更加专注于业务逻辑的实现。
Spring MVC 的注解使用实例
01-09
以上就是Spring MVC中的一些核心注解用法，通过这些注解，开发者可以轻松地构建出松散耦合、易于维护的MVC应用。在实际开发中，结合Spring Boot和其他相关注解，如`@ComponentScan`、`@EnableWebMvc`等，可以进一步...
Spring MVC中常用注解的使用
大宝的博客
12-21 341
1、@Controller @Controller 用于标记在一个类上，使用它标记的类就是一个SpringMVC Controller 对象。分发处理器将会扫描使用了该注解的类的方法，并检测该方法是否使用了@RequestMapping 注解。@Controller 只是定义了一个控制器类，而使用@RequestMapping 注解的方法才是真正处理请求的处理器。 将控制器类交给Spring ...
请求响应-数组集合参数的接受
weixin_64939936的博客
07-11 872
关键代码如下：
springMVC后台接收类型为集合
qq_41816742的博客
11-16 899
1
spring web常用注解和方法传参介绍
2201_75456895的博客
03-21 1069
修饰类或接口，告诉spring帮我们管理这个类2. @Controller：修饰类，表示该类返回的是视图3. @ResponseBody：修饰类或方法，当一个类用Controller修饰时，若某个方法想返回数据，则可以用该注解修饰1. @RequestMapping：修饰类和方法，表示访问时的url路径2. @RequestParam：传递集合类时或修改请求中某个键的名字时需要加上，加上该注解默认required为true，即为必传属性。
【Spring】“请求“ 之后端传参重命名，传递数组、集合，@PathVariable，@RequestPart
最新发布
Yeeear的博客
10-07 5787
某些特殊情况下，前端传递的参数key和我们后端接收的key可以不一致，比如前端传了一个time给后端，而后端是使用createtime字段来接收的，这样就会出现参数接收不到的情况，如果出现这种情况，我们就可以使用来重命名前后端的参数值Springtimecreatetimecreatetimetime。
spring mvc常用注解_动力节点Java学院整理
08-29
Spring MVC常用注解 Spring MVC框架中大量使用了注解来简化开发过程，提高开发效率。下面我们将详细介绍Spring MVC中常用的注解。 1. @Controller注解 @Controller注解用于定义控制器，控制器是通过服务接口定义...
Spring MVC常用注解
06-02
下面将详细讲解 Spring MVC 中常用的注解。 1. `@Controller`：这个注解标记一个类作为 Spring MVC 的控制器。控制器负责接收 HTTP 请求并调用业务逻辑，然后将结果传递给视图层。例如： ```java @Controller ...
spring mvc常用注解用法说明
08-26
这是我根据自己使用springmvc的经验加上上网搜的资料整合而成，基本涵盖了springmvc常用的注解，以及注意的一些事项
集合参数@RequestParam
weixin_46597615的博客
05-29 343
集合参数@RequestParam
使用from-data传一个集合数据的时候，不能使用@RequestBody注解 要使用@RequestParam注解
qq_45841851的博客
12-01 1152
（3）其他格式，比如application/json,application/xml等，必须使用@RequestBody来处理。（1）application/x-www-form-urlencoded：@RequestBody不是必须加的。（2）mutipart/form-data：@RequestBody不能处理这种格式。查到的解决方法是在接口上加@RequestBody()注解。1、一个请求最多只能有一个@RequestBody注解。解决方法：添加@RequestParam注解。
前后端参数传递总结（@RequestParam @RequestBody@PathVariable）
yigan123的博客
10-31 2万+
前后端参数传递总结（@RequestParam @RequestBody@PathVariable @RequestHeader ）@RequestParam@RequestBody合理的创建标题，有助于目录的生成如何改变文本的样式 @RequestParam @RequestParam 常用来处理简单类型的绑定，通过Request.getParameter() 获取的String可直接转换为简单类型的情况（ String–> 简单类型的转换操作由ConversionService配置的转换器来完成
@RequestBody的使用
p_minipanda2的博客
10-15 560
https://blog.csdn.net/justry_deng/article/details/80972817 基础知识介绍： @RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的)；GET方式无请求体，所以使用@RequestBody接收数据时，前端不能使用GET方式提交数据，而是用POST方式进行提交。在后端的同一个接收方法里，...
@RequestParam 绑定List参数
热门推荐
weixin_30780221的博客
03-07 2万+
今天遇到了一个问题,比较尴尬. 我写了一个接口,参数用@RequestParam接收,是一个List<String>.用postman可以正常的调用. 但是其他组的开发用feignClient就无法调通,报400. 苦思冥想不清楚问题原因.后来想到应该是请求头的原因. 假如Content-Type 是 application/json,前台传来的是json的话,用@Reques...
转载get 、post请求 后台@RequestParam、@RequestBody 接收的方法集合
lv_dreamer的博客
03-30 913
https://blog.csdn.net/weixin_37270353/article/details/84067715
spring mvc 常用注解
08-24
综上所述，常用的Spring MVC注解包括@Controller、@RequestMapping、@ResponseBody、@RequestParam、@PathVariable、@Resource和@Autowired。这些注解在Spring MVC框架中起到了不同的作用，可以帮助我们更好地进行...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值