connection-pool feature:

PouyaPouryaie · PouyaPouryaie · commit 6eb6129b2a44 · 2021-09-30T14:03:32.000+03:30
add HikariCp as dataSource alongside normal dataSource
diff --git a/README.md b/README.md
@@ -5,7 +5,9 @@ This project, implement instance of basic feature, <br> you maybe want use for A
 ## basicFeature
 - spring-web
 - spring-jpa
-    - with custom configuration for PersistenceContext 
+    - with custom configuration for PersistenceContext
+- Connection-pool
+    - HikariCp with Possibility of customization
 - Ehcache 
     - customize cache config and implement log for cache
 - Log4j2 
@@ -67,4 +69,8 @@ This project, implement instance of basic feature, <br> you maybe want use for A
 3 - sample test define in test directory with groovy language <br>
 4 - Swagger Api for show details of endpoints <br>
 5 - In order to change swagger url, you must be change springdoc.swagger-ui.path property in application-dev.properties <br>
-6 - TestContainer for run db as dockerImage, properties config exist in application-test.properties <br>
+6 - TestContainer for run db as dockerImage, properties config exist in application-test.properties <br>
+
+### dataSource feature
+1 - choose between use simpleDataSource or HikariCp datasource <br>
+2 - you can customize properties for dataSource in application.properties
diff --git a/pom.xml b/pom.xml
@@ -10,7 +10,7 @@
 	</parent>
 	<groupId>ir.bigz</groupId>
 	<artifactId>springboot-real</artifactId>
-	<version>1.2.0</version>
+	<version>1.3.0</version>
 	<name>basicFeaturesForSpringProject</name>
 	<description>Demo project for use Spring Boot in project</description>
 
diff --git a/src/main/java/ir/bigz/springbootreal/configuration/DataSourceConfiguration.java b/src/main/java/ir/bigz/springbootreal/configuration/DataSourceConfiguration.java
@@ -1,11 +1,7 @@
 package ir.bigz.springbootreal.configuration;
 
