Как настроить HikariCP в моем загрузочном приложении Spring в моих файлах application.properties?

Ответ 1

@Configuration
@ConfigurationProperties(prefix = "params.datasource")
public class JpaConfig extends HikariConfig {

    @Bean
    public DataSource dataSource() throws SQLException {
        return new HikariDataSource(this);
    }

}

application.yml

params:
  datasource:
    driverClassName: com.mysql.jdbc.Driver
    jdbcUrl: jdbc:mysql://localhost:3306/myDb
    username: login
    password: password
    maximumPoolSize: 5

ОБНОВЛЕНО! Начиная с версии Spring Boot 1.3.0:

1. Просто добавьте HikariCP в зависимости
2. Настроить application.yml

application.yml

spring:
  datasource:
    type: com.zaxxer.hikari.HikariDataSource
    url: jdbc:h2:mem:TEST
    driver-class-name: org.h2.Driver
    username: username
    password: password
    hikari:
      idle-timeout: 10000

ОБНОВЛЕНО! Начиная с версии Spring Boot 2.0.0:

Пул соединений по умолчанию изменился с Tomcat на Hikari :)

Ответ 2

Вы можете просто использовать application.yml/application.properties. Нет необходимости явно создавать любые DataSource Bean

Вам нужно исключить tomcat-jdbc, как указано ydemartino

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.apache.tomcat</groupId>
            <artifactId>tomcat-jdbc</artifactId>
        </exclusion>
    </exclusions>
</dependency>

Поскольку вы не создадите DataSource bean, вам нужно явно указать использование Hikari через spring.datasource.type со значением com.zaxxer.hikari.HikariDataSource в application.yml/application.properties

spring:
    datasource:
        hikari:
            connection-test-query: SELECT 1 FROM DUAL
            minimum-idle: 1
            maximum-pool-size: 5
            pool-name: yourPoolName
            auto-commit: false
        driver-class-name: com.mysql.jdbc.Driver
        url: jdbc:mysql://localhost:3306/myDb
        username: login
        password: password
        type: com.zaxxer.hikari.HikariDataSource

В вашем приложении application.yml/application.properties вы можете настроить специальные параметры Hikari, такие как размер пула и т.д. в spring.datasource.hikari.*

Ответ 3

Я наткнулся на HikariCP и я был поражен результатами тестов, и я хотел попробовать его вместо своего выбора по умолчанию C3P0 и, к моему удивлению, я изо всех сил пытался получить configurations правильно, потому что конфигурации различаются в зависимости от того, какую комбинацию используемого вами tech-стека вы используете.

У меня есть проект Spring Boot с JPA, Web, Security стартеры JPA, Web, Security (с использованием Spring Initializer), чтобы использовать PostgreSQL в качестве базы данных с HikariCP качестве пула соединений.
Я использовал инструмент Gradle as build, и я хотел бы поделиться тем, что сработало для меня в следующих предположениях:

1. Spring Boot Starter JPA (Веб и безопасность - необязательно)
2. Грейдл тоже
3. Работа и настройка PostgreSQL с базой данных (например, схема, пользователь, db)

Вам понадобится следующий build.gradle если вы используете Gradle или эквивалентный pom.xml если вы используете maven

buildscript {
    ext {
        springBootVersion = '1.5.8.RELEASE'
    }
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
    }
}

apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'
apply plugin: 'war'

group = 'com'
version = '1.0'
sourceCompatibility = 1.8

repositories {
    mavenCentral()
}

