Spring MVC相关注解运用 —— 上篇

拼搏现实的明天。 2023-10-09 21:31 29阅读 0赞

**目录**

一、@Controller、@RequestMapping

1.1 示例程序

1.2 测试结果

二、@RequestParam

2.1 示例程序

2.2 测试结果

三、@RequestHeader、@CookieValue

3.1 示例程序

3.2 测试结果

四、@SessionAttributes

4.1 示例程序

4.2 测试结果

五、@ModelAttribute

5.1 示例程序

5.2 测试结果

往期专栏&文章相关导读

1. Maven系列专栏文章

2. Mybatis系列专栏文章

3. Spring系列专栏文章

4. Spring MVC系列专栏文章

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

## 一、@Controller、@RequestMapping ##

> @Controller：作用：标记控制器，将控制器交给Spring容器管理。
> 
> 位置：类上方

> @RequestMapping：作用：给控制器方法设置请求路径  
> 位置：方法或类上方。用于类上，表示类中的所有控制器方法都是以该地址作为父路径。  
> 属性：
> 
> 1.  value/path:请求路径
> 2.  method:指定请求方式
> 3.  params:规定必须发送的请求参数
> 4.  headers:规定请求必须包含的请求头

### 1.1 示例程序 ###

package com.example.controller;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.*;
    
    @Controller
    @RequestMapping("/c3")
    public class MyController3 {
        /**
         * 访问路径为 /c3/annotation1
         * 支持post和get请求
         * 请求时必须带有age参数
         * 请求时必须带有User-agent请求头
         * @param username
         * @return
         */
        @RequestMapping(path = "/annotation1",method = {RequestMethod.GET,RequestMethod.POST},params = {"age"},headers = {"User-agent"})
        public String annotation1(String username){
            System.out.println("annotation1\t"+username);
            return "lyl-HQX";
        }
    }

> 这里规定了请求参数必须带有age，但是下方方法参数列表没有age，那我们测试一下有age和无age。

### 1.2 测试结果 ###