-import com.zaxxer.hikari.HikariConfig;
-import com.zaxxer.hikari.HikariDataSource;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties;
-import org.springframework.boot.context.properties.ConfigurationProperties;
-import org.springframework.boot.jdbc.DataSourceBuilder;
+import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.core.env.Environment;
@@ -24,50 +20,16 @@ public class DataSourceConfiguration {
     @Autowired
     private Environment env;
 
-    @Bean
-    @ConfigurationProperties(prefix = "demo.datasource")
-    public DataSourceProperties dataSourceProperties() {
-        return new DataSourceProperties();
-    }
-
-
-    @Bean
-    public DataSource dataSource() {
-        DataSourceProperties dataSourceProperties = dataSourceProperties();
-        // final HikariDataSource dataSource = new HikariDataSource();
-        // dataSource.setDriverClassName(dataSourceProperties.getDriverClassName());
-        // dataSource.setJdbcUrl(dataSourceProperties.getUrl());
-        // dataSource.setUsername(dataSourceProperties.getUsername());
-        // dataSource.setPassword(dataSourceProperties.getPassword());
-        // dataSource.setConnectionTimeout(Integer.parseInt(env.getProperty("spring.datasource.hikari.connectionTimeout")));
-        // dataSource.setMaximumPoolSize(Integer.parseInt(env.getProperty("spring.datasource.hikari.maximumPoolSize")));
-        // return dataSource;
-        return connectionPoolDataSource(DataSourceBuilder.create()
-                .driverClassName(dataSourceProperties.getDriverClassName())
-                .url(dataSourceProperties.getUrl())
-                .username(dataSourceProperties.getUsername())
-                .password(dataSourceProperties.getPassword())
-                .build());
-    }
-
-    protected HikariConfig hikariConfig(DataSource dataSource) {
-        HikariConfig hikariConfig = new HikariConfig();
-        int cpuCores = Runtime.getRuntime().availableProcessors();
-        hikariConfig.setMaximumPoolSize(cpuCores * 4);
-        hikariConfig.setDataSource(dataSource);
-        hikariConfig.setAutoCommit(false);
-        return hikariConfig;
-    }
+    private final DataSource dataSource;
 
-    protected HikariDataSource connectionPoolDataSource(
-            DataSource dataSource) {
-        return new HikariDataSource(hikariConfig(dataSource));
+    public DataSourceConfiguration(@Qualifier("HikariDataSourceInit") DataSource dataSource) {
+        this.dataSource = dataSource;
     }
 
     @Bean
     public LocalContainerEntityManagerFactoryBean entityManagerFactory() {
         LocalContainerEntityManagerFactoryBean factory = new LocalContainerEntityManagerFactoryBean();
-        factory.setDataSource(dataSource());
+        factory.setDataSource(dataSource);
         factory.setPackagesToScan(new String[]{"ir.bigz.springbootreal.dao"});
         factory.setJpaVendorAdapter(new HibernateJpaVendorAdapter());
 
diff --git a/src/main/java/ir/bigz/springbootreal/configuration/HikariDataSourceInit.java b/src/main/java/ir/bigz/springbootreal/configuration/HikariDataSourceInit.java
@@ -0,0 +1,44 @@
+package ir.bigz.springbootreal.configuration;
+
+import com.zaxxer.hikari.HikariConfig;
+import com.zaxxer.hikari.HikariDataSource;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.env.Environment;
+
+import javax.sql.DataSource;
+import java.util.Properties;
+
+/**
+ * {@link HikariDataSourceInit} use for build connection-pool base on HikariCp with customize properties,
+ * and then added to {@link DataSourceConfiguration} class as datasource for use in app.
+ */
+
+@Configuration
+public class HikariDataSourceInit{
+
+    @Autowired
+    private Environment env;
+
+    @Bean(name = "HikariDataSourceInit")
+    public DataSource dataSource(){
+        HikariConfig hikariConfig = new HikariConfig(hikariProperties());
+        int cpuCores = Runtime.getRuntime().availableProcessors();
+        hikariConfig.setMaximumPoolSize(cpuCores * 4);
+        hikariConfig.setConnectionTimeout(Long.parseLong(env.getProperty("hikari.connectionTimeout")));
+        hikariConfig.setIdleTimeout(Long.parseLong(env.getProperty("hikari.idleTimeout")));
+        hikariConfig.setMaxLifetime(Long.parseLong(env.getProperty("hikari.maxLifetime")));
+        return new HikariDataSource(hikariConfig);
+    }
+
+    protected Properties hikariProperties(){
+        Properties hikariProps = new Properties();
+        hikariProps.setProperty("dataSourceClassName", env.getProperty("hikari.dataSourceClassName"));
+        hikariProps.setProperty("dataSource.user", env.getProperty("hikari.dataSource.user"));
+        hikariProps.setProperty("dataSource.password", env.getProperty("hikari.dataSource.password"));
+        hikariProps.setProperty("dataSource.databaseName", env.getProperty("hikari.dataSource.databaseName"));
+        return hikariProps;
+    }
+
+}
diff --git a/src/main/java/ir/bigz/springbootreal/configuration/SimpleDataSourceInit.java b/src/main/java/ir/bigz/springbootreal/configuration/SimpleDataSourceInit.java
@@ -0,0 +1,33 @@
+package ir.bigz.springbootreal.configuration;
+
+import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.jdbc.DataSourceBuilder;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import javax.sql.DataSource;
+
+/**
+ * {@link SimpleDataSourceInit} implement basicDataSource,
+ * if you want use connection-pool use {@link HikariDataSourceInit}
+ */
+@Configuration
+public class SimpleDataSourceInit {
+
+    @Bean
+    @ConfigurationProperties(prefix = "demo.datasource")
+    public DataSourceProperties dataSourceProperties(){
+        return new DataSourceProperties();
+    }
+
+//    @Bean(name = "SimpleDataSourceInit")
+    public DataSource dataSource(){
+        DataSourceProperties dataSourceProperties = dataSourceProperties();
+        return DataSourceBuilder.create()
+                .driverClassName(dataSourceProperties.getDriverClassName())
+                .url(dataSourceProperties.getUrl())
+                .username(dataSourceProperties.getUsername())
+                .password(dataSourceProperties.getPassword())
+                .build();
+    }
+}
diff --git a/src/main/resources/application-dev.properties b/src/main/resources/application-dev.properties
@@ -1,7 +1,7 @@
 ################### Server Configuration ##########################
 server.port=9090
 
-################### DataSource Configuration ##########################
+################### Simple DataSource Configuration ##########################
 demo.datasource.driver-class-name=org.postgresql.Driver
 demo.datasource.url=jdbc:postgresql://localhost:5432/myapp
 demo.datasource.username=postgres
@@ -14,9 +14,16 @@ demo.jpa.show-sql=true
 ################### cache Configuration ##########################
 spring.cache.jcache.config=classpath:ehcache.xml
 
-################### default connection pool ##########################
-spring.datasource.hikari.connectionTimeout=20000
-spring.datasource.hikari.maximumPoolSize=5
+################### Hikari DataSource Configuration ##########################
+hikari.dataSourceClassName=org.postgresql.ds.PGSimpleDataSource
+hikari.dataSource.user=postgres
+hikari.dataSource.password=postgres
+hikari.dataSource.databaseName=myapp
+hikari.dataSource.portNumber=5432
+hikari.dataSource.serverName=localhost
+hikari.connectionTimeout=30000
+hikari.idleTimeout=600000
+hikari.maxLifetime=1800000
 
 ################### condition Configuration ##########################
 app.generator.enabled=false
diff --git a/src/main/resources/application-docker.properties b/src/main/resources/application-docker.properties
@@ -2,7 +2,7 @@
 server.port=9090
 
 
-################### DataSource Configuration ##########################
+################### Simple DataSource Configuration ##########################
 
 demo.datasource.driver-class-name=org.postgresql.Driver
 demo.datasource.url=jdbc:postgresql://spring-db:5432/myapp
@@ -18,10 +18,16 @@ demo.jpa.show-sql=true
 
 spring.cache.jcache.config=classpath:ehcache.xml
 
-################### default connection pool ##########################
-
-spring.datasource.hikari.connectionTimeout=20000
-spring.datasource.hikari.maximumPoolSize=5
+################### Hikari DataSource Configuration ##########################
+hikari.dataSourceClassName=org.postgresql.ds.PGSimpleDataSource
+hikari.dataSource.user=postgres
+hikari.dataSource.password=postgres
+hikari.dataSource.databaseName=myapp
+hikari.dataSource.portNumber=5432
+hikari.dataSource.serverName=localhost
+hikari.connectionTimeout=30000
+hikari.idleTimeout=600000
+hikari.maxLifetime=1800000
 
 ################### condition Configuration ##########################
 
diff --git a/src/test/groovy/ir/bigz/springbootreal/web/InitTestContainerDB.groovy b/src/test/groovy/ir/bigz/springbootreal/web/InitTestContainerDB.groovy
@@ -1,7 +1,8 @@
 package ir.bigz.springbootreal.web
 
 import ir.bigz.springbootreal.configuration.DataSourceConfiguration
-
+import ir.bigz.springbootreal.configuration.HikariDataSourceInit
+import ir.bigz.springbootreal.configuration.SimpleDataSourceInit
 import ir.bigz.springbootreal.configuration.WebConfiguration
 import ir.bigz.springbootreal.dal.UserRepositoryImpl
 import ir.bigz.springbootreal.dao.User
@@ -24,7 +25,7 @@ import spock.lang.Specification
 
 @Testcontainers
 @ContextConfiguration(classes = [UserRepositoryImpl.class, User.class,
-        DataSourceConfiguration.class, WebConfiguration.class], initializers = InitTestContainerDB.class)
+        DataSourceConfiguration.class, WebConfiguration.class, SimpleDataSourceInit.class, HikariDataSourceInit.class], initializers = InitTestContainerDB.class)
 @SpringBootTest(properties = "spring.profiles.active:test")
 @EnableAutoConfiguration(exclude = [DataSourceAutoConfiguration.class,
         HibernateJpaAutoConfiguration.class,
diff --git a/src/test/groovy/ir/bigz/springbootreal/web/RepositoryTest.groovy b/src/test/groovy/ir/bigz/springbootreal/web/RepositoryTest.groovy
@@ -1,6 +1,8 @@
 package ir.bigz.springbootreal.web
 
 import ir.bigz.springbootreal.configuration.DataSourceConfiguration
+import ir.bigz.springbootreal.configuration.HikariDataSourceInit
+import ir.bigz.springbootreal.configuration.SimpleDataSourceInit
 import ir.bigz.springbootreal.configuration.WebConfiguration
 import ir.bigz.springbootreal.dal.DaoRepository
 import ir.bigz.springbootreal.dal.DaoRepositoryImpl
@@ -25,7 +27,7 @@ import java.sql.Timestamp
 import java.time.LocalDateTime
 
 @ContextConfiguration(classes = [UserRepositoryImpl.class, User.class,
-        DataSourceConfiguration.class, WebConfiguration.class, DataGenerator.class])
+        DataSourceConfiguration.class, SimpleDataSourceInit.class, HikariDataSourceInit.class, WebConfiguration.class, DataGenerator.class])
 @Title("Test repository layer")
 @SpringBootTest(properties = "spring.profiles.active:test")
 @EnableAutoConfiguration(exclude = [DataSourceAutoConfiguration.class,
diff --git a/src/test/resources/application-test.properties b/src/test/resources/application-test.properties
@@ -5,6 +5,8 @@ server.port=9090
 demo.datasource.dockerImageName=postgres:latest
 demo.datasource.imagePort=5432
 demo.datasource.dbName=sp_test
+
+################### Simple DataSource Configuration ##########################
 demo.datasource.url=jdbc:tc:postgresql:latest://localhost/myapp
 demo.datasource.username=user
 demo.datasource.password=password
@@ -18,9 +20,16 @@ demo.jpa.show-sql=true
 ################### cache Configuration ##########################
 spring.cache.jcache.config=classpath:ehcache.xml
 
-################### default connection pool ##########################
-spring.datasource.hikari.connectionTimeout=20000
-spring.datasource.hikari.maximumPoolSize=5
+################### Hikari DataSource Configuration ##########################
+hikari.dataSourceClassName=org.postgresql.ds.PGSimpleDataSource
+hikari.dataSource.user=user
+hikari.dataSource.password=password
+hikari.dataSource.databaseName=sp_test
+hikari.dataSource.portNumber=5432
+hikari.dataSource.serverName=localhost
+hikari.connectionTimeout=30000
+hikari.idleTimeout=600000
+hikari.maxLifetime=1800000
 
 ################### condition Configuration ##########################
 app.generator.enabled=false
