使用JDBC和Spring訪問關係數據

本指南將引導您完成使用Spring訪問關係數據的過程。html

你要構建什麼

您將使用Spring構建一個JdbcTemplate應用程序來訪問存儲在關係數據庫中的數據。java

你須要什麼
如何完成本指南

與大多數Spring入門指南同樣,您能夠從頭開始並完成每一個步驟,或者您能夠繞過您已熟悉的基本設置步驟。不管哪一種方式,您最終都會使用工做代碼。github

從頭開始,請繼續使用Gradle構建。web

跳過基礎知識,請執行如下操做:spring

  • 下載並解壓縮本指南的源存儲庫,或使用Git克隆它:
git clone https://github.com/spring-guides/gs-relational-data-access.git
  • 進入gs-relational-data-access/initial
  • 跳轉到建立Customer對象。

完成後,能夠根據gs-relational-data-access/complete中的代碼檢查結果。數據庫

使用Gradle構建

首先,設置一個基本的構建腳本。在使用Spring構建應用程序時,您可使用任何您喜歡的構建系統,但此處包含了使用GradleMaven所需的代碼。若是您不熟悉這二者,請參閱使用Gradle構建Java項目使用Maven構建Java項目apache

建立目錄結構

在您選擇的項目目錄中,建立如下子目錄結構;例如,在*nix系統上使用mkdir -p src/main/java/hello:數組

└── src
    └── main
        └── java
            └── hello
建立Gradle構建文件

下面是最初的Gradle構建文件bash

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:2.0.3.RELEASE")
    }
}

apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'idea'
apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'

bootJar {
    baseName = 'gs-relational-data-access'
    version =  '0.1.0'
}

repositories {
    mavenCentral()
}

sourceCompatibility = 1.8
targetCompatibility = 1.8

dependencies {
    compile("org.springframework.boot:spring-boot-starter")
    compile("org.springframework:spring-jdbc")
    compile("com.h2database:h2")
    testCompile("junit:junit")
}

Spring Boot gradle plugin提供了許多便捷的功能:

  • 它收集類路徑上的全部jar並構建一個可運行的「über-jar」,這使得執行和傳輸服務更加方便。
  • 它搜索public static void main()標記爲可運行類的方法。
  • 它提供了一個內置的依賴項解析器,它設置版本號以匹配Spring Boot依賴項。您能夠覆蓋任何您但願的版本,但它將默認爲Boot的所選版本集。

使用Maven構建

首先,設置一個基本的構建腳本。在使用Spring構建應用程序時,您可使用任何您喜歡的構建系統,但此處包含了使用Maven所需的代碼。若是您不熟悉Maven,請參閱使用Maven構建Java項目

建立目錄結構

在您選擇的項目目錄中,建立如下子目錄結構;例如,在*nix系統上使用mkdir -p src/main/java/hello:

└── src
    └── main
        └── java
            └── hello

pom.xml

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

    <groupId>org.springframework</groupId>
    <artifactId>gs-relational-data-access</artifactId>
    <version>0.1.0</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.3.RELEASE</version>
    </parent>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
        </dependency>
    </dependencies>


    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

Spring Boot gradle plugin提供了許多便捷的功能:

  • 它收集類路徑上的全部jar並構建一個可運行的「über-jar」,這使得執行和傳輸服務更加方便。
  • 它搜索public static void main()標記爲可運行類的方法。
  • 它提供了一個內置的依賴項解析器,它設置版本號以匹配Spring Boot依賴項。您能夠覆蓋任何您但願的版本,但它將默認爲Boot的所選版本集。

使用IDE構建

建立一個Customer對象

您將在下面使用的簡單數據訪問邏輯管理客戶的名字和姓氏。要在應用程序級別表示此數據,請建立一個Customer類。

package hello;

public class Customer {
    private long id;
    private String firstName, lastName;

    public Customer(long id, String firstName, String lastName) {
        this.id = id;
        this.firstName = firstName;
        this.lastName = lastName;
    }

    @Override
    public String toString() {
        return String.format(
                "Customer[id=%d, firstName='%s', lastName='%s']",
                id, firstName, lastName);
    }

    // getters & setters omitted for brevity
}
存儲和檢索數據

Spring提供了一個名爲JdbcTemplate的模板類,能夠輕鬆使用SQL關係數據庫和JDBC。大多數JDBC代碼都陷入資源獲取,鏈接管理,異常處理和通常錯誤檢查之中,這與代碼要實現的內容徹底無關,JdbcTemplate負責這一切。您所要作的就是專一於手頭的任務。

src/main/java/hello/Application.java

package hello;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.jdbc.core.JdbcTemplate;

import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

@SpringBootApplication
public class Application implements CommandLineRunner {

    private static final Logger log = LoggerFactory.getLogger(Application.class);

    public static void main(String args[]) {
        SpringApplication.run(Application.class, args);
    }

    @Autowired
    JdbcTemplate jdbcTemplate;

