Example code for SpringBoot to integrate Alibaba Druid monitoring

Druid is Alibaba's open source database connection pool, which provides excellent monitoring functions for database operations. This article will explain how the springboot project integrates Druid.

This article is developed under a jpa-based project. First, add druid dependencies to the pom file. The pom file is as follows:

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>

copy code

The first half of application.properties and the integration of jpa have not changed at all. Some druid configurations are added below. If you don't understand the druid configuration, you can check it online. (I think this article is well written, Portal)

2. #The port number
3. server.port=8888
5. ##validate When loading hibernate, verify the database table structure created
6. ##create Every time hibernate is loaded, the database table structure is recreated, which is the reason for the loss of database table data.
7. ##create-drop is created when hibernate is loaded, and the exit is to delete the table structure
8. ##update Load hibernate to automatically update the database structure
9. ##validate Validate the structure of the table at startup, the table will not be created
10. ##none do nothing at startup
11. spring.jpa.hibernate.ddl-auto=create
13. ##Console print sql
14. spring.jpa.show-sql=true
16. ##Database configuration
17. ##Database address
18. spring.datasource.url=jdbc:mysql://localhost:3306/test?characterEncoding=utf8&useSSL=false
19. ##database username
20. spring.datasource.username=root
21. ##Database password
22. spring.datasource.password=root
23. ##Database driver
24. spring.datasource.driver-class-name=com.mysql.jdbc.Driver
25. Jiangsu Surrogacy
26. Jiangsu Surrogacy Company
27. #here is different
28. #If you use druid, you need to configure one more property spring.datasource.type
29. spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
32. # Configuration information of the connection pool
33. # Initialize size, min, max
34. spring.datasource.initialSize=5
35. spring.datasource.minIdle=5
36. spring.datasource.maxActive=20
37. # Configure the time to wait for a timeout to get a connection
38. spring.datasource.maxWait=60000
39. # Configure how long the interval is to perform detection and detect idle connections that need to be closed, in milliseconds
40. spring.datasource.timeBetweenEvictionRunsMillis = 60000
41. # Configure the minimum lifetime of a connection in the pool, in milliseconds
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. # Open PSCache and specify the size of PSCache on each connection
48. spring.datasource.poolPreparedStatements=true
49. spring.datasource.maxPoolPreparedStatementPerConnectionSize=20
50. # Configure the filters for monitoring statistics interception. After removing, the monitoring interface sql cannot be counted. 'wall' is used for firewalls
51. spring.datasource.filters=stat,wall,log4j
52. # Turn on the mergeSql function through the connectProperties property; slow SQL records

copy code

Then add DruidConfig to the project, briefly explain, this configuration file is mainly to load the configuration of application.properties, the code is as follows:

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 //Primary data source
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. }

copy code

Then create DruidFilter, the code is as follows:

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. }

copy code

Create a new DruidServlet and add the annotation @WebServlet to the class, which configures the account password for logging in to the Druid monitoring page, the configuration such as the whitelist and blacklist, and the code is as follows:

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 whitelist (no configuration or empty, all access is allowed)
17. @WebInitParam(name="deny",value=""),// IP blacklist (deny takes precedence over allow)
18. @WebInitParam(name="loginUsername",value="admin"),// Login user name of druid management page
19. @WebInitParam(name="loginPassword",value="admin")// Login druid management page password
20. })
21. public class DruidServlet extends StatViewServlet {
23. }

copy code

Then add the annotation @ServletComponentScan to the startup class to scan the project to the servlet. The code is as follows:

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. // The startup class must be annotated with @ServletComponentScan, otherwise the servlet cannot be scanned
8. @ServletComponentScan
9. public class SpringbootDruidApplication {
10. public static void main(String[] args) {
11. SpringApplication.run(SpringbootDruidApplication.class, args);
12. }
13. }

copy code

The rest is the same entity (entity class), repository (data operation layer), controller (controller used for testing) as the integrated jpa, and the code is displayed directly.

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. }

copy code

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. }

copy code

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=Beijing&cityIntroduce=China Capital
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=Shenyang&cityIntroduce=Capital of Liaoning Province
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. }

copy code

Then start the project, you can see that the console has created the city table.

Then visit http://localhost:8888/druid, you can see the following picture:

Enter the account password admin, admin, as shown below

Then we can visit http://localhost:8888/saveCity?cityName=Beijing&cityIntroduce=China Capital

Then click on the SQL monitoring above the navigation, as shown below,

From the above figure, you can see that the sql that started the project to create the table has just executed the sql. The integration has been completed here.