SpringMVC注解

发表时间:2018-01-18 16:03:21 浏览量( 17 ) 留言数( 0 )

学习目标:

1、掌握SpringMVC框架的常用的注解


学习过程:

   和Struts2的Action配置类似,SpringMVC的更加提倡就是使用注解的方式配置url路径和实现方法的映射关系,而且SpringMVC的注解简单但是功能强大,下面我们一起看一下。

1、@Controller

@Controller

public class UserController {

}

和Struts1一样,Spring的Controller是单例的。这就意味着会被多个请求线程共享。因此,我们将控制器设计成无状态类,注意这一点和Struts2是完全不一样的, 无状态类我们可以理解成为一般不会定义类的变量,因为这样的话,这个变量会给所有的访问用户共享的。


2、@RequestMapping

RequestMapping是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。

在类前面定义,则将url和类绑定;

示例代码如下:

@Controller

@RequestMapping("/queryuser")

public class UserController {


}

RequestMapping注解有六个属性,下面我们把她分成三类进行说明。

1、 value, method;

value:     指定请求的实际地址,指定的地址可以是URI Template 模式(后面将会说明);

method:  指定请求的method类型, GET、POST、PUT、DELETE等;

2、 consumes,produces;

consumes: 指定处理请求的提交内容类型(Content-Type),例如application/json, text/html;

produces:    指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回;

3、 params,headers;

params: 指定request中必须包含某些参数值是,才让该方法处理。

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


 @RequestMapping("/appointments")

public class AppointmentsController {


    @RequestMapping(method = RequestMethod.GET)

    public Map<String, Appointment> get() {

        return appointmentBook.getAppointmentsForToday();

    }

    @RequestMapping(value="/{day}", method = RequestMethod.GET)

    public Map<String, Appointment> getForDay(@PathVariable @DateTimeFormat(iso=ISO.DATE) Date day, Model model) {

        return appointmentBook.getAppointmentsForDay(day);

    }


    @RequestMapping(value="/new", method = RequestMethod.GET)

    public AppointmentForm getNewForm() {

        return new AppointmentForm();

    }

    @RequestMapping(method = RequestMethod.POST)

    public String add(@Valid AppointmentForm appointment, BindingResult result) {

        if (result.hasErrors()) {

            return "appointments/new";

        }

        appointmentBook.addAppointment(appointment);

        return "redirect:/appointments";

    }

}


3、@RequestParam和@PathVariable

A) @RequestParam常用来处理简单类型的绑定,通过Request.getParameter() 获取的String可直接转换为简单类型的情况。默认和方法的参数名称同名。所以你可以可以不配置的,Spring也只支持直接绑定对象的。并不需要配置改注解,当然你也可以通过配置设置对应页面传递的名称,是否必传,默认值等属性

B)@PathVariable,常用在GET模式下,这里使用了@PathVariable绑定输入参数,非常适合Restful风格。因为隐藏了参数与路径的关系,可以提升网站的安全性,静态化页面,降低恶意攻击风险。如果是POST模式下,使用@RequestBody绑定请求对象,Spring会帮你进行协议转换,将Json、Xml协议转换成你需要的对象。


@RequestParam实例


    //可以上面都不写,直接绑定

    @RequestMapping(value = "/del")

    public String test(String name){

         

        return "hello";

    }


    

    //可以直接绑定对象。

    @RequestMapping(value = "/del")

    public String test(User user){

         

        return "hello";

    }


   //可以设定其他约束条件

    @RequestMapping(value = "/del")

    public String deleteAgents(@RequestParam(value = "query", required = false, defaultValue = "") String query,@RequestParam("ids")String ids[]){

         

        return "hello";

    }


@PathVariable例子

@Controller  

public class PersonController {  

   

    @RequestMapping(value = "/person/profile/{id}/{name}/{status}", method = RequestMethod.GET)  

    public String   porfile(@PathVariable int id, @PathVariable String name,  

            @PathVariable boolean status) {  

      

       return "hello";

    }  

  


}  

  这里我们使用了restful风格。@RequestMapping(value = "/person/profile/{id}/{name}/{status}", method = RequestMethod.GET)中的{id}/{name}/{status}与@PathVariable int id, @PathVariable String name,@PathVariable boolean status一一对应,按名匹配。这是restful式风格。 

如果映射名称有所不一,可以参考如下方式:

@RequestMapping(value = "/person/profile/{id}", method = RequestMethod.GET)  

public @ResponseBody  

Person porfile(@PathVariable("id") int uid) {  

    return new Person(uid, name, status);  

}  

 

4、@ResponseBody

作用: 

      该注解用于将Controller的方法返回的对象,通过适当的HttpMessageConverter转换为指定格式后,写入到Response对象的body数据区。

使用时机:

      返回的数据不是html标签的页面,而是其他某种格式的数据时(如json、xml等)使用,也是常用于restful模式中

    @RequestMapping(value = "/person/login", method = RequestMethod.POST,produces = "application/json;charset=UTF-8")  

    @ResponseBody

    public   Person login(String uname,String pass) {  

        return person;  

    }  


