SpringBootの場合はアノテーションを書くことで、設定ファイルをほとんど記載せずにアプリケーションを動かすことができます。

今回はSpringBootを使わずに、SpringMVCを利用してデータアクセスまでの動きや設定ファイルなどについて確認していきます。

またデータベースはPostgre環境を使っています。

やること

/get/userにアクセスする
データベースからデータを取得する
レスポンスを返す

一気にやるとわからなくなるので、一つずつ実装と設定をしていきます。

今回のソースコードは以下にあげております

https://github.com/jirentaicho/springframework-sample

環境構築

参考サイト

https://qiita.com/rubytomato@github/items/1d48ef0368e7297a1c5c

動的WEBプロジェクト→Maven化してpomを修正しました。

また当記事は「［改訂新版］Spring入門 ――Javaフレームワーク・より良い設計とアーキテクチャ」という本を参考にしています。

SpringMVCを利用してWebアプリケーションを作成する

まずは/get/userにアクセスして適当な文字列でも返せるようにします。

SpringMVCの設定ファイル

src/main/resources/META-INF/spring/beans-webmvc.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/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">

	<!-- Controllerのあるパッケージを指定する -->
	<context:component-scan base-package="com.volkruss.testspringf.controller"/>
</beans>

SpringMVCのカスタムスキーマを導入する
- ここが通常のBean定義ファイルと異なる
context:component-scan
- ここで指定したパッケージ配下のアノテーションが付いたクラスはコンポーネントとしてDIコンテナに登録される
- つまり@Controllerのついたクラスも対象となります

この作成したxmlをClassPathXmlApplicationContextの引数に渡すことでも動作しますが、今回はweb.xmlを作成してこれをロードします

web.xmlの作成

先ほど作った設定ファイルを読み込みます。またフロントコントローラーとしてSpringMVCが用意しているDispatcherServletを利用します。

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="
             http://xmlns.jcp.org/xml/ns/javaee
             http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1">
  <display-name>Sample MVC</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>
        classpath:/META-INF/spring/beans-webmvc.xml
      </param-value>
    </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>

DispatcherServlet
- フロントコントローラーで全てのHTTPリクエストを受け付ける。SpringMVCが用意しているDispartcherServletクラスを利用します。
- お決り的な書き方だと思います。

コントローラーの作成

@RestController
public class UserController {
	@GetMapping("/")
	public String home() {
		return "Welcome To Your App";
	}
	@GetMapping("/get/user")
	public String getUser() {
		return "UserA";
	}
}

@RestControllerでコントローラーとして設定されます
- 昔はインターフェースを実装するなどが必要だったそうです
- Spring v2.5以降は@Controllerアノテーションだけで設定ができるようになりました
- これでBean定義ができるので、コンポーネントスキャンさえされていれば利用可能です
/でホーム画面を想定したデータを返します
/get/userでユーザーの取得を想定したデータを返します

実行

この状態で実行しようとしても、SpringBootではないので実行ができません。※SpringBootはTomcatが内蔵されています

Tomcatをサーバーとして追加して、そこに作ったプロジェクトを乗せることで実行します。

サーバータブからクリエイトリンクを押してTomcatを追加します。※TomcatはEclipseのAllInOneに入ってたやつを使っています。

追加したTomcatサーバーを右クリックして追加と削除を行います

作っているプロジェクトを追加します。

これでTomcatを実行します。

うまく表示されていればOKです。

もちろんweb.xmlの設定ができていないと以下のように404エラーになってしまいます。

SpringBootを使えば一撃技ですが、SpringMVCを使う場合はこのように設定ファイルが大変ですね。ちなみにServlet3.0以降だとweb.xmlを使わずにプログラミングベースで設定する方法(WebApplicationInitializer)もあります※後述します

Bean定義を行う

コントローラーからサービスクラスを利用します。このサービスクラスは@Componentなどとしても良いのですが、今回は全てxmlファイルにて行います。

まずはサービスクラスのインターフェースと実装クラスを作成します

public interface UserService {
	String findUser();
}

public class UserServiceImpl implements UserService{

	@Override
	public String findUser() {
		return "find User";
	}
}

この実装クラスをBean定義に記載して、インジェクションできるかどうか確認しますので、とりあえず文字列を返すだけです。

Bean定義ファイルの作成

src\main\resources\META-INF\spring\beans-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"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
           http://www.springframework.org/schema/beans/spring-beans.xsd">
   <bean id="userService" class="com.volkruss.testspringf.application.service.impl.UserServiceImpl" >
   </bean>
</beans>

bean idはオブジェクトを一意にするもの
classはbean idの実態をパッケージ+クラス名で指定します

web.xmlの修正

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="
             http://xmlns.jcp.org/xml/ns/javaee
             http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1">
  <display-name>Sample MVC</display-name>
  <context-param>
  	<param-name>contextConfigLocation</param-name>
  	<param-value>
  		classpath:/META-INF/spring/beans-context.xml
  	</param-value>
  </context-param> 
  <listener>
    <listener-class>
      org.springframework.web.context.ContextLoaderListener
    </listener-class>
  </listener>
  <servlet>
    <servlet-name>dispatcherServlet</servlet-name>
    <servlet-class>
      org.springframework.web.servlet.DispatcherServlet
    </servlet-class>
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>
        classpath:/META-INF/spring/beans-webmvc.xml
      </param-value>
    </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>

