Najprostrzy serwis REST za pomocą spring mvc i tomcata

1. Tworzymy projekt mavenowy w eclipsie z archetypu maven.archetype.webapp

2. Dodajemy potrzebne zależności do poma:

<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.java.ro</groupId>
    <artifactId>RestMvc</artifactId>
    <packaging>war</packaging>
    <version>0.0.1-SNAPSHOT</version>
    <name>RestMvc Maven Webapp</name>
    <url>http://maven.apache.org</url>
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>3.8.1</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>3.2.8.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
            <version>2.5</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>org.codehaus.jackson</groupId>
            <artifactId>jackson-mapper-asl</artifactId>
            <version>1.4.1</version>
        </dependency>
    </dependencies>
    <build>
        <finalName>RestMvc</finalName>
    </build>
</project>


3. Następnie konfigurujemy dispacher servlet w web.xml który będzie nam obsługiwał żądania i przekazywał dalej. Servlet potrzebuje contextu springa który podawany jest w parametrze.

<!DOCTYPE web-app PUBLIC
 "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
 "http://java.sun.com/dtd/web-app_2_3.dtd" >

<web-app>
    <display-name>RestMvc</display-name>
    <servlet>
        <servlet-name>appServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>/WEB-INF/spring/servlet-context.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>appServlet</servlet-name>
        <url-pattern>*.json</url-pattern>
    </servlet-mapping>
</web-app>

 4. Kolejną konfiguracyjną rzeczą jest stworzenie pliku kontekstu spring który jest podawany do dispatcher servletu (/WEB-INF/spring/servlet-context.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:mvc="http://www.springframework.org/schema/mvc"
    xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.2.xsd
        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-3.2.xsd">

    <mvc:annotation-driven/>
  
    <context:component-scan base-package="com.java.ro.restmvc.controler"/>
  
    <bean class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver">
        <property name="order" value="1"/>
    </bean>
</beans>

5. Teraz jesteśmy już gotowi do stworzenia kontrolera który obsłuży nam żądanie i zwróci dane w formacie json:

5.1 Potrzebujemy danych które zostaną zwrócone:

package com.java.ro.restmvc.model;

import java.util.Date;

public class Person {
   
    private String name;
    private String surname;
    private Date dateOfBirth;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getSurname() {
        return surname;
    }

    public void setSurname(String surname) {
        this.surname = surname;
    }

    public Date getDateOfBirth() {
        return dateOfBirth;
    }

    public void setDateOfBirth(Date dateOfBirth) {
        this.dateOfBirth = dateOfBirth;
    }
}

5.2 Kontroler który obsłuży żądanie:

package com.java.ro.restmvc.controler;

import java.util.Date;

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

import com.java.ro.restmvc.model.Person;


@Controller
public class PersonControler {
   
    @RequestMapping(value="/getPerson", method= RequestMethod.GET)
    public @ResponseBody Person getPerson() {
        Person p = new Person();
        p.setDateOfBirth(new Date());
        p.setName("Jan");
        p.setSurname("Kowalski");
        return p;
    }
}

6. Teraz wystarczy podłączyć Tomcata do eclipsa, dodać projekt i uruchomić.
7. Aby dostać się do danych wystarczy w przeglądarce wpisać:

http://localhost:8080/RestMvc/getPerson.json

Oto wynik: