（二）SpringMVC中的常用注解

最新推荐文章于 2022-04-06 10:42:16 发布

Jacobshash

最新推荐文章于 2022-04-06 10:42:16 发布

阅读量148

点赞数

本文链接：https://blog.csdn.net/LOL_toulan/article/details/104395612

版权

Spring MVC 专栏收录该内容

9 篇文章 0 订阅

订阅专栏

SpringMVC中的常用注解

本篇博客源码GitHub地址：源码地址

注解名	作用
@RequestMapping	用于建立请求 URL 和处理请求方法之间的对应关
@RequestParam	把请求中指定名称的参数给控制器中的形参赋值。
@RequestBody	用于获取请求体内容。直接使用得到是 key=value&key=value…结构的数据。get 请求方式不适用。
@PathVaribale	用于绑定 url 中的占位符。例如：请求 url 中 /delete/{id}，这个{id}就是 url 占位符。url 支持占位符是 spring3.0 之后加入的。是 springmvc 支持 rest 风格 URL 的一个重要标志。
@RequestHeader	用于获取请求消息头。
@CookieValue	用于把指定 cookie 名称的值传入控制器方法参数
@ModelAttribute	该注解是 SpringMVC4.3 版本以后新加入的。它可以用于修饰方法和参数。出现在方法上，表示当前方法会在控制器的方法执行之前，先执行。它可以修饰没有返回值的方法，也可以修饰有具体返回值的方法。出现在参数上，获取指定的数据给参数赋值。
@SessionAttribute	用于多次执行控制器方法间的参数共享。

RequestMapping

我们查看RequestMapping的注解类发现，
在这里插入图片描述
出现位置：
类上： 请求 URL 的第一级访问目录。此处不写的话，就相当于应用的根目录。写的话需要以/开头。
它出现的目的是为了使我们的 URL 可以按照模块化管理。
方法上： 请求 URL 的第二级访问目录。
属性：

属性名	作用
value	用于指定请求的 URL。它和 path 属性的作用是一样的。
method	用于指定请求的方式。
params	用于指定限制请求参数的条件。它支持简单的表达式。要求请求参数的 key 和 value 必须和配置的一模一样。
headers	用于指定限制请求消息头的条件。
consumes	指定处理请求的提交内容类型（Content-Type），例如application/json, text/html;
produces	指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回

例如：
params = {“accountName”}，表示请求参数必须有 accountName
params = {“moeny!100”}，表示请求参数中 money 不能是 100。

注意：

以上四个属性只要出现 2 个或以上时，他们的关系是与的关系
其中，consumes， produces使用content-typ信息进行过滤信息；headers中可以使用content-type进行过滤和判断。
这里的Headers里面可以匹配所有Header里面可以出现的信息。
当你有如下Accept头，将遵守如下规则进行应用：
- Accept：text/html,application/xml,application/json
  将按照如下顺序进行produces的匹配 ①text/html ②application/xml ③application/json
- Accept：application/xml;q=0.5,application/json;q=0.9,text/html
  将按照如下顺序进行produces的匹配 ①text/html ②application/json ③application/xml参数为媒体类型的质量因子，越大则优先权越高(从0到1)
- Accept：*/*,text/*,text/html
  将按照如下顺序进行produces的匹配①text/html ②text/* ③*/*

核心代码：

我们请求该方法时的请求路径为：http://localhost:8080/springmvc_introduction_demo01_war/test/hello

@Controller
@RequestMapping("/test")
public class HelloController {

    @RequestMapping("/hello")
    public String hello(){
        System.out.println("hello springMVC");
        return "success";
    }
}

在这里插入图片描述
我们请求该方法时的请求路径为：http://localhost:8080/springmvc_introduction_demo01_war/hello

@Controller
public class WorldController {
    @RequestMapping("hello")
    public String hello(){
        System.out.println("hello springMVC");
        return "success";
    }
}

在这里插入图片描述

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
hello world!

<a href="test/hello?username=hehe">简单案例</a>
<a href="hello">简单案例</a>
</body>
</html>

