Spring Framework 为 SQL 数据库提供了广泛的支持。从直接使用 JdbcTemplate 进行 JDBC 访问到完全的对象关系映射(object relational mapping)技术,比如 Hibernate、Mybatis。Spring Data 提供了更多级别的功能,直接从接口创建的 Repository 实现,并使用了约定从方法名生成查询。
导入相关依赖:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jdbc</artifactId> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <scope>runtime</scope> </dependency>application.yaml
spring: datasource: username: root password: 123456 driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://localhost:3306/demo?serverTimezone=UTC编写单元测试,是否能做正常建立连接
@SpringBootTest class SpringbootDataApplicationTests { @Autowired DataSource dataSource; @Test void contextLoads() throws SQLException { //输出结果:class com.zaxxer.hikari.HikariDataSource,即SpringBoot默认的配置的数据源是HikariDataSource System.out.println(dataSource.getClass()); Connection connection = dataSource.getConnection(); //输出结果:HikariProxyConnection@157783888 wrapping com.mysql.cj.jdbc.ConnectionImpl@9b9a327,能够获取连接 System.out.println(connection); connection.close(); } }默认的数据源是HikariDataSource,数据库连接池就是HikariDataSource。那么我们能否修改成alibaba的Druid呢?当然可以,只需两步:
添加Pom依赖修改指定type类型为Druidc3p0等同理
可以发现,我们很简单的就与数据库取得了连接,能够进行数据库数据交互。
1、有了数据源(com.zaxxer.hikari.HikariDataSource),然后可以拿到数据库连接(java.sql.Connection),有了连接,就可以使用连接和原生的 JDBC 语句来操作数据库
2、即使不使用第三方第数据库操作框架,如 MyBatis等,Spring 本身也对原生的JDBC 做了轻量级的封装,即 org.springframework.jdbc.core.JdbcTemplate
3、数据库操作的所有 CRUD 方法都在 JdbcTemplate 中。
4、Spring Boot 不仅提供了默认的数据源,同时默认已经配置好了 JdbcTemplate 放在了容器中,程序员只需自己注入即可使用
5、JdbcTemplate 的自动配置原理是依赖 org.springframework.boot.autoconfigure.jdbc 包下的 org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration 类
JDBCController.java
@RestController public class JDBCController { @Autowired JdbcTemplate jdbcTemplate; @GetMapping("/emplist") public List<Map<String,Object>> empList(){ String sql = "select * from emp"; List<Map<String, Object>> maps = jdbcTemplate.queryForList(sql); return maps; } @GetMapping("/addEmp") public String addUser(){ String sql = "insert into emp(empno,ename) values(1111,'zhangsan')"; jdbcTemplate.update(sql); return "success"; } @GetMapping("/updateEmp/{id}") public String updateEmp(@PathVariable("id") Integer id){ String sql = "update emp set ename=? where empno = "+id; String name = "list"; jdbcTemplate.update(sql,name); return "update success"; } @GetMapping("/deleteEmp/{id}") public String deleteEmp(@PathVariable("id")Integer id){ String sql = "delete from emp where empno = "+id; jdbcTemplate.update(sql); return "delete success"; } }注意:我们一般也不会使用JdbcTemplate,大多数情况下都是集成第三方框架,如MyBatis、Hibernate
默认的数据源是HikariDataSource,是日本提供的功能。如果我们想要使用Alibaba提供的DruidDataSource,应该如何配置呢?
在最后一行通过type指定使用DruidDataSource数据源即可。
使用同样的单元测试,能够发现打印的结果是:
class com.alibaba.druid.pool.DruidDataSource即数据源切换成了DruidDataSource
Druid是数据库连接池,可以添加很多Druid的独有配置。
一般情况下初学者是用不到配置这么多参数的,但是我们要知道DruidDataSource是能够灵活配置很多参数的。
spring: datasource: username: root password: 123456 url: jdbc:mysql://192.168.85.111:3306/demo?serverTimezone=UTC&useUnicode=true@characterEncoding=utf-8 driver-class-name: com.mysql.jdbc.Driver type: com.alibaba.druid.pool.DruidDataSource #Spring Boot 默认是不注入这些属性值的,需要自己绑定 #druid 数据源专有配置 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 #配置监控统计拦截的filters,stat:监控统计、log4j:日志记录、wall:防御sql注入 #如果允许时报错 java.lang.ClassNotFoundException: org.apache.log4j.Priority #则导入 log4j 依赖即可,Maven 地址: https://mvnrepository.com/artifact/log4j/log4j filters: stat,wall,log4j maxPoolPreparedStatementPerConnectionSize: 20 useGlobalDataSourceStat: true connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500但是配置完成之后,上面配置的参数并不是能够直接生效的,还需要自定义自己的数据源配置类,绑定参数:
DruidConfig.java
@Configuration public class DruidConfig { //使用prefix = "spring.datasource",才能够读取yaml文件中详细配置的参数 @ConfigurationProperties(prefix = "spring.datasource") @Bean public DataSource druidDataSource(){ return new DruidDataSource(); } }进行测试:
@SpringBootTest class DataApplicationTests { @Autowired DataSource dataSource; @Test void contextLoads() throws SQLException { System.out.println(dataSource.getClass()); Connection connection = dataSource.getConnection(); System.out.println(connection); DruidDataSource druidDataSource = (DruidDataSource)dataSource; //输出能够对应我们对Druid进行的配置 System.out.println(druidDataSource.getMaxActive());//输出:8,最大值是8 System.out.println(druidDataSource.getInitialSize());//输出:5,初始化值是5 connection.close(); } }Druid是为监控而生的,Druid数据源还具有监控的功能,并提供了一个web界面方便用户进行查看。是Alibaba提供的,直接拿来用即可。
1、加入log4j的日志依赖
要想进行监控日志的查看,需要添加log4j的依赖。
<!-- https://mvnrepository.com/artifact/log4j/log4j --> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency>2、向DruidConfig中添加代码,配置druid监控管理台的servlet
Druid官网提供的监控管理台Servlet模板:
@Configuration public class DruidConfig { @ConfigurationProperties(prefix = "spring.datasource") @Bean public DataSource druidDataSource(){ return new DruidDataSource(); } @Bean public ServletRegistrationBean druidServletRegistrationBean(){ ServletRegistrationBean<Servlet> servletRegistrationBean = new ServletRegistrationBean<>(new StatViewServlet(),"/druid/*"); Map<String,String> initParams = new HashMap<>(); initParams.put("loginUsername","admin"); initParams.put("loginPassword","123456"); //后台允许谁可以访问 //initParams.put("allow", "localhost"):表示只有本机可以访问 //initParams.put("allow", ""):为空或者为null时,表示允许所有访问 initParams.put("allow",""); //deny:Druid 后台拒绝谁访问 //initParams.put("msb", "192.168.1.20");表示禁止此ip访问 servletRegistrationBean.setInitParameters(initParams); return servletRegistrationBean; } //配置 Druid 监控 之 web 监控的 filter //WebStatFilter:用于配置Web和Druid数据源之间的管理关联监控统计 @Bean public FilterRegistrationBean webStatFilter() { FilterRegistrationBean bean = new FilterRegistrationBean(); bean.setFilter(new WebStatFilter()); //exclusions:设置哪些请求进行过滤排除掉,从而不进行统计 Map<String, String> initParams = new HashMap<>(); initParams.put("exclusions", "*.js,*.css,/druid/*"); bean.setInitParameters(initParams); //"/*" 表示过滤所有请求 bean.setUrlPatterns(Arrays.asList("/*")); return bean; } }3、启动项目,测试监控功能
登录页面 Druid提供的监控功能
我们开发过程中使用的数据库可能不止一个,如果不同的功能需要连接不同的数据库,那么就要在不同的数据库之间切换,我们需要配置多数据源并能够动态切换。
DataSource是和线程绑定的,动态数据源的配置主要是通过继承AbstractRoutingDataSource类实现的,实现在AbstractRoutingDataSource类中的 protected Object determineCurrentLookupKey()方法来获取数据源,所以我们需要先创建一个多线程线程数据隔离的类来存放DataSource,然后在determineCurrentLookupKey()方法中通过这个类获取当前线程的DataSource,在AbstractRoutingDataSource类中,DataSource是通过Key-value的方式保存的,我们可以通过ThreadLocal来保存Key,从而实现数据源的动态切换。
在配置文件中配置多个数据源
spring: datasource: local: username: root password: 123456 driver-class-name: com.mysql.jdbc.Driver jdbc-url: jdbc:mysql://localhost:3306/demo?serverTimezone=UTC remote: username: root password: 123456 driver-class-name: com.mysql.jdbc.Driver jdbc-url: jdbc:mysql://192.168.85.111:3306/demo?serverTimezone=UTC上面的配置文件中配置了两个数据源:
local:Windows下本地的Mysql数据库remote:Linux虚拟机中node01节点的Mysql数据库创建一个数据源切换处理类,有对数据源变量的获取、设置和情况的方法,其中threadlocal用于保存某个线程共享变量。
public class DynamicDataSourceContextHolder { /** * 使用ThreadLocal维护变量,ThreadLocal为每个使用该变量的线程提供独立的变量副本, * 所以每一个线程都可以独立地改变自己的副本,而不会影响其它线程所对应的副本。 */ private static final ThreadLocal<String> CONTEXT_HOLDER = new ThreadLocal<>(); /** * 设置数据源变量 * @param dataSourceType */ public static void setDataSourceType(String dataSourceType){ System.out.printf("切换到{%s}数据源", dataSourceType); CONTEXT_HOLDER.set(dataSourceType); } /** * 获取数据源变量 * @return */ public static String getDataSourceType(){ return CONTEXT_HOLDER.get(); } /** * 清空数据源变量 */ public static void clearDataSourceType(){ CONTEXT_HOLDER.remove(); } }动态切换数据源主要依靠AbstractRoutingDataSource。创建一个AbstractRoutingDataSource的子类,重写determineCurrentLookupKey方法,用于决定使用哪一个数据源。这里主要用到AbstractRoutingDataSource的两个属性defaultTargetDataSource和targetDataSources。defaultTargetDataSource默认目标数据源,targetDataSources(map类型)存放用来切换的数据源。
import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource; import javax.sql.DataSource; import java.util.Map; public class DynamicDataSource extends AbstractRoutingDataSource { public DynamicDataSource(DataSource defaultTargetDataSource, Map<Object, Object> targetDataSources) { super.setDefaultTargetDataSource(defaultTargetDataSource); super.setTargetDataSources(targetDataSources); // afterPropertiesSet()方法调用时用来将targetDataSources的属性写入resolvedDataSources中的 super.afterPropertiesSet(); } /** * 根据Key获取数据源的信息 * * @return */ @Override protected Object determineCurrentLookupKey() { return DynamicDataSourceContextHolder.getDataSourceType(); } }设置拦截数据源的注解,可以设置在具体的类上,或者在具体的方法上。
import java.lang.annotation.*; @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface DataSource { /** * 切换数据源名称 */ //默认是REMOTE DataSourceType value() default DataSourceType.REMOTE; }通过拦截上面的注解,在其执行之前处理设置当前执行SQL的数据源的信息,CONTEXT_HOLDER.set(dataSourceType)这里的数据源信息从我们设置的注解上面获取信息,如果没有设置就是用默认的数据源的信息。
import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.Around; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Pointcut; import org.aspectj.lang.reflect.MethodSignature; import org.springframework.core.annotation.Order; import org.springframework.stereotype.Component; import java.lang.reflect.Method; @Aspect @Order(1) @Component public class DataSourceAspect { @Pointcut("@annotation(com.mashibing.mult.DataSource)") public void dsPointCut() { } @Around("dsPointCut()") public Object around(ProceedingJoinPoint point) throws Throwable { MethodSignature signature = (MethodSignature) point.getSignature(); Method method = signature.getMethod(); DataSource dataSource = method.getAnnotation(DataSource.class); if (dataSource != null) { DynamicDataSourceContextHolder.setDataSourceType(dataSource.value().name()); } try { return point.proceed(); } finally { // 销毁数据源 在执行方法之后 DynamicDataSourceContextHolder.clearDataSourceType(); } } }通过注解让不同的映射请求使用不同的数据源。
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.jdbc.core.JdbcTemplate; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; import java.util.List; import java.util.Map; @RestController public class EmpController { @Autowired JdbcTemplate jdbcTemplate; @GetMapping("/local") @DataSource(value = DataSourceType.LOCAL) public List<Map<String, Object>> local(){ List<Map<String, Object>> maps = jdbcTemplate.queryForList("select * from emp"); return maps; } @GetMapping("/remote") @DataSource(value = DataSourceType.REMOTE) public List<Map<String, Object>> remote(){ List<Map<String, Object>> maps = jdbcTemplate.queryForList("select * from emp"); return maps; } }到此为止我们就可以让不同的增删改查操作,或者不同的功能模块使用不同的数据源。
在以上的学习中我们我们学习了如下内容:
使用默认HikariDataSource数据源与数据库进行连接,并使用内嵌的JdbcTemplate完成简单的增删改查,与数据库完成交互不使用默认HikariDataSource数据源,自己定义配置数据源DruidDataSource(C3P0同理),并了解了DruidDataSource中配置参数的细节,以及使用DruidDataSource提供的监控功能掌握如何配置多个数据源,并能够根据不同的功能需求,动态的切换数据源