SpringでシンプルなHello World

公式ドキュメントからの説明を示しつつHello Worldを書いていたのですが色々説明するところがあって書ききるのが遅くなりそうなのでほぼ説明無しでHello Worldの例を書くことにしました。
Web上で探せばたくさんあるからこれを書く意味あるかな?とも思いましたが自分用のメモも兼ねてますしあまり気にしないことにしました(笑)

以下で最小限にHello Worldします。

SampleWebAppという名前で/SampleWebApp/helloというURLでアクセスすると最終的にHelloWorld.jspの内容を表示する、という簡単なHello Worldを作成します。まずはweb.xmlから。

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns="http://xmlns.jcp.org/xml/ns/javaee"
  xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
  id="WebApp_ID" version="3.1">
  <display-name>SampleWebApp</display-name>

  <servlet>
    <servlet-name>SampleWebApp</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
  </servlet>

  <servlet-mapping>
    <servlet-name>SampleWebApp</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>
</web-app>

SpringのDispatcherServletのみを宣言しそれをContextRootにマッピングしています。DispatcherServletにinit-paramでcontextConfigLocationを指定することでSpringの設定ファイルやクラスを指定することも可能ですが指定しない場合は「/WEB-INF/<servlet-name>-servlet.xml」を読み込みます。今回のケースだとservlet-nameをSampleWebAppと指定しているのでDefaultの設定ファイルの名前はSampleWebApp.xmlとなります。

明示的に指定する場合はこんな感じですね。

    <servlet>
        <servlet-name>SampleWebApp</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>/WEB-INF/spring-context.xml</param-value>
        </init-param>
    </servlet>

次にSpringの設定ファイルです。

<?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/mvc"
  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/mvc
        http://www.springframework.org/schema/mvc/spring-mvc.xsd">

  <context:component-scan base-package="local.SampleWebApp" />
  <mvc:annotation-driven />

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

component-scanで指定したPackage以下からSpringのContextになるものを調べて管理してくれます。annotaion-drivenでアノテーションベースでの定義が可能になります。1)だったはず。

viewResolverで指定しているのはcontrollerが返したViewResource名に応じたJSPを自動的に選択してくれる設定です。Controllerが”HelloWorld”を返せば/Web-INF/jsp/HelloWorld.jspでClientにResponseを返してくれます。

あとはControllerとなるクラスとHTMLを出力するためのJSPです。

package local.SampleWebApp;

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

@Controller
public class HelloWorld {

	@RequestMapping("/hello")
	public String hello() {
		return "HelloWorld";
	}
}
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Hello World</title>
</head>
<body>
<H1>Hello World!</H1>
</body>
</html>

今更ですがもう少し処理を書き足せばよかったと思うぐらいシンプルですね…。@Controllerを付与したClassがControllerとして動くことを宣言し、@RequestMappingで該当メソッドが@RequestMappingで指定したURLで呼ばれるように宣言します。

この場合は/SampleWebApp/helloでHelloWorldクラスのhelloメソッドが呼ばれます。

helloメソッドは”HelloWorld”を返しているのみですが、返した内容によってViewResolverが出力するためのJSPなりを解決し出力を生成します。

本当にシンプルな内容になってしまいました。そのうちmessageSource、Locale等々の内容も記載します。2)予定

では。

References   [ + ]

1. だったはず。
2. 予定