@Controller
@RequestMapping("/test")
public class HelloController {

    @RequestMapping(value = "/hello",method = RequestMethod.GET,params = {"username=hehe"},headers = "Accept")
    public String hello(){
        System.out.println("hello springMVC");
        return "success";
    }
}

有参数
在这里插入图片描述
没有参数

参数错误

源代码：

HelloController .java

@Controller
@RequestMapping("/test")
public class HelloController {

    @ResponseBody
    @RequestMapping(value = "/hello",method = RequestMethod.GET,params = {"username=hehe"})
    public String hello(){
        System.out.println("hello springMVC");
        return "success";
    }
}

WorldController.java

@Controller
public class WorldController {
    @RequestMapping("hello")
    public String hello(){
        System.out.println("hello springMVC");
        return "success";
    }
}

springmvc.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd">

    <!-- 开启注解扫描，因为需要将该xml加载到项目中，所以，将该文件配置到web.xml中，让核心控制器加载的时候将该文件也加载到项目中 -->
    <context:component-scan base-package="com.toulan"></context:component-scan>
    <!--
        例如：某个请求的全路径为:http://localhost:8080/springmvc_introduction_demo01_war/WEB-INF/pages/success.jsp

        因为我们的项目启动地址为 http://localhost:8080/springmvc_introduction_demo01_war 所以当
        prefix：/WEB-INF/pages/
        suffix：.jsp

        我们在controller层return页面时就只需要传jsp页面的名称: success ，如果我们此处不配置suffix 我们就需要传success.jsp  return "success.jsp";
        如果此处不写 prefix  suffix 那么我们在控制层就需要返回 /WEB-INF/pages/success.jsp  return "/WEB-INF/pages/success.jsp";
    -->
    <!--配置视图解析器对象-->
    <!--通过Spring的IOC容器，创建InternalResourceViewResolver对象，并使用-->
    <bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <!-- 在构建URL时用于查看名称的前缀，通俗点讲，就是浏览器请求路径的前缀 -->
        <property name="prefix" value="/WEB-INF/pages/"></property>
        <!-- 在构建URL时附加到视图名称的后缀 -->
        <property name="suffix" value=".jsp"></property>

    </bean>

    <!--开启SpringMVC框架注解的支持，例如RequestMapping等
    同时使用 <mvc:annotation-driven> 自动加载 RequestMappingHandlerMapping （处理映射器） 和
    RequestMappingHandlerAdapter （ 处 理 适 配 器 ） ， 可 用 在 SpringMVC.xml 配 置 文 件 中 使 用
    <mvc:annotation-driven>替代注解处理器和适配器的配置。
    -->
    <mvc:annotation-driven></mvc:annotation-driven>
</beans>

web.xml

<!DOCTYPE web-app PUBLIC
        "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
        "http://java.sun.com/dtd/web-app_2_3.dtd" >

<web-app>
<display-name>Archetype Created Web Application</display-name>
<!--创建核心控制器，所有的请求都会经过改类然后通过该servlet，通过该servlet对请求进行分发-->
<servlet>
    <servlet-name>dispatcherServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
        <!--将配置文件springmvc.xml加载到项目中-->
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:springmvc.xml</param-value>
    </init-param>
    <!--看最下面-->
    <load-on-startup>1</load-on-startup>
</servlet>

<servlet-mapping>
    <servlet-name>dispatcherServlet</servlet-name>
    <!--拦截所有请求-->
    <url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>

index.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
hello world!

<a href="test/hello?username=hehe">简单案例</a>
<a href="hello">简单案例</a>
</body>
</html>

success.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
<span id="address"></span>
<script type="text/javascript">
    var url = document.location;
    document.getElementById("address").innerHTML=url;
</script>
</body>
</html>

RequestParam

作用：

把请求中指定名称的参数给控制器中的形参赋值

属性：

value：请求参数中的名称。
required：请求参数中是否必须提供此参数。默认值：true。表示必须提供，如果不提供将报错

核心代码：

