基础框架 SpringMVC常用注解详解

心已赠人 2023-01-01 07:58 122阅读 0赞

## 基础框架 SpringMVC常用注解详解 ##

### 一、RequestMapping注解 ###

#### 1.RequestMapping注解的作用 ####

RequestMapping注解的作用是建立请求URL和处理方法之间的对应关系。

#### 2.RequestMapping注解可以作用在方法和类上 ####

1. 作用在类上：第一级的访问目录
    2. 作用在方法上：第二级的访问目录
    3. 细节：路径可以不编写 / 表示应用的根目录开始
    4. 细节：${ pageContext.request.contextPath }也可以省略不写，但是路径上不能写 /

#### 3.RequestMapping的属性 ####

1. path 指定请求路径的url
    2. value value属性和path属性是一样的
    3. mthod 指定该方法的请求方式
    4. params 指定限制请求参数的条件
    5. headers 发送的请求中必须包含的请求头

#### 4.RequestMapping的属性圆码分析 ####

RequestMapping源码

/** * Annotation for mapping web requests onto specific handler classes and/or * handler methods. * @since 2.5 */
    @Target({ ElementType.METHOD, ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Mapping
    public @interface RequestMapping { 
    
        /** * Assign a name to this mapping. * RequestMapping请求名称，不常用。 */
        String name() default "";
    
        /** * The primary mapping expressed by this annotation. * 请求路径，放在类上表示一级访问目录，放在方法上表示二级访问目录 */
        @AliasFor("path")
        String[] value() default { };
    
        /** * value与path作用相同 * 请求路径，放在类上表示一级访问目录，放在方法上表示二级访问目录 */
        @AliasFor("value")
        String[] path() default { };
    
        /** * The HTTP request methods to map to, narrowing the primary mapping: * 指定请求类型：GET, POST, HEAD, OPTIONS, PUT, PATCH, DELETE, TRACE * RequestMethod是一个枚举对象 */
        RequestMethod[] method() default { };
    
        /** * The parameters of the mapped request, narrowing the primary mapping. * 这个也不常用，但是这个就厉害了，指定请求参数以及参数的值。不符合则返回异常。 */
        String[] params() default { };
    
        /** * The headers of the mapped request, narrowing the primary mapping. * 这个也不常用，但是也很厉害，这个是用来设置请求头信息的，设置以后请求必须带有该请求头属性，否则也是返回异常 */
        String[] headers() default { };
    
        /** * The consumable media types of the mapped request, narrowing the primary mapping. * @see org.springframework.http.MediaType * @see javax.servlet.http.HttpServletRequest#getContentType() */
        String[] consumes() default { };
    
        /** * The producible media types of the mapped request, narrowing the primary mapping. * @see org.springframework.http.MediaType */
        String[] produces() default { };
    
    }

RequestMapping属性使用案例

/** * hello控制器 * RequestMapping属性使用案例 * * @author zrj * @date 2020/12/31 * @since V1.0 **/
    @Controller
    @RequestMapping(path = "/hello")
    public class HelloController { 
    
        /** * hello请求 * * @return */
        @RequestMapping(path = "/sayHello")
        public String sayHello() { 
            System.out.println( "Hello SpringMVC" );
            return "success";
        }
    
        /** * RequestMapping注解 * * @return */
        @RequestMapping(value = "/testRequestMapping", params = { "username=heihei"}, headers = { "Accept"})
        public String testRequestMapping() { 
            System.out.println( "测试RequestMapping注解..." );
            return "success";
        }
    }

### 二、RequestParam注解 ###

作用：
    把请求中指定名称的参数给控制器中的形参赋值。
    属性：
    value： 请求参数中的名称。
    required：请求参数中是否必须提供此参数。 默认值： true。表示必须提供，如果不提供将报错

### 三、 RequestBody注解 ###

作用：
    用于获取请求体内容。 直接使用得到是 key=value&key=value...结构的数据。
    get 请求方式不适用。
    属性：
    required：是否必须有请求体。默认值是:true。当取值为 true 时,get 请求方式会报错。如果取值
    为 false， get 请求得到是 null

### 四、PathVariable注解 ###

作用：
    用于绑定 url 中的占位符。 例如：请求 url 中 /delete/{id}， 这个{id}就是 url 占位符。
    url 支持占位符是 spring3.0 之后加入的。是 springmvc 支持 rest 风格 URL 的一个重要标志。
    属性：
    value： 用于指定 url 中占位符名称。
    required：是否必须提供占位符

### 五、RequestHeader注解 ###

用：
    用于获取请求消息头。
    属性：
    value：提供消息头名称
    required：是否必须有此消息头
    
    注：在实际开发中一般不怎么用。

### 六、CookieValue注解 ###

作用：
    用于把指定 cookie 名称的值传入控制器方法参数。
    属性：
    value：指定 cookie 的名称。
    required：是否必须有此 cookie。

### 七、ModelAttribute注解 ###

作用：
    该注解是 SpringMVC4.3 版本以后新加入的。它可以用于修饰方法和参数。
    出现在方法上，表示当前方法会在控制器的方法执行之前，先执行。它可以修饰没有返回值的方法，也可以修饰有具体返回值的方法。出现在参数上，获取指定的数据给参数赋值。
    
    属性：
    value：用于获取数据的 key。 key 可以是 POJO 的属性名称，也可以是 map 结构的 key。
    应用场景：
    当表单提交数据不是完整的实体类数据时，保证没有提交数据的字段使用数据库对象原来的数据。
    例如：
    我们在编辑一个用户时，用户有一个创建信息字段，该字段的值是不允许被修改的。在提交表单数
    据是肯定没有此字段的内容，一旦更新会把该字段内容置为 null，此时就可以使用此注解解决问题

### 八、SessionAttributes注解 ###

作用：
    用于多次执行控制器方法间的参数共享。
    属性：
    value：用于指定存入的属性名称
    type：用于指定存入的数据类型。

### 九、上述注解案例验证 ###

1.  项目结果  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTgzNjU1_size_16_color_FFFFFF_t_70]
2.  引入依赖

<?xml version="1.0" encoding="UTF-8"?>
    
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.hello</groupId>
        <artifactId>springmvc_demo</artifactId>
        <version>1.0-SNAPSHOT</version>
        <packaging>war</packaging>
    
        <name>springmvc_demo Maven Webapp</name>
        
        <url>http://www.example.com</url>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <maven.compiler.source>1.8</maven.compiler.source>
            <maven.compiler.target>1.8</maven.compiler.target>
            <spring.version>5.0.2.RELEASE</spring.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context</artifactId>
                <version>${spring.version}</version>
            </dependency>
    
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-web</artifactId>
                <version>${spring.version}</version>
            </dependency>
    
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-webmvc</artifactId>
                <version>${spring.version}</version>
            </dependency>
    
            <dependency>
                <groupId>javax.servlet</groupId>
                <artifactId>servlet-api</artifactId>
                <version>2.5</version>
                <scope>provided</scope>
            </dependency>
    
            <dependency>
                <groupId>javax.servlet.jsp</groupId>
                <artifactId>jsp-api</artifactId>
                <version>2.0</version>
                <scope>provided</scope>
            </dependency>
    
        </dependencies>
    
        <build>
            <finalName>springmvc_day01_01_start</finalName>
            <pluginManagement>
                <plugins>
                    <plugin>
                        <artifactId>maven-clean-plugin</artifactId>
                        <version>3.0.0</version>
                    </plugin>
                    
                    <plugin>
                        <artifactId>maven-resources-plugin</artifactId>
                        <version>3.0.2</version>
                    </plugin>
                    <plugin>
                        <artifactId>maven-compiler-plugin</artifactId>
                        <version>3.7.0</version>
                    </plugin>
                    <plugin>
                        <artifactId>maven-surefire-plugin</artifactId>
                        <version>2.20.1</version>
                    </plugin>
                    <plugin>
                        <artifactId>maven-war-plugin</artifactId>
                        <version>3.2.0</version>
                    </plugin>
                    <plugin>
                        <artifactId>maven-install-plugin</artifactId>
                        <version>2.5.2</version>
                    </plugin>
                    <plugin>
                        <artifactId>maven-deploy-plugin</artifactId>
                        <version>2.8.2</version>
                    </plugin>
                </plugins>
            </pluginManagement>
        </build>
    </project>

1.  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>
    
        
        <filter>
            <filter-name>characterEncodingFilter</filter-name>
            <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
            <init-param>
                <param-name>encoding</param-name>
                <param-value>UTF-8</param-value>
            </init-param>
        </filter>
        <filter-mapping>
            <filter-name>characterEncodingFilter</filter-name>
            <url-pattern>/*</url-pattern>
        </filter-mapping>
    
        
        <servlet>
            <servlet-name>dispatcherServlet</servlet-name>
            <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
            <init-param>
                <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>

1.  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">
    
        
        <context:component-scan base-package="com.hello"/>
    
        
        <bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
            <property name="prefix" value="/WEB-INF/pages/"/>
            <property name="suffix" value=".jsp"/>
        </bean>
    
        
        <bean id="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean">
            <property name="converters">
                <set>
                    <bean class="com.hello.convert.StringToDateConverter"/>
                </set>
            </property>
        </bean>
    
        
        <mvc:annotation-driven conversion-service="conversionService"/>
        
    
    </beans>

1.  Controller

/** * 常用注解测试类 * SessionAttributes(value = {"msg"}) * 把msg=美美存入到session域对中 * * @author zrj * @date 2021/1/1 * @since V1.0 **/
    @Controller
    @RequestMapping("/anno")
    @SessionAttributes(value = { "msg"})
    public class AnnoController { 
    
        /** * RequestParam要解决的是前端参数与后台参数名称不一致的时候做映射，而且默认是必传参数 * 不传RequestParam设置的属性name或者名称与name属性不一样都会报错 * boolean required() default true; * * @param username * @return */
        @RequestMapping("/testRequestParam")
        public String testRequestParam(@RequestParam(name = "name") String username) { 
            System.out.println( "testRequestParam执行了..." );
            System.out.println( "请求参数：username=" + username );
            return "success";
        }
    
        /** * 获取到请求体的内容 * * @return */
        @RequestMapping("/testRequestBody")
        public String testRequestBody(@RequestBody String body) { 
            System.out.println( "testRequestBody执行了..." );
            System.out.println( "请求参数：" + body );
            return "success";
        }
    
        /** * PathVariable注解 * * @return */
        @RequestMapping(value = "/testPathVariable/{sid}")
        public String testPathVariable(@PathVariable(name = "sid") String id) { 
            System.out.println( "testPathVariable执行了..." );
            System.out.println( "请求参数：" + id );
            return "success";
        }
    
        /** * 获取请求头的值 * * @param header * @return */
        @RequestMapping(value = "/testRequestHeader")
        public String testRequestHeader(@RequestHeader(value = "Accept") String header, HttpServletRequest request, HttpServletResponse response) throws IOException { 
            System.out.println( "testRequestHeader执行了..." );
            System.out.println( "请求参数：" + header );
            // return "success";
            // response.sendRedirect(request.getContextPath()+"/anno/testCookieValue");
            return "redirect:/param.jsp";
        }
    
    
        /** * 获取Cookie的值 * * @return */
        @RequestMapping(value = "/testCookieValue")
        public String testCookieValue(@CookieValue(value = "JSESSIONID") String cookieValue) { 
            System.out.println( "testCookieValue执行了..." );
            System.out.println( "请求参数：" + cookieValue );
            return "success";
        }
    
        /** * ModelAttribute注解 * * @return */
        @RequestMapping(value = "/testModelAttribute")
        public String testModelAttribute(@ModelAttribute("abc") User user) { 
            System.out.println( "testModelAttribute执行了..." );
            System.out.println( "请求参数：" + user );
            return "success";
        }
    
        /** * 所有Controller执行之前都会执行该方法 */
        @ModelAttribute
        public void showUser(String uname, Map<String, User> map) { 
            System.out.println( "showUser执行了..." );
            // 通过用户查询数据库（模拟）
            User user = new User();
            user.setUname( uname );
            user.setAge( 20 );
            user.setDate( new Date() );
            map.put( "abc", user );
        }
    
        /** * 该方法会先执行 @ModelAttribute public User showUser(String uname){ System.out.println("showUser执行了..."); // 通过用户查询数据库（模拟） User user = new User(); user.setUname(uname); user.setAge(20); user.setDate(new Date()); return user; } */
    
        /** * SessionAttributes的注解 * * @return */
        @RequestMapping(value = "/testSessionAttributes")
        public String testSessionAttributes(Model model) { 
            System.out.println( "testSessionAttributes执行了..." );
            // 底层会存储到request域对象中
            model.addAttribute( "msg", "美美" );
            return "success";
        }
    
        /** * 获取值 * * @param modelMap * @return */
        @RequestMapping(value = "/getSessionAttributes")
        public String getSessionAttributes(ModelMap modelMap) { 
            System.out.println( "getSessionAttributes执行了..." );
            String msg = (String) modelMap.get( "msg" );
            System.out.println( "请求参数：" + msg );
            return "success";
        }
    
        /** * 清除 * * @param status * @return */
        @RequestMapping(value = "/delSessionAttributes")
        public String delSessionAttributes(SessionStatus status) { 
            System.out.println( "getSessionAttributes执行了..." );
            status.setComplete();
            return "success";
        }
    
    }

1.  jsp  
    anno.jsp

<%--
      Created by IntelliJ IDEA.
      User: zrj
      Date: 2021/1/1
      Time: 17:13
      To change this template use File | Settings | File Templates.
    --%>
    <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    <html>
    <head>
        <title>常用的注解</title>
    </head>
    <body>
    
        <%--常用的注解-RequestParam测试 --%>
        <a href="anno/testRequestParam?name=哈哈">RequestParam</a><br/>
    
        <%--常用的注解-RequestBody测试 --%>
        <form action="anno/testRequestBody" method="post">
            用户姓名：<input type="text" name="username"/><br/>
            用户年龄：<input type="text" name="age"/><br/>
            <input type="submit" value="提交"/><br/>
        </form>
    
        <%--常用的注解-PathVariable测试 --%>
        <a href="anno/testPathVariable/10">testPathVariable</a><br/>
        <%--常用的注解-RequestHeader测试 --%>
        <a href="anno/testRequestHeader">RequestHeader</a><br/>
        <%--常用的注解-CookieValue测试 --%>
        <a href="anno/testCookieValue">CookieValue</a><br/>
    
        <%--常用的注解-testModelAttribute测试 --%>
        <form action="anno/testModelAttribute" method="post">
            用户姓名：<input type="text" name="uname"/><br/>
            用户年龄：<input type="text" name="age"/><br/>
            <input type="submit" value="提交"/><br/>
        </form>
    
        <%--常用的注解-testSessionAttributes测试 --%>
        <span>常用的注解-testSessionAttributes测试</span><br/>
        <a href="anno/testSessionAttributes">testSessionAttributes</a><br/>
        <a href="anno/getSessionAttributes">getSessionAttributes</a><br/>
        <a href="anno/delSessionAttributes">delSessionAttributes</a><br/>
    
    </body>
    </html>

success.jsp

<%--
      Created by IntelliJ IDEA.
      User: zrj
      Date: 2020/12/31
      Time: 20:45
      To change this template use File | Settings | File Templates.
    --%>
    <%@ page contentType="text/html;charset=UTF-8" language="java"  isELIgnored="false" %>
    <html>
    <head>
        <title>Title</title>
    </head>
    <body>
        <h3>成功了</h3><br/>
    
        <span>我是msg：</span>
        ${  msg }<br/>
    
        <span>我是sessionScope：</span>
        ${ sessionScope}<br/>
    </body>
    </html>

其他参数参考上篇环境[基础框架 SpringMVC请求参数绑定][SpringMVC]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTgzNjU1_size_16_color_FFFFFF_t_70]: /images/20221120/78889178acb4477cbc262b9888d9e47d.png
[SpringMVC]: https://blog.csdn.net/m0_37583655/article/details/112061549