ページの先頭行へ戻る
Interstage Business Application Server オープンJavaフレームワークユーザーズガイド GlassFish編
第2章 Spring Framework > 2.3 Spring Frameworkの機能 > 2.3.4 WebMVC機能
前次

2.3.4 WebMVC機能

WebMVC機能について説明します。

2.3.4.1 MVCフレームワーク

Spring Frameworkが提供するMVCフレームワークは、処理の中核を担うModel(M)と画面への表示・出力を担うView(V)、入力内容に基づいてModelとViewを制御するController(C)の3要素を組み合わせたMVCモデル2を採用し、Webアプリケーション開発を容易にする事を目的としたフレームワークです。

Webアプリケーション開発をサポートするSpring Web MVCフレームワークでは、以下の機能を提供します。

Spring Web MVCフレームワークは上記の機能によって、Webアプリケーション開発を支援します。

Spring Web MVCフレームワークではWebアプリケーション環境定義をXML形式(web.xml)またはJava形式で設定することが可能です。

例

各形式のWebアプリケーション環境定義の例を以下に示します。

XML形式のWebアプリケーション環境定義(web.xml)：

…
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/dispatcher-servlet.xml</param-value>
    </context-param>

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

    <servlet-mapping>
        <servlet-name>dispatcher</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
…

Java形式のWebアプリケーション環境定義：

public class UserWebApplicationInitializer implements WebApplicationInitializer {

    @Override
    public void onStartup(ServletContext container) {
        XmlWebApplicationContext appContext = new XmlWebApplicationContext();
        appContext.setConfigLocation("/WEB-INF/dispatcher-servlet.xml");
        ServletRegistration.Dynamic registration 
            = container.addServlet("dispatcher", new DispatcherServlet(appContext));
        registration.setLoadOnStartup(1);
        registration.addMapping("/");
    }
}

2.3.4.2 アノテーション付きコントローラ

@Controllerや@RestControllerを付与したクラスにおいて、リクエストのURLとメソッドのマッピング定義やリクエストの入力値の処理などを実現する機能です。

例

アノテーション付きコントローラの実装例を以下に示します

@Controller
public class UserController {
    @GetMapping(“/get”)
    public String get() {
        return “hello”;
    }
}

Spring FrameworkはURIを作成するAPIを提供します。

2.3.4.4 Viewテクノロジ

Viewテクノロジと連携し、処理結果をレンダリングする機能を提供します。

本製品は以下のViewテクノロジとの連携をサポートします。

Spring Frameworkのタグライブラリを使用する場合、以下のディレクトリーからSpring FrameworkのTLDファイル(spring.tld、spring-form.tld)をWEB-INFディレクトリーの下に配置してください。

/opt/FJSVibs/spring5/lib

[Interstageのインストールディレクトリー]\BAS\spring5\lib

2.3.4.5 HTTPキャッシング

キャッシュを制御する以下のヘッダーと連携し、リクエストに設定されたヘッダーの値へのアクセスやレスポンスへのヘッダーの設定などを実現する機能です。

2.3.4.6 HTTP/2サポート

Servlet 4.0から提供されるHTTPプロトコルのHTTP/2をサポートします。

2.3.4.7 WebSocket連携

GlassFishの標準機能であるJava API for WebSocketと連携できます。

Spring FrameworkのWebSocket連携機能は、Spring MVCベースの実装ができます。また、SockJSを使用することで、WebSocketに対応していないブラウザでもWebSocket連携ができます。

WebSocket連携を使用することで、Spring MVCと同様の方法でWebアプリケーションの実装が可能です。

例

Spring Frameworkで動作するWebSocketアプリケーションを作成するためには、下記のアプリケーションが必要です。

  • ハンドラークラス

  • 設定クラス

ハンドラークラスは、発行されたイベントに対応した処理を実装します。

送信を行うデータに応じてTextWebSocketHandler、BinaryWebSocketHandlerを継承して作成してください。

ハンドラークラスの作成:

テキストデータを扱う場合

import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

public class TestHandler extends TextWebSocketHandler {

    @Override
    public void handleTextMessage(WebSocketSession webSocketSession, TextMessage textMessage) throws Exception {
        // 文字列を送信する場合は、ここに処理を実装します。
        webSocketSession.sendMessage(textMessage);
    }
}

バイナリデータを扱う場合

import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

public class TestHandler extends BinaryWebSocketHandler{

    @Override
    public void handleBinaryMessage(WebSocketSession webSocketSession, BinaryMessage binaryMessage) throws Exception  {
        // バイナリデータを送信する場合は、ここに処理を実装します。
        webSocketSession.sendMessage(binaryMessage);
    }
}

設定クラスには、WebSocket上のリクエストを処理するハンドラーを登録する必要があります。WebSocketConfigurerインターフェースを実装して、クラスにConfigurationアノテーションとEnableWebSocketアノテーションを設定してください。

設定クラス:

import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        // イベントを処理するハンドラーを設定します。
        registry.addHandler(new testHandler(), "/echo");
    }
    @Bean
    public WebSocketHandler testHandler() {
        return new TestHandler();
    }
}
前次
Copyright 2023 Fujitsu Limited