@Controller
@RequestMapping("/test")
public class HelloController {
    @RequestMapping("/testRequestParam")
    public String testServletAPI(@RequestParam(value = "name",required = true) String username
                                ,@RequestParam(value = "age",required = false) Integer age,
                                 String email) {
        System.out.println(username+"=="+age+"=="+email);
        return "success";
    }
}

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<a href="test/testRequestParam?name=test&email=123@12.com">requestParam 注解(没有age)</a><br>
<a href="test/testRequestParam?age=10">requestParam 注解(没有name)</a><br>
<a href="test/testRequestParam?name=test&age=10">requestParam 注解.(没有email)</a><br>
<a href="test/testRequestParam?name=test&age=10&email=123@12.com">requestParam 注解.(都有)</a><br>
</body>
</html>

在这里插入图片描述

RequestBody

作用：

用于获取请求体内容。直接使用得到是 key=value&key=value…结构的数据。get 请求方式不适用。

属性：

required：是否必须有请求体。默认值是:true。当取值为 true 时,get 请求方式会报错。如果取值为 false，get 请求得到是 null。

核心代码：

    /**
     * testRequestBody
     * @param body
     * @return
     */
    @RequestMapping("/testRequestBody")
    public String testRequestBody(@RequestBody String body) {
        System.out.println(body);
        return "success";
    }

<form action="test/testRequestBody" method="post">
    <table border="1px">
        <tr>
            <td>用户名:</td>
            <td><input name="username" type="text"></td>
        </tr>
        <tr>
            <td>年龄:</td>
            <td><input name="age" type="text"></td>
        </tr>
        <tr>
            <td>email:</td>
            <td><input name="email" type="text"></td>
        </tr>
        <tr>
            <td><input type="submit" value="提交"></td>
        </tr>
    </table>
</form>

<a href="test/testRequestBody?username=test&age=10&email=123@12.com">RequestBody测试</a><br>

在这里插入图片描述
第一次点击超链接出错

第二次点击表单提交

当改变代码

    @RequestMapping("/testRequestBody")
    public String testRequestBody(@RequestBody(required = false) String body) {
        System.out.println(body);
        return "success";
    }

在这里插入图片描述

PathVaribale

作用：

用于绑定 url 中的占位符。例如：请求 url 中 /delete/{id}，这个{id}就是 url 占位符。url 支持占位符是 spring3.0 之后加入的。是 springmvc 支持 rest 风格 URL 的一个重要标志。

属性：

value：用于指定 url 中占位符名称。
required：是否必须提供占位符。

核心代码：

    @RequestMapping("/testPathVariable/{id}")
    @ResponseBody
    public String testPathVariable(@PathVariable("id") Integer id){
        System.out.println("用户Id:" + id);
        return "success";
    }

<a href="test/testPathVariable/101">RequestBody测试</a><br>

在这里插入图片描述

RequestHeader

作用：

用于获取请求消息头。

属性：

value：提供消息头名称
required：是否必须有此消息头

注：

在实际开发中一般不怎么用。

核心代码：

    @RequestMapping("/testRequestHeader")
    public String testRequestHeader(@RequestHeader(value="Accept", required=false)
    								String requestHeader){
        System.out.println(requestHeader);
        return "success";
    }

<a href="test/testRequestHeader">获取请求消息头</a>

在这里插入图片描述

CookieValue

作用：

用于把指定 cookie 名称的值传入控制器方法参数。

属性：

value：指定 cookie 的名称。
required：是否必须有此 cookie。

核心代码：

    /**
     * 设置cookie
     * @param request
     * @param response
     * @return
     */
    @RequestMapping("/setCookieValue")
    public String setCookieValue(HttpServletRequest request,
                                 HttpServletResponse response){

        Cookie cookie = new Cookie("beauty", "chengguo");
        response.addCookie(cookie);
        return "success";
    }


    /**
     * 获取cookie
     * @param cookieValue
     * @return
     */
    @RequestMapping("/testCookieValue")
    public String testCookieValue(@CookieValue(value="beauty",required=false)
                                         String cookieValue){

        System.out.println(cookieValue);
        return "success";
    }