dependencies {
    compile('org.springframework.boot:spring-boot-starter-aop')

    // Exclude the tomcat-jdbc since it used as default for connection pooling
    // This can also be achieved by setting the spring.datasource.type to HikariCP 
    // datasource see application.properties below
    compile('org.springframework.boot:spring-boot-starter-data-jpa') {
        exclude group: 'org.apache.tomcat', module: 'tomcat-jdbc'
    }
    compile('org.springframework.boot:spring-boot-starter-security')
    compile('org.springframework.boot:spring-boot-starter-web')
    runtime('org.postgresql:postgresql')
    testCompile('org.springframework.boot:spring-boot-starter-test')
    testCompile('org.springframework.security:spring-security-test')

    // Download HikariCP but, exclude hibernate-core to avoid version conflicts
    compile('com.zaxxer:HikariCP:2.5.1') {
        exclude group: 'org.hibernate', module: 'hibernate-core'
    }

    // Need this in order to get the HikariCPConnectionProvider
    compile('org.hibernate:hibernate-hikaricp:5.2.11.Final') {
        exclude group: 'com.zaxxer', module: 'HikariCP'
        exclude group: 'org.hibernate', module: 'hibernate-core'
    }
}

В приведенном выше build.gradle есть куча исключений, и потому

1. Сначала исключаем, инструктируем град, которые исключают пул соединений jdbc-tomcat при загрузке зависимостей spring-boot-starter-data-jpa. Этого можно добиться, установив spring.datasource.type=com.zaxxer.hikari.HikariDataSource также, но я не хочу дополнительной зависимости, если мне это не нужно
2. Second exclude, инструктирует gradle исключать hibernate-core при загрузке зависимости com.zaxxer и потому, что hibernate-core уже загружен Spring Boot и мы не хотим, чтобы заканчивались разными версиями.
3. Третье исключение, инструктирует gradle исключать hibernate-core при загрузке модуля hibernate-hikaricp который необходим, чтобы заставить HikariCP использовать org.hibernate.hikaricp.internal.HikariCPConnectionProvider как поставщик подключения вместо устаревшего com.zaxxer.hikari.hibernate.HikariConnectionProvider

Как только я выяснил build.gradle и что сохранить, а что нет, я был готов скопировать/вставить конфигурацию datasource в свои application.properties build.gradle и ожидали, что все будет работать с летающими цветами, но на самом деле я не наткнулся на следующие проблемы

• Spring boot не удалось узнать данные базы данных (т.е. Url, driver), следовательно, не удалось установить jpa и hibernate (потому что я не назвал значения ключа свойства правильно)
• HikariCP возвращается к com.zaxxer.hikari.hibernate.HikariConnectionProvider
• После указания Spring использовать нового поставщика подключения для автоматической настройки hibernate/jpa, HikariCP завершился неудачно, потому что он искал некоторый key/value в application.properties и жаловался на dataSource, dataSourceClassName, jdbcUrl. Мне пришлось отлаживать HikariConfig, HikariConfigurationUtil, HikariCPConnectionProvider и выяснил, что HikariCP не смог найти свойства из application.properties потому что он был назван по-разному.

В любом случае, я должен был полагаться на пробную версию и ошибки и убедиться, что HikariCP может выбрать свойства (то есть источник данных, который HikariCP данные db, а также свойства объединения), а также Sping Boot ведут себя так, как ожидалось, и я закончил со следующим файлом application.properties.

server.contextPath=/
debug=true

# Spring data source needed for Spring boot to behave
# Pre Spring Boot v2.0.0.M6 without below Spring Boot defaults to tomcat-jdbc connection pool included 
# in spring-boot-starter-jdbc and as compiled dependency under spring-boot-starter-data-jpa
spring.datasource.type=com.zaxxer.hikari.HikariDataSource
spring.datasource.url=jdbc:postgresql://localhost:5432/somedb
spring.datasource.username=dbuser
spring.datasource.password=dbpassword

# Hikari will use the above plus the following to setup connection pooling
spring.datasource.hikari.minimumIdle=5
spring.datasource.hikari.maximumPoolSize=20
spring.datasource.hikari.idleTimeout=30000
spring.datasource.hikari.poolName=SpringBootJPAHikariCP
spring.datasource.hikari.maxLifetime=2000000
spring.datasource.hikari.connectionTimeout=30000

