Spring JdbcTemplate示例

教學

Spring

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类中通过bean进行实现。

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數據源配置

下一步是創建Spring配置類來定義 DataSource bean。我使用基於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)，會返回我們模型類別的一個實例（即 Person）。

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 類別

最後一步是創建 DAO 類別，使用 SQL 查詢將我們的模型類別映射到資料庫表格。我們還將使用 @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就是這些了，您可以從以下鏈接下載最終項目。

下載Spring JdbcTemplate示例項目

參考： API文檔

Source:
https://www.digitalocean.com/community/tutorials/spring-jdbctemplate-example