Spring JdbcTemplateの例

Spring JdbcTemplateは、Spring JDBCパッケージで最も重要なクラスです。

Spring JdbcTemplate

• JDBCは、データベースへの接続の開閉、SQL例外の処理など、多くの定型コードを生成します。これにより、コードが非常に手間がかかり、読みにくくなります。
• Spring FrameworkでJDBCを実装すると、多くの低レベルの操作（接続の開閉、SQLクエリの実行など）を処理する必要があります。
• これにより、Spring Frameworkでデータベースと連携する場合、データベースからの接続パラメーターの定義とSQLクエリの登録のみを行う必要があり、その他の作業はSpringによって自動的に処理されます。
• SpringのJDBCには、データベースとのやり取りのためのいくつかのクラス（いくつかのアプローチ）があります。その中で最も一般的なのは、JdbcTemplateクラスを使用する方法です。これは、すべてのイベントとデータベース接続の処理を管理する基本クラスです。
• JdbcTemplateクラスは、SQLクエリを実行し、ResultSetを反復処理し、呼び出された値を取得し、命令とプロシージャの呼び出しを更新し、例外を「キャッチ」し、org.springframwork.daoパッケージで定義された例外に変換します。
• インスタンスのJdbcTemplateクラスはスレッドセーフです。これは、JdbcTemplateクラスの単一のインスタンスを構成することで、それを複数のDAOオブジェクトで使用できることを意味します。
• JdbcTemplateを使用する場合、ほとんどの場合、Spring構成ファイルで構成されます。その後、DAOクラスでビーンを使用して実装されます。

Spring JdbcTemplateの例

Spring JdbcTemplateの例プログラムを見てみましょう。ここではPostgresqlデータベースを使用していますが、MySQLやOracleなど他のリレーショナルデータベースも使用できます。必要なのはデータベースの構成を変更することだけです。まず、作業するためにいくつかのサンプルデータが必要です。以下のSQLクエリはテーブルを作成し、いくつかのデータで埋めるためのものです。

create table people (
id serial not null primary key,
first_name varchar(20) not null,
last_name varchar(20) not null,
age integer not null
);

insert into people (id, first_name, last_name, age) values
(1, 'Vlad', 'Boyarskiy', 21),
(2,'Oksi', ' Bahatskaya', 30),
(3,'Vadim', ' Vadimich', 32);

以下の画像はEclipseでの最終的なプロジェクト構造を示しています。

Spring JDBC Maven依存関係

以下の依存関係が必要です- spring-core、spring-context、spring-jdbc、およびpostgresql。 MySQLなどの他のリレーショナルデータベースを使用している場合は、対応するJavaドライバーの依存関係を追加してください。 以下が私たちの最終的なpom.xmlファイルです。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="https://maven.apache.org/POM/4.0.0" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>

	<groupId>com.journaldev.spring</groupId>
	<artifactId>JdbcTemplate</artifactId>
	<version>1.0-SNAPSHOT</version>
	<properties>
		<spring.framework>4.3.0.RELEASE</spring.framework>
		<postgres.version>42.1.4</postgres.version>
	</properties>
	<dependencies>
		<dependency>
			<groupId>org.postgresql</groupId>
			<artifactId>postgresql</artifactId>
			<version>${postgres.version}</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-core</artifactId>
			<version>${spring.framework}</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-context</artifactId>
			<version>${spring.framework}</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-jdbc</artifactId>
			<version>${spring.framework}</version>
		</dependency>
	</dependencies>

</project>

Springデータソースの設定

次のステップは、DataSourceビーンを定義するSpring構成クラスを作成することです。 私はJavaベースの構成を使用していますが、Spring Bean構成XMLファイルを使用してこれを行うこともできます。

package com.journaldev.spring.config;

import javax.sql.DataSource;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import org.springframework.core.env.Environment;
import org.springframework.jdbc.datasource.DriverManagerDataSource;