# Without below HikariCP uses deprecated com.zaxxer.hikari.hibernate.HikariConnectionProvider
# Surprisingly enough below ConnectionProvider is in hibernate-hikaricp dependency and not hibernate-core
# So you need to pull that dependency but, make sure to exclude it transitive dependencies or you will end up 
# with different versions of hibernate-core 
spring.jpa.hibernate.connection.provider_class=org.hibernate.hikaricp.internal.HikariCPConnectionProvider

# JPA specific configs
spring.jpa.properties.hibernate.show_sql=true
spring.jpa.properties.hibernate.format_sql=true
spring.jpa.properties.hibernate.use_sql=true
spring.jpa.properties.hibernate.id.new_generator_mappings=false
spring.jpa.properties.hibernate.default_schema=dbschema
spring.jpa.properties.hibernate.search.autoregister_listeners=false
spring.jpa.properties.hibernate.bytecode.use_reflection_optimizer=false

# Enable logging to verify that HikariCP is used, the second entry is specific to HikariCP
logging.level.org.hibernate.SQL=DEBUG
logging.level.com.zaxxer.hikari.HikariConfig=DEBUG
logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE 

Как показано выше, конфигурации делятся на категории, основанные на следующих шаблонах именования

• spring.datasource.x (Spring auto-configure выберет их, так же как и HikariCP)
• spring.datasource.hikari.x (HikariCP выбирает их для настройки пула, отметьте имена полей camelCase)
• spring.jpa.hibernate.connection.provider_class (инструктирует Spring использовать новый HibernateConnectionProvider)
• spring.jpa.properties.hibernate.x (Используется Spring для автоматической настройки JPA, отметьте имена полей с символами подчеркивания)

Трудно найти учебник или сообщение или какой-то ресурс, который показывает, как используется указанный выше файл свойств и как должны быть названы свойства. Ну, вот оно.

build.gradle вышеуказанных build.gradle application.properties с помощью build.gradle (или, по крайней мере, аналогичного) в версию проекта Spring Boot JPA (1.5.8) должен работать как шарм и подключаться к вашей предварительно сконфигурированной базе данных (то есть в моем случае это PostgreSQL, что оба HikariCP & Spring из spring.datasource.url на котором должен использоваться драйвер базы данных).

Я не видел необходимости создавать компонент DataSource и потому, что Spring Boot способен делать все для меня, просто изучая application.properties и это аккуратно.

Статья в HikariCP github wiki показывает, как настроить Spring Boot с JPA, но не имеет объяснений и деталей.

Вышеуказанный два файла также доступны в качестве общего gist https://gist.github.com/rhamedy/b3cb936061cc03acdfe21358b86a5bc6

Ответ 4

Это работает для моего загрузочного приложения, если оно помогает. Этот класс сообщает вам, какие свойства ищет объект конфигурации:

https://github.com/brettwooldridge/HikariCP/blob/2.3.x/hikaricp-common/src/main/java/com/zaxxer/hikari/AbstractHikariConfig.java

Я думаю, что несколько источников данных могут поддерживаться путем добавления datasource_whatever к ключам свойств в исходном файле конфигурации. Ура!

@Configuration
class DataSourceConfig {

   @Value('${spring.datasource.username}')
   private String user;

   @Value('${spring.datasource.password}')
   private String password;

   @Value('${spring.datasource.url}')
   private String dataSourceUrl;

   @Value('${spring.datasource.dataSourceClassName}')
   private String dataSourceClassName;

   @Value('${spring.datasource.connectionTimeout}')
   private int connectionTimeout;

   @Value('${spring.datasource.maxLifetime}')
   private int maxLifetime;

   @Bean
   public DataSource primaryDataSource() {
      Properties dsProps = [url: dataSourceUrl, user: user, password: password]
      Properties configProps = [
            connectionTestQuery: 'select 1 from dual',
            connectionTimeout: connectionTimeout,
            dataSourceClassName: dataSourceClassName,
            dataSourceProperties: dsProps,
            maxLifetime: maxLifetime
      ]

      // A default max pool size of 10 seems reasonable for now, so no need to configure for now.
      HikariConfig hc = new HikariConfig(configProps)
      HikariDataSource ds = new HikariDataSource(hc)
      ds
   }
}

