Añadir un controller de spring a nuestra aplicación web

Un Controller de spring se encarga de mapear las url de nuestra web con los programas java que se ejecutan.

Para añadir un controller sólo debemos añadir una clase java y marcarla con la anotación java @Controller.

A continuación podemos marcar algunos métodos de la clase java con la anotación java @RequestMapping indicando que este método se debe ejecutar en respuesta a una petición a la url que indiquemos como valor.

También podemos marcar el valor devuelto por la función con la anotación java @ResponseBody para que el Controller de spring use el valor devuelto por el método como el cuerpo de la respuesta html a la url anterior.

Es muy simple.

Añadir un fichero de configuración de springframework en springsource tool suite

La forma más sencilla de añadir un fichero de configuración de springframework a nuestro proyecto usando springsource tool suite es usando el diálogo que aparece cuando hacemos click en el menú "File - New - Other..." y a continuación filtramos por "spring".

Seleccionamos la opción "Spring Bean Configuration File" y seguimos las instrucciones.

Podremos añadir beans y contextos de spring de una forma muy fácil.

Cambiar la localización del fichero de configuración de springframework

Cuando usamos el DispatchServlet de springframework en nuestro proyecto web, este, por defecto, busca un archivo de configuración en el directorio WEB-INF con el siguiente nombre:

"nombre-del-servlet"-servlet.xml

Muchas veces nos será útil cambiar la localización y el nombre de este fichero para mantener todos los ficheros de configuración en el mismo sitio.

Para hacer esto podemos usar el parámetro de inicio llamado "contextConfigLocation" que indicará el nombre y localización del fichero de configuración.

Así, nuetro fichero web.xml quedaría algo como:

<web-app>
  <display-name>Nioos Api - Login</display-name>
  <servlet>
      <servlet-name>dispatcherServlet</servlet-name>
      <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
      <init-param>
          <param-name>contextConfigLocation</param-name>
          <param-value>/WEB-INF/conf/spring-config.xml</param-value>
          <description>Spring Framework context configuarion files location</description>
      </init-param>      <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
      <servlet-name>dispatcherServlet</servlet-name>
      <url-pattern>/*</url-pattern>
  </servlet-mapping>
</web-app>

Útil si nos gusta tener la cosas ordenadas.

Añadir las librerias de springframework usando maven

La forma más sencilla de añadir las librerías de spring a nuestro proyecto web es usando maven.

Lo único que hay que hacer es añadir la dependencia "spring-web" al fichero pom.xml de maven.

El fichero en cuestión quedará algo como:

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.nioos.api</groupId>
  <artifactId>NioosApiLogin</artifactId>
  <packaging>war</packaging>
  <version>0.0.1-SNAPSHOT</version>
  <name>Nioos Login Webapp</name>
  <url>https://api.nioos.com/NioosApiLogin</url>
  <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>
  <build>
    <finalName>NioosApiLogin</finalName>
  </build>
  <dependencies>
      <dependency>
          <groupId>org.springframework</groupId>
          <artifactId>spring-webmvc</artifactId>
          <version>3.1.1.RELEASE</version>
      </dependency>  </dependencies>
</project>

Esta única dependencia añadirá todo el resto de librerías necesarias para nuestro proyecto.

Agregar springframework a nuestro proyecto web

Spring es un framework de desarrollo de aplicaciones java muy popular que podemos usar para desarrollar nuestras aplicaciones web.

Para empezar a usarlo en nuestro proyecto web lo más simple es añadir uno de los servlets que vienen empaquetados con este framework, en concreto, el DispatcherServlet.

Para hacer esto sólo tenemos que modificar el fichero web.xml de nuestra aplicacion web y añadir el servlet y el mapeo correspondiente.

Por ejemplo:

<web-app>
  <display-name>Nioos Api - Login</display-name>
  <servlet>
      <servlet-name>dispatcherServlet</servlet-name>
      <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
      <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
      <servlet-name>dispatcherServlet</servlet-name>
      <url-pattern>/*</url-pattern>
  </servlet-mapping>
</web-app>

Fácil, ¿verdad?