<a href="test/setCookieValue">设置 cookie 的值</a><br/>
<a href="test/testCookieValue">获取 cookie 的值</a><br/>

在这里插入图片描述

ModelAttribute

作用：

该注解是 SpringMVC4.3 版本以后新加入的。它可以用于修饰方法和参数。
出现在方法上，表示当前方法会在控制器的方法执行之前，先执行。它可以修饰没有返回值的方法，也可以修饰有具体返回值的方法。
出现在参数上，获取指定的数据给参数赋值。

属性：

value：用于获取数据的 key。key 可以是 POJO 的属性名称，也可以是 map 结构的 key。

应用场景：

当表单提交数据不是完整的实体类数据时，保证没有提交数据的字段使用数据库对象原来的数据。
例如：
- 我们在编辑一个用户时，用户有一个创建信息字段，该字段的值是不允许被修改的。在提交表单数据是肯定没有此字段的内容，一旦更新会把该字段内容置为 null，此时就可以使用此注解解决问题。

核心代码：

下面演示当表单提交数据不是完整的实体类数据时

public class User {
    private String username;
    private String password;
    private Date date;
    private Integer age;
    //setter and getter
    //toString
    }

    @RequestMapping("/testModelAttribute")
    public String testModelAttribute(User user) {

        System.out.println("testModelAttribute执行了");
        System.out.println(user);
        return "success";
    }

    @ModelAttribute
    public void showUser() {
        System.out.println("showUser执行了");
    }

<form action="test/testModelAttribute">
    <table border="1px">
        <tr>
            <td>用户名:</td>
            <td><input name="username" type="text"></td>
        </tr>
        <tr>
            <td>密码:</td>
            <td><input name="password" type="text"></td>
        </tr>
        <tr>
            <td>年龄:</td>
            <td><input name="age" type="text"></td>
        </tr>
        <tr>
            <td><input type="submit" value="提交"></td>
        </tr>
    </table>
</form>

我们发现上面的代码jsp页面中的字段没有展示全，一般我们这样会报错，但是我们加上注解之后，程序会先走注解所在的方法，
在这里插入图片描述

ModelAttribute 修饰方法带返回值

**需求：**修改用户信息，要求用户的生日不能修改

    @RequestMapping("/testModelAttribute")
    public String testModelAttribute(User user) {

        System.out.println("testModelAttribute执行了");
        System.out.println(user);
        return "success";
    }

    @ModelAttribute
    public User showUser(String username, Integer age) {
        //通过username查询数据库中的信息(模拟)
        User user = new User();
        user.setUsername(username);
        user.setPassword("loltoulan");
        user.setAge(age);
        user.setDate(new Date());
        return user;
    }

<form action="test/testModelAttribute">
    <table border="1px">
        <tr>
            <td>用户名:</td>
            <td><input name="username" type="text"></td>
        </tr>
        <tr>
            <td>密码:</td>
            <td><input name="password" type="text" value="loltoulan" disabled="disabled"></td>
        </tr>
        <%--<tr>
            <td>生日:</td>
            <td><input name="date" type="text"></td>
        </tr>--%>
        <tr>
            <td>年龄:</td>
            <td><input name="age" type="text" ></td>
        </tr>
        <tr>
            <td><input type="submit" value="提交"></td>
        </tr>
    </table>
</form>

在这里插入图片描述

ModelAttribute 修饰方法不带返回值

	//从map中取出数据
    @RequestMapping("/testModelAttribute")
    public String testModelAttribute(@ModelAttribute("show") User user) {

        System.out.println("testModelAttribute执行了");
        System.out.println(user);
        return "success";
    }

    @ModelAttribute
    public void showUser(String username, Integer age,Map<String,User> userMap) {
        //通过username查询数据库中的信息(模拟)
        User user = new User();
        user.setUsername(username);
        user.setPassword("loltoulan");
        user.setAge(age);
        user.setDate(new Date());
      	//将数据存到map中
        userMap.put("show", user);
    }

