Spring Boot自动配置仍然使用Tomcat数据源而非HikariCP？

Question

我有一个使用 Spring Boot 1.2.5.RELEASE 的服务，并且我想使用 HikariCP 数据源来替换默认的 tomcat-jdbc。根据这个 Spring Boot 参考文档，我了解到只需要从类路径中排除 tomcat-jdbc 并添加 HikariCP 就可以了。

这是我的 pom.xml 内容：

...
<dependencyManagement>
    ...
    <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-data-jpa</artifactId>
                <version>${spring-boot.version}</version>
                <exclusions>
                    <exclusion>
                        <groupId>org.apache.tomcat</groupId>
                        <artifactId>tomcat-jdbc</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    ...
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>
        <groupId>com.zaxxer</groupId>
        <artifactId>HikariCP</artifactId>
    </dependency>
</dependencies>
...

maven依赖树:

[INFO] --- maven-dependency-plugin:2.1:tree (default-cli) @ myproject-user-manage-webservice ---
[INFO] com.mybusiness.myproject:myproject-user-manage-webservice:jar:0.0.1-SNAPSHOT
[INFO] +- com.mybusiness.myproject:myproject-commons:jar:0.0.1-SNAPSHOT:compile
[INFO] |  \- com.mybusiness.myproject:myproject-core:jar:0.0.1-SNAPSHOT:compile
[INFO] |     \- com.mybusiness.myproject:myproject-core-commons:jar:0.0.1-SNAPSHOT:compile
[INFO] +- com.mybusiness.myproject:myproject-api:jar:0.0.1-SNAPSHOT:compile
[INFO] |  +- com.fasterxml.jackson.core:jackson-annotations:jar:2.4.4:compile (version managed from 2.4.6)
[INFO] |  \- com.mybusiness.myproject:myproject-framework:jar:0.0.1-SNAPSHOT:compile
[INFO] |     +- org.springframework.boot:spring-boot-starter-security:jar:1.2.1.RELEASE:compile (version managed from 1.2.5.RELEASE)
[INFO] |     +- mysql:mysql-connector-java:jar:5.1.34:compile (version managed from 5.1.35)
[INFO] |     +- com.mybusiness.framework:despegar-fwk-logging:jar:1.4.148:compile
[INFO] |     +- org.jenkins-ci.plugins:testInProgress-client:jar:1.4:compile
[INFO] |     |  \- org.json:json:jar:20140107:compile
[INFO] |     +- commons-io:commons-io:jar:1.3.2:compile
[INFO] |     \- org.apache.commons:commons-lang3:jar:3.4:compile
[INFO] +- com.mybusiness.myproject:myproject-user-manage-domain:jar:0.0.1-SNAPSHOT:compile
[INFO] |  +- org.springframework.boot:spring-boot-starter-aop:jar:1.2.1.RELEASE:compile
[INFO] |  |  +- org.aspectj:aspectjrt:jar:1.8.4:compile (version managed from 1.8.2)
[INFO] |  |  \- org.aspectj:aspectjweaver:jar:1.8.4:compile
[INFO] |  +- org.springframework.boot:spring-boot-starter-data-jpa:jar:1.2.1.RELEASE:compile
[INFO] |  |  +- org.springframework.boot:spring-boot-starter-jdbc:jar:1.2.1.RELEASE:compile
[INFO] |  |  |  +- org.springframework:spring-jdbc:jar:4.1.4.RELEASE:compile
[INFO] |  |  |  \- org.springframework:spring-tx:jar:4.1.4.RELEASE:compile
[INFO] |  |  +- org.hibernate:hibernate-entitymanager:jar:4.3.7.Final:compile
[INFO] |  |  |  +- org.jboss.logging:jboss-logging-annotations:jar:1.2.0.Beta1:compile
[INFO] |  |  |  +- org.hibernate:hibernate-core:jar:4.3.7.Final:compile
[INFO] |  |  |  |  +- antlr:antlr:jar:2.7.7:compile
[INFO] |  |  |  |  \- org.jboss:jandex:jar:1.1.0.Final:compile
[INFO] |  |  |  +- dom4j:dom4j:jar:1.6.1:compile
[INFO] |  |  |  |  \- xml-apis:xml-apis:jar:1.0.b2:compile
[INFO] |  |  |  +- org.hibernate.common:hibernate-commons-annotations:jar:4.0.5.Final:compile
[INFO] |  |  |  \- org.hibernate.javax.persistence:hibernate-jpa-2.1-api:jar:1.0.0.Final:compile
[INFO] |  |  +- javax.transaction:javax.transaction-api:jar:1.2:compile
[INFO] |  |  +- org.springframework:spring-orm:jar:4.1.4.RELEASE:compile (version managed from 4.0.7.RELEASE)
[INFO] |  |  +- org.springframework.data:spring-data-jpa:jar:1.7.1.RELEASE:compile
[INFO] |  |  |  \- org.springframework.data:spring-data-commons:jar:1.9.1.RELEASE:compile
[INFO] |  |  \- org.springframework:spring-aspects:jar:4.1.4.RELEASE:compile
[INFO] |  +- org.springframework.security:spring-security-jwt:jar:1.0.2.RELEASE:compile (version managed from 1.0.3.RELEASE)
[INFO] |  |  \- org.bouncycastle:bcpkix-jdk15on:jar:1.47:compile
[INFO] |  |     \- org.bouncycastle:bcprov-jdk15on:jar:1.47:compile
[INFO] |  \- org.flywaydb:flyway-core:jar:3.0:compile
[INFO] +- org.springframework.boot:spring-boot-starter-web:jar:1.2.1.RELEASE:compile
[INFO] |  +- org.springframework.boot:spring-boot-starter:jar:1.2.1.RELEASE:compile
[INFO] |  |  +- org.springframework.boot:spring-boot:jar:1.2.1.RELEASE:compile
[INFO] |  |  +- org.springframework.boot:spring-boot-autoconfigure:jar:1.2.1.RELEASE:compile
[INFO] |  |  \- org.yaml:snakeyaml:jar:1.14:runtime
[INFO] |  +- org.springframework.boot:spring-boot-starter-tomcat:jar:1.2.1.RELEASE:compile
[INFO] |  |  +- org.apache.tomcat.embed:tomcat-embed-core:jar:8.0.15:compile
[INFO] |  |  +- org.apache.tomcat.embed:tomcat-embed-el:jar:8.0.15:compile
[INFO] |  |  +- org.apache.tomcat.embed:tomcat-embed-logging-juli:jar:8.0.15:compile
[INFO] |  |  \- org.apache.tomcat.embed:tomcat-embed-websocket:jar:8.0.15:compile
[INFO] |  +- com.fasterxml.jackson.core:jackson-databind:jar:2.4.4:compile
[INFO] |  |  \- com.fasterxml.jackson.core:jackson-core:jar:2.4.4:compile
[INFO] |  +- org.hibernate:hibernate-validator:jar:5.1.3.Final:compile
[INFO] |  |  +- javax.validation:validation-api:jar:1.1.0.Final:compile
[INFO] |  |  \- org.jboss.logging:jboss-logging:jar:3.1.3.GA:compile
[INFO] |  +- org.springframework:spring-core:jar:4.1.4.RELEASE:compile
[INFO] |  +- org.springframework:spring-web:jar:4.1.4.RELEASE:compile
[INFO] |  \- org.springframework:spring-webmvc:jar:4.1.4.RELEASE:compile
[INFO] |     \- org.springframework:spring-expression:jar:4.1.4.RELEASE:compile
[INFO] +- org.springframework.boot:spring-boot-starter-actuator:jar:1.2.1.RELEASE:compile
[INFO] |  \- org.springframework.boot:spring-boot-actuator:jar:1.2.1.RELEASE:compile
[INFO] +- org.springframework.boot:spring-boot-starter-test:jar:1.2.1.RELEASE:test (scope not updated to compile)
[INFO] |  +- junit:junit:jar:4.12:test
[INFO] |  +- org.mockito:mockito-core:jar:1.10.8:test
[INFO] |  +- org.hamcrest:hamcrest-core:jar:1.3:test
[INFO] |  +- org.hamcrest:hamcrest-library:jar:1.3:test
[INFO] |  \- org.springframework:spring-test:jar:4.1.4.RELEASE:test
[INFO] +- org.springframework.boot:spring-boot-starter-log4j:jar:1.2.1.RELEASE:compile
[INFO] |  +- org.slf4j:jcl-over-slf4j:jar:1.7.8:compile (version managed from 1.7.7)
[INFO] |  +- org.slf4j:jul-to-slf4j:jar:1.7.8:compile
[INFO] |  +- org.slf4j:slf4j-log4j12:jar:1.7.8:compile
[INFO] |  \- log4j:log4j:jar:1.2.17:compile
[INFO] +- org.springframework.security.oauth:spring-security-oauth2:jar:2.0.7.RELEASE:compile
[INFO] |  +- org.springframework:spring-beans:jar:4.1.4.RELEASE:compile
[INFO] |  +- org.springframework:spring-context:jar:4.1.4.RELEASE:compile
[INFO] |  +- org.springframework.security:spring-security-core:jar:3.2.5.RELEASE:compile
[INFO] |  |  \- aopalliance:aopalliance:jar:1.0:compile
[INFO] |  +- org.springframework.security:spring-security-config:jar:3.2.5.RELEASE:compile
[INFO] |  +- org.springframework.security:spring-security-web:jar:3.2.5.RELEASE:compile
[INFO] |  +- commons-codec:commons-codec:jar:1.6:compile
[INFO] |  \- org.codehaus.jackson:jackson-mapper-asl:jar:1.9.13:compile
[INFO] |     \- org.codehaus.jackson:jackson-core-asl:jar:1.9.13:compile
[INFO] +- org.springframework.hateoas:spring-hateoas:jar:0.16.0.RELEASE:compile
[INFO] |  +- org.springframework:spring-aop:jar:4.1.4.RELEASE:compile (version managed from 3.2.9.RELEASE)
[INFO] |  +- org.objenesis:objenesis:jar:2.1:compile
[INFO] |  \- org.slf4j:slf4j-api:jar:1.7.8:compile (version managed from 1.7.7)
[INFO] +- com.zaxxer:HikariCP:jar:2.2.5:compile
[INFO] |  \- org.javassist:javassist:jar:3.18.1-GA:compile
[INFO] +- ma.glasnost.orika:orika-core:jar:1.4.5:compile
[INFO] |  +- com.thoughtworks.paranamer:paranamer:jar:2.3:compile
[INFO] |  +- com.googlecode.concurrentlinkedhashmap:concurrentlinkedhashmap-lru:jar:1.2_jdk5:compile
[INFO] |  \- com.carrotsearch:java-sizeof:jar:0.0.4:compile
[INFO] +- io.springfox:springfox-swagger2:jar:2.1.1:compile
[INFO] |  +- org.mapstruct:mapstruct:jar:1.0.0.Beta4:compile
[INFO] |  +- io.swagger:swagger-annotations:jar:1.5.0:compile
[INFO] |  +- io.swagger:swagger-models:jar:1.5.0:compile
[INFO] |  +- io.springfox:springfox-spi:jar:2.1.1:compile
[INFO] |  |  \- io.springfox:springfox-core:jar:2.1.1:compile
[INFO] |  +- io.springfox:springfox-schema:jar:2.1.1:compile
[INFO] |  +- io.springfox:springfox-swagger-common:jar:2.1.1:compile
[INFO] |  +- io.springfox:springfox-spring-web:jar:2.1.1:compile
[INFO] |  +- com.google.guava:guava:jar:18.0:compile
[INFO] |  +- com.fasterxml:classmate:jar:1.2.0:compile
[INFO] |  +- joda-time:joda-time:jar:2.5:compile
[INFO] |  +- org.springframework.plugin:spring-plugin-core:jar:1.2.0.RELEASE:compile
[INFO] |  \- org.springframework.plugin:spring-plugin-metadata:jar:1.2.0.RELEASE:compile
[INFO] \- io.springfox:springfox-swagger-ui:jar:2.1.1:compile

