JAVA

индекс
157,29

Введение в Spring MVC с аннотациями

Вчера начал разбираться со Spring MVC 3.0.Искал статьи на Хабре, нашел пару штук.Правда они были без аннотаций.
Цель этой статьи написать Hello World c использованием возможностей писать конфиги прямо в коде, благодаря аннотациям.Ну что приступим.

Создаем вэб проект
В основе любого вэб проекта лежит файл web.xml, вот его код:
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
version="2.5">

<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/dispatcher-servlet.xml</param-value>
</context-param>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>

<servlet-name>dispatcher</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<load-on-startup>1</load-on-startup>

<servlet-mapping>
<servlet-name>dispatcher</servlet-name>
<url-pattern>*.form</url-pattern>
</servlet-mapping>

<welcome-file-list>
<welcome-file>/WEB-INF/pages/index.jsp</welcome-file>
</welcome-file-list>

</web-app>

Здесь мы объявляем вездесущий спринговский сервлет DispatcherServlet который и будет обрабатывать наши запросы, также указываем файл где лежат настройки dispatcher-servlet.xml.
Перейдем к самому dispatcher-servlet.xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/tx"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.5.xsd">

    <context:component-scan base-package="az.mecid.controllers"/>

    <bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping"/>
    <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"/>

    <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
        <property name="prefix" value="/WEB-INF/pages/"/>
        <property name="suffix" value=".jsp"/>
    </bean>

</beans>


тут мы указываем какой пакет сканировать на наличие spring bean'ов, затем идут два бина которые нужны для работы с аннотациями,c помощью бина viewResolver указываем где лежат наши View, и благодаря свойству suffix мы можем использовать их без расширений.

Написание конфигов не самое приятное, но теперь с этим закончили.
Создадим страничку с формой, в которой есть поле ввода и сабмит.
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
  <head><title>Simple jsp page</title></head>
  <body>

  <form action="test.form" method="get">
      <input type="text" name="name">
      <input type="submit">
  </form>

  </body>
</html>

Теперь самое интересно напишем контроллер, обрабатывающий данную форму:
package az.mecid.controllers;

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

@Controller
public class HelloController {

@RequestMapping(value = "/test.form",method = RequestMethod.GET)
public String test(@RequestParam("name") String param,Model model){
model.addAttribute("name",param);
return "hello";
}
}

Помечаем наш класс аннотацией @Controller, благодаря этому нам не надо писать в XML, его имя, куда мэпить и всякое другое.Затем создаем метод test(обработчик нашей формы)и с помощью аннотации @RequestMapping указываем куда ее мэпить и какой запрос ей ловить пост или гет.Теперь поговорим о параметрах метода тест, аннотация @RequestParam(«name») String namе говорит о том, что в обработчик получает поле name формы которую обрабатывает, ну это если бы в сервлете сделать
String param = request.getParametr("name");

Второй параметр метода test,model это коллекция, которая содержит информацию в виде ключ-значение.
Кодmodel.addAttribute("name",param); эквивалентен тому, что если бы в сервлете писать request.setAttribute("name",param);
Метод test возвращает строку, это строка, а точнее имя View на которую мы хотим сделать forward.
Это эквивалентно request.getRequestDispatcher("hello.jsp").forward(req,res); Благодаря тому что в конфигах мы написали что наши все View хранятся в WEB-INF/pages и имеют расширение .jsp не нужно указывать полный путь с раширением.
Теперь нам нужно создать папку pages в WEB-INF, и там же создать наш View hello.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
  <head><title>Simple jsp page</title></head>
  <body>
  Hello <%= request.getAttribute("name")%>
  </body>
</html>


Ну вот и все запускаем, видим форму, сабмитим и видем торжественный Hello!
Исходники можно скачать тут и тут с либами
+4
5 марта 2010, 00:52
20

комментарии (6)

+3
beq #
Думаю, что статья будет полезна тем, кто хочет начать использовать Spring MVC или перейти на использование аннотаций. Однако, есть пара замечаний:

1. Код в статье неплохо было бы раскрасить, потому что сходу не понятно, где заканчивается объяснение и начинается код.

2. Зачем тянуть в xml-описание бинов все возможные нэймспейсы, даже если они не используются?

3. Можно ли View-ресолвер описать аннотациями?

Ну и возможно кому-то будет интересно: статья про использование Spring-аннотаций здесь на Хабре:

1. flashxl.habrahabr.ru/blog/48439/
2. habrahabr.ru/blogs/java/48606/
0
Mecid #
спасибо, за комментарии, будем менятся в лучшую сторону
+2
Colwin #
Хотелось бы подметить, что для больших проектов использование XML вместо аннотаций удобнее, т.к. можно последить весь маппинг в одном месте. Когда же маппинг размазан по классам, навигация становится затруднительной. Естественно, это относится к тому случаю, когда используемая IDE не поддерживает визуализацию маппинга, построенного на аннотациях.
Вторым аргументов в пользу XML является то, что при поддержке сервера с рабочим приложением при отсутствии актуальных (для данной конкретной версии) исходников наличие файла с маппингом — большой плюс.
0
Mecid #
конечно, вы правы, но есть места где аннотации удобнее
0
dborovikov #
Не соглашусь=) После перехода на аннотации это был как глоток свежего воздуха, причем для любых проектов.
1) Никаких проблем с навигацией не испытывал. IDE есть, как вы и подметили.
2) Как-то всегда были исходники под рукой. Может у вас проблемы с организацией процесса разработки?

Основное преимущество аннотаций это то, что не нужно все время прыгать между кодом и меппингами, да и многие ошибки видны compile-time.
–1
Colwin #
Я не зря подчеркнул слово «актуальные».
Проблема в том, что обычно в репозитории лежит рабочая версия кода, а на сервере — последний релиз. При этом иногда случаются форс-мажорные ситуации, когда в результате хот-фиксов релиз не соответствует НИ ОДНОЙ сборке из репозитория. Редкость, но все-таки иногда случается. В этом случае наличие XML предпочтительнее аннотаций.

Только зарегистрированные пользователи могут оставлять комментарии. Войдите, пожалуйста.