美文网首页
3. SpringMVC常用注解

3. SpringMVC常用注解

作者: 飞扬code | 来源:发表于2019-10-29 21:08 被阅读0次

    准备

    image.png
    package com.neuedu.Controller;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    
    /**
     * 常用的注解
     */
    @Controller
    @RequestMapping("/anno")
    public class AnnoController {
    
        @RequestMapping("/testRequestParam")
        public String testRequestParam(){
            System.out.println("执行了...");
            return "success";
        }
    }
    
    
    image.png
    <%--
      Created by IntelliJ IDEA.
      User: Administrator
      Date: 2019/10/22
      Time: 18:56
      To change this template use File | Settings | File Templates.
    --%>
    <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    <html>
    <head>
        <title>Title</title>
    </head>
    <body>
        <%--常用的注解--%>
        <a href="anno/testRequestParam">RequestParam</a>
        <br>
    </body>
    </html>
    
    

    1. RequestParam

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

        @RequestMapping("/testRequestParam")
        public String testRequestParam(@RequestParam(name="name") String username){
            System.out.println("执行了...");
            System.out.println(username);
            return "success";
        }
    
    <a href="anno/testRequestParam?name=haha">RequestParam</a>
    
    image.png
    image.png

    2. RequestBody(异步中使用)

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

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

        /**
         * 获取到请求体的内容
         * @return
         */
        @RequestMapping("/testRequestBody")
        public String testRequestBody(@RequestBody String body){
            System.out.println("执行了...");
            System.out.println(body);
            return "success";
        }
    
    
        <form action="anno/testRequestBody" method="post">
            用户姓名:<input type="text" name="username" /><br/>
            用户年龄:<input type="text" name="age" /><br/>
            <input type="submit" value="提交" />
        </form>
    
    image.png image.png

    3. PathVaribale

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

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

        /**
         * PathVariable注解
         * @return
         */
        @RequestMapping(value="/testPathVariable/{sid}")
        public String testPathVariable(@PathVariable(name="sid") String id){
            System.out.println("执行了...");
            System.out.println(id);
            return "success";
        }
    
    
    <a href="anno/testPathVariable/10">testPathVariable</a>
    
    image.png
    image.png

    4. RequestHeader(使用较少)

    作用:
    用于获取请求消息头。

    属性:
    value:提供消息头名称
    required:是否必须有此消息头

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

        @RequestMapping(value="/testRequestHeader")
        public String testRequestHeader(@RequestHeader(value="Accept") String header){
            System.out.println("执行了...");
            System.out.println(header);
            return "success";
        }
    
    
        <a href="anno/testRequestHeader">RequestHeader</a>
    
    image.png image.png

    5. CookieValue(使用较少)

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

    属性:
    value:指定 cookie 的名称。
    required:是否必须有此 cookie。

        /**
         * 获取Cookie的值
         * @return
         */
        @RequestMapping(value="/testCookieValue")
        public String testCookieValue(@CookieValue(value="JSESSIONID") String cookieValue){
            System.out.println("执行了...");
            System.out.println(cookieValue);
            return "success";
        }
    
    
        <a href="anno/testCookieValue">CookieValue</a>
    
    image.png
    image.png

    6. ModelAttribute

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

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

        /**
         * ModelAttribute注解
         * @return
         */
        @RequestMapping(value="/testModelAttribute")
        public String testModelAttribute(){
            System.out.println("testModelAttribute执行了...");
            return "success";
        }
    
        @ModelAttribute
        public void showUser(){
            System.out.println("showUser执行了...");
        }
    
    
        <form action="anno/testModelAttribute" method="post">
            用户姓名:<input type="text" name="uname" /><br/>
            用户年龄:<input type="text" name="age" /><br/>
            <input type="submit" value="提交" />
        </form>
    
    image.png image.png image.png

    应用场景:
    当表单提交数据不是完整的实体类数据时,保证没有提交数据的字段使用数据库对象原来的数据。

    例如:
    我们在编辑一个用户时,用户有一个创建信息字段,该字段的值是不允许被修改的。在提交表单数据是肯定没有此字段的内容,一旦更新会把该字段内容置为 null,此时就可以使用此注解解决问题。

    问题:对象数据不完整:


    image.png image.png

    基于Map的应用场景示例 1 :ModelAttribute修饰方法不带返回值

       /**
         * ModelAttribute注解
         * @return
         */
        @RequestMapping(value="/testModelAttribute")
        public String testModelAttribute(@ModelAttribute("abc") User user){
            System.out.println("testModelAttribute执行了...");
            System.out.println(user);
            return "success";
        }
    
        @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);
        }
    
    image.png

    基于Map的应用场景示例 1 :ModelAttribute修饰方法带返回值

        /**
         * ModelAttribute注解
         * @return
         */
        @RequestMapping(value="/testModelAttribute")
        public String testModelAttribute(User user){
            System.out.println("testModelAttribute执行了...");
            System.out.println(user);
            return "success";
        }
    
        @ModelAttribute
        public User showUser(String uname){
            System.out.println("showUser执行了...");
            // 通过用户查询数据库(模拟)
            User user = new User();
            user.setUname(uname);
            user.setAge(20);
            user.setDate(new Date());
            map.put("abc",user);
        }
    
    image.png

    7. SessionAttribute

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

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

    <a href="anno/testSessionAttributes">testSessionAttributes</a>
    
    
        /**
         * SessionAttributes的注解
         * @return
         */
        @RequestMapping(value="/testSessionAttributes")
        public String testSessionAttributes(Model model){
            System.out.println("testSessionAttributes...");
            // 底层会存储到request域对象中
            model.addAttribute("msg","哈哈");
            return "success";
        }
    

    Model 是 spring 提供的一个接口,该接口有一个实现类 ExtendedModelMap该类继承了 ModelMap,而 ModelMap 就是 LinkedHashMap 子类

    image.png image.png

    把msg=哈哈 存入到session域对中,在success.jsp中显示${sessionScope.msg}

    image.png

    从session域取出值

    <a href="anno/getSessionAttributes">getSessionAttributes</a>
    
        /**
         * 获取值
         * @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";
        }
    
    image.png
    <a href="anno/delSessionAttributes">delSessionAttributes</a>
    
        /**
         * 清除
         * @param status
         * @return
         */
        @RequestMapping(value="/delSessionAttributes")
        public String delSessionAttributes(SessionStatus status){
            System.out.println("getSessionAttributes...");
            status.setComplete();
            return "success";
        }
    

    相关文章

      网友评论

          本文标题:3. SpringMVC常用注解

          本文链接:https://www.haomeiwen.com/subject/cnkcvctx.html