@Configuration
@ComponentScan("com.journaldev.spring")
@PropertySource("classpath:database.properties")
public class AppConfig {

	@Autowired
	Environment environment;

	private final String URL = "url";
	private final String USER = "dbuser";
	private final String DRIVER = "driver";
	private final String PASSWORD = "dbpassword";

	@Bean
	DataSource dataSource() {
		DriverManagerDataSource driverManagerDataSource = new DriverManagerDataSource();
		driverManagerDataSource.setUrl(environment.getProperty(URL));
		driverManagerDataSource.setUsername(environment.getProperty(USER));
		driverManagerDataSource.setPassword(environment.getProperty(PASSWORD));
		driverManagerDataSource.setDriverClassName(environment.getProperty(DRIVER));
		return driverManagerDataSource;
	}
}

• @Configuration – このクラスがSpringコンテキストの構成であることを示します。
• @ComponentScan(“com.journaldev.spring”)- コンポーネントクラスをスキャンするパッケージを指定します。
• @PropertySource(“classpath:database.properties”)- プロパティはdatabase.propertiesファイルから読み込まれます。

database.propertiesファイルの内容は以下のとおりです。

driver=org.postgresql.Driver
url=jdbc:postgresql://127.0.0.1:5432/school
dbuser=postgres
dbpassword=postgres

MySQLまたは他のリレーショナルデータベースを使用している場合は、上記の構成を適宜変更してください。

Spring JDBC モデルクラス

次のステップは、データベーステーブルをマップするためのモデルクラスを作成することです。

package com.journaldev.model;

public class Person {
	private Long id;
	private Integer age;
	private String firstName;
	private String lastName;

	public Person() {
	}

	public Person(Long id, Integer age, String firstName, String lastName) {
		this.id = id;
		this.age = age;
		this.firstName = firstName;
		this.lastName = lastName;
	}

	public Long getId() {
		return id;
	}

	public void setId(Long id) {
		this.id = id;
	}

	public Integer getAge() {
		return age;
	}

	public void setAge(Integer age) {
		this.age = age;
	}

	public String getFirstName() {
		return firstName;
	}

	public void setFirstName(String firstName) {
		this.firstName = firstName;
	}

	public String getLastName() {
		return lastName;
	}

	public void setLastName(String lastName) {
		this.lastName = lastName;
	}

	@Override
	public String toString() {
		return "Person{" + "id=" + id + ", age=" + age + ", firstName='" + firstName + '\'' + ", lastName='" + lastName
				+ '\'' + '}';
	}
}

データベースからデータを取得するためには、RowMapperインターフェースを実装する必要があります。このインターフェースには、mapRow(ResultSet resultSet, int i)という1つのメソッドだけがあり、このメソッドはモデルクラス（つまり、Person）のインスタンスを1つ返します。

package com.journaldev.model;

import java.sql.ResultSet;
import java.sql.SQLException;

import org.springframework.jdbc.core.RowMapper;

public class PersonMapper implements RowMapper<Person> {

	public Person mapRow(ResultSet resultSet, int i) throws SQLException {

		Person person = new Person();
		person.setId(resultSet.getLong("id"));
		person.setFirstName(resultSet.getString("first_name"));
		person.setLastName(resultSet.getString("last_name"));
		person.setAge(resultSet.getInt("age"));
		return person;
	}
}

Spring JDBC DAO クラス

最終ステップは、SQLクエリを使用してモデルクラスをデータベーステーブルにマップするDAOクラスを作成することです。また、@Autowired注釈を使用してDataSourceを構成し、一部のAPIを公開します。

package com.journaldev.spring.dao;

import java.util.List;

import com.journaldev.model.Person;

public interface PersonDAO {
	Person getPersonById(Long id);

	List<Person> getAllPersons();

	boolean deletePerson(Person person);

	boolean updatePerson(Person person);

	boolean createPerson(Person person);
}

package com.journaldev.spring.dao;

