【Spring MVC】Spring MVC的功能使用和相关注解介绍

news2024/11/25 23:43:52

Spring MVC主要有三个功能：

连接
获取参数
输出数据

对于 Spring MVC 来说，掌握了以上 3 个功能就相当于掌握了Spring MVC。

1.连接

连接的功能：将⽤户（浏览器）和 Java 程序连接起来，也就是访问⼀个地址能够调⽤到我们的Spring 程序。

1.1 实现 Spring MVC的连接

先创建一个SpringMVC项目，过程和SpringBoot项目创建相同。

可以参考这篇文章SpringBoot的创建和运行

接下来，创建⼀个 UserController 类，实现⽤户到 Spring 程序的互联互通，具体实现代码如下：

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller // 让 spring 框架启动时，加载
@ResponseBody // 返回⾮⻚⾯数据
@RequestMapping("/user") // 路由器规则注册
public class UserController {
 // 路由器规则注册
 	@RequestMapping("/hi")
 	public String sayHi(){
 		return "<h1>Hi,Spring MVC.</h1>";
 	}
}

这样实现之后，当访问地址：http://localhost:8080/user/hi 时就能打印“hello，spring mvc”的信息了。

1.2 注解介绍

@RequestMapping

@RequestMapping是⽤来注册接⼝的路由映射的。

路由映射：所谓的路由映射指的是，当⽤户访问⼀个 url 时，将⽤户的请求对应到程序中某个类的某个⽅法的过程就叫路由映射

@RequestMapping 即可修饰类，也可以修饰⽅法，当修饰类和⽅法时，访问的地址是类 + ⽅法。
@RequestMapping 既是post请求又是get请求。

@Controller
@RequestMapping("/web")
public class WebController {

    //响应视图
    @RequestMapping("/index")
    public String index(){
        return "/index.html";
    }
    //响应正文
    @ResponseBody
    @RequestMapping("/indexData")
    //只支持get请求
    //@RequestMapping(value = "/indexData",method = RequestMethod.GET)
    public String indexData(){
        return "hello,MVC";
    }
}

@GetMapping

实现get请求。

get请求的三种写法：

// 写法1
@RequestMapping("/index")
// 写法2
@RequestMapping(value = "/index",method = RequestMethod.GET)
// 写法3
@GetMapping("/index")

@PostMapping

实现post请求。

post请求的两种写法：

// 写法1
@RequestMapping(value = "/index",method = RequestMethod.POST)
// 写法2
@PostMapping("/index")

2.获取参数

2.1 传递单个参数

在 Spring MVC 中可以直接⽤⽅法中的参数来实现传参，⽐如以下代码：

@RestController
@RequestMapping("/param")
public class ParamController {

    //servlet传参
    @RequestMapping("/get1")
    public String get1(HttpServletRequest request){
        String name=request.getParameter("name");
        return "name:"+name;
    }
    //MVC传参
    @RequestMapping("/get2")
    public String get2(String name){
        return "name:"+name;
    }
    //多个参数传参
    @RequestMapping("/get3")
    public String get3(String name,Integer age){
        return "name:"+name+"|age:"+age;
    }
}

2.2 传递对象

定义一个Student类：

@Data
public class Student {
    private Integer id;
    private String name;
    private Integer age;
}

传递对象代码实现：

    @RequestMapping("/get6")
    public String get6(Student student){
        return student.toString();
    }

2.3 后端参数重命名

某些特殊的情况下，前端传递的参数 key 和我们后端接收的 key 可以不⼀致，⽐如前端传递了⼀个
n 给后端，⽽后端⼜是由name 字段来接收的，这样就会出现参数接收不到的情况，如果出现
这种情况，我们就可以使⽤ @RequestParam 来重命名前后端的参数值。

代码实现：

    @RequestMapping("/get7")
    public String get7(@RequestParam(name="n",required = false) String name){
        return "name:"+name;
    }

参数必传：将required设置成false,来避免不传递时报错

2.4 接收JSON对象

@RequestBody

上传一个json格式的数据：

在这里插入图片描述

后端接收代码实现：

    @RequestMapping("/get8")
    public String get8(@RequestBody Student student){
        log.info(student.toString());
        return student.toString();
    }

@RequestBody表示接收的是一个json字符串，String会帮我们把这个字符串转为对象。

2.5 获取URL中参数

@PathVariable

给定一个URL：
在这里插入图片描述
实现代码：

    @RequestMapping("/get9/{shopid}")
    public String get9(@PathVariable Integer shopid){
        return "shopid:"+shopid;
    }

2.6 上传文件

@RequestPart

实现代码：

    @RequestMapping("/get10")
    public String get10(@RequestPart("file") MultipartFile file) throws IOException {
        log.info(file.getOriginalFilename());
        file.transferTo(new File("D:\\Desktop\\Bit\\temp"+file.getOriginalFilename()));
        return "success";
    }

2.7 获取Cookie/Session/header

@CookieValue

获取Session实现代码：

    @RequestMapping("/get11")
    public String get11(@CookieValue(required = false) String bite){
        return "bite:"+bite;
    }

@SessionAttribute

设置Session实现代码：

    @RequestMapping("/get12")
    public String get12(@SessionAttribute(required = false) String username){
        return "username:"+username;
    }

设置之后，cookie中会多一个sessionId。

@RequestHeader

获取Header内容实现代码：

    @RequestMapping("/get13")
    public String get13(@RequestHeader("User-Agent") String useragent){
        return "useragent:"+useragent;
    }

2.8 返回JSON对象

实现代码：

    @RequestMapping("/get14")
    public Map<String,String> get14(){
        Map<String,String>map=new HashMap<>();
        map.put("k1","v1");
        map.put("k2","v2");
        map.put("k3","v3");
        map.put("k4","v4");
        return map;
    }

3.输出数据

3.1 返回静态页面

实现代码：

    //响应视图
    @RequestMapping("/index")
    public String index(){
        return "/index.html";
    }

3.2 返回text正文

@ResponseBody

实现代码：

	//响应正文
    @ResponseBody

> 这里是引用

    @RequestMapping("/indexData")
    public String indexData(){
        return "hello,MVC";
    }
}

4.请求转发和请求重定向

return 不但可以返回⼀个视图，还可以实现跳转，跳转的⽅式有两种：

forward：请求转发；
redirect：请求重定向。

举例说明： forward（请求转发）和 redirect（请求重定向）的区别

你告诉你妈妈，你想吃辣条，如果你妈妈，说好，我帮你去买，这就是 forward 请求转发；如果你妈妈让你⾃⼰去买，那么就是
请求 redirect 重定向

4.1 请求转发forward

代码实现：

    /**
     * 请求转发
     * @return
     */
    @RequestMapping("/forward")
    public String forward(){
        return "forward:/index.html";
    }

4.2 请求重定向redirect

代码实现：

    /**
     * 请求重定向
     * @return
     */
    @RequestMapping("/redirect")
    public String redirect(){
        return "redirect:/index.html";
    }