    @Override
    public void run(String... strings) throws Exception {

        log.info("Creating tables");

        jdbcTemplate.execute("DROP TABLE customers IF EXISTS");
        jdbcTemplate.execute("CREATE TABLE customers(" +
                "id SERIAL, first_name VARCHAR(255), last_name VARCHAR(255))");

        // Split up the array of whole names into an array of first/last names
        List<Object[]> splitUpNames = Arrays.asList("John Woo", "Jeff Dean", "Josh Bloch", "Josh Long").stream()
                .map(name -> name.split(" "))
                .collect(Collectors.toList());

        // Use a Java 8 stream to print out each tuple of the list
        splitUpNames.forEach(name -> log.info(String.format("Inserting customer record for %s %s", name[0], name[1])));

        // Uses JdbcTemplate's batchUpdate operation to bulk load data
        jdbcTemplate.batchUpdate("INSERT INTO customers(first_name, last_name) VALUES (?,?)", splitUpNames);

        log.info("Querying for customer records where first_name = 'Josh':");
        jdbcTemplate.query(
                "SELECT id, first_name, last_name FROM customers WHERE first_name = ?", new Object[] { "Josh" },
                (rs, rowNum) -> new Customer(rs.getLong("id"), rs.getString("first_name"), rs.getString("last_name"))
        ).forEach(customer -> log.info(customer.toString()));
    }
}

@SpringBootApplication 是一個便利註釋,添加了如下全部內容:

  • @Configuration 標記該類做爲應用程序上下文的bean定義的源。
  • @EnableAutoConfiguration 告訴Spring Boot開始根據類路徑設置,其餘bean和各類屬性設置添加bean。
  • @ComponentScan告訴Spring在包中尋找其餘組件,配置和服務,容許它找到控制器。

main()方法使用Spring Boot的SpringApplication.run()方法來啓動應用程序。您是否注意到沒有一行XML?也沒有web.xml文件。此Web應用程序是100%純Java,您無需處理配置任何管道或基礎結構。

main()方法使用Spring Boot的SpringApplication.run()方法來啓動應用程序。您是否注意到沒有一行XML?也沒有web.xml文件。此Web應用程序是100%純Java,您無需處理配置任何管道或基礎結構。

Spring Boot支持H2,一種內存中的關係數據庫引擎,並自動建立鏈接。由於咱們使用的是spring-jdbc,Spring Boot會自動建立一個JdbcTemplate。@Autowired自動加載JdbcTemplate並使其可用。

這個Application類實現了Spring Boot CommandLineRunner,這意味着它將run()在加載應用程序上下文後執行該方法。

首先,使用JdbcTemplate’s `execute方法安裝一些DDL 。

其次,您獲取字符串列表並使用Java 8流,將它們拆分爲Java數組中的firstname/lastname對。

而後使用JdbcTemplate’s `batchUpdate方法在新建立的表中安裝一些記錄。方法調用的第一個參數是查詢字符串,最後一個參數(Objects 的數組)包含要替換爲「?」字符的查詢的變量。

對於單個插入語句,JdbcTemplate’s `insert方法很好。但對於多個,最好使用batchUpdate。

使用?的參數,以免SQL注入攻擊經過指示JDBC來綁定變量。

最後,使用query方法在表中搜索與條件匹配的記錄。您再次使用「?」參數爲查詢建立參數,在進行調用時傳入實際值。最後一個參數是用於將每一個結果行轉換爲新Customer對象的Java 8 lambda 。

Java 8 lambdas很好地映射到單個方法接口,如Spring的RowMapper。若是您使用的是Java 7或更早版本,則能夠輕鬆插入匿名接口實現,並具備與lambda expresion正文所包含的相同的方法體,而且它能夠絕不費力地使用Spring。

構建可執行的JAR

您可使用Gradle或Maven從命令行運行該應用程序。或者,您能夠構建一個包含全部必需依賴項,類和資源的可執行JAR文件,並運行該文件。這使得在整個開發生命週期中,跨不一樣環境等將服務做爲應用程序發佈,版本和部署變得容易。

若是您使用的是Gradle,則可使用運行該應用程序./gradlew bootRun。或者您可使用構建JAR文件./gradlew build。而後你能夠運行JAR文件:

java -jar build/libs/gs-relational-data-access-0.1.0.jar

若是您使用的是Maven,則可使用該應用程序運行該應用程序./mvnw spring-boot:run。或者您可使用構建JAR文件./mvnw clean package。而後你能夠運行JAR文件:

java -jar target/gs-relational-data-access-0.1.0.jar

上面的過程將建立一個可運行的JAR。您也能夠選擇構建經典WAR文件

顯示日誌輸出,您能夠從日誌中看到它在後臺線程上。您應該每隔5秒鐘看到計劃任務:

2015-06-19 10:58:31.152  INFO 67731 --- [           main] hello.Application                        : Creating tables
2015-06-19 10:58:31.219  INFO 67731 --- [           main] hello.Application                        : Inserting customer record for John Woo
2015-06-19 10:58:31.220  INFO 67731 --- [           main] hello.Application                        : Inserting customer record for Jeff Dean
2015-06-19 10:58:31.220  INFO 67731 --- [           main] hello.Application                        : Inserting customer record for Josh Bloch
2015-06-19 10:58:31.220  INFO 67731 --- [           main] hello.Application                        : Inserting customer record for Josh Long
2015-06-19 10:58:31.230  INFO 67731 --- [           main] hello.Application                        : Querying for customer records where first_name = 'Josh':
2015-06-19 10:58:31.242  INFO 67731 --- [           main] hello.Application                        : Customer[id=3, firstName='Josh', lastName='Bloch']
2015-06-19 10:58:31.242  INFO 67731 --- [           main] hello.Application                        : Customer[id=4, firstName='Josh', lastName='Long']
2015-06-19 10:58:31.244  INFO 67731 --- [           main] hello.Application                        : Started Application in 1.693 seconds (JVM running for 2.054)
概要

恭喜!您剛剛使用Spring開發了一個簡單的JDBC客戶端。

相關文章
相關標籤/搜索