首頁>網絡編程教程>Java教程

Spring Boot+Mybatis+Druid+PageHelper實現多數據源並分頁的方法

作者：Eve Cole 更新時間：2025-08-26 14:32:02

前言

本篇文章主要講述的是SpringBoot整合Mybatis、Druid和PageHelper 並實現多數據源和分頁。其中SpringBoot整合Mybatis這塊，在之前的的一篇文章中已經講述了，這裡就不過多說明了。重點是講述在多數據源下的如何配置使用Druid和PageHelper 。

Druid介紹和使用

在使用Druid之前，先來簡單的了解下Druid。

Druid是一個數據庫連接池。 Druid可以說是目前最好的數據庫連接池！因其優秀的功能、性能和擴展性方面，深受開發人員的青睞。

Druid已經在阿里巴巴部署了超過600個應用，經過一年多生產環境大規模部署的嚴苛考驗。 Druid是阿里巴巴開發的號稱為監控而生的數據庫連接池！

同時Druid不僅僅是一個數據庫連接池，Druid 核心主要包括三部分：

  • 基於Filter－Chain模式的插件體系。
  • DruidDataSource 高效可管理的數據庫連接池。
  • SQLParser

Druid的主要功能如下:

  1. 是一個高效、功能強大、可擴展性好的數據庫連接池。
  2. 可以監控數據庫訪問性能。
  3. 數據庫密碼加密
  4. 獲得SQL執行日誌
  5. 擴展JDBC

介紹方面這塊就不再多說，具體的可以看官方文檔。

那麼開始介紹Druid如何使用。

首先是Maven依賴，只需要添加druid這一個jar就行了。

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

配置方面，主要的只需要在application.properties或application.yml添加如下就可以了。

說明：因為這裡我是用來兩個數據源，所以稍微有些不同而已。 Druid 配置的說明在下面中已經說的很詳細了，這裡我就不在說明了。

 ## 默認的數據源master.datasource.url=jdbc:mysql://localhost:3306/springBoot?useUnicode=true&characterEncoding=utf8&allowMultiQueries=truemaster.datasource.username=rootmaster.datasource.password=123456master.datasource.driverClassName=com.mysql.jdbc.Driver## 另一個的數據源cluster.datasource.url=jdbc:mysql://localhost:3306/springBoot_test?useUnicode=true&characterEncoding=utf8cluster.datasource.username=rootcluster.datasource.password=123456cluster.datasource.driverClassName=com.mysql.jdbc.Driver# 連接池的配置信息# 初始化大小，最小，最大spring.datasource.type=com.alibaba.druid.pool.DruidDataSourcespring.datasource.initialSize=5 spring.datasource.minIdle=5 spring.datasource.maxActive=20 # 配置獲取連接等待超時的時間spring.datasource.maxWait=60000 # 配置間隔多久才進行一次檢測，檢測需要關閉的空閒連接，單位是毫秒spring.datasource.timeBetweenEvictionRunsMillis=60000 # 配置一個連接在池中最小生存的時間，單位是毫秒spring.datasource.minEvictableIdleTimeMillis=300000 spring.datasource.validationQuery=SELECT 1 FROM DUAL spring.datasource.testWhileIdle=true spring.datasource.testOnBorrow=false spring.datasource.testOnReturn=false # 打開PSCache，並且指定每個連接上PSCache的大小spring.datasource.poolPreparedStatements=true spring.datasource.maxPoolPreparedStatementPerConnectionSize=20 # 配置監控統計攔截的filters，去掉後監控界面sql無法統計，'wall'用於防火牆spring.datasource.filters=stat,wall,log4j # 通過connectProperties屬性來打開mergeSql功能；慢SQL記錄spring.datasource.connectionProperties=druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000

成功添加了配置文件之後，我們再來編寫Druid相關的類。