context-paramのcontextConfigLocationに対してBean定義ファイルのパスを渡します
Listener-classにContextLoaderListenerを設定します
- このクラスはXmlWebApplicationContextクラス(Applicationコンテキスト)をロードします
- Bean定義に基づいてDIコンテナに登録しているような感じですね

コントローラーの修正

コントローラーを修正して、サービスクラスをインジェクションします。ここでは@Autowiredを使ってインジェクションします

@RestController
public class UserController {
	
	@Autowired
	private UserService userService;
	
	@GetMapping("/")
	public String home() {
		return "Welcome To Your App";
	}
	@GetMapping("/get/user")
	public String getUser() {
		String user = this.userService.findUser();
		return user;
	}
}

@Autowiredを使わない方法もあります。下記参照ください

リンク

画面にアクセスするとサービスクラスから取得できていることを確認できます

ここまでで

SpringMVCのxmlファイルの作成
Bean定義のxmlファイルを作成
web.xmlの作成

を行いました。これによって以下を確認しました。

/get/userにアクセスするとレスポンスが帰ってくる
DIできる

SpringJDBCを使う

手順としてはデータソース、JdbcTemplateのBeanを定義します。そしてJdbcTemplateを利用してSQLを発行する流れになります。

また通常データベースの接続情報はプロパティファイルなどに記載します。

依存の解決

pom.xmlを修正して、postgreとjdbcの利用準備をしておきます。またデータソースについても指定します

<dependencies>
	<dependency>
	    <groupId>org.springframework</groupId>
	    <artifactId>spring-webmvc</artifactId>
	    <version>5.3.20</version>
	</dependency>
	<!-- 追加 -->
	<dependency>
	    <groupId>org.postgresql</groupId>
	    <artifactId>postgresql</artifactId>
	    <version>42.3.5</version>
	</dependency>
	<dependency>
	    <groupId>org.springframework</groupId>
	    <artifactId>spring-jdbc</artifactId>
	    <version>5.3.20</version>
	</dependency>
	<dependency>
		<groupId>commons-dbcp</groupId>
		<artifactId>commons-dbcp</artifactId>
	<version>1.4</version>
</dependency>
</dependencies>

データソースのBean定義

データソースとしては以下のような取得方法がある

サードパーティ
JNDI経由
組み込みデータベースのデータソース
DriverManagerDataSource
- テスト用にピッタリ

今回は参考書籍にもあるサードパーティが提供するデータソースを利用します。src\main\resources\META-INF\spring\database-beans-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"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
           http://www.springframework.org/schema/beans/spring-beans.xsd">
   <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"
   	destroy-method="close">
   	<property name="driverClassName" value="" />
	<property name="url" value="" />
	<property name="username" value="" />
	<property name="password" value="" />
	<property name="maxActive" value="" />
   	</bean>
</beans>

dataSourceにBasicDataSourceを利用します
データベースの接続情報はプロパティファイルから読み取るため空白にしています。

次にプロパティファイルを作成しますsrc\main\resources\jdbc.properties

jdbc.driverClassName=org.postgresql.Driver
jdbc.url=jdbc:postgresql://192.168.11.13:5432/zenn
jdbc.username=zenn
jdbc.password=zenn
jdbc.maxPoolSize=20

自分の環境に合わせて接続情報を記載します

次にdatabase-beans-context.xmlを修正します。今作成したjdbc.propertiesを利用するようにします

<?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"
       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-4.3.xsd
           ">
   <context:property-placeholder location="classpath:jdbc.properties"/>
   <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"
   	destroy-method="close">
	<property name="driverClassName" value="${jdbc.driverClassName}" />
	<property name="url" value="${jdbc.url}" />
	<property name="username" value="${jdbc.username}" />
	<property name="password" value="${jdbc.password}" />
	<property name="maxActive" value="${jdbc.maxPoolSize}" />
   	</bean>
</beans>

context:property-placeholderタグでプロパティファイルを読み取ります
- 利用にあたってbeansタグも修正が入ってます
${}でプロパティのキーを指定

JDBCのBean定義

SpringJDBCを利用します。database-beans-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:context="http://www.springframework.org/schema/context"
       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-4.3.xsd
           ">
   <context:property-placeholder location="classpath:jdbc.properties"/>
   <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"
   	destroy-method="close">
	<property name="driverClassName" value="${jdbc.driverClassName}" />
	<property name="url" value="${jdbc.url}" />
	<property name="username" value="${jdbc.username}" />
	<property name="password" value="${jdbc.password}" />
	<property name="maxActive" value="${jdbc.maxPoolSize}" />
   	</bean>
   	<!-- JDBC -->
	<bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate">
	    <constructor-arg ref="dataSource" />
	</bean>
</beans>

jdbcTemplateのBeanを定義します
コンストラクターにdataSourceを指定します

web.xmlの修正

