整合JDBC与数据源自动配置原理

ゝ一纸荒年。 2023-07-14 15:57 40阅读 0赞

##### （一）整合连接 #####

SpringBoot依赖启动选择：  
1：web-SpringWeb  
2：SQL： JDBC、MySQL

参考依赖

<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.yml配置文件设置

spring:
      datasource:
        username: root
        password: admin
        url: jdbc:mysql://127.0.0.1:3306/test
        driver‐class‐name: com.mysql.jdbc.Driver

测试连接

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class SpringbootJdbcApplicationTests { 
    
        //注入数据源
        @Autowired
        DataSource  dataSource;
    
    
        @Test
        public void contextLoads() throws SQLException { 
            System.out.println("------JDBC测试-------");
            System.out.println(dataSource.getConnection());
    
        }
    
    }

##### （二）自动配置原理 #####

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class SpringbootJdbcApplicationTests { 
        @Autowired
        DataSource dataSource;
        @Test
        public void contextLoads() throws SQLException { 
            System.out.println("------JDBC测试-------");
            System.out.println("数据源类型：" + dataSource.getClass());
            System.out.println("数据源连接：" + dataSource.getConnection());
     }}

继续上面的测试，本次将打印出数据源的类型，打印结果如下：

数据源类型：class org.apache.tomcat.jdbc.pool.DataSource

字面意思判断，这个是tomcat关联的数据源，那么这个具体如何配置启动的呢，根据SpringBoot自动配置原理，它的所有的自动配置都在org.springframework.boot.autoconfigure这个包下，因此我们如果想要了解更多去查找对应的自动配置即可，比如本次的jdbc

通过查找发现DataSourceConfiguration类中存在相应的数据源配置，通过观察源码可以发现其中包含了Tomcat数据源、Hikari数据源、DBCP数据源、dbcp2数据源、自定义数据源.

它们会根据提供的依赖来判断并返回Bean，由于我们并没有提供相关的依赖，但是SpringBoot默认是选择tomcat容器相关组件的，因此在首次测试的DataSource的时候打印出的类型是tomcat数据源,所以如果想要切换需要添加相关的依赖

该类代码的最后部分如下，描述的是创建自定义的数据源，它会根据提供的配置文件属性建造一个自定义的数据源. 使用DataSourceBuilder创建数据源，利用反射创建响应type的数据源，并且绑定相关属性。 比如c3p0数据源.

/** * Generic DataSource configuration. 表示的是根据配置自定义数据源 */
    	@ConditionalOnMissingBean(DataSource.class)
    	@ConditionalOnProperty(name = "spring.datasource.type")
    	static class Generic { 
    @Bean
    		public DataSource dataSource(DataSourceProperties properties) { 
    			return properties.initializeDataSourceBuilder().build();
    		}
    
    	}

public DataSourceBuilder initializeDataSourceBuilder() { 
    		return DataSourceBuilder.create(getClassLoader()).type(getType())
    				.driverClassName(determineDriverClassName()).url(determineUrl())
    				.username(determineUsername()).password(determinePassword());
    	}

##### （三）配置中数据源参考配置 #####

@ConfigurationProperties(prefix = "spring.datasource")
    public class DataSourceProperties
    		implements BeanClassLoaderAware, EnvironmentAware, InitializingBean {   ... }

配置文件中数据源的配置参考该类的成员属性，前缀spring.datasource  
其他配置详见该类属性字段

##### （四）自动配置脚本 #####

在SpringBoot的架构中，DataSourceInitializer类可以实现自动执行脚本的功能。通过自定义DataSourceInitializer Bean就可以实现按照业务要求执行特定的脚本。

备注：自动配置脚本的前提是已经配置好了数据源，具体原因参考DataSourceInitializer方法中判断

DML(Data Manipulation Language)数据操纵语言：

适用范围：对数据库中的数据进行一些简单操作，如insert,delete,update,select等.

DDL(Data Definition Language)数据定义语言：  
适用范围：对数据库中的某些对象(例如，database,table)进行管理，如Create,Alter和Drop.

###### 使用方式一 ######

通过观察DataSourceInitializer类得出结论，该类作为一个监听器，当Servlet启动时触发事件，如果classpath路径下有如下俩个SQL文件，那么就事件就会去执行对应的脚本

schema.sql，schema‐all.sql；

###### 使用方式二 ######

