手机版
你好,游客 登录 注册
背景:
阅读新闻

Spring MVC 4 相关注解的详细讲解

[日期:2016-05-24] 来源:Linux社区  作者:chenjianxiang [字体: ]

首先我是一个初学Spring MVC,抱着去加深印象的目的去整理相关Spring MVC 4的相关注解,同时也希望给需要相关查阅的读者带来帮助。

1.@Controller
Controller控制器是通过服务接口定义的提供访问应用程序的一种行为,它解释用户的输入,将其转换成一个模型然后将试图呈献给用户。Spring MVC 使用 @Controller 定义控制器,它还允许自动检测定义在类路径下的组件并自动注册。如想自动检测生效,需在xml头文件下引入 spring-context:

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

2.@RequestMapping
RequestMapping 注解将类似 "/admin"这样的URL映射到整个类或特定的处理方法上。一般来说,类级别的注解映射特定的请求路径到表单控制器上,而方法级别的注解只是映射 为一个特定的HTTP方法请求("GET","POST"等)或HTTP请求参数。

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
@RequestMapping("admin")
public class LoginController {
   
    @RequestMapping(value = "login" , method = RequestMethod.GET , consumes = "text/html")
    public String toLoginPage(){
        return "/WEB-INF/jsp/login.jsp";
    }
}

上述url的访问地址应该是:localhost:8080/proj/admin/login.html
consumes-指定处理请求的提交内容类型Content-Type,例如 application/json,text/html。
produces-指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回。
value-指定请求的实际地址,指定的地址可以是URI Template 模式

A) 可以指定为普通的具体值;
B) 可以指定为含有某变量的一类值(URI Template Patterns with Path Variables);
C) 可以指定为含正则表达式的一类值( URI Template Patterns with Regular Expressions);

如下示例:

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
public class BlogController {
   
    @RequestMapping(value = "blog/{nick}/{year:20\\d{2}}/{month:1|1[0-2]}/{day:[12][0-9]|30|[1-9]}" , method = RequestMethod.GET)
    public String toBlogPage(@PathVariable String nick,
            @PathVariable Integer year,@PathVariable Integer month,@PathVariable Integer day){
        return "/WEB-INF/jsp/blog.jsp";
    }
}

params-指定request中必须包含某些参数值是,才让该方法处理。
headers-指定request中必须包含某些指定的header值,才能让该方法处理请求。

如下示例:

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
public class BlogController {
 
    //仅处理request的header中包含了指定“Refer”请求头和对应值为“http://www.ttyouni.com/”的请求
    @RequestMapping(value = "image", headers="Referer=http://www.ttyouni.com/" )
    public String getImage(){
        return "/WEB-INF/jsp/image.jsp";
    }
}

3.@RathVariable
在Spring MVC中,可以使用 @PathVariable 注解方法参数并将其绑定到URI模板变量的值上,之前示例中也有相关体现。
4.@RequestParam
@RequestParam将请求的参数绑定到方法中的参数上。其实即使不配置该参数,注解也会默认使用该参数。如果想自定义指定参数的话,可以将@RequestParam的 required 属性设置为false。
5.@RequestBody
@RequestBody是指方法参数应该被绑定到HTTP请求Body上。
6.@SessionAttibutes
@SessionAttibutes可以通过ModelMap对象的put操作设置相关的session同时在attibute对象也会有该对象。

示例如下:

import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;

import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.SessionAttributes;

import com.chen.proj.service.UserService;

@Controller
@RequestMapping("admin")
@SessionAttributes("user")
public class LoginController {
   
    @Resource
    UserService service;
   
    @RequestMapping(value = "doLogin", method = RequestMethod.POST)
    public String doLogin(@RequestParam String username , @RequestParam String password, HttpServletRequest request,
            ModelMap map ){   
        try {
            User user = service.doLogin(username, password);
            map.put("user", user);
        } catch (Exception e) {
            request.setAttribute("error", e.getMessage());
            return "/WEB-INF/jsp/login.jsp";
        }     
        return "/WEB-INF/jsp/loginsuccess.jsp";
    }
   
}

7.@ResponseBody

@ResponseBody与@RequestBody类似,它的作用是将返回类型直接输入到HTTP response body中。@ResponseBody在输出JSON格式的数据时会用到。

示例如下:

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import com.chen.proj.bean.User;

@Controller
public class JsonController {

    @ResponseBody
    @RequestMapping("/getJson")
    public User getUserInfo(){
        User user = new User();
        user.setPassword("1234");
        user.setUsername("jsontest");
        return user;
    }   
}

8.@RestController

 我们经常见到一些控制器实现了REST的API,只为服务于json,xml或其它自定义的类型内容。@RestController用来创建REST类型的控制器,与@Controller类型。@RestController就是这样一种类型,它避免了你重复的写@RequestMapping与@ResponseBody

9.@ModelAttribute

@ModelAttribute可以作用在方法或方法参数上,当它作用在方法上时,标明该方法的目的是添加一个或多个模型属性。
当作用在方法参数上时,表明该参数可以在方法模型中检索到。如果该参数不在当前模型中,该参数先被实例化然后添加到模型中。一旦模型中有了该参数,该参数的字段应该填充所有请求参数匹配的名称中。这是spring mvc中重要的数据绑定机制,它省去了单独解析每个表单字段的时间。

 

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

import com.chen.proj.bean.User;

@Controller
public class UserController {

    @ModelAttribute
    public User addUser(@RequestParam String number) {
        return service.findUser(number);
    }

    @ModelAttribute
    public void populateModel(@RequestParam String number, Model model) {
        model.addAttribute(service.findUser(number));   
        // add more ...
    }
}

注解的出现终结了xml配置文件漫天飞的年代,它让程序拥有更高的可读性,可配置性与灵活性。给人一种更简洁明了的感觉。

Spring MVC+Spring3+Hibernate4开发环境搭建 http://www.linuxidc.com/Linux/2013-07/87119.htm

Spring MVC整合Freemarker基于注解方式 http://www.linuxidc.com/Linux/2013-02/79660.htm

基于注解的Spring MVC简单介绍 http://www.linuxidc.com/Linux/2012-02/54896.htm

Spring MVC 框架搭建及详解 http://www.linuxidc.com/Linux/2012-01/52740.htm

Spring MVC使用Cron表达式的定时器 http://www.linuxidc.com/Linux/2014-12/110733.htm

简单的Spring MVC经典案例 http://www.linuxidc.com/Linux/2016-04/129718.htm

本文永久更新链接地址http://www.linuxidc.com/Linux/2016-05/131703.htm

linux
本文评论   查看全部评论 (0)
表情: 表情 姓名: 字数

       

评论声明
  • 尊重网上道德,遵守中华人民共和国的各项有关法律法规
  • 承担一切因您的行为而直接或间接导致的民事或刑事法律责任
  • 本站管理人员有权保留或删除其管辖留言中的任意内容
  • 本站有权在网站内转载或引用您的评论
  • 参与本评论即表明您已经阅读并接受上述条款