所以，HikariCP明确在类路径中，而tomcat-jdbc则不在。但是当我启动服务时，autoconfig仍然创建org.apache.tomcat.jdbc.pool.DataSource而不是HikariCP。

我做错了什么？

---

编辑

这是我的应用程序启动器：

@SpringBootApplication
@EnableHypermediaSupport(type = {HypermediaType.HAL})
public class ApplicationRunner {

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

}

- jscherman

---

你是如何启动服务的？ - M. Deinum

尝试清理项目，也许JAR包仍在你的构件输出目录中。 - GUISSOUMA Issam

你是从命令行运行jar文件还是从IDE启动主类？（如果是后者，你能提一下你的IDE吗？）至少尝试从命令行运行jar文件。 - M. Deinum

дҪ иғҪеҗҰзЎ®и®ӨдҪ зҡ„зұ»и·Ҝеҫ„дёҠжІЎжңү org.apache.tomcat.jdbc.pool.DataSource иҝҷдёӘзұ»пјҹеңЁ Eclipse дёӯжү“ејҖзұ»еһӢпјҲctrl+shift+tпјүпјҢиҫ“е…Ҙ DataSourceпјҢиҝҷдёӘзұ» org.apache.tomcat.jdbc.pool.DataSource жҳҜеҗҰеҮәзҺ°еңЁеҲ—иЎЁдёӯпјҹ - GUISSOUMA Issam

