Druid 的整合 springboot mybaits

爱被打了一巴掌 2022-12-17 07:02 9阅读 0赞

**创建 SpringBoot 项目**

在整合 Druid 之前，需要先创建一个 SpringBoot 和 MyBatis 的项目，先来观察一下，它默认是否使用了数据库连接池，使用了什么数据库连接池。然后，再来整合 Druid 这款数据库连接池到项目当中。

创建 SpringBoot 和 Mybatis 的项目很简单，通过向导即可完成( 完整项目项目www.fhadmin.org)。创建项目后的依赖如下：

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.1.3</version>
    </dependency>
    
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
        <exclusions>
            <exclusion>
                <groupId>org.junit.vintage</groupId>
                <artifactId>junit-vintage-engine</artifactId>
            </exclusion>
        </exclusions>
    </dependency>

其中的依赖很少，添加了 SpringMVC、Mybatis 和 MySQL。有了依赖之后，添加数据库的配置，否则项目无法启动。数据库的配置如下：

spring:
        datasource:
            url: jdbc:mysql://192.168.0.106:3306/scms?serverTimezone=UTC
            username: root
            password:

有了上面的配置，项目就可以启动了，不过整个项目没有任何功能启动也无意义。因此来写一个简单的单元测试，代码如下：

//www.fhadmin.org
    @Autowired
    DataSource dataSource;
    
    @Test
    void contextLoads() throws SQLException
    {
        System.out.println(dataSource.getClass());
        Connection connection = dataSource.getConnection();
        System.out.println(connection);
    }

有了单元测试之后，直接运行单元测试的代码，输出结果如下：

class com.zaxxer.hikari.HikariDataSource
    2020-10-02 11:17:41.279  INFO 25817 --- [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Starting...
    2020-10-02 11:17:41.457  INFO 25817 --- [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Start completed.
    HikariProxyConnection@1405548909 wrapping com.mysql.cj.jdbc.ConnectionImpl@435cc7f9
    2020-10-02 11:17:41.472  INFO 25817 --- [extShutdownHook] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Shutdown initiated...
    2020-10-02 11:17:41.482  INFO 25817 --- [extShutdownHook] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Shutdown completed.

可以看到，虽然在项目中没有整合任何的数据库连接池，但是 Spring 默认整合了 Hikari 这个数据库连接池。但是，我们想要使用的是 Druid，那么该如何做？

**整合 Druid**

整合 Druid 的方法也比较简单的，引入 Druid 的相关依赖，并修改数据库的配置即可。依赖如下：

<dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid</artifactId>
        <version>1.1.24</version>
    </dependency>

修改数据库的配置只需要增加一行配置即可，配置如下：

spring:
        datasource:
            url: jdbc:mysql://192.168.0.106:3306/scms?serverTimezone=UTC
            username: root
            password:
            type: com.alibaba.druid.pool.DruidDataSource

比较前面的配置，我们的配置增加了一行配置，然后我们接着运行前面的单元测试代码。输出如下：

class com.alibaba.druid.pool.DruidDataSource
    2020-10-02 12:01:18.784  INFO 26316 --- [           main] com.alibaba.druid.pool.DruidDataSource   : {dataSource-1} inited
    com.mysql.cj.jdbc.ConnectionImpl@3f0d6038
    2020-10-02 12:01:18.920  INFO 26316 --- [extShutdownHook] com.alibaba.druid.pool.DruidDataSource   : {dataSource-1} closing ...
    2020-10-02 12:01:18.921  INFO 26316 --- [extShutdownHook] com.alibaba.druid.pool.DruidDataSource   : {dataSource-1} closed
    2020-10-02 12:01:18.922  INFO 26316 --- [extShutdownHook] o.s.s.concurrent.ThreadPoolTaskExecutor  : Shutting down ExecutorService 'applicationTaskExecutor'

可以看到，数据库连接池已经变成了 alibaba 的 Druid 了。

当然了，这不能算完，因为数据库连接池还是有很多配置的，我们添加一些配置，配置如下：

spring:
        datasource:
            url: jdbc:mysql://192.168.0.106:3306/scms?serverTimezone=UTC
            username: root
            password:
            type: com.alibaba.druid.pool.DruidDataSource
            initialSize: 5
            minIdle: 5
            maxActive: 20
            maxWait: 60000
            timeBetweenEvictionRunsMillis: 60000
            minEvictableIdleTimeMillis: 300000
            validationQuery: SELECT 1 FROM DUAL
            testWhileIdle: true
            testOnBorrow: false
            testOnReturn: false
            poolPreparedStatements: true

上面的配置对 Druid 进行相关的配置，但是添加上配置是否能生效，修改我们的单元测试代码并运行，单元测试代码修改如下：

DruidDataSource druidDataSource = (DruidDataSource)dataSource;
    System.out.println("initialSize: " + druidDataSource.getInitialSize());
    System.out.println("maxActive: " + druidDataSource.getMaxActive());

运行修改后的单元测试，查看输出：

initialSize: 0
    maxActive: 8

可以看到，并没有按照我们的预期进行输出，因为配置并没有被读取。我们需要能够将修改的配置进行读取。

**读取数据库连接池配置**

想要使用数据库连接池的配置，那么就需要定义一个读取配置的类，并重新实例化一个 DataSource 类。代码如下：

//完整项目项目fhadmin.org
    @Configuration
    public class DruidConfig
    {
        @ConfigurationProperties(prefix = "spring.datasource")
        @Bean
        public DataSource druidDataSource() {
            return new DruidDataSource();
        }
    }

再次运行单元测试，查看输出：

initialSize: 5
    maxActive: 20

可以看到，现在的输出结果已经和配置相同了。

**配置监控**

在前面已经提到过，Druid 有强大的监控功能，但是需要我们进行简单的代码编写才可以进行查看具体的监控，代码如下；

@Bean
    public ServletRegistrationBean druidServletRegistrationBean()
    {
        ServletRegistrationBean<Servlet> servletServletRegistrationBean = new ServletRegistrationBean<>(new StatViewServlet(), "/druid/*");;
        Map<String, String> initParam = new HashMap<>();
        //后台允许谁可以访问
        initParam.put("loginUsername", "admin");
        initParam.put("loginPassword", "123456");
        initParam.put("allow", "");
        servletServletRegistrationBean.setInitParameters(initParam);
    
        return servletServletRegistrationBean;
    }

// 配置 Druid 监控 之  web 监控的 filter
    // WebStatFilter：用于配置Web和Druid数据源之间的管理关联监控统计
    @Bean
    public FilterRegistrationBean webStatFilter() {
        FilterRegistrationBean bean = new FilterRegistrationBean();
        bean.setFilter(new WebStatFilter());
    
        Map<String, String> initParams = new HashMap<>();
        initParams.put("exclusions", "*.js,*.css,/druid/*");
        bean.setInitParameters(initParams);
    
        //"/*" 表示过滤所有请求
        bean.setUrlPatterns(Arrays.asList("/*"));
        return bean;
    }

启动项目，然后访问 localhost:8080/druid/ 就会进入 Druid 的监控界面