首先是MasterDataSourceConfig.java這個類，這個是默認的數據源配置類。

 @Configuration@MapperScan(basePackages = MasterDataSourceConfig.PACKAGE, sqlSessionFactoryRef = "masterSqlSessionFactory")public class MasterDataSourceConfig { static final String PACKAGE = "com.pancm.dao.master"; static final String MAPPER_LOCATION = "classpath:mapper/master/*.xml"; @Value("${master.datasource.url}") private String url; @Value("${master.datasource.username}") private String username; @Value("${master.datasource.password}") private String password; @Value("${master.datasource.driverClassName}") private String driverClassName; @Value("${spring.datasource.initialSize}") private int initialSize; @Value("${spring.datasource.minIdle}") private int minIdle; @Value("${spring.datasource.maxActive}") private int maxActive; @Value("${spring.datasource.maxWait}") private int maxWait; @Value("${spring.datasource.timeBetweenEvictionRunsMillis}") private int timeBetweenEvictionRunsMillis; @Value("${spring.datasource.minEvictableIdleTimeMillis}") private int minEvictableIdleTimeMillis; @Value("${spring.datasource.validationQuery}") private String validationQuery; @Value("${spring.datasource.testWhileIdle}") private boolean testWhileIdle; @Value("${spring.datasource.testOnBorrow}") private boolean testOnBorrow; @Value("${spring.datasource.testOnReturn}") private boolean testOnReturn; @Value("${spring.datasource.poolPreparedStatements}") private boolean poolPreparedStatements; @Value("${spring.datasource.maxPoolPreparedStatementPerConnectionSize}") private int maxPoolPreparedStatementPerConnectionSize; @Value("${spring.datasource.filters}") private String filters; @Value("{spring.datasource.connectionProperties}") private String connectionProperties; @Bean(name = "masterDataSource") @Primary public DataSource masterDataSource() { DruidDataSource dataSource = new DruidDataSource(); dataSource.setUrl(url); dataSource.setUsername(username); dataSource.setPassword(password); dataSource.setDriverClassName(driverClassName); //具體配置dataSource.setInitialSize(initialSize); dataSource.setMinIdle(minIdle); dataSource.setMaxActive(maxActive); dataSource.setMaxWait(maxWait); dataSource.setTimeBetweenEvictionRunsMillis(timeBetweenEvictionRunsMillis); dataSource.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis); dataSource.setValidationQuery(validationQuery); dataSource.setTestWhileIdle(testWhileIdle); dataSource.setTestOnBorrow(testOnBorrow); dataSource.setTestOnReturn(testOnReturn); dataSource.setPoolPreparedStatements(poolPreparedStatements); dataSource.setMaxPoolPreparedStatementPerConnectionSize(maxPoolPreparedStatementPerConnectionSize); try { dataSource.setFilters(filters); } catch (SQLException e) { e.printStackTrace(); } dataSource.setConnectionProperties(connectionProperties); return dataSource; } @Bean(name = "masterTransactionManager") @Primary public DataSourceTransactionManager masterTransactionManager() { return new DataSourceTransactionManager(masterDataSource()); } @Bean(name = "masterSqlSessionFactory") @Primary public SqlSessionFactory masterSqlSessionFactory(@Qualifier("masterDataSource") DataSource masterDataSource) throws Exception { final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean(); sessionFactory.setDataSource(masterDataSource); sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver() .getResources(MasterDataSourceConfig.MAPPER_LOCATION)); return sessionFactory.getObject(); }}

其中這兩個註解說明下:

**@Primary** ：標誌這個Bean 如果在多個同類Bean 候選時，該Bean
優先被考慮。多數據源配置的時候注意，必須要有一個主數據源，用@Primary 標誌該Bean。

**@MapperScan**： 掃描Mapper 接口並容器管理。

需要注意的是sqlSessionFactoryRef 表示定義一個唯一SqlSessionFactory 實例。

上面的配置完之後，就可以將Druid作為連接池使用了。但是Druid並不簡簡單單的是個連接池，它也可以說是一個監控應用，它自帶了web監控界面，可以很清晰的看到SQL相關信息。

在SpringBoot中運用Druid的監控作用，只需要編寫StatViewServlet和WebStatFilter類，實現註冊服務和過濾規則。這裡我們可以將這兩個寫在一起，使用**@Configuration**和**@Bean**。

為了方便理解，相關的配置說明也寫在代碼中了，這裡就不再過多贅述了。

代碼如下:

 @Configurationpublic class DruidConfiguration { @Bean public ServletRegistrationBean druidStatViewServle() { //註冊服務ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean( new StatViewServlet(), "/druid/*"); // 白名單(為空表示,所有的都可以訪問,多個IP的時候用逗號隔開) servletRegistrationBean.addInitParameter("allow", "127.0.0.1"); // IP黑名單(存在共同時，deny優先於allow) servletRegistrationBean.addInitParameter("deny", "127.0.0.2"); // 設置登錄的用戶名和密碼servletRegistrationBean.addInitParameter("loginUsername", "pancm"); servletRegistrationBean.addInitParameter("loginPassword", "123456"); // 是否能夠重置數據. servletRegistrationBean.addInitParameter("resetEnable", "false"); return servletRegistrationBean; } @Bean public FilterRegistrationBean druidStatFilter() { FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean( new WebStatFilter()); // 添加過濾規則filterRegistrationBean.addUrlPatterns("/*"); // 添加不需要忽略的格式信息filterRegistrationBean.addInitParameter("exclusions", "*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*"); System.out.println("druid初始化成功!"); return filterRegistrationBean; }}

編寫完之後，啟動程序，在瀏覽器輸入:http://127.0.0.1:8084/druid/index.html ，然後輸入設置的用戶名和密碼，便可以訪問Web界面了。

多數據源配置

在進行多數據源配置之前，先分別在springBoot和springBoot_test的mysql數據庫中執行如下腳本。

 -- springBoot庫的腳本CREATE TABLE `t_user` ( `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '自增id', `name` varchar(10) DEFAULT NULL COMMENT '姓名', `age` int(2) DEFAULT NULL COMMENT '年齡', PRIMARY KEY (`id`)) ENGINE=InnoDB AUTO_INCREMENT=15 DEFAULT CHARSET=utf8-- springBoot_test庫的腳本CREATE TABLE `t_student` ( `id` int(11) NOT NULL AUTO_INCREMENT, `name` varchar(16) DEFAULT NULL, `age` int(11) DEFAULT NULL, PRIMARY KEY (`id`)) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8

注:為了偷懶，將兩張表的結構弄成一樣了！不過不影響測試!

在application.properties中已經配置這兩個數據源的信息，上面已經貼出了一次配置，這裡就不再貼了。

這裡重點說下第二個數據源的配置。和上面的MasterDataSourceConfig.java差不多，區別在與沒有使用**@Primary** 註解和名稱不同而已。需要注意的是MasterDataSourceConfig.java對package和mapper的掃描是精確到目錄的，這裡的第二個數據源也是如此。那麼代碼如下:

 @Configuration@MapperScan(basePackages = ClusterDataSourceConfig.PACKAGE, sqlSessionFactoryRef = "clusterSqlSessionFactory")public class ClusterDataSourceConfig { static final String PACKAGE = "com.pancm.dao.cluster"; static final String MAPPER_LOCATION = "classpath:mapper/cluster/*.xml"; @Value("${cluster.datasource.url}") private String url; @Value("${cluster.datasource.username}") private String username; @Value("${cluster.datasource.password}") private String password; @Value("${cluster.datasource.driverClassName}") private String driverClass; // 和MasterDataSourceConfig一樣，這里略@Bean(name = "clusterDataSource") public DataSource clusterDataSource() { DruidDataSource dataSource = new DruidDataSource(); dataSource.setUrl(url); dataSource.setUsername(username); dataSource.setPassword(password); dataSource.setDriverClassName(driverClass); // 和MasterDataSourceConfig一樣，這里略... return dataSource; } @Bean(name = "clusterTransactionManager") public DataSourceTransactionManager clusterTransactionManager() { return new DataSourceTransactionManager(clusterDataSource()); } @Bean(name = "clusterSqlSessionFactory") public SqlSessionFactory clusterSqlSessionFactory(@Qualifier("clusterDataSource") DataSource clusterDataSource) throws Exception { final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean(); sessionFactory.setDataSource(clusterDataSource); sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources(ClusterDataSourceConfig.MAPPER_LOCATION)); return sessionFactory.getObject(); }}

成功寫完配置之後，啟動程序，進行測試。

分別在springBoot和springBoot_test庫中使用接口進行添加數據。

t_user

 POST http://localhost:8084/api/user{"name":"張三","age":25}{"name":"李四","age":25}{"name":"王五","age":25}

t_student

 POST http://localhost:8084/api/student{"name":"學生A","age":16}{"name":"學生B","age":17}{"name":"學生C","age":18}

成功添加數據之後，然後進行調用不同的接口進行查詢。

請求:

 GET http://localhost:8084/api/user?name=李四

返回:

 { "id": 2, "name": "李四", "age": 25}

請求:

 GET http://localhost:8084/api/student?name=學生C

返回:

 { "id": 1, "name": "學生C", "age": 16}

通過數據可以看出，成功配置了多數據源了。

PageHelper 分頁實現

PageHelper是Mybatis的一個分頁插件，非常的好用！這裡強烈推薦！ ！ ！

PageHelper的使用很簡單，只需要在Maven中添加pagehelper這個依賴就可以了。
Maven的依賴如下:

 <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper-spring-boot-starter</artifactId> <version>1.2.3</version> </dependency>

注：這裡我是用springBoot版的！也可以使用其它版本的。

添加依賴之後，只需要添加如下配置或代碼就可以了。

第一種，在application.properties或application.yml添加

pagehelper: helperDialect: mysql offsetAsPageNum: true rowBoundsWithCount: true reasonable: false

第二種，在mybatis.xml配置中添加

<bean id="sqlSessionFactory"> <property name="dataSource" ref="dataSource" /> <!-- 掃描mapping.xml文件--> <property name="mapperLocations" value="classpath:mapper/*.xml"></property> <!-- 配置分頁插件--> <property name="plugins"> <array> <bean> <property name="properties"> <value> helperDialect=mysql offsetAsPageNum=true rowBoundsWithCount=true reasonable=false </value> </property> </bean> </array> </property> </bean>

第三種，在代碼中添加，使用**@Bean**註解在啟動程序的時候初始化。

 @Bean public PageHelper pageHelper(){ PageHelper pageHelper = new PageHelper(); Properties properties = new Properties(); //數據庫properties.setProperty("helperDialect", "mysql"); //是否將參數offset作為PageNum使用properties.setProperty("offsetAsPageNum", "true"); //是否進行count查詢properties.setProperty("rowBoundsWithCount", "true"); //是否分頁合理化properties.setProperty("reasonable", "false"); pageHelper.setProperties(properties); }

因為這裡我們使用的是多數據源，所以這裡的配置稍微有些不同。我們需要在sessionFactory這裡配置。這裡就對MasterDataSourceConfig.java進行相應的修改。在masterSqlSessionFactory方法中，添加如下代碼。

 @Bean(name = "masterSqlSessionFactory") @Primary public SqlSessionFactory masterSqlSessionFactory(@Qualifier("masterDataSource") DataSource masterDataSource) throws Exception { final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean(); sessionFactory.setDataSource(masterDataSource); sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver() .getResources(MasterDataSourceConfig.MAPPER_LOCATION)); //分頁插件Interceptor interceptor = new PageInterceptor(); Properties properties = new Properties(); //數據庫properties.setProperty("helperDialect", "mysql"); //是否將參數offset作為PageNum使用properties.setProperty("offsetAsPageNum", "true"); //是否進行count查詢properties.setProperty("rowBoundsWithCount", "true"); //是否分頁合理化properties.setProperty("reasonable", "false"); interceptor.setProperties(properties); sessionFactory.setPlugins(new Interceptor[] {interceptor}); return sessionFactory.getObject(); }

注：其它的數據源也想進行分頁的時候，參照上面的代碼即可。

這裡需要注意的是reasonable參數，表示分頁合理化，默認值為false。如果該參數設置為true 時，pageNum<=0 時會查詢第一頁，pageNum>pages（超過總數時），會查詢最後一頁。默認false 時，直接根據參數進行查詢。

設置完PageHelper 之後，使用的話，只需要在查詢的sql前面添加PageHelper.startPage(pageNum,pageSize); ，如果是想知道總數的話，在查詢的sql語句后買呢添加page.getTotal()就可以了。

代碼示例:

 public List<T> findByListEntity(T entity) { List<T> list = null; try { Page<?> page =PageHelper.startPage(1,2); System.out.println(getClassName(entity)+"設置第一頁兩條數據!"); list = getMapper().findByListEntity(entity); System.out.println("總共有:"+page.getTotal()+"條數據,實際返回:"+list.size()+"兩條數據!"); } catch (Exception e) { logger.error("查詢"+getClassName(entity)+"失敗!原因是:",e); } return list; }

代碼編寫完畢之後，開始進行最後的測試。

查詢t_user表的所有的數據，並進行分頁。

請求:

 GET http://localhost:8084/api/user

返回:

 [ { "id": 1, "name": "張三", "age": 25 }, { "id": 2, "name": "李四", "age": 25 }]

控制台打印:

開始查詢...
User設置第一頁兩條數據!
2018-04-27 19:55:50.769 DEBUG 6152 --- [io-8084-exec-10] cpdmUserDao.findByListEntity_COUNT : ==> Preparing: SELECT count(0) FROM t_user WHERE 1 = 1
2018-04-27 19:55:50.770 DEBUG 6152 --- [io-8084-exec-10] cpdmUserDao.findByListEntity_COUNT : ==> Parameters:
2018-04-27 19:55:50.771 DEBUG 6152 --- [io-8084-exec-10] cpdmUserDao.findByListEntity_COUNT : <== Total: 1
2018-04-27 19:55:50.772 DEBUG 6152 --- [io-8084-exec-10] cpdao.master.UserDao.findByListEntity : ==> Preparing: select id, name, age from t_user where 1=1 LIMIT ?
2018-04-27 19:55:50.773 DEBUG 6152 --- [io-8084-exec-10] cpdao.master.UserDao.findByListEntity : ==> Parameters: 2(Integer)
2018-04-27 19:55:50.774 DEBUG 6152 --- [io-8084-exec-10] cpdao.master.UserDao.findByListEntity : <== Total: 2
總共有:3條數據,實際返回:2兩條數據!

查詢t_student表的所有的數據，並進行分頁。

請求:

 GET http://localhost:8084/api/student

返回:

 [ { "id": 1, "name": "學生A", "age": 16 }, { "id": 2, "name": "學生B", "age": 17 }]

控制台打印:

開始查詢...
Studnet設置第一頁兩條數據!
2018-04-27 19:54:56.155 DEBUG 6152 --- [nio-8084-exec-8] cpdcSfindByListEntity_COUNT : ==> Preparing: SELECT count(0) FROM t_student WHERE 1 = 1
2018-04-27 19:54:56.155 DEBUG 6152 --- [nio-8084-exec-8] cpdcSfindByListEntity_COUNT : ==> Parameters:
2018-04-27 19:54:56.156 DEBUG 6152 --- [nio-8084-exec-8] cpdcSfindByListEntity_COUNT : <== Total: 1
2018-04-27 19:54:56.157 DEBUG 6152 --- [nio-8084-exec-8] cpdcStudentDao.findByListEntity : ==> Preparing: select id, name, age from t_student where 1=1 LIMIT ?
2018-04-27 19:54:56.157 DEBUG 6152 --- [nio-8084-exec-8] cpdcStudentDao.findByListEntity : ==> Parameters: 2(Integer)
2018-04-27 19:54:56.157 DEBUG 6152 --- [nio-8084-exec-8] cpdcStudentDao.findByListEntity : <== Total: 2
總共有:3條數據,實際返回:2兩條數據!

查詢完畢之後，我們再來看Druid 的監控界面。在瀏覽器輸入:http://127.0.0.1:8084/druid/index.html


可以很清晰的看到操作記錄!

如果想知道更多的Druid相關知識，可以查看官方文檔!

結語

這篇終於寫完了，在進行代碼編寫的時候，碰到過很多問題，然後慢慢的嘗試和找資料解決了。本篇文章只是很淺的介紹了這些相關的使用，在實際的應用可能會更複雜。

參考文章:https://www.bysocket.com/?p=1712

Durid官方地址:https://github.com/alibaba/druid

PageHelper官方地址:https://github.com/pagehelper/Mybatis-PageHelper

項目我放到github上面去了: https://github.com/xuwujing/springBoot ，大家也可以本地下載：點擊這裡

總結

以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，如果有疑問大家可以留言交流，謝謝大家對武林網的支持。

相關文章