Ответ 5

Вам не нужен избыточный код для ввода значений свойств в переменные. Вы можете напрямую установить свойства с помощью файла свойств.

Поместите файл hikari.properties в путь к классам.

driverClassName=com.mysql.jdbc.Driver
jdbcUrl=jdbc:mysql://localhost:3306/myDb
connectionTestQuery=SELECT 1
maximumPoolSize=20
username=...
password=...

И сделайте источник данных bean следующим образом.

@Bean(destroyMethod = "close")
public DataSource dataSource() throws SQLException {
    HikariConfig config = new HikariConfig("/hikari.properties");
    HikariDataSource dataSource = new HikariDataSource(config);

    return dataSource;
}

Ответ 6

вы не можете использовать метод dataSourceClassName в конфигурациях application.properties, как сказал @Andy Wilkinson. если вы хотите иметь имя dataSourceClassName, вы можете использовать Java Config как:

@Configuration
@ComponentScan
class DataSourceConfig {

 @Value("${spring.datasource.username}")
private String user;

@Value("${spring.datasource.password}")
private String password;

@Value("${spring.datasource.url}")
private String dataSourceUrl;

@Value("${spring.datasource.dataSourceClassName}")
private String dataSourceClassName;

@Value("${spring.datasource.poolName}")
private String poolName;

@Value("${spring.datasource.connectionTimeout}")
private int connectionTimeout;

@Value("${spring.datasource.maxLifetime}")
private int maxLifetime;

@Value("${spring.datasource.maximumPoolSize}")
private int maximumPoolSize;

@Value("${spring.datasource.minimumIdle}")
private int minimumIdle;

@Value("${spring.datasource.idleTimeout}")
private int idleTimeout;

@Bean
public DataSource primaryDataSource() {
    Properties dsProps = new Properties();
    dsProps.put("url", dataSourceUrl);
    dsProps.put("user", user);
    dsProps.put("password", password);
    dsProps.put("prepStmtCacheSize",250);
    dsProps.put("prepStmtCacheSqlLimit",2048);
    dsProps.put("cachePrepStmts",Boolean.TRUE);
    dsProps.put("useServerPrepStmts",Boolean.TRUE);

    Properties configProps = new Properties();
       configProps.put("dataSourceClassName", dataSourceClassName);
       configProps.put("poolName",poolName);
       configProps.put("maximumPoolSize",maximumPoolSize);
       configProps.put("minimumIdle",minimumIdle);
       configProps.put("minimumIdle",minimumIdle);
       configProps.put("connectionTimeout", connectionTimeout);
       configProps.put("idleTimeout", idleTimeout);
       configProps.put("dataSourceProperties", dsProps);

   HikariConfig hc = new HikariConfig(configProps);
   HikariDataSource ds = new HikariDataSource(hc);
   return ds;
   }
  } 

причина, по которой вы не можете использовать dataSourceClassName, потому что она будет выбрасывать и исключать

Caused by: java.lang.IllegalStateException: both driverClassName and dataSourceClassName are specified, one or the other should be used.

который означает, что весенняя загрузка появляется из свойства spring.datasource.url Драйвера и в то же время установка dataSourceClassName создает это исключение. Чтобы все было правильно, ваше приложение application.properties должно выглядеть примерно так для HikariCP datasource:

# hikariCP 
  spring.jpa.databasePlatform=org.hibernate.dialect.MySQLDialect
  spring.datasource.url=jdbc:mysql://localhost:3306/exampledb
  spring.datasource.username=root
  spring.datasource.password=
  spring.datasource.poolName=SpringBootHikariCP
  spring.datasource.maximumPoolSize=5
  spring.datasource.minimumIdle=3
  spring.datasource.maxLifetime=2000000
  spring.datasource.connectionTimeout=30000
  spring.datasource.idleTimeout=30000
  spring.datasource.pool-prepared-statements=true
  spring.datasource.max-open-prepared-statements=250