<form action="test/testModelAttribute">
    <table border="1px">
        <tr>
            <td>用户名:</td>
            <td><input name="username" type="text"></td>
        </tr>
        <tr>
            <td>密码:</td>
            <td><input name="password" type="text" value="loltoulan"></td>
        </tr>
        <%--<tr>
            <td>生日:</td>
            <td><input name="date" type="text"></td>
        </tr>--%>
        <tr>
            <td>年龄:</td>
            <td><input name="age" type="text" ></td>
        </tr>
        <tr>
            <td><input type="submit" value="提交"></td>
        </tr>
    </table>
</form>

在这里插入图片描述

SessionAttribute

作用：

用于多次执行控制器方法间的参数共享。

属性：

value：用于指定存入的属性名称
type：用于指定存入的数据类型。

在这里插入图片描述
简单案例：

@Controller
@RequestMapping("session")
@SessionAttributes("msg")
public class SessionAttributeControllers {

    @RequestMapping("/testSessionAttributes")
    public String testSessionAttributes(Model model){
        System.out.println("testSessionAttributes....");
        model.addAttribute("msg", "犬来八荒(成果)");
        System.out.println("存入了数据");
        return "success";
    }
    //Model 是 spring 提供的一个接口，该接口有一个实现类 ExtendedModelMap
    //该类继承了 ModelMap，而 ModelMap 就是 LinkedHashMap 子类
    @RequestMapping("/getSessionAttributes")
    public String getSessionAttributes(ModelMap model){
        System.out.println();
        System.out.println("getSessionAttributes....");
        String msg = (String) model.get("msg");
        System.out.println(msg);
        return "success";
    }
    @RequestMapping("/delSessionAttributes")
    public String delSessionAttributes(SessionStatus sessionStatus) {
        System.out.println("delSessionAttributes....");
        sessionStatus.setComplete();
        return "success";
    }
}

<a href="session/testSessionAttributes">存入 SessionAttribute</a>
<hr/>
<a href="session/getSessionAttributes">取出 SessionAttribute</a>
<hr/>
<a href="session/delSessionAttributes">清除 SessionAttribute</a>

在这里插入图片描述

复杂核心代码：

@Controller("sessionAttributeController")
@RequestMapping("/springmvc")
@SessionAttributes(value ={"username","password"},types={Integer.class})
public class SessionAttributeController {
    /**
     * 把数据存入 SessionAttribute
     * @param model
     * @return
     * Model 是 spring 提供的一个接口，该接口有一个实现类 ExtendedModelMap
     * 该类继承了 ModelMap，而 ModelMap 就是 LinkedHashMap 子类
     */
    @RequestMapping("/testPut")
    public String testPut(Model model){
        model.addAttribute("username", "泰斯特");
        model.addAttribute("password","123456");
        model.addAttribute("age", 31);
        //跳转之前将数据保存到 username、password 和 age 中，因为注解@SessionAttribute 中有这几个参数
        System.out.println("存入了数据");
        return "success";
    }

    @RequestMapping("/testGet")
    public String testGet(ModelMap model){

        System.out.println(model.get("username")+";"+model.get("password")+";"+model.get("age"));

        return "success";
    }

    @RequestMapping("/testClean")
    public String complete(SessionStatus sessionStatus){
        sessionStatus.setComplete();
        System.out.println("销毁了数据");
        return "success";
    }
}

<!-- SessionAttribute 注解的使用 -->
<a href="springmvc/testPut">存入 SessionAttribute</a>
<hr/>
<a href="springmvc/testGet">取出 SessionAttribute</a>
<hr/>
<a href="springmvc/testClean">清除 SessionAttribute</a>

在这里插入图片描述

Jacobshash

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
（二）SpringMVC中的常用注解

SpringMVC注解注解名作用@RequestMapping用于建立请求 URL 和处理请求方法之间的对应关我们查看RequestMapping的注解类发现，出现位置：类上：请求 URL 的第一级访问目录。此处不写的话，就相当于应用的根目录。写的话需要以/开头。它出现的目的是为了使我们的 URL 可以按照模块化管理。方法上：请求 URL 的第二级访问目...
复制链接

扫一扫