(Portal 开发读书笔记）Spring Portlet MVC 常用注解大全

@Controller  ,标注在类级别，用于标注一个Portlet Handler,控制器类可以是任意的类。

----

@Autowired ，标注在构造器，setter方法，或者字段上，用于让Spring根据类型来注入依赖，所以如果在Spring上下文中如果有某个类的多个bean实例，则会抛出异常，此时我们应该配合@Qualifier 一起使用。

比如我们有

1. <bean id="bookservice1" class="foo.bar.service.BookService/> 
2.  
3. <bean id="bookservice2" class="foo.bar.service.BookService"/> 
4.  
5. <bean id="bookservice3" class="foo.bar.service.BookService"/> 

我们想让我们的Controller注入bookservice1 ，则必须联合使用@Autowired和@Qualifier:

1. @Controller(value="addBookController") 
2. public class AddBookController { 
3. @Autowired 
4. @Qualifier("bookservice1") 
5. private BookService bookService; 
6. ... 
7. } 

-----

@Resource,标注在类，字段，setter方法，但是不可以标注在构造器上，用于让Spring根据名字来注入依赖。

1. @Controller(value="addBookController") 
2. public class AddBookController { 
3. @Resource(name="myBookService") 
4. private BookService bookService; 
5. ... 
6. } 

在Portlet Controller的内部，我们还可以用以下的注解：

@RequestMapping,标注在类和方法上，Portlet常用的映射策略是：将一种Portlet模式映射到控制器类上，然后将请求参数映射到各个处理器方法上。

当用于类级时，它可以将对portlet的请求根据当前portlet的mode和请求参数来映射到Handler上，例如：

1. @Controller(value="someController") 
2. @RequestMapping(value="VIEW", 
3. params="action=showSomething") 
4. public class SomeController { 
5. public String showSomething(...) { 
6. return "addBookForm"; 
7. } 
8. public void doSomething(...) { 
9. } 
10. } 

当用于方法级时，它可以将对portlet的请求根据当前portlet的mode和请求参数映射到Handler的某个方法上，例如：

1. @Controller(value="someController") 
2. public class SomeController { 
3. @RequestMapping(value="VIEW", 
4. params="action=showSomething") 
5. public String showSomething(...) { 
6. } 
7. @RequestMapping(value="ACTION", params="action=doSomeWork") 
8. public void doSomething(...) { 
9. } 
10. } 

注意，类级别的@RequestMapping的模式和方法级别的@RequestMapping的模式必须匹配，否则会产生错误。

也可以根据方法的签名来让Spring自动判断某个方法是render处理方法还是action处理方法,比如：

1. @Controller(value="someController") 
2. @RequestMapping(value="VIEW") 
3. public class SomeController { 
4. ... 
5. 
   //下面的处理方法是一个render请求的处理方法
6. @RequestMapping(params="action=showSomething") 
7. public String showSomething(Model model) { 
8. } 
9. //下面的处理方法是一个action请求的处理方法
10. @RequestMapping(params="action=doSomeWork") 
11. public void doSomething(ActionRequest request) { 
12. } 
13. } 

action请求的处理方法总是返回void

---- 

为了让请求类型映射更加清晰，我们不用@RequestMapping，而是用更加具体的标注比如 @RenderMapping ,@ActionMapping:

----

@RequestMapping 

@RenderMapping:标注在方法上，用于将一个render类型的portlet 请求映射到处理器的render方法上,其中value也可以不指定，如果不指定则表示渲染到NOMAL+MAXIMIZED+MINIMIZED上。

1. @Controller(value="someController") 
2. @RequestMapping(value="VIEW") 
3. public class SomeController { 
4. @RenderMapping(value="NORMAL", 
5. params="action=showSomething") 
6. public String showSomething(Model model) { 
7. } 
8. } 

注意，@RenderMapping必须和@RequestMapping联合使用，因为@RequestMapping可以指定Portlet Mode,而@RenderMapping无法指定Portlet Mode.

 -----

@ActionMapping:

@ActionMapping标注在方法上，用于将一个action类型的portlet请求映射到处理器的action方法上，其中value也可以不指定。

1. @Controller(value="someController") 
2. @RequestMapping("VIEW") 
3. public class SomeController { 
4. @ActionMapping(value="doSomeWork", 
5. params={"work=laundry","time=enough"}) 
6. public String doSomething(ActionRequest request) { 
7. ... 
8. } 
9. ... 
10. } 

注意，@ActionMapping必须和@RequestMapping联合使用，因为@RequestMapping可以指定Portlet Mode,而@ActionMapping无法指定Portlet Mode.

----

@RequestParam 是方法参数级的注解，用于绑定请求参数到方法参数

1. @RequestMapping 
2.  public void advancedSearch( 
3.    @RequestParam("queryStr") String queryStr, 
4.    @RequestParam("showFlag") String showFlag, 
5.    @RequestParam("totalnumber") String totalNumber, 
6.    @RequestParam("upType") String upType, 
7.    @RequestParam("jmesareq") String jmesaReq, 
8.    @RequestParam("isExportOper") String isExportOper, 
9.    RenderResponse response, final RenderRequest request, 
10.    ModelMap model) { 
11.   // get query structure and query type from page 
12.   List<Long> cd_ids = new ArrayList<Long>(); 
13.   if(StringUtils.equals("invoke", jmesaReq)){ 
14.    cd_ids = (List<Long>)request.getSession().getAttribute(Constants.RESULT_IDS); 
15.   } 
16.  .... 
17.  } 

-----

@ModelAttribute ，标注在方法或者方法参数中，用于从Model对象中添加或者移除属性。

如果用于方法级别，那么方法的返回值被添加到Model对象中，value属性表明存放到Model中的key.例如：

1. @Controller(value="bookController") 
2. @RequestMapping("VIEW") 
3. public class BookController { 
4. @Autowired 
5. @Qualifier("myBookService") 
6. private BookService bookService; 
7. ... 
8. @ModelAttribute(value="books") 
9. public List<Book> getBooks() { 
10. return bookService.getBooks(isbnNumber); 
11. } 
12. ... 
13. } 

注意，被@ModelAttribute标注的方法的调用时间总是早于被@RenderMapping或者@ActionMapping所标注的方法.

注意，@ModelAttribute标注也必须和@RequestMapping联合使用。

如果用于方法参数级别，那么它用于绑定模型中的属性到方法参数，例如：

1. @RequestMapping(value = "VIEW") 
2. @Controller(value="addBookController") 
3. public class AddBookController { 
4. @Autowired 
5. @Qualifier("myBookService") 
6. private BookService bookService; 
7. ... 
8. @ActionMapping(params = "myaction=addBook") 
9. public void addBook(@ModelAttribute(value="book") 
10. Book book, ...) { 
11. ... 
12. bookService.addBook(book); 
13. } 
14. } 

-----

@SessionAttributes ，标注在类级别，用于让模型的属性存储于控制器的会话状态中。直到Session结束(详细说来是调用了SessionStatus的setComplete()方法)。这样做的好处就是可以在一个作用域更大的区域上共享对象，用法是将@SessionAttributes和@ModelAttribute 联合使用，并且他们的value值设成一样。例如：

1. @Controller 
2. @RequestMapping(value="VIEW") 
3. @SessionAttributes(value="book") 
4. public class EditBookController { 
5. @Autowired 
6. @Qualifier("myBookService") 
7. private BookService bookService; 
8. @ModelAttribute("book") 
9. public Book getBook(@RequestParam Long isbnNumber) { 
10. return bookService.getBook(isbnNumber); 
11. } 
12. @ActionMapping(params="myaction=editBook") 
13. public void editBook 
14. (@ModelAttribute("book")Book book,...){ 
15. ... 
16. bookService.editBook(book); 
17. ... 
18. } 
19. } 
20. @RenderMapping(params="myaction=editBookForm") 
21. public String showEditBookForm(){ 
22. return "editBookForm"; 
23. } 
24. } 

对于共享PortletSession上相同类型的多个属性，也可以用如下的写法：

1. @SessionAttributes(types=XXXClass.class) 

这样所有XXClass类型的属性都会被设置到PortletSession域上。

-----

@InitBinder 标注在方法级，为什么要用这个注解呢？

因为请求类型的参数都是String类型的, 所以要让某个属性编辑器（比如自定义的属性编辑器），格式化器或者校验器来处理某个请求参数，就必须用WebDataBinder进行绑定，而@InitBinder就负责初始化WebDataBinder,比如：

1. @Controller 
2. public class MyFormController { 
3.  
4.     @InitBinder 
5.     public void initBinder(WebDataBinder binder) { 
6.         SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd"); 
7.         dateFormat.setLenient(false); 
8.         binder.registerCustomEditor(Date.class, new CustomDateEditor(dateFormat, false)); 
9.     } 
10.     … 
11. } 

这个例子就是Date类型绑定到自定义的Date编辑器。