Примечание. Пожалуйста, проверьте, есть ли какой-либо tomcat-jdbc.jar или commons-dbcp.jar в вашем пути к классам, добавленном в большинстве случаев транзитивной зависимостью. Если они присутствуют в пути к классам, Spring Boot настроит источник данных, используя пул соединений по умолчанию, который является tomcat. HikariCP будет использоваться только для создания источника данных, если в пути к классам нет другого провайдера. существует резервная последовательность от tomcat → to HikariCP → to Commons DBCP.

Ответ 7

Вы можете использовать метод dataSourceClassName, вот пример с MySQL. (Протестировано с помощью spring загрузки 1.3 и 1.4)

Сначала вам нужно исключить tomcat-jdbc из пути к классам, поскольку он будет выбран в пользу hikaricp.

pom.xml

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-jdbc</artifactId>
        <exclusions>
            <exclusion>
                <groupId>org.apache.tomcat</groupId>
                <artifactId>tomcat-jdbc</artifactId>
            </exclusion>
        </exclusions>
    </dependency>

application.properties

spring.datasource.dataSourceClassName=com.mysql.jdbc.jdbc2.optional.MysqlDataSource
spring.datasource.dataSourceProperties.serverName=localhost
spring.datasource.dataSourceProperties.portNumber=3311
spring.datasource.dataSourceProperties.databaseName=mydb
spring.datasource.username=root
spring.datasource.password=root

Затем просто добавьте

@Bean
@ConfigurationProperties(prefix = "spring.datasource")
public DataSource dataSource() {
    return DataSourceBuilder.create().build();
}

Я создал тестовый проект здесь: https://github.com/ydemartino/spring-boot-hikaricp

Ответ 8

Вот хорошая новость. HikariCP - это пул соединений по умолчанию, теперь с Spring Boot 2.0.0.

Заметки о выпуске Spring Boot 2.0.0

Технология объединения базы данных по умолчанию в Spring Boot 2.0 была переключена с Tomcat Pool на HikariCP. Weve обнаружил, что Hakari предлагает превосходную производительность, и многие из наших пользователей предпочитают его над Tomcat Pool.

Ответ 9

Итак, получается, что почти все настройки по умолчанию для HikariCP работают для меня, кроме количества соединений с БД. Я установил это свойство в свой application.properties:

spring.datasource.maximumPoolSize=20

И Энди Уилкинсон прав, насколько я могу судить, поскольку вы не можете использовать метод конфигурации dataSourceClassName для HikariCP с помощью Spring Boot.

Ответ 10

Согласно документации, она изменена,

https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-sql.html

Пример:

spring:
    datasource:
        url: 'jdbc:mysql://localhost/db?useSSL=false'
        username: root
        password: pass
        driver: com.mysql.jdbc.Driver
        hikari:
            minIdle: 10
            idle-timeout: 10000
            maximumPoolSize: 30

Это следующие изменения конфигурации, которые мы можем сделать на hikari, пожалуйста, добавьте/обновите в соответствии с вашими потребностями.

autoCommit
connectionTimeout
idleTimeout
maxLifetime
connectionTestQuery
connectionInitSql
validationTimeout
maximumPoolSize
poolName
allowPoolSuspension
readOnly
transactionIsolation
leakDetectionThreshold

Ответ 11

Я использую Spring Boot 2.0.4.RELEASE. Hikari - это пул соединений по умолчанию, и .hikari больше не требуется.

application.properties

spring.datasource.driverClassName=com.mysql.jdbc.Driver
spring.datasource.jdbcUrl=jdbc:mysql://localhost:3306/myDB...
spring.datasource.username=xxx
spring.datasource.password=xxx
spring.datasource.poolname=myPool

application.yml

spring:
    datasource:
        driverClassName: com.mysql.jdbc.Driver
        jdbcUrl: jdbc:mysql://localhost:3306/myDB...
        username: xxx
        password: xxx
        poolName: myPool