首先尝试最简单的方法。尝试清理项目，确保Tomcat jar包不存在。另外，您确定没有在XML中定义任何可能潜入类路径的上下文吗？ - Laran Evans

Answer 1

• 将 Hikari 添加到您的 pom 中

• 在您的 application.yml 文件中添加以下属性

spring:
  datasource:
    type: com.zaxxer.hikari.HikariDataSource
    ...

- Ben

Answer 2

编辑：本答案提供了在标准Spring中配置Hikari的方法，对于Boot也同样适用。然而，自从我写这篇文章以来，Boot已经为Hikari添加了更好的集成，像this这样的答案可能更适合Boot。

只需在@Configuration类中提供数据源即可：

@Configuration
public class HikariCPConfig {

    @Value("${hikari.driverclassname}")
    private String driverClassName;

    @Value("${hikari.jdbc.url}")
    private String jdbcUrl;

    @Value("${hikari.username}")
    private String userName;

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

    @Value("${hikari.pool.size}")
    private int poolSize;

    @Bean(destroyMethod = "close")
    public DataSource dataSource() {
        final HikariDataSource ds = new HikariDataSource();
        ds.setMaximumPoolSize(poolSize);
        ds.setDriverClassName(driverClassName);
        ds.setJdbcUrl(jdbcUrl);
        ds.setUsername(userName);
        ds.setPassword(password);
        return ds;
    }

}