今作ったbean定義をweb.xmlで読み取っておきます

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="
             http://xmlns.jcp.org/xml/ns/javaee
             http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1">
  <display-name>Sample MVC</display-name>
  <context-param>
  	<param-name>contextConfigLocation</param-name>
  	<param-value>
  		classpath:/META-INF/spring/beans-context.xml classpath:/META-INF/spring/database-beans-context.xml
  	</param-value>
  </context-param> 
  
  <listener>
    <listener-class>
      org.springframework.web.context.ContextLoaderListener
    </listener-class>
  </listener>
  <servlet>
    <servlet-name>dispatcherServlet</servlet-name>
    <servlet-class>
      org.springframework.web.servlet.DispatcherServlet
    </servlet-class>
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>
        classpath:/META-INF/spring/beans-webmvc.xml
      </param-value>
    </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>

複数のBean定義を利用する場合は、空白で区切るだけでOKです
- 空白以外にも改行、セミコロン、カンマでもOK

SQLを発行する

実際にSQLを発行してみます。DAOに書くべきですが、サービスクラスで直接使ってしまいます。

public class UserServiceImpl implements UserService{
	
	private JdbcTemplate jdbcTemplate;
	
	@Override
	public String findUser() {
		// SQLを発行
		String result = this.jdbcTemplate.queryForObject("select name from characters where id = 6", String.class);
		return result;
	}
	
	// インジェクション用のメソッド
	public void setJdbcTemplate(JdbcTemplate jdbcTemplate) {
		this.jdbcTemplate = jdbcTemplate;
	}
}

先ほどBean定義したJdbcTemplateをアクセサメソッドを介してインジェクションさせます
- ※Bean定義したクラスから@Autowiredを呼べなかった(未確認)のでアクセサメソッドを介しています。
queryForObjectは戻り値の型を指定できます。実際のSQLの結果が1件1カラムなのでString.classを取得しています。

次にこのサービスクラスのBean定義を修正してJdbcTemplateをインジェクションするようにします

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
           http://www.springframework.org/schema/beans/spring-beans.xsd">
   <bean id="userService" class="com.volkruss.testspringf.application.service.impl.UserServiceImpl" >
   	<property name="jdbcTemplate" ref="jdbcTemplate"></property>
   </bean>
</beans>

propertyのrefに別ファイルで定義しているjdbcTemplateというbean idのものを指定します
- 別ファイルのためrefを指定
- localだと同一ファイルで指定できるらしい？local=”jdbcTemplate”>
  - local=”jdbcTemplate”>

ちなみにデータベースはこのようになっています

※今回はあえて日本語を避けています

WebApplicationInitializer

Servlet3.0以降はServletやFilterなどweb.xmlに記載していたものを、プログラミングベースで記載できるようになりました。とのことです。

https://spring.pleiades.io/spring-framework/docs/current/javadoc-api/org/springframework/web/WebApplicationInitializer.html

今回のweb.xmlをプログラミングベースで書き直したものを掲載します

package com.volkruss.testspringf;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;

import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.support.XmlWebApplicationContext;
import org.springframework.web.servlet.support.AbstractDispatcherServletInitializer;

public class WebApplicationXmlConfig extends AbstractDispatcherServletInitializer{

	@Override
	protected WebApplicationContext createServletApplicationContext() {
		XmlWebApplicationContext ctx = new XmlWebApplicationContext();
		ctx.setConfigLocation("classpath:/META-INF/spring/beans-webmvc.xml");
		return ctx;
	}

	@Override
	protected String[] getServletMappings() {
		return new String[] {"/"};
	}

	@Override
	protected WebApplicationContext createRootApplicationContext() {
		XmlWebApplicationContext ctx = new XmlWebApplicationContext();
		ctx.setConfigLocations(
				"classpath:/META-INF/spring/beans-context.xml",
				"classpath:/META-INF/spring/database-beans-context.xml");
		return ctx;
	}
	
	// 必須のメソッド
	@Override
	public void onStartup(ServletContext servletContext) throws ServletException {
		super.onStartup(servletContext);
	}

}

JavaConfgiを使う場合はAbstractAnnotationConfigDispatcherServletInitializerを利用します
web.xmlを削除して実行しています
依存モジュールを追加ています

<dependency>
    <groupId>javax</groupId>
    <artifactId>javaee-api</artifactId>
    <version>7.0</version>
    <scope>provided</scope>
</dependency>

web.xmlを使わないバージョンは以下のブランチにソースをあげております

https://github.com/jirentaicho/springframework-sample/tree/dev2

エラー

classpath:が記載されていない可能性があります。
- <context:property-placeholder location=”classpath:jdbc.properties” />

利用しているデータソースが異なっている場合があります今回の記事で利用しているのは”org.apache.commons.dbcp.BasicDataSource”です。

確認してみるとデータベースからレコードを取得できていることがわかります

参考

http://teqspaces.com/Spring/2

http://terasolunaorg.github.io/guideline/current/ja/ArchitectureInDetail/GeneralFuncDetail/PropertyManagement.html

SpringMVCとJDBCでデータアクセスを行う | 設定ファイル