1.1 案例:数据源对象管理
在这一节中,我们将通过一个案例来学习下对于第三方 bean 该如何进行配置管理。
以后我们会用到很多第三方的 bean,本次案例将使用咱们前面提到过的数据源Druid(德鲁伊)
和C3P0
来配置学习下。
1.1.1 环境准备
学习之前,先来准备下案例环境:
-
创建一个 Maven 项目
-
pom.xml 添加依赖
<dependencies> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>5.2.10.RELEASE</version> </dependency> </dependencies>
-
resources 下添加 spring 的配置文件 applicationContext.xml
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd"> </beans>
-
编写一个运行类 App
public class App { public static void main(String[] args) { ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext.xml"); } }
1.1.2 思路分析
在上述环境下,我们来对数据源进行配置管理,先来分析下思路:
需求:使用 Spring 的 IOC 容器来管理 Druid 连接池对象
1.使用第三方的技术,需要在 pom.xml 添加依赖
2.在配置文件中将【第三方的类】制作成一个 bean,让 IOC 容器进行管理
3.数据库连接需要基础的四要素
驱动
、连接
、用户名
和密码
,【如何注入】到对应的 bean 中4.从 IOC 容器中获取对应的 bean 对象,将其打印到控制台查看结果
思考:
- 第三方的类指的是什么?
- 如何注入数据库连接四要素?
1.1.3 实现 Druid 管理
带着这两个问题,把下面的案例实现下:
步骤 1:导入druid
的依赖
pom.xml 中添加依赖
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.16</version>
</dependency>
步骤 2:配置第三方 bean
在 applicationContext.xml 配置文件中添加DruidDataSource
的配置
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd">
<!--管理DruidDataSource对象-->
<bean class="com.alibaba.druid.pool.DruidDataSource">
<property name="driverClassName" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/spring_db"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</bean>
</beans>
说明:
- driverClassName:数据库驱动
- url:数据库连接地址
- username:数据库连接用户名
- password:数据库连接密码
- 数据库连接的四要素要和自己使用的数据库信息一致。
步骤 3:从 IOC 容器中获取对应的 bean 对象
public class App {
public static void main(String[] args) {
ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext.xml");
DataSource dataSource = (DataSource) ctx.getBean("dataSource");
System.out.println(dataSource);
}
}
步骤 4:运行程序
打印如下结果: 说明第三方 bean 对象已经被 spring 的 IOC 容器进行管理
做完案例后,我们可以将刚才思考的两个问题答案说下:
-
第三方的类指的是什么?
DruidDataSource
-
如何注入数据库连接四要素?
setter注入
1.1.4 实现 C3P0 管理
完成了 DruidDataSource 的管理,接下来我们再来加深下练习,这次我们来管理C3P0
数据源,具体的实现步骤是什么呢?
需求:使用 Spring 的 IOC 容器来管理 C3P0 连接池对象
实现方案和上面基本一致,重点要关注管理的是哪个 bean 对象`?
步骤 1:导入C3P0
的依赖
pom.xml 中添加依赖
<dependency>
<groupId>c3p0</groupId>
<artifactId>c3p0</artifactId>
<version>0.9.1.2</version>
</dependency>
对于新的技术,不知道具体的坐标该如何查找?
- 直接百度搜索
- 从 mvn 的仓库
https://mvnrepository.com/
中进行搜索
步骤 2:配置第三方 bean
在 applicationContext.xml 配置文件中添加配置
<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
<property name="driverClass" value="com.mysql.jdbc.Driver"/>
<property name="jdbcUrl" value="jdbc:mysql://localhost:3306/spring_db"/>
<property name="user" value="root"/>
<property name="password" value="root"/>
<property name="maxPoolSize" value="1000"/>
</bean>
注意:
- ComboPooledDataSource 的属性是通过 setter 方式进行注入
- 想注入属性就需要在 ComboPooledDataSource 类或其上层类中有提供属性对应的 setter 方法
- C3P0 的四个属性和 Druid 的四个属性是不一样的
步骤 3:运行程序
程序会报错,错误如下
报的错为ClassNotFoundException,翻译出来是类没有发现的异常
,具体的类为com.mysql.jdbc.Driver
。错误的原因是缺少 mysql 的驱动包。
分析出错误的原因,具体的解决方案就比较简单,只需要在 pom.xml 把驱动包引入即可。
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
添加完 mysql 的驱动包以后,再次运行 App,就可以打印出结果:
注意:
- 数据连接池在配置属性的时候,除了可以注入数据库连接四要素外还可以配置很多其他的属性,具体都有哪些属性用到的时候再去查,一般配置基础的四个,其他都有自己的默认值
- Druid 和 C3P0 在没有导入 mysql 驱动包的前提下,一个没报错一个报错,说明 Druid 在初始化的时候没有去加载驱动,而 C3P0 刚好相反
- Druid 程序运行虽然没有报错,但是当调用 DruidDataSource 的 getConnection()方法获取连接的时候,也会报找不到驱动类的错误
1.2 加载 properties 文件
上节中我们已经完成两个数据源druid
和C3P0
的配置,但是其中包含了一些问题,我们来分析下:
- 这两个数据源中都使用到了一些固定的常量如数据库连接四要素,把这些值写在 Spring 的配置文件中不利于后期维护
- 需要将这些值提取到一个外部的 properties 配置文件中
- Spring 框架如何从配置文件中读取属性值来配置就是接下来要解决的问题。
问题提出来后,具体该如何实现?
1.2.1 第三方 bean 属性优化
1.2.1.1 实现思路
需求:将数据库连接四要素提取到 properties 配置文件,spring 来加载配置信息并使用这些信息来完成属性注入。
1.在 resources 下创建一个 jdbc.properties(文件的名称可以任意)
2.将数据库连接四要素配置到配置文件中
3.在 Spring 的配置文件中加载 properties 文件
4.使用加载到的值实现属性注入
其中第 3,4 步骤是需要大家重点关注,具体是如何实现。
1.2.1.2 实现步骤
步骤 1:准备 properties 配置文件
resources 下创建一个 jdbc.properties 文件,并添加对应的属性键值对
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://127.0.0.1:3306/spring_db
jdbc.username=root
jdbc.password=root
步骤 2:开启context
命名空间
在 applicationContext.xml 中开context
命名空间
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd">
</beans>
步骤 3:加载 properties 配置文件
在配置文件中使用context
命名空间下的标签来加载 properties 配置文件
<context:property-placeholder location="jdbc.properties"/>
步骤 4:完成属性注入
使用${key}
来读取 properties 配置文件中的内容并完成属性注入
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd">
<context:property-placeholder location="jdbc.properties"/>
<bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource">
<property name="driverClassName" value="${jdbc.driver}"/>
<property name="url" value="${jdbc.url}"/>
<property name="username" value="${jdbc.username}"/>
<property name="password" value="${jdbc.password}"/>
</bean>
</beans>
至此,读取外部 properties 配置文件中的内容就已经完成。
1.2.2 读取单个属性
1.2.2.1 实现思路
对于上面的案例,效果不是很明显,我们可以换个案例来演示下:
需求:从 properties 配置文件中读取 key 为 name 的值,并将其注入到 BookDao 中并在 save 方法中进行打印。
1.在项目中添加 BookDao 和 BookDaoImpl 类
2.为 BookDaoImpl 添加一个 name 属性并提供 setter 方法
3.在 jdbc.properties 中添加数据注入到 bookDao 中打印方便查询结果
4.在 applicationContext.xml 添加配置完成配置文件加载、属性注入(${key})
1.2.2.2 实现步骤
步骤 1:在项目中添对应的类
BookDao 和 BookDaoImpl 类,并在 BookDaoImpl 类中添加name
属性与 setter 方法
public interface BookDao {
public void save();
}
public class BookDaoImpl implements BookDao {
private String name;
public void setName(String name) {
this.name = name;
}
public void save() {
System.out.println("book dao save ..." + name);
}
}
步骤 2:完成配置文件的读取与注入
在 applicationContext.xml 添加配置,bean的配置管理
、读取外部properties
、依赖注入
:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd">
<context:property-placeholder location="jdbc.properties"/>
<bean id="bookDao" class="com.itheima.dao.impl.BookDaoImpl">
<property name="name" value="${jdbc.driver}"/>
</bean>
</beans>
步骤 3:运行程序
在 App 类中,从 IOC 容器中获取 bookDao 对象,调用方法,查看值是否已经被获取到并打印控制台
public class App {
public static void main(String[] args) throws Exception{
ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext.xml");
BookDao bookDao = (BookDao) ctx.getBean("bookDao");
bookDao.save();
}
}
1.2.2.3 注意事项
至此,读取 properties 配置文件中的内容就已经完成,但是在使用的时候,有些注意事项:
-
问题一:键值对的 key 为
username
引发的问题
1.在 properties 中配置键值对的时候,如果 key 设置为username
username=root666
2.在 applicationContext.xml 注入该属性
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd"> <context:property-placeholder location="jdbc.properties"/> <bean id="bookDao" class="com.itheima.dao.impl.BookDaoImpl"> <property name="name" value="${username}"/> </bean> </beans>
3.运行后,在控制台打印的却不是
root666
,而是自己电脑的用户名
4.出现问题的原因是
<context:property-placeholder/>
标签会加载系统的环境变量,而且环境变量的值会被优先加载,如何查看系统的环境变量?public static void main(String[] args) throws Exception{ Map<String, String> env = System.getenv(); System.out.println(env); }
大家可以自行运行,在打印出来的结果中会有一个 USERNAME=XXX[自己电脑的用户名称]
5.解决方案
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd"> <context:property-placeholder location="jdbc.properties" system-properties-mode="NEVER"/> </beans>
system-properties-mode:设置为 NEVER,表示不加载系统属性,就可以解决上述问题。
当然还有一个解决方案就是避免使用
username
作为属性的key
。 -
问题二:当有多个 properties 配置文件需要被加载,该如何配置?1.调整下配置文件的内容,在 resources 下添加
jdbc.properties
,jdbc2.properties
,内容如下:
jdbc.propertiesjdbc.driver=com.mysql.jdbc.Driver jdbc.url=jdbc:mysql://127.0.0.1:3306/spring_db jdbc.username=root jdbc.password=root
jdbc2.properties
username=root666
2.修改 applicationContext.xml
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd"> <!--方式一 --> <context:property-placeholder location="jdbc.properties,jdbc2.properties" system-properties-mode="NEVER"/> <!--方式二--> <context:property-placeholder location="*.properties" system-properties-mode="NEVER"/> <!--方式三 --> <context:property-placeholder location="classpath:*.properties" system-properties-mode="NEVER"/> <!--方式四--> <context:property-placeholder location="classpath*:*.properties" system-properties-mode="NEVER"/> </beans>
说明:
- 方式一:可以实现,如果配置文件多的话,每个都需要配置
- 方式二:
*.properties
代表所有以 properties 结尾的文件都会被加载,可以解决方式一的问题,但是不标准 - 方式三:标准的写法,
classpath:
代表的是从根路径下开始查找,但是只能查询当前项目的根路径 - 方式四:不仅可以加载当前项目还可以加载当前项目所依赖的所有项目的根路径下的 properties 配置文件
1.2.3 加载 properties 文件小结
** 本节主要讲解的是 properties 配置文件的加载,需要掌握的内容有:**
-
如何开启
context
命名空间
-
如何加载 properties 配置文件
<context:property-placeholder location="" system-properties-mode="NEVER"/>
-
如何在 applicationContext.xml 引入 properties 配置文件中的值
${key}