> 如果请求路径为：[http://localhost:8080/c3/annotation1?age=10][http_localhost_8080_c3_annotation1_age_10]
> 
> 测试结果为：
> 
> ![d976b6971a08481e87fe6c54a7e1c4fe.png][]
> 
> 但是如果请求路径是： [http://localhost:8080/c3/annotation1?username=10][http_localhost_8080_c3_annotation1_username_10]
> 
> ![32430dae0db6441eacaad3811ebbbd58.png][] 可以看到就报错，因此确实需要带age参数
> 
> 因此请求路径应该写成这样：[http://localhost:8080/c3/annotation1?username=10&age=10][http_localhost_8080_c3_annotation1_username_10_age_10]
> 
> ![87084529048c4e1190c1cbe4f91f4179.png][]
> 
> 可以看到确实打印出了用户名10。

## 二、@RequestParam ##

> 作用：在控制器方法中获取请求参数  
> 位置：方法参数前  
> 属性：
> 
> 1.  name：指定请求参数名称
> 2.  defaultValue： 为参数设置默认值
> 3.  required：设置是否是必须要传入的参数

### 2.1 示例程序 ###

// 在控制器方法中获取请求参数
        @RequestMapping("/annotation2")
        public String annotation2(@RequestParam(name = "name",defaultValue = "HQX",required = false) String name){
            System.out.println("annotation2\t"+name);
            return "lyl-HQX";
        }

> 这个注解是修饰请求参数的相关属性，那我们有没有这个name属性应该都是可以的。

### 2.2 测试结果 ###

> 当请求路径为：[http://localhost:8080/c3/annotation2][http_localhost_8080_c3_annotation2]
> 
> ![f83d95dea7a844f4b560861f7538f040.png][]
> 
> 请求路径没有该参数了，该参数的默认值就是HQX，正常输出
> 
> 当请求路径为：[http://localhost:8080/c3/annotation2?name=LYL][http_localhost_8080_c3_annotation2_name_LYL]
> 
> ![c1285877f7df49ff8b4a8e786332b030.png][]
> 
> OK，当请求路径有该参数时，就按照请求路径的参数值来输出，可以看得到确实是测试成功了。

## 三、@RequestHeader、@CookieValue ##

> @RequestHeader
> 
>  *  作用：在控制器方法中获取请求头数据
>  *  位置：方法参数前
> 
> @CookieValue
> 
>  *  作用：在控制器方法中获取Cookie数据
>  *  位置：方法参数前

### 3.1 示例程序 ###

/**
         * @RequestHeader
         * 作用：在控制器方法中获取请求头数据
         * 位置：方法参数前
         * @CookieValue
         * 作用：在控制器方法中获取Cookie数据
         * 位置：方法参数前
         */
        // 获取User-Agent请求头和JSESSIONID的Cookie值
        @RequestMapping("/annotation3")
        public String annotation3(@RequestHeader("User-Agent")String userAgent, @CookieValue("JSESSIONID") String jSessionId){
            System.out.print("annotation3\t");
            System.out.println("userAgent: "+userAgent);
            System.out.print("jSessionId: " + jSessionId);
            return "lyl-HQX";
        }

### 3.2 测试结果 ###

> 请求路径：[http://localhost:8080/c3/annotation3][http_localhost_8080_c3_annotation3]
> 
> ![6d97c3942c50488eb2f8e04b98f82507.png][]
> 
> 可以看得到确实打印了请求头的相关数据：比如说windows系统，多少位，浏览器的版本等。sessionID也获取出来了。

## 四、@SessionAttributes ##

> 作用：将Model模型中的数据存到session域中  
> 位置：类上方

### 4.1 示例程序 ###

package com.example.controller;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.ui.Model;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.SessionAttributes;
    
    import javax.servlet.http.HttpSession;
    
    @Controller
    @RequestMapping("/c4")
    // 将Model模型中name的数据存到session域中
    @SessionAttributes("name")
    public class MyController4 {
        @RequestMapping("/t1")
        public String t1(Model model){
            // model1中保存name数据
            model.addAttribute("name","LYL");
            return "lyl-HQX";
        }
        @RequestMapping("/t2")
        public String t2(HttpSession session){
            // 从session中获取name数据
            System.out.println(session.getAttribute("name"));
            return "lyl-HQX";
        }
    }

### 4.2 测试结果 ###

> OK，从上面程序我们可以知道，要先访问/t1，再访问/t2，才可以获取name的值。直接访问/t2是无法打印出name的属性值的。接下来我们测试一下：
> 
> 当我们先访问/t2:：[http://localhost:8080/c4/t2][http_localhost_8080_c4_t2]
> 
> ![90427f9cf0a34e1cb568de4a0d3bc020.png][]
> 
> OK，可以看到确实是打印出null,
> 
> ![57bbc9cc7a564f68a140d5def09a179e.png][]
> 
> 并且浏览器也没有对应的值。
> 
> 接下来访问/t1，[http://localhost:8080/c4/t1][http_localhost_8080_c4_t1]
> 
> 添加值之后
> 
> ![cbcd6bab52214f7f8a0fd73244baf20e.png][]
> 
> 再访问/t2，可以看得到控制台确实打印出来了。
> 
> ![353ed6992ed843dca6f30a33217e923e.png][]

## 五、@ModelAttribute ##

> 作用1：设置指定方法在控制器其他方法前执行  
> 位置：方法上方
> 
> 作用2：从Model模型中获取数据给参数赋值  
> 位置：方法参数前

### 5.1 示例程序 ###

**作用一示例程序：**

package com.example.controller;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.ModelAttribute;
    import org.springframework.web.bind.annotation.RequestMapping;
    
    @Controller
    @RequestMapping("/c5")
    public class MyController5 {
        // @ModelAttribute作用1：设置指定方法在控制器其他方法前执行
        @ModelAttribute
        public void before(){
            System.out.println("前置方法");
        }
    
        @RequestMapping("/t1")
        public String t1(){
            System.out.println("t1");
            return "lyl-HQX";
        }
    }

**作用二示例程序：**

package com.example.controller;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.ui.Model;
    import org.springframework.web.bind.annotation.ModelAttribute;
    import org.springframework.web.bind.annotation.RequestMapping;
    
    @Controller
    @RequestMapping("/c5")
    public class MyController5 {
        // @ModelAttribute作用1：设置指定方法在控制器其他方法前执行
        @ModelAttribute
        public void before(Model model){
            System.out.println("前置方法");
            model.addAttribute("name","LYL");
        }
    
        @RequestMapping("/t1")
        public String t1(@ModelAttribute("name") String name){
            System.out.println(name);
            return "lyl-HQX";
        }
    }

### 5.2 测试结果 ###

> 作用一测试结果：[http://localhost:8080/c5/t1][http_localhost_8080_c5_t1]
> 
> ![8898d5cf44e34379a98120af17cb844f.png][]
> 
> OK，可以看得到前置方法确实生效了。

> 作用二测试结果：[http://localhost:8080/c5/t1][http_localhost_8080_c5_t1]
> 
> ![8fe0908cd2614bb188b4f2ab714c946c.png][]
> 
> ![7c872b211fe24ed2a021c451a7724464.png][] OK，可以看到确实两个作用都成功执行了。

## 往期专栏&文章相关导读 ##

> 大家如果对于本期内容有什么不了解的话也可以去看看往期的内容，下面列出了博主往期精心制作的Maven，Mybatis等专栏系列文章，走过路过不要错过哎！如果对您有所帮助的话就点点赞，收藏一下啪。其中Spring专栏有些正在更，所以无法查看，但是当博主全部更完之后就可以看啦。

### 1. Maven系列专栏文章 ###

<table> 
 <tbody> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/category_12258928.html" title="Maven系列专栏" rel="nofollow">Maven系列专栏</a></td> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/127848003" title="Maven工程开发" rel="nofollow">Maven工程开发</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129187397" title="Maven聚合开发【实例详解---5555字】" rel="nofollow">Maven聚合开发【实例详解---5555字】</a></td> 
  </tr> 
 </tbody> 
</table>

### 2. Mybatis系列专栏文章 ###

<table> 
 <tbody> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/category_12258926.html?spm=1001.2014.3001.5482" title="Mybatis系列专栏" rel="nofollow">Mybatis系列专栏</a></td> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129219355" title="MyBatis入门配置" rel="nofollow">MyBatis入门配置</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129219871" title="Mybatis入门案例【超详细】" rel="nofollow">Mybatis入门案例【超详细】</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129302923" title="MyBatis配置文件 —— 相关标签详解" rel="nofollow">MyBatis配置文件 —— 相关标签详解</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129762660" title="Mybatis模糊查询——三种定义参数方法和聚合查询、主键回填" rel="nofollow">Mybatis模糊查询——三种定义参数方法和聚合查询、主键回填</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129338508" title="Mybatis动态SQL查询 --（附实战案例--8888个字--88质量分）" rel="nofollow">Mybatis动态SQL查询 --（附实战案例--8888个字--88质量分）</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129849030" title="Mybatis分页查询——四种传参方式" rel="nofollow">Mybatis分页查询——四种传参方式</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129351561" title="Mybatis一级缓存和二级缓存（带测试方法）" rel="nofollow">Mybatis一级缓存和二级缓存（带测试方法）</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129634685" title="Mybatis分解式查询" rel="nofollow">Mybatis分解式查询</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129633599" title="Mybatis关联查询【附实战案例】" rel="nofollow">Mybatis关联查询【附实战案例】</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129648122" title="MyBatis注解开发---实现增删查改和动态SQL" rel="nofollow">MyBatis注解开发---实现增删查改和动态SQL</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129649043" title="MyBatis注解开发---实现自定义映射关系和关联查询" rel="nofollow">MyBatis注解开发---实现自定义映射关系和关联查询</a></td> 
  </tr> 
 </tbody> 
</table>

### 3. Spring系列专栏文章 ###

<table> 
 <tbody> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/category_12263380.html" title="Spring系列专栏" rel="nofollow">Spring系列专栏</a></td> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129779778?spm=1001.2014.3001.5502" title="Spring IOC 入门简介【自定义容器实例】" rel="nofollow">Spring IOC 入门简介【自定义容器实例】</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129780496" title="IOC使用Spring实现附实例详解" rel="nofollow">IOC使用Spring实现附实例详解</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129781123" title="Spring IOC之对象的创建方式、策略及销毁时机和生命周期且获取方式" rel="nofollow">Spring IOC之对象的创建方式、策略及销毁时机和生命周期且获取方式</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129874133" title="Spring DI简介及依赖注入方式和依赖注入类型" rel="nofollow">Spring DI简介及依赖注入方式和依赖注入类型</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129875785" title="Spring IOC相关注解运用——上篇" rel="nofollow">Spring IOC相关注解运用——上篇</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129881047" title="Spring IOC相关注解运用——下篇" rel="nofollow">Spring IOC相关注解运用——下篇</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129882550" title="Spring AOP简介及相关案例" rel="nofollow">Spring AOP简介及相关案例</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129886638" title="注解、原生Spring、SchemaBased三种方式实现AOP【附详细案例】" rel="nofollow">注解、原生Spring、SchemaBased三种方式实现AOP【附详细案例】</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129887452" title="Spring事务简介及相关案例" rel="nofollow">Spring事务简介及相关案例</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129888183" title="Spring 事务管理方案和事务管理器及事务控制的API" rel="nofollow">Spring 事务管理方案和事务管理器及事务控制的API</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/129907209" title="Spring 事务的相关配置、传播行为、隔离级别及注解配置声明式事务" rel="nofollow">Spring 事务的相关配置、传播行为、隔离级别及注解配置声明式事务</a></td> 
  </tr> 
 </tbody> 
</table>

### 4. Spring MVC系列专栏文章 ###

<table> 
 <tbody> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/category_12295839.html?spm=1001.2014.3001.5482" title="SpringMVC系列专栏" rel="nofollow">SpringMVC系列专栏</a></td> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/130274073" title="Spring MVC简介附入门案例" rel="nofollow">Spring MVC简介附入门案例</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/130372221" title="Spring MVC各种参数获取及获取方式自定义类型转换器和编码过滤器" rel="nofollow">Spring MVC各种参数获取及获取方式自定义类型转换器和编码过滤器</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/130375526" title="Spring MVC获取参数和自定义参数类型转换器及编码过滤器" rel="nofollow">Spring MVC获取参数和自定义参数类型转换器及编码过滤器</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/130448697" title="Spring MVC处理响应附案例详解" rel="nofollow">Spring MVC处理响应附案例详解</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/130500872" title="Spring MVC相关注解运用 —— 上篇" rel="nofollow">Spring MVC相关注解运用 —— 上篇</a></td> 
  </tr> 
  <tr> 
   <td> <p><a href="https://blog.csdn.net/qq_53317005/article/details/130502645" title="Spring MVC相关注解运用 —— 中篇" rel="nofollow">Spring MVC相关注解运用 —— 中篇</a></p> </td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/130507906" title="Spring MVC相关注解运用 —— 下篇" rel="nofollow">Spring MVC相关注解运用 —— 下篇</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/130529049" title="Spring MVC多种情况下的文件上传" rel="nofollow">Spring MVC多种情况下的文件上传</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/130534706" title="Spring MVC异步上传、跨服务器上传和文件下载" rel="nofollow">Spring MVC异步上传、跨服务器上传和文件下载</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/130535533" title="Spring MVC异常处理【单个控制异常处理器、全局异常处理器、自定义异常处理器】" rel="nofollow">Spring MVC异常处理【单个控制异常处理器、全局异常处理器、自定义异常处理器】</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/130536137" title="Spring MVC拦截器和跨域请求" rel="nofollow">Spring MVC拦截器和跨域请求</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://blog.csdn.net/qq_53317005/article/details/130568147" title="SSM整合案例【C站讲解最详细流程的案例】" rel="nofollow">SSM整合案例【C站讲解最详细流程的案例】</a></td> 
  </tr> 
 </tbody> 
</table>

[http_localhost_8080_c3_annotation1_age_10]: http://localhost:8080/c3/annotation1?age=10
[d976b6971a08481e87fe6c54a7e1c4fe.png]: https://img-blog.csdnimg.cn/d976b6971a08481e87fe6c54a7e1c4fe.png
[http_localhost_8080_c3_annotation1_username_10]: http://localhost:8080/c3/annotation1?username=10
[32430dae0db6441eacaad3811ebbbd58.png]: https://img-blog.csdnimg.cn/32430dae0db6441eacaad3811ebbbd58.png
[http_localhost_8080_c3_annotation1_username_10_age_10]: http://localhost:8080/c3/annotation1?username=10&age=10
[87084529048c4e1190c1cbe4f91f4179.png]: https://img-blog.csdnimg.cn/87084529048c4e1190c1cbe4f91f4179.png
[http_localhost_8080_c3_annotation2]: http://localhost:8080/c3/annotation2
[f83d95dea7a844f4b560861f7538f040.png]: https://img-blog.csdnimg.cn/f83d95dea7a844f4b560861f7538f040.png
[http_localhost_8080_c3_annotation2_name_LYL]: http://localhost:8080/c3/annotation2?name=LYL
[c1285877f7df49ff8b4a8e786332b030.png]: https://img-blog.csdnimg.cn/c1285877f7df49ff8b4a8e786332b030.png
[http_localhost_8080_c3_annotation3]: http://localhost:8080/c3/annotation3
[6d97c3942c50488eb2f8e04b98f82507.png]: https://img-blog.csdnimg.cn/6d97c3942c50488eb2f8e04b98f82507.png
[http_localhost_8080_c4_t2]: http://localhost:8080/c4/t2
[90427f9cf0a34e1cb568de4a0d3bc020.png]: https://img-blog.csdnimg.cn/90427f9cf0a34e1cb568de4a0d3bc020.png
[57bbc9cc7a564f68a140d5def09a179e.png]: https://img-blog.csdnimg.cn/57bbc9cc7a564f68a140d5def09a179e.png
[http_localhost_8080_c4_t1]: http://localhost:8080/c4/t1
[cbcd6bab52214f7f8a0fd73244baf20e.png]: https://img-blog.csdnimg.cn/cbcd6bab52214f7f8a0fd73244baf20e.png
[353ed6992ed843dca6f30a33217e923e.png]: https://img-blog.csdnimg.cn/353ed6992ed843dca6f30a33217e923e.png
[http_localhost_8080_c5_t1]: http://localhost:8080/c5/t1
[8898d5cf44e34379a98120af17cb844f.png]: https://img-blog.csdnimg.cn/8898d5cf44e34379a98120af17cb844f.png
[8fe0908cd2614bb188b4f2ab714c946c.png]: https://img-blog.csdnimg.cn/8fe0908cd2614bb188b4f2ab714c946c.png
[7c872b211fe24ed2a021c451a7724464.png]: https://img-blog.csdnimg.cn/7c872b211fe24ed2a021c451a7724464.png