И configuration не нужно расширять HikariConfig, а DataSourceBuilder можно использовать так, как было раньше.

@Configuration
public class DataSourceConfiguration {

    @Bean(name="myDataSource")
    @ConfigurationProperties("spring.datasource")
    public DataSource myDataSource() {
        return DataSourceBuilder.create().build();
    }
}

Ответ 12

С более поздними версиями spring -boot, переключение на Hikari может быть выполнено полностью в конфигурации. Я использую 1.5.6.RELEASE, и этот подход работает.

build.gradle:

compile "com.zaxxer:HikariCP:2.7.3"

приложение YAML

spring:
  datasource:
    type: com.zaxxer.hikari.HikariDataSource
    hikari:
      idleTimeout: 60000
      minimumIdle: 2
      maximumPoolSize: 20
      connectionTimeout: 30000
      poolName: MyPoolName
      connectionTestQuery: SELECT 1

Измените connectionTestQuery в соответствии с вашей базовой БД. Что это, никакого кода не требуется.

Ответ 13

Мой SetUp:
Spring Boot v1.5.10
Хикари v.3.2.x (для оценки)

Чтобы действительно понять конфигурацию источника данных Hikari, я рекомендую отключить автоматическую настройку Spring Boot для источника данных.

Добавьте к application.properties следующее:

spring.autoconfigure.exclude = org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration

Это отключит функцию Spring Boot для самостоятельной настройки DataSource.

Теперь вы можете определить свою собственную настраиваемую конфигурацию для создания компонента HikariDataSource и заполнить его желаемыми свойствами.

НОТА :
Открытый класс HikariDataSource расширяет HikariConfig

Вам нужно

1. заполнить объект HikariConfig, используя желаемые свойства Хикари
2. инициализируйте объект HikariDataSource объектом HikariConfig, переданным как аргумент конструктору.

Я считаю, что для определения собственного класса собственной конфигурации (@Configuration) я создал собственный источник данных и заполнял его свойствами источника данных, определенными в отдельном файле (по сравнению с традиционными: application.properties)

Таким образом, я могу определить свой собственный SessionFactory Bean с помощью Hibernate, который рекомендуется: "LocalSessionFactoryBean" и заполнить его с помощью источника данных Hikari> и других свойств Hiberante-JPA.

Краткое описание свойств источника данных Hikari Spring Boot:

spring.datasource.hikari.allow бассейн-подвеска = истина
spring.datasource.hikari.auto фиксации = ложь
spring.datasource.hikari.catalog =
spring.datasource.hikari.connection-INIT-SQL =
spring.datasource.hikari.connection-тест-запрос =
spring.datasource.hikari.connection-тайм-аут = 100
spring.datasource.hikari.data-источник-имя-класса =
spring.datasource.hikari.data-источник-JNDI =
Класса имя-spring.datasource.hikari.driver =
spring.datasource.hikari.idle-тайм-аут = 50
spring.datasource.hikari.initialization обанкротиться-быстро = верно
spring.datasource.hikari.isolate-внутренние-запросы = верно
spring.datasource.hikari.jdbc-URL =
spring.datasource.hikari.leak обнаружения порога =
spring.datasource.hikari.login-тайм-аут = 60
spring.datasource.hikari.max-срок службы =
spring.datasource.hikari.maximum бассейн размером = 500
spring.datasource.hikari.minimum-простаивает = 30
spring.datasource.hikari.password =
spring.datasource.hikari.pool имя =
spring.datasource.hikari.read только = истина
spring.datasource.hikari.register-MBeans = верно
spring.datasource.hikari.transaction изоляция =
spring.datasource.hikari.username =
spring.datasource.hikari.validation тайм-аут =

Ответ 14

Springboot позволяет легко настроить HickariCP. Хук DropWizard от Hickari CP позволяет собирать статистику в составе Springboot HealthCheck. Пожалуйста, загляните в мой блог здесь

https://medium.com/@venkatakambhampaty/health-checks-in-springboot-73b8dc760052