5、@RequestBody

作用: 

    1、该注解用于读取Request请求的body部分数据,使用系统默认配置的HttpMessageConverter进行解析,然后把相应的数据绑定到要返回的对象上;

    2、再把HttpMessageConverter返回的对象数据绑定到 controller中方法的参数上。

使用时机:

A) GET、POST方式提时, 根据request header Content-Type的值来判断:

    application/x-www-form-urlencoded, 可选(即非必须,因为这种情况的数据@RequestParam, @ModelAttribute也可以处理,当然@RequestBody也能处理);

    multipart/form-data, 不能处理(即使用@RequestBody不能处理这种格式的数据);

    其他格式, 必须(其他格式包括application/json, application/xml等。这些格式的数据,必须使用@RequestBody来处理);

B) PUT方式提交时, 根据request header Content-Type的值来判断:

    application/x-www-form-urlencoded, 必须;

    multipart/form-data, 不能处理;

    其他格式, 必须;

说明:request的body部分的数据编码格式由header部分的Content-Type指定;

@RequestMapping(value = "/listConsumerInfoDeleted", produces = "application/json;charset=UTF-8")

@ResponseBody

public Map<String, Object> listConsumerInfoDeleted(@RequestBody ConsumerInfoDeletedSearch search) {

Map<String, Object> map = consumerService.getConsumerInfoDeleteds(search);

return map;

}

 

6、@SessionAttributes

@SessionAttributes:

该注解用来绑定HttpSession中的attribute对象的值,便于在方法中的参数里使用。

该注解有value、types两个属性,可以通过名字和类型指定要使用的attribute 对象;


@Controller

@RequestMapping("/user")

@SessionAttributes({"u","a"})   //将ModelMap中属性名字为u、a的再放入session中。这样,request和session中都有了。

publicclass UserController  {

    @RequestMapping(params="method=list")

    public String list(ModelMap map) {              

  System.out.println("HelloController.handleRequest()");

    map.addAttribute("u","users");  //将u放入request作用域中,这样转发页面也可以取到这个数据。

       return"index";

    }

}页面里面的代码

<body>

   <h1>${requestScope.u.uname}</h1>

   <h1>${sessionScope.u.uname}</h1>

  </body>


7、@ModelAttribute

该注解有两个用法,一个是用于方法上,一个是用于参数上;

用于方法上时:  通常用来在处理@RequestMapping之前,为请求绑定需要从后台查询的model;

用于参数上时: 用来通过名称对应,把相应名称的值绑定到注解的参数bean上;要绑定的值来源于:

我们也常常会定义一个BaseController作为所有Controller,然后需要用到的一些公用的属性也可以使用ModelAttribute。如果一下代码

@ModelAttribute

public void initPath(HttpServletRequest request, HttpServletResponse response, ModelMap model) {

String path = request.getContextPath();

basePath = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort() + path + "/";


String servletPath = request.getServletPath();


model.addAttribute("servletPath", servletPath);

model.addAttribute("path", path);

model.addAttribute("basePath", basePath);

model.addAttribute("booturl", configInfoUtil.getBooturl());


}

A) @SessionAttributes 启用的attribute 对象上;

B) @ModelAttribute 用于方法上时指定的model对象;

C) 上述两种情况都没有时,new一个需要绑定的bean对象,然后把request中按名称对应的方式把值绑定到bean中。


 用到方法上@ModelAttribute的示例代码: 

@ModelAttribute  

public Account addAccount(@RequestParam String number) {  

    return accountManager.findAccount(number);  

}  

这种方式实际的效果就是在调用@RequestMapping的方法之前,为request对象的model里put(“account”, Account);

用在参数上的@ModelAttribute示例代码:

@RequestMapping(value="/owners/{ownerId}/pets/{petId}/edit", method = RequestMethod.POST)  

public String processSubmit(@ModelAttribute Pet pet) {  

     

首先查询 @SessionAttributes有无绑定的Pet对象,若没有则查询@ModelAttribute方法层面上是否绑定了Pet对象,若没有则将URI template中的值按对应的名称绑定到Pet对象的各属性上。


@ModelAttribute可以和@SessionAttributes配合在一块使用。可以通过ModelMap中属性的值通过该注解自动赋给指定变量。


 示例代码如下:

@Controller

@RequestMapping("/user")

@SessionAttributes({"u","a"}) 

publicclass UserController  {

   

    @RequestMapping(params="method=list1")

    public String list1(ModelMap map) {

       System.out.println("HelloController.handleRequest()");

       map.addAttribute("u","光头强");

       return"index";

    }

   

    @RequestMapping(params="method=list2")

public String list2(@ModelAttribute("u")String username ,ModelMap map) {

       System.out.println("HelloController.handleRequest()");

       System.out.println(username );

       return"index";

    }

   

}

注解内容比较多,但是也比较简单,所以大家自己上机,多练习一下即可。代码我都是从正式的实例中拷贝过来的。