接下来，在application.properties文件中声明您的数据源属性，这些属性可以由Maven构建提供：

#Hikari
hikari.driverclassname = com.mysql.jdbc.Driver
hikari.jdbc.url = jdbc:mysql://localhost:3306/my_db
hikari.username = ${db.username}
hikari.password = ${db.password}
hikari.pool.size = 5

然后您需要使用Spring扫描您的HikariCPConfig类，但是由于您正在使用@SpringBootApplication，它相当于@Configuration @EnableAutoConfiguration和@ComponentScan，所以这不应该是一个问题。

另请参阅:

• 使用@SpringBootApplication注释
• 在Spring Boot中配置数据源

- Aritz

---

既然这是一个有效的解决方案，我本来想避免利用Spring Boot自动配置的方式。但如果问题仍然存在，我肯定会采取这种方式。谢谢！ - jscherman

我知道，但是在生产环境中，由于Tomcat连接在一段时间内处于非活动状态时会关闭，因此连接失败。我读到可能使用HikariCP就不会发生这种情况（或者我必须为每个请求设置测试连接，这将大大降低性能）。 - jscherman

我解决了问题，但实际上我不知道怎么做的:P。只是因为另一个原因重新安装了eclipse，一切顺利。谢谢！无论如何我接受你的答案，因为那是一个解决方案。 - jscherman

这可能听起来有点可笑，但我甚至不知道发生了什么...我只是重新安装了Eclipse（出于其他原因），然后它就正常工作了...也许是与Eclipse缓存相关的问题？很奇怪，因为我尝试清理项目并更新依赖项都没有成功。无论如何，明天我会尝试重现错误并看看会发生什么 :-) - jscherman

@jscherman，我最近也遇到了Tomcat连接池的同样问题（它在生产环境中一段时间后被关闭）。我通过以下配置解决了这个问题：spring.datasource.test-on-borrow: true 和 spring.datasource.validation-query: SELECT 1。这样你就可以强制池验证每个连接。 - Aritz

Answer 3

spring.datasource.type 从 Spring Boot 1.3.0 开始使用，因此在 1.2.5 上无法工作。

- martian

---

你是什么意思？我在哪里使用spring.datasource.type？ - jscherman

如果你正在使用1.3.0+版本，你可以指定属性spring.datasouce.type，否则你必须定义一个bean来覆盖spring-boot自动配置。 - martian

我假设你的评论是回应@Ben的评论。我明白你的意思，但在我提出这个问题的时候，正如你所说，我无法使用datasourr类型参数。做法就像我所说的文档中提到的那样：从类路径中获取Hikari。问题是它也没有起作用。然后重新安装Eclipse后，问题奇怪地消失了，所以我不知道问题出在哪里。 - jscherman

如果您将war部署到tomcat的webapps目录中，那么tomcat-jdbc库已经存在。Spring Boot会在hikaricp之前搜索tomcat-jdbc，因此您的配置将无法正常工作。我写了一个示例。https://github.com/zhanhb/spring-boot-druid-sample/blob/1442b5441d4632c30d15cff8c92c4948a27b2fa2/src/main/java/com/github/zhanhb/customdatasource/config/CustomDataSource.java - martian