SpringBoot集成阿里巴巴Druid监控的示例代码

druid是阿里巴巴开源的数据库连接池，提供了优秀的对数据库操作的监控功能，本文要讲解一下springboot项目怎么集成druid。

本文在基于jpa的项目下开发，首先在pom文件中额外加入druid依赖，pom文件如下：

2. <?xml version="1.0" encoding="UTF-8"?>
3. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5. <modelVersion>4.0.0</modelVersion>
7. <groupId>com.dalaoyang</groupId>
8. <artifactId>springboot_druid</artifactId>
9. <version>0.0.1-SNAPSHOT</version>
10. <packaging>jar</packaging>
12. <name>springboot_druid</name>
13. <description>springboot_druid</description>
15. <parent>
16. <groupId>org.springframework.boot</groupId>
17. <artifactId>spring-boot-starter-parent</artifactId>
18. <version>1.5.12.RELEASE</version>
19. <relativePath/> <!-- lookup parent from repository -->
20. </parent>
22. <properties>
23. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
24. <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
25. <java.version>1.8</java.version>
26. </properties>
28. <dependencies>
29. <dependency>
30. <groupId>org.springframework.boot</groupId>
31. <artifactId>spring-boot-starter-data-jpa</artifactId>
32. </dependency>
33. <dependency>
34. <groupId>org.springframework.boot</groupId>
35. <artifactId>spring-boot-starter-web</artifactId>
36. </dependency>
38. <dependency>
39. <groupId>org.springframework.boot</groupId>
40. <artifactId>spring-boot-devtools</artifactId>
41. <scope>runtime</scope>
42. </dependency>
43. <dependency>
44. <groupId>mysql</groupId>
45. <artifactId>mysql-connector-java</artifactId>
46. <scope>runtime</scope>
47. </dependency>
48. <dependency>
49. <groupId>org.springframework.boot</groupId>
50. <artifactId>spring-boot-starter-test</artifactId>
51. <scope>test</scope>
52. </dependency>
53. <dependency>
54. <groupId>com.alibaba</groupId>
55. <artifactId>druid</artifactId>
56. <version>1.0.28</version>
57. </dependency>
58. </dependencies>
60. <build>
61. <plugins>
62. <plugin>
63. <groupId>org.springframework.boot</groupId>
64. <artifactId>spring-boot-maven-plugin</artifactId>
65. </plugin>
66. </plugins>
67. </build>
68. </project>

复制代码

application.properties上半段和整合jpa一点没变，下面加入了一些druid的配置，如果对druid的配置有什么不理解的，可以去网上查一下。（这篇文章我觉得写的很好，传送门）

2. #端口号
3. server.port=8888
5. ##validate 加载hibernate时，验证创建数据库表结构
6. ##create 每次加载hibernate，重新创建数据库表结构，这就是导致数据库表数据丢失的原因。
7. ##create-drop 加载hibernate时创建，退出是删除表结构
8. ##update 加载hibernate自动更新数据库结构
9. ##validate 启动时验证表的结构，不会创建表
10. ##none 启动时不做任何操作
11. spring.jpa.hibernate.ddl-auto=create
13. ##控制台打印sql
14. spring.jpa.show-sql=true
16. ##数据库配置
17. ##数据库地址
18. spring.datasource.url=jdbc:mysql://localhost:3306/test?characterEncoding=utf8&useSSL=false
19. ##数据库用户名
20. spring.datasource.username=root
21. ##数据库密码
22. spring.datasource.password=root
23. ##数据库驱动
24. spring.datasource.driver-class-name=com.mysql.jdbc.Driver
25. 江苏代孕
26. 江苏代孕公司
27. #这里是不同的
28. #使用druid的话 需要多配置一个属性spring.datasource.type
29. spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
32. # 连接池的配置信息
33. # 初始化大小，最小，最大
34. spring.datasource.initialSize=5
35. spring.datasource.minIdle=5
36. spring.datasource.maxActive=20
37. # 配置获取连接等待超时的时间
38. spring.datasource.maxWait=60000
39. # 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒
40. spring.datasource.timeBetweenEvictionRunsMillis=60000
41. # 配置一个连接在池中最小生存的时间，单位是毫秒
42. spring.datasource.minEvictableIdleTimeMillis=300000
43. spring.datasource.validationQuery=SELECT 1 FROM DUAL
44. spring.datasource.testWhileIdle=true
45. spring.datasource.testOnBorrow=false
46. spring.datasource.testOnReturn=false
47. # 打开PSCache，并且指定每个连接上PSCache的大小
48. spring.datasource.poolPreparedStatements=true
49. spring.datasource.maxPoolPreparedStatementPerConnectionSize=20
50. # 配置监控统计拦截的filters，去掉后监控界面sql无法统计，'wall'用于防火墙
51. spring.datasource.filters=stat,wall,log4j
52. # 通过connectProperties属性来打开mergeSql功能；慢SQL记录

