Spring MVC中的一些常用注解

港控/mmm° 2024-02-05 23:45 63阅读 0赞

**目录**

@RequestMapping

实现路由映射

限制请求方式

@PathVariable

从url中获取变量的值

更改绑定参数的名字

@RequestParam

可以传递集合

更改绑定参数的名字

可修改是否为必传参数

@RequestBody

获取请求正文的内容

可修改是否为必传参数

@RequestPart

可以支持上传文件

更改绑定参数的名字

可修改是否为必传参数

@Controller

@CookieValue

获取指定的Cookie值

@SessionAttribute

获取指定的Session值

@RequestHeader

获取请求头中的值

@Controller

返回html页面

@ResponseBody

设置返回类型为数据

--------------------

## @RequestMapping ##

这个注解既是类注解也是方法注解

### 实现路由映射 ###

这个注解主要来实现URL路由映射，也就是浏览器连接程序的作用。

url的组成：[http://IP:端口号/类注解/方法注解][http_IP]

@RestController
    public class LoginController {
        @RequestMapping("/fun1")
        public String fun1() {
            return "hahaha";
        }
    }

![860f2eb72bdc48c5b0647e8a777bb01b.png][]

@RequestMapping("/test")
    @RestController
    public class LoginController {
        @RequestMapping("/fun1")// "/"可写可不写
        public String fun1() {
            return "hahaha";
        }
    }

![251d137a46f04b9eb7d4092b3eca8de6.png][]

### 限制请求方式 ###

@RequestMapping("/test")
    @RestController
    public class LoginController {
        @RequestMapping(value = "/fun1", method = RequestMethod.GET)// 只接收GET请求
        public String fun1() {
            return "hahaha";
        }
    }

![315a47682df446699cc7d4ffc02bd715.png][]

## @PathVariable ##

### 从url中获取变量的值 ###

@RequestMapping("/fun2/{name}")
    public String fun2(@PathVariable String name) {
        return "name:"+name;
    }

![338c5384445b4b95b041f5ba837e68ca.png][]

![f4131f8f286d46ac9bac3ade92cdb9dc.png][]

### 更改绑定参数的名字 ###

![76fe501ff99e41dc900031e3ae9f1d87.png][]

此时形参username的名字就可以随意更改了。

## @RequestParam ##

### 可以传递集合 ###

如果不加 @RequestParam注释Spring会默认将前端传的集合转换成数组。

@RequestMapping("/fun3")
    public List<String> fun3(@RequestParam List<String> list) {
        return list;
    }

![33b0313ade624401969dee823cbf042f.png][]

@RequestMapping("/fun3")
    public List<String> fun3(List<String> list) {
        return list;
    }

![d82a956042d640f5ad5c5d6c39823f3f.png][]

### 更改绑定参数的名字 ###

@RequestMapping("/fun3")
    public List<String> fun3(@RequestParam("list") List<String> a) {
        return a;
    }

此时形参username的名字就可以随意更改了。

### 可修改是否为必传参数 ###

被@RequestParam修饰的参数默认为必传参数。

@RequestMapping("/fun3")
    public List<String> fun3(@RequestParam(value = "list", required = false) List<String> a) {
        return a;
    }

此时如果不传参数就不会报错。

![2dd09d9639004ef0b34c2bc64558d1c9.png][]

## @RequestBody ##

### 获取请求正文的内容 ###

@RequestMapping("/fun4")
    public String fun4(@RequestBody User user){
        return user.toString();
    }

![060d65de7a93401fb381195d74e92cd1.png][]

### 可修改是否为必传参数 ###

被@RequestBody修饰的参数默认为必传参数。

将其设置为非必传参数：

@RequestMapping("/fun4")
    public String fun4(@RequestBody(required = false) User user){
        return user.toString();
    }

## @RequestPart ##

### 可以支持上传文件 ###

@RequestMapping("/fun5")
    public String fun5(@RequestPart MultipartFile file){
        return file.getOriginalFilename();//返回文件名
    }

![46350476a6b142c389198924140cb58a.png][]

### 更改绑定参数的名字 ###

@RequestMapping("/fun5")
    public String fun5(@RequestPart("file") MultipartFile a){
        return a.getOriginalFilename();
    }

![763802a629104923b61def62593e6fdd.png][]

### 可修改是否为必传参数 ###

被@RequestPart修饰的参数默认为必传参数。

@RequestMapping("/fun5")
    //设置参数为非必传
    public String fun5(@RequestPart(value = "file", required = false) MultipartFile a){
        return a.getOriginalFilename();
    }

## @Controller ##

## @CookieValue ##

### 获取指定的Cookie值 ###

注：@CookieValue该注释只能获取一个Cookie值。

@RequestMapping("/fun6")
    //获取Cookie中键为name的值
    public String fun6(@CookieValue("name") String value) {
        return "name:"+value;
    }

首先在浏览器中创建一个 Cookie

![abc4167015e94a24b6e58c9488c55cea.png][]

![5fb5ccb7e9c24bd19f1dce6dc715c0c3.png][]

## @SessionAttribute ##

### 获取指定的Session值 ###

注：只能获取单个Session

//因为Session是服务器端的概念，所以获取之前应该先设置
    @RequestMapping("/fun7")
    public void fun7(HttpSession session) {
        //设置Session值
        session.setAttribute("name", "zhangsan");
    }
    //获取Session值
    @RequestMapping("/fun8")
    public String fun8(@SessionAttribute("name") String name) {
        return "name:"+name;
    }

![2468f7b84d1c4f519d7bbd2bf82978da.png][]

## @RequestHeader ##

### 获取请求头中的值 ###

下面这是一段请求头信息

![c75381957ebf4af3bf07ec8f7bcf9518.png][]

现在获取里面的Host的值

@RequestMapping("/fun9")
    public String fun9(@RequestHeader("Host") String data) {
        return "Host:"+data;
    }

![808425a04faa4261b2cba0b9b6b25afe.png][]

## @Controller ##

@Controller是一个类注解，它定义⼀个控制器，Spring框架启动时加载，把这个对象交给Spring管理。默认返回的是一个页面。

### 返回html页面 ###

先创建一个HTML页面login.html

里面只有一行代码：

![d42c6cf89186440b86bfc1b6dd3ed8c4.png][]

@Controller
    @RequestMapping("/test1")
    public class Test {
        @RequestMapping("/fun1")
        public String fun1() {
            return "/login.html";
        }
    }

![5d1d38f1ba664753b37731305d3036a7.png][]

## @ResponseBody ##

注：这个注解既可以修饰类，也可以修饰方法。

被修饰的类或方法都只能返回数据。

### 设置返回类型为数据 ###

@Controller
    @RequestMapping("/test1")
    public class Test {
        @ResponseBody
        @RequestMapping("/fun1")
        public String fun1() {
            return "/login.html";
        }
    }

![3698d8760c444d8d834814b69a594f5d.png][]

[http_IP]: http://127.0.0.1:8080/
[860f2eb72bdc48c5b0647e8a777bb01b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/b958e3d29ea049308799410f6261a49b.png
[251d137a46f04b9eb7d4092b3eca8de6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/7b287618d8e14b18b1e70497ca6c307a.png
[315a47682df446699cc7d4ffc02bd715.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/9f6caa354c5a49738c2acb9e1cba92aa.png
[338c5384445b4b95b041f5ba837e68ca.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/a932045d90574118823dae0478d6e8dd.png
[f4131f8f286d46ac9bac3ade92cdb9dc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/b859a9e9931f44a3b215ef52eeca9468.png
[76fe501ff99e41dc900031e3ae9f1d87.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/7b8c35f2e5f34c488c75ff24c028a07b.png
[33b0313ade624401969dee823cbf042f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/fee29ae8f59d4b77bf9e7f7fb246a804.png
[d82a956042d640f5ad5c5d6c39823f3f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/c3c040027f904ee8a289ad79434f4b07.png
[2dd09d9639004ef0b34c2bc64558d1c9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/4fac2366b08a49128b5bf3a570366cb5.png
[060d65de7a93401fb381195d74e92cd1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/5d557b0bc6b444d7aebd7c8c8e6ce2e5.png
[46350476a6b142c389198924140cb58a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/38ebadcf27bd479a86ee17e8bee30b53.png
[763802a629104923b61def62593e6fdd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/b8137ad2557940639c186f4e006c6dcf.png
[abc4167015e94a24b6e58c9488c55cea.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/60a0e21817ff47d590bf150a1cb51b27.png
[5fb5ccb7e9c24bd19f1dce6dc715c0c3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/03b53eacbd0a4da3b0bcab5566d2a548.png
[2468f7b84d1c4f519d7bbd2bf82978da.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/6b37fb4b68b24f4c87c81fd324c890f4.png
[c75381957ebf4af3bf07ec8f7bcf9518.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/d45ff13aa5dc4039b35ff59884505cb1.png
[808425a04faa4261b2cba0b9b6b25afe.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/fd4066d0e5f8453a83ea5f66efd5b3cb.png
[d42c6cf89186440b86bfc1b6dd3ed8c4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/42cc573bb6994328956f09af02eae049.png
[5d1d38f1ba664753b37731305d3036a7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/4797ba37d51848adbe2b3ac7c48b7d30.png
[3698d8760c444d8d834814b69a594f5d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/30/c6b8e4302f134c38a1a24a6a3e9bb80f.png