除了限制上述俩个SQL文件名的方式外，还可以通过配置文件来执行其他名称的SQL脚本  
规则参考：schema‐*.sql、data‐*.sql .源码参考如下

private void runDataScripts() { 
    		List<Resource> scripts = getScripts("spring.datasource.data",
    				this.properties.getData(), "data");
    		String username = this.properties.getDataUsername();
    		String password = this.properties.getDataPassword();
    		runScripts(scripts, username, password);
    	}
    
    	private List<Resource> getScripts(String propertyName, List<String> resources,
    			String fallback) { 
    		if (resources != null) { 
    			return getResources(propertyName, resources, true);
    		}
    		String platform = this.properties.getPlatform();
    		List<String> fallbackResources = new ArrayList<String>();
    		fallbackResources.add("classpath*:" + fallback + "-" + platform + ".sql");
    		fallbackResources.add("classpath*:" + fallback + ".sql");
    		return getResources(propertyName, fallbackResources, false);
    	}

通过观察可以发现其中data‐*.sql针对的是DML操作，schema‐*.sql针对的是DDL操作，代码中的platform ,data变量是来自于DataSourceProperties成员属性，我们知道该类是管理配置文件，因此我们可以通过配置文件来完成修改，但是需要以这样的格式命名schema‐*.sql、data‐*.sql

spring:
      datasource:
        username: root
        password: admin
        url: jdbc:mysql://127.0.0.1:3306/test
        driver‐class‐name: com.mysql.jdbc.Driver
        platform: user

上述设置就能够在启动时识别资源路径下的 schema-user.sql文件

###### 使用方式三 ######

通过属性文件设置schema和data并且指定对应的路径地址，可以含有多个执行语句

spring:
      datasource:
        username: root
        password: admin
        url: jdbc:mysql://127.0.0.1:3306/test
        driver‐class‐name: com.mysql.jdbc.Driver
        schema:
          - classpath:user1.sql
          - classpath:user2.sql
    data: classpath:mysql.sql

注意：  
1：classpath:user1.sql是一个整体字符串，不是属性键值，没有空格，否则报错  
2：对于自动加载SQL文件，必须有schema文件，才能执行data文件，参考代码如下，所以，如果没有对应的DDL语句，可以设置一个空的schema文件也可以，但是不能没有schema而只存在data文件

if (!this.initialized) { 
    	runDataScripts();
    	this.initialized = true;
    }

###### （五）JdbcTemplate自动配置原理和使用 ######

JdbcTemplate是默认提供给开发人员使用的数据操作类，其中该类SpringBoot已经完成自动配置，加载到单例池容器中.  
自动配置原理类：  
org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration

@Configuration
    @ConditionalOnClass({  DataSource.class, JdbcTemplate.class })
    @ConditionalOnSingleCandidate(DataSource.class)
    @AutoConfigureAfter(DataSourceAutoConfiguration.class)
    public class JdbcTemplateAutoConfiguration { 
    
    	private final DataSource dataSource;
    
    	public JdbcTemplateAutoConfiguration(DataSource dataSource) { 
    		this.dataSource = dataSource;
    	}
    
    	@Bean
    	@Primary
    	@ConditionalOnMissingBean(JdbcOperations.class)
    	public JdbcTemplate jdbcTemplate() { 
    		return new JdbcTemplate(this.dataSource);
    	}
    
    	@Bean
    	@Primary
    	@ConditionalOnMissingBean(NamedParameterJdbcOperations.class)
    	public NamedParameterJdbcTemplate namedParameterJdbcTemplate() { 
    		return new NamedParameterJdbcTemplate(this.dataSource);
    	}
    
    }

代码中jdbcTemplate方法头部注入了@Bean注解，该方法已经完成了数据源的配置和封装操作，并且在项目启动的时候已完成Bean加载，说明我们是可以直接在项目中使用这个类对象的，下面给出简单的测试实例

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class SpringbootJdbcApplicationTests { 
     @Autowired
        JdbcTemplate jdbcTemplate;
       @Test
        public void testJdbcTemplate() throws SQLException { 
            System.out.println("------JdbcTemplate-------");
            System.out.println("查询");
            List<Map<String, Object>> list = jdbcTemplate.queryForList("select * from `type`");
            Map<String, Object> object = list.get(0);
            System.out.println(object);
        }
    }

![在这里插入图片描述][20200314223452181.png]

[20200314223452181.png]: /images/20230529/c268f2dd1a8849b38d34cc903a88383a.png