复制代码

然后在项目中加入DruidConfig，简单讲解一下，这个配置文件主要是加载application.properties的配置，代码如下：

2. package com.dalaoyang.config;
3. import java.sql.SQLException;
4. import javax.sql.DataSource;
5. import org.apache.log4j.Logger;
6. import org.springframework.beans.factory.annotation.Value;
7. import org.springframework.context.annotation.Bean;
8. import org.springframework.context.annotation.Configuration;
9. import org.springframework.context.annotation.Primary;
10. import com.alibaba.druid.pool.DruidDataSource;
11. /**
12. * @author dalaoyang
13. * @Description
14. * @project springboot_learn
15. * @package com.dalaoyang.config
16. * @email [email protected]
17. * @date 2018/4/12
18. */
19. @Configuration
20. public class DruidConfig {
21. private Logger logger = Logger.getLogger(this.getClass());
23. @Value("${spring.datasource.url}")
24. private String dbUrl;
26. @Value("${spring.datasource.username}")
27. private String username;
29. @Value("${spring.datasource.password}")
30. private String password;
32. @Value("${spring.datasource.driver-class-name}")
33. private String driverClassName;
35. @Value("${spring.datasource.initialSize}")
36. private int initialSize;
38. @Value("${spring.datasource.minIdle}")
39. private int minIdle;
41. @Value("${spring.datasource.maxActive}")
42. private int maxActive;
44. @Value("${spring.datasource.maxWait}")
45. private int maxWait;
47. @Value("${spring.datasource.timeBetweenEvictionRunsMillis}")
48. private int timeBetweenEvictionRunsMillis;
50. @Value("${spring.datasource.minEvictableIdleTimeMillis}")
51. private int minEvictableIdleTimeMillis;
53. @Value("${spring.datasource.validationQuery}")
54. private String validationQuery;
56. @Value("${spring.datasource.testWhileIdle}")
57. private boolean testWhileIdle;
59. @Value("${spring.datasource.testOnBorrow}")
60. private boolean testOnBorrow;
62. @Value("${spring.datasource.testOnReturn}")
63. private boolean testOnReturn;
65. @Value("${spring.datasource.poolPreparedStatements}")
66. private boolean poolPreparedStatements;
68. @Value("${spring.datasource.maxPoolPreparedStatementPerConnectionSize}")
69. private int maxPoolPreparedStatementPerConnectionSize;
71. @Value("${spring.datasource.filters}")
72. private String filters;
74. @Value("{spring.datasource.connectionProperties}")
75. private String connectionProperties;
77. @Bean
78. @Primary //主数据源
79. public DataSource dataSource(){
80. DruidDataSource datasource = new DruidDataSource();
81. datasource.setUrl(this.dbUrl);
82. datasource.setUsername(username);
83. datasource.setPassword(password);
84. datasource.setDriverClassName(driverClassName);
85. //configuration
86. datasource.setInitialSize(initialSize);
87. datasource.setMinIdle(minIdle);
88. datasource.setMaxActive(maxActive);
89. datasource.setMaxWait(maxWait);
90. datasource.setTimeBetweenEvictionRunsMillis(timeBetweenEvictionRunsMillis);
91. datasource.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis);
92. datasource.setValidationQuery(validationQuery);
93. datasource.setTestWhileIdle(testWhileIdle);
94. datasource.setTestOnBorrow(testOnBorrow);
95. datasource.setTestOnReturn(testOnReturn);
96. datasource.setPoolPreparedStatements(poolPreparedStatements);
97. datasource.setMaxPoolPreparedStatementPerConnectionSize(maxPoolPreparedStatementPerConnectionSize);
98. try {
99. datasource.setFilters(filters);
100. } catch (SQLException e) {
101. logger.error("druid configuration Exception", e);
102. }
103. datasource.setConnectionProperties(connectionProperties);
104. return datasource;
105. }
106. }

