SpringBoot使用編程方式配置DataSource的方法

更新時間：2019年01月28日 17:16:43 作者：qianmoQ

這篇文章主要介紹了SpringBoot使用編程方式配置DataSource的方法，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧

Spring Boot使用固定算法來掃描和配置DataSource。這使我們可以在默認情況下輕松獲得完全配置的DataSource實現(xiàn)。

Spring Boot還會按順序快速的自動配置連接池（HikariCP， Apache Tomcat或Commons DBCP），具體取決于路徑中的哪些類。

雖然Spring Boot的DataSource自動配置在大多數情況下運行良好，但有時我們需要更高級別的控制，因此我們必須設置自己的DataSource實現(xiàn)，因此忽略自動配置過程。

Maven依賴

總體而言，以編程方式創(chuàng)建DataSource實現(xiàn)非常簡單。

為了學習如何實現(xiàn)這一目標，我們將實現(xiàn)一個簡單的存儲庫層，它將對某些JPA實體執(zhí)行CRUD操作。

我們來看看我們的演示項目的依賴項：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
  <groupId>com.h2database</groupId>
  <artifactId>h2</artifactId>
  <version>2.4.1</version> 
  <scope>runtime</scope> 
</dependency>

我們將使用內存中的H2數據庫實例來運行存儲庫層。通過這樣做，我們將能夠測試以編程方式配置的DataSource，而無需執(zhí)行昂貴的數據庫操作。

讓我們確保在Maven Central上查看最新版本的spring-boot-starter-data-jpa。

配置DataSource

如果我們堅持使用Spring Boot的DataSource自動配置并以當前狀態(tài)運行我們的項目，程序將按預期工作。

Spring Boot將為我們完成所有重型基礎設施管道。這包括創(chuàng)建H2 DataSource實現(xiàn)，該實現(xiàn)將由HikariCP，Apache Tomcat或Commons DBCP自動處理，并設置內存數據庫實例。

此外，我們甚至不需要創(chuàng)建application.properties文件，因為Spring Boot也會提供一些默認的數據庫設置。

正如我們之前提到的，有時我們需要更高級別的自定義，因此我們必須以編程方式配置我們自己的DataSource實現(xiàn)。

實現(xiàn)此目的的最簡單方法是定義DataSource工廠方法，并將其放在使用@Configuration注解的類中：

@Configuration
public class DataSourceConfig {
   
  @Bean
  public DataSource getDataSource() {
    DataSourceBuilder dataSourceBuilder = DataSourceBuilder.create();
    dataSourceBuilder.driverClassName("org.h2.Driver");
    dataSourceBuilder.url("jdbc:h2:mem:test");
    dataSourceBuilder.username("SA");
    dataSourceBuilder.password("");
    return dataSourceBuilder.build();
  }
}

在這種情況下，我們使用方便的DataSourceBuilder類 - 一個簡潔的Joshua Bloch構建器模式 - 以編程方式創(chuàng)建我們的自定義DataSource對象。

這種方法非常好，因為構建器可以使用一些常用屬性輕松配置DataSource。此外，它還可以使用底層連接池。

使用application.properties文件外部化DataSource配置

當然，也可以部分外部化我們的DataSource配置。例如，我們可以在工廠方法中定義一些基本的DataSource屬性：

@Bean
public DataSource getDataSource() { 
  DataSourceBuilder dataSourceBuilder = DataSourceBuilder.create(); 
  dataSourceBuilder.username("SA"); 
  dataSourceBuilder.password(""); 
  return dataSourceBuilder.build(); 
}

并在application.properties文件中指定一些額外的配置：

spring.datasource.url=jdbc:h2:mem:test
spring.datasource.driver-class-name=org.h2.Driver

在外部源中定義的屬性（例如上面的application.properties文件或通過使用@ConfigurationProperties注解的類）將覆蓋Java API中定義的屬性。

很明顯，通過這種方法，我們不再將DataSource配置設置保存在一個地方。

另一方面，它允許我們保持編譯時和運行時配置彼此并很好地分離。

這非常好，因為它允許我們輕松設置綁定點。這樣我們可以從其他來源包含不同的DataSource，而無需重構我們的bean工廠方法。

測試DataSource配置
測試我們的自定義DataSource配置非常簡單。整個過程歸結為創(chuàng)建JPA實體，定義基本存儲庫接口以及測試存儲庫層。

創(chuàng)建JPA實體

讓我們開始定義我們的示例JPA實體類，它將為用戶建模：

@Entity
@Table(name = "users")
public class User {
   
  @Id
  @GeneratedValue(strategy = GenerationType.AUTO)
  private long id;
  private String name;
  private String email;
 
  // standard constructors / setters / getters / toString
   
}

存儲庫層

我們需要實現(xiàn)一個基本的存儲庫層，它允許我們對上面定義的User實體類的實例執(zhí)行CRUD操作。

由于我們使用的是Spring Data JPA，因此我們不必從頭開始創(chuàng)建自己的DAO實現(xiàn)。我們只需要擴展CrudRepository接口獲得一個工作的存儲庫實現(xiàn)：

@Repository
public interface UserRepository extends CrudRepository<User, Long> {}

測試存儲庫層

最后，我們需要檢查我們的編程配置的DataSource是否實際工作。我們可以通過集成測試輕松完成此任務：

@RunWith(SpringRunner.class)
@DataJpaTest
public class UserRepositoryIntegrationTest {
   
  @Autowired
  private UserRepository userRepository;
  
  @Test
  public void whenCalledSave_thenCorrectNumberOfUsers() {
    userRepository.save(new User("Bob", "bob@domain.com"));
    List<User> users = (List<User>) userRepository.findAll();
     
    assertThat(users.size()).isEqualTo(1);
  }  
}

UserRepositoryIntegrationTest類是測試用例。它只是運行兩個存儲庫接口的CRUD方法來持久化并查找實體。

請注意，無論我們是否決定以編程方式配置DataSource實現(xiàn)，或將其拆分為Java配置方法和application.properties文件，我們都應該始終獲得有效的數據庫連接。

運行示例應用程序

最后，我們可以使用標準的main()方法運行我們的演示應用程序：

@SpringBootApplication
public class Application {
 
  public static void main(String[] args) {
    SpringApplication.run(Application.class, args);
  }
 
  @Bean
  public CommandLineRunner run(UserRepository userRepository) throws Exception {
    return (String[] args) -> {
      User user1 = new User("John", "john@domain.com");
      User user2 = new User("Julie", "julie@domain.com");
      userRepository.save(user1);
      userRepository.save(user2);
      userRepository.findAll().forEach(user -> System.out.println(user);
    };
  }
}

我們已經測試了存儲庫層，因此我們確信我們的DataSource已經成功配置。因此，如果我們運行示例應用程序，我們應該在控制臺輸出中看到存儲在數據庫中的User實體列表。

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: