Spring MVC常用注解及用法

椅子哥2024-08-28 18:02

目录

1.建立连接--@RequestMapping

2.请求

[2.1 传递单个参数](#2.1 传递单个参数)

[2.2 传递多个参数](#2.2 传递多个参数)

[2.3 传递对象](#2.3 传递对象)

[2.4 参数重命名--@RequestParam](#2.4 参数重命名--@RequestParam)

[2.5 传递数组](#2.5 传递数组)

[2.6 传递集合](#2.6 传递集合)

[2.7 传递json数据--@RequestBody](#2.7 传递json数据--@RequestBody)

[2.8 获取URL中参数--@PathVariable](#2.8 获取URL中参数--@PathVariable)

[2.9 上传文件--@RequestPart](#2.9 上传文件--@RequestPart)

[2.10 获取Cookie--@CookieValue](#2.10 获取Cookie--@CookieValue)

[2.11 存储和获取Session--@SessionAttribute](#2.11 存储和获取Session--@SessionAttribute)

[2.12 获取Header--@RequestHeader](#2.12 获取Header--@RequestHeader)

3.响应

[3.1 返回静态页面--@Controller](#3.1 返回静态页面--@Controller)

[3.2 返回数据--@ResponseBody](#3.2 返回数据--@ResponseBody)

[3.3 返回HTML代码片段](#3.3 返回HTML代码片段)

[3.4 返回json数据](#3.4 返回json数据)

[3.5 设置状态码](#3.5 设置状态码)

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

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

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

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

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

1.建立连接--@RequestMapping

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

java 复制代码 
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既可以修饰方法，也可以修饰类。当同时修饰类和方法时，访问的地址是类路径+方法路径

java 复制代码 
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请求等，我们可以通过设置参数来指定请求的类型，或者使用特定的注解

java 复制代码 
@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赋值给该参数

java 复制代码 
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传递参数

java 复制代码 
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会自动实现对对象参数的赋值

java 复制代码 
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这个注释来重命名参数

java 复制代码 
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可以自动绑定数组参数的赋值

java 复制代码 
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注释来绑定参数关系，从而确保传递的参数是集合类

java 复制代码 
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注释将请求正文中的数据与后端参数进行绑定

java 复制代码 
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路径上的数据绑定

java 复制代码 
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

java 复制代码 
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

java 复制代码 
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：

java 复制代码 
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：

java 复制代码 
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

java 复制代码 
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注释

java 复制代码 
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用于返回数据。它既是类注解，也是方法注解，当作用在类上时，表示类中的所有方法返回的都是数据，当作用在方法上时，表示该方法返回的是数据

java 复制代码 
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代码，会被浏览器解析

java 复制代码 
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数据返回

java 复制代码 
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提供的方法手动指定状态码

java 复制代码 
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 "设置状态码成功";
    }
}
相关推荐
积跬步DEV2 分钟前
Claude Prompt 汉语新解
开发语言·前端·javascript
dot.Net安全矩阵11 分钟前
.NET 一款在线解密Web.config的脚本
前端·学习·安全·web安全·oracle·矩阵·.net
菜♕卷11 分钟前
SpringCloud-04 OpenFeign服务调用与负载均衡
spring·spring cloud·负载均衡
虚无火星车13 分钟前
说说停止线程池的执行流程？
java·开发语言
奔跑的代码！14 分钟前
sass实现文字两侧横线
前端·vue·sass
新手小袁_J15 分钟前
SpringBoot整合JDBCTemplate（day34）
java·spring boot·后端·spring·spring cloud·maven
计算机学姐20 分钟前
基于python+django+vue的社区爱心养老管理系统
开发语言·vue.js·后端·python·mysql·django·web3.py
正小安21 分钟前
使用Nignx打包前端项目
前端·vue.js·nginx·阿里云
Flying_Fish_roe25 分钟前
Reactive 编程-Loom 项目（虚拟线程）
java
promise52426 分钟前
Linux cat命令详解使用：高效文本内容管理
linux·运维·服务器·后端·bash
热门推荐
01RAG 实践- Ollama+RagFlow 部署本地知识库022024年高教社杯数学建模国赛C题超详细解题思路分析03【2024数模国赛赛题思路公开】国赛B题思路丨附可运行代码丨无偿自提04Codeforces 969 div2[A~E] 个人题解05【2024高教社杯全国大学生数学建模竞赛】B题 生产过程中的决策问题——解题思路 代码 论文062024 高教社杯 数学建模国赛 （A题）深度剖析|“板凳龙” 闹元宵|数学建模完整代码+建模过程全解全析07【经验分享】Ubuntu22.04安装微信(linux官方版)082024数学建模国赛高教社杯C题:农作物的种植策略 思路代码文章助攻手把手保姆级092024年高教杯国赛（C题）数学建模竞赛解题思路|完整代码论文集合10Coze扣子平台完整体验和实践（附国内和国际版对比）