复制代码

然后创建DruidFilter，代码如下：

2. package com.dalaoyang.filter;
3. import javax.servlet.annotation.WebFilter;
4. import javax.servlet.annotation.WebInitParam;
5. import com.alibaba.druid.support.http.WebStatFilter;
6. /**
7. * @author dalaoyang
8. * @Description
9. * @project springboot_learn
10. * @package com.dalaoyang.filter
11. * @email [email protected]
12. * @date 2018/4/12
13. */
14. @WebFilter(filterName="druidWebStatFilter",urlPatterns="/*",
15. initParams={
16. @WebInitParam(name="exclusions",value="*.js,*.gif,*.jpg,*.bmp,*.png,*.css,*.ico,/druid/*")//忽略资源
17. }
18. )
19. public class DruidFilter extends WebStatFilter {
20. }

复制代码

新建DruidServlet，在类上面加注解@WebServlet，其中配置了登录druid监控页面的账号密码，白名单黑名单之类的配置，代码如下：

2. package com.dalaoyang.servlet;
3. import javax.servlet.annotation.WebInitParam;
4. import javax.servlet.annotation.WebServlet;
5. import com.alibaba.druid.support.http.StatViewServlet;
6. /**
7. * @author dalaoyang
8. * @Description
9. * @project springboot_learn
10. * @package com.dalaoyang.servlet
11. * @email [email protected]
12. * @date 2018/4/12
13. */
14. @WebServlet(urlPatterns="/druid/*",
15. initParams={
16. @WebInitParam(name="allow",value=""),// IP白名单(没有配置或者为空，则允许所有访问)
17. @WebInitParam(name="deny",value=""),// IP黑名单 (deny优先于allow)
18. @WebInitParam(name="loginUsername",value="admin"),// 登录druid管理页面用户名
19. @WebInitParam(name="loginPassword",value="admin")// 登录druid管理页面密码
20. })
21. public class DruidServlet extends StatViewServlet {
23. }

复制代码

然后在启动类加入注解@ServletComponentScan，让项目扫描到servlet，代码如下：

2. package com.dalaoyang;
3. import org.springframework.boot.SpringApplication;
4. import org.springframework.boot.autoconfigure.SpringBootApplication;
5. import org.springframework.boot.web.servlet.ServletComponentScan;
6. @SpringBootApplication
7. // 启动类必须加入@ServletComponentScan注解，否则无法扫描到servlet
8. @ServletComponentScan
9. public class SpringbootDruidApplication {
10. public static void main(String[] args) {
11. SpringApplication.run(SpringbootDruidApplication.class, args);
12. }
13. }

复制代码

剩余的就是和整合jpa一样的entity（实体类），repository（数据操作层），controller（测试使用的controller），直接展示代码。

City

2. package com.dalaoyang.entity;
3. import javax.persistence.*;
4. /**
5. * @author dalaoyang
6. * @Description
7. * @project springboot_learn
8. * @package com.dalaoyang.Entity
9. * @email [email protected]
10. * @date 2018/4/7
11. */
12. @Entity
13. @Table(name="city")
14. public class City {
15. @Id
16. @GeneratedValue(strategy=GenerationType.AUTO)
17. private int cityId;
18. private String cityName;
19. private String cityIntroduce;
21. public City(int cityId, String cityName, String cityIntroduce) {
22. this.cityId = cityId;
23. this.cityName = cityName;
24. this.cityIntroduce = cityIntroduce;
25. }
27. public City(String cityName, String cityIntroduce) {
28. this.cityName = cityName;
29. this.cityIntroduce = cityIntroduce;
30. }
32. public City() {
33. }
35. public int getCityId() {
36. return cityId;
37. }
39. public void setCityId(int cityId) {
40. this.cityId = cityId;
41. }
43. public String getCityName() {
44. return cityName;
45. }
47. public void setCityName(String cityName) {
48. this.cityName = cityName;
49. }
51. public String getCityIntroduce() {
52. return cityIntroduce;
53. }
55. public void setCityIntroduce(String cityIntroduce) {
56. this.cityIntroduce = cityIntroduce;
57. }
58. }

复制代码

CityRepository

2. package com.dalaoyang.repository;
3. import com.dalaoyang.entity.City;
4. import org.springframework.data.jpa.repository.JpaRepository;
6. /**
7. * @author dalaoyang
8. * @Description
9. * @project springboot_learn
10. * @package com.dalaoyang.Repository
11. * @email [email protected]
12. * @date 2018/4/7
13. */
14. public interface CityRepository extends JpaRepository<City,Integer> {
15. }

复制代码

CityController

2. package com.dalaoyang.controller;
3. import com.dalaoyang.entity.City;
4. import com.dalaoyang.repository.CityRepository;
5. import org.springframework.beans.factory.annotation.Autowired;
6. import org.springframework.web.bind.annotation.GetMapping;
7. import org.springframework.web.bind.annotation.RestController;
8. /**
9. * @author dalaoyang
10. * @Description
11. * @project springboot_learn
12. * @package com.dalaoyang.controller
13. * @email [email protected]
14. * @date 2018/4/7

15. 
    http://www.ljhseo.com/
    http://www.xyrjkf.net/
    http://www.xyrjkf.cn/
    http://www.xyrjkf.com.cn/
    http://www.zjdygsi.cn/ 
    http://www.zjdaiyun.cn/ 
    http://www.jsdygsi.cn/ 
    http://www.xyrjkf.top/ 
    http://www.xyrjkf.com/
    http://www.daiyunzj.cn/

16. http://ljhseo.com

    http://xyrjkf.net
    http://xyrjkf.cn
    http://xyrjkf.com.cn
    http://zjdygsi.cn
    http://zjdaiyun.cn
    http://jsdygsi.cn
    http://xyrjkf.top
    http://xyrjkf.com
    http://daiyunzj.cn

17. */
18. @RestController
19. public class CityController {
20. @Autowired
21. private CityRepository cityRepository;
23. //http://localhost:8888/saveCity?cityName=北京&cityIntroduce=中国首都
24. @GetMapping(value = "saveCity")
25. public String saveCity(String cityName,String cityIntroduce){
26. City city = new City(cityName,cityIntroduce);
27. cityRepository.save(city);
28. return "success";
29. }
31. //http://localhost:8888/deleteCity?cityId=2
32. @GetMapping(value = "deleteCity")
33. public String deleteCity(int cityId){
34. cityRepository.delete(cityId);
35. return "success";
36. }
38. //http://localhost:8888/updateCity?cityId=3&cityName=沈阳&cityIntroduce=辽宁省省会
39. @GetMapping(value = "updateCity")
40. public String updateCity(int cityId,String cityName,String cityIntroduce){
41. City city = new City(cityId,cityName,cityIntroduce);
42. cityRepository.save(city);
43. return "success";
44. }
45. //http://localhost:8888/getCityById?cityId=3
46. @GetMapping(value = "getCityById")
47. public City getCityById(int cityId){
48. City city = cityRepository.findOne(cityId);
49. return city;
50. }
51. }

复制代码

然后启动项目，可以看到控制台已经创建了city表。

然后访问http://localhost:8888/druid，可以看到如下图：

输入账号密码admin，admin，如下图

然后这时我们可以访问http://localhost:8888/saveCity?cityName=北京&cityIntroduce=中国首都

然后点击导航上面的SQL监控，如下图，

从上图可以看到启动项目创建表的sql已经刚刚执行的sql。到这里整合已经完成了。