import java.util.List;

import javax.sql.DataSource;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Component;

import com.journaldev.model.Person;
import com.journaldev.model.PersonMapper;

@Component
public class PersonDAOImpl implements PersonDAO {

	JdbcTemplate jdbcTemplate;

	private final String SQL_FIND_PERSON = "select * from people where id = ?";
	private final String SQL_DELETE_PERSON = "delete from people where id = ?";
	private final String SQL_UPDATE_PERSON = "update people set first_name = ?, last_name = ?, age  = ? where id = ?";
	private final String SQL_GET_ALL = "select * from people";
	private final String SQL_INSERT_PERSON = "insert into people(id, first_name, last_name, age) values(?,?,?,?)";

	@Autowired
	public PersonDAOImpl(DataSource dataSource) {
		jdbcTemplate = new JdbcTemplate(dataSource);
	}

	public Person getPersonById(Long id) {
		return jdbcTemplate.queryForObject(SQL_FIND_PERSON, new Object[] { id }, new PersonMapper());
	}

	public List<Person> getAllPersons() {
		return jdbcTemplate.query(SQL_GET_ALL, new PersonMapper());
	}

	public boolean deletePerson(Person person) {
		return jdbcTemplate.update(SQL_DELETE_PERSON, person.getId()) > 0;
	}

	public boolean updatePerson(Person person) {
		return jdbcTemplate.update(SQL_UPDATE_PERSON, person.getFirstName(), person.getLastName(), person.getAge(),
				person.getId()) > 0;
	}

	public boolean createPerson(Person person) {
		return jdbcTemplate.update(SQL_INSERT_PERSON, person.getId(), person.getFirstName(), person.getLastName(),
				person.getAge()) > 0;
	}
}

PersonDAOImplクラスは@Component注釈で注釈付けされており、このクラスにはJdbcTemplate型のフィールドがあります。このクラスのコンストラクタが呼び出されると、DataSourceのインスタンスが注入され、JdbcTemplateのインスタンスを作成できます。その後、それをメソッドで使用できます。

Spring JdbcTemplate テストプログラム

当社のSpring JdbcTemplateの例題プロジェクトが準備されました。テストクラスでこれをテストしましょう。

package com.journaldev;

import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import com.journaldev.model.Person;
import com.journaldev.spring.config.AppConfig;
import com.journaldev.spring.dao.PersonDAO;

public class Main {
	public static void main(String[] args) {
		AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);

		PersonDAO personDAO = context.getBean(PersonDAO.class);

		System.out.println("List of person is:");

		for (Person p : personDAO.getAllPersons()) {
			System.out.println(p);
		}

		System.out.println("\nGet person with ID 2");

		Person personById = personDAO.getPersonById(2L);
		System.out.println(personById);

		System.out.println("\nCreating person: ");
		Person person = new Person(4L, 36, "Sergey", "Emets");
		System.out.println(person);
		personDAO.createPerson(person);
		System.out.println("\nList of person is:");

		for (Person p : personDAO.getAllPersons()) {
			System.out.println(p);
		}

		System.out.println("\nDeleting person with ID 2");
		personDAO.deletePerson(personById);

		System.out.println("\nUpdate person with ID 4");

		Person pperson = personDAO.getPersonById(4L);
		pperson.setLastName("CHANGED");
		personDAO.updatePerson(pperson);

		System.out.println("\nList of person is:");
		for (Person p : personDAO.getAllPersons()) {
			System.out.println(p);
		}

		context.close();
	}
}

以下の画像は、上記のプログラムを実行したときに生成される出力を示しています。出力はサンプルデータと複数の実行に基づいて異なりますが、ここでは例題プログラムを使用する方法を学ぶことが目的です。Spring JdbcTemplateについては以上です。以下のリンクから最終プロジェクトをダウンロードできます。

Spring JdbcTemplateの例題プロジェクトのダウンロード

参考: APIドキュメント