Spring IOC&DI配置管理第三方bean

r囧r小猫 2024-04-01 09:21 100阅读 0赞

现在如果有需求让我们去管理第三方jar包中的类，该如何管理?

## 1. 案例:数据源对象管理 ##

将通过一个案例来学习下对于第三方bean该如何进行配置管理。  
以后我们会用到很多第三方的bean,本次案例将使用咱们前面提到过的数据源`Druid`和`C3P0`来配置学习下。

### 1.1 环境准备 ###

先来准备下案例环境:

*  创建一个Maven项目  
    ![在这里插入图片描述][7f57fb28acb7471a86cc0aa8b3689ee0.png_pic_center]
 *  pom.xml添加依赖
    
        <dependencies>
                <dependency>
                    <groupId>org.springframework</groupId>
                    <artifactId>spring-context</artifactId>
                    <version>5.2.15.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>
 *  编写一个运行类SpringDatesource
    
        public class SpringDatesource {
              
            public static void main(String[] args) {
              
                ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
        
            }
        }

### 1.2 思路分析 ###

在上述环境下，我们来对数据源进行配置管理，先来分析下思路:

> 需求:使用Spring的IOC容器来管理Druid连接池对象
> 
> 1.使用第三方的技术，需要在pom.xml添加依赖
> 
> 2.在配置文件中将【第三方的类】制作成一个bean，让IOC容器进行管理
> 
> 3.数据库连接需要基础的四要素`驱动`、`连接`、`用户名`和`密码`，【如何注入】到对应的bean中
> 
> 4.从IOC容器中获取对应的bean对象，将其打印到控制台查看结果

**思考:**

*  第三方的类指的是什么?
 *  如何注入数据库连接四要素?

### 1.3 实现Druid管理 ###

带着这两个问题，把下面的案例实现下:

#### 步骤1:导入`druid`的依赖 ####

pom.xml中添加依赖

<dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.2.11</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">
    
        
        <bean name="dataSource" class="com.alibaba.druid.pool.DruidDataSource" >
            <property name="driverClassName" value="com.mysql.jdbc.Driver" />
            <property name="url" value="jdbc:mysql://localhost:3306/spring" />
            <property name="username" value="root" />
            <property name="password" value="123456" />
        </bean>
    </beans>

**说明:**

*  driverClassName:数据库驱动
 *  url:数据库连接地址
 *  username:数据库连接用户名
 *  password:数据库连接密码
 *  数据库连接的四要素要和自己使用的数据库信息一致。

#### 步骤3:从IOC容器中获取对应的bean对象 ####

public class SpringDatesource {
        
        public static void main(String[] args) {
        
            ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
            DataSource dataSource = (DataSource) context.getBean("dataSource");
            System.out.println(dataSource);
        }
    }

#### 步骤4:运行程序 ####

打印如下结果: 说明第三方bean对象已经被spring的IOC容器进行管理  
![在这里插入图片描述][6d16b786d4e6425cb1cfe16ed341481b.png_pic_center]  
做完案例后，我们可以将刚才思考的两个问题答案说下:

*  第三方的类指的是什么?
    
        DruidDataSource
 *  如何注入数据库连接四要素?
    
        setter注入

### 1.4 实现C3P0管理 ###

完成了DruidDataSource的管理，接下来我们再来加深下练习，这次我们来管理`C3P0`数据源，具体的实现步骤是什么呢?

> 需求:使用Spring的IOC容器来管理C3P0连接池对象
> 
> 实现方案和上面基本一致，重点要关注管理的是哪个bean对象\`?

#### 步骤1:导入`C3P0`的依赖 ####

pom.xml中添加依赖

<dependency>
                <groupId>com.mchange</groupId>
                <artifactId>c3p0</artifactId>
                <version>0.9.5.4</version>
            </dependency>

**对于新的技术，不知道具体的坐标该如何查找?**

*  直接百度搜索
 *  从mvn的仓库`https://mvnrepository.com/`中进行搜索  
    ![在这里插入图片描述][15faafef70214bf595e65b7aa89f46a2.png_pic_center]

#### 步骤2:配置第三方bean ####

在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">
    
        
        <bean name="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource" >
            <property name="driverClass" value="com.mysql.jdbc.Driver" />
            <property name="jdbcUrl" value="jdbc:mysql://localhost:3306/spring" />
            <property name="user" value="root" />
            <property name="password" value="123456" />
            <property name="maxPoolSize" value="1000"/>
        </bean>
    </beans>

**注意:**

*  ComboPooledDataSource的属性是通过setter方式进行注入
 *  想注入属性就需要在ComboPooledDataSource类或其上层类中有提供属性对应的setter方法
 *  C3P0的四个属性和Druid的四个属性是不一样的

#### 步骤3:运行程序 ####

![在这里插入图片描述][76ec3db2ce0a47bd92e4d54892c0fa19.png_pic_center]  
**注意：**

*  数据连接池在配置属性的时候，除了可以注入数据库连接四要素外还可以配置很多其他的属性，具体都有哪些属性用到的时候再去查，一般配置基础的四个，其他都有自己的默认值
 *  Druid和C3P0在没有导入mysql驱动包的前提下，一个没报错一个报错，说明Druid在初始化的时候没有去加载驱动，而C3P0刚好相反
 *  Druid程序运行虽然没有报错，但是当调用DruidDataSource的getConnection()方法获取连接的时候，也会报找不到驱动类的错误

## 2. 加载properties文件 ##

已经完成两个数据源`druid`和`C3P0`的配置，但是其中包含了一些问题，我们来分析下:

*  这两个数据源中都使用到了一些固定的常量如数据库连接四要素，把这些值写在Spring的配置文件中不利于后期维护
 *  需要将这些值提取到一个外部的properties配置文件中
 *  Spring框架如何从配置文件中读取属性值来配置就是接下来要解决的问题。

问题提出来后，具体该如何实现?

### 2.1 第三方bean属性优化 ###

#### 2.1.1 实现思路 ####

> 需求:将数据库连接四要素提取到properties配置文件，spring来加载配置信息并使用这些信息来完成属性注入。
> 
> 1.在resources下创建一个jdbc.properties(文件的名称可以任意)
> 
> 2.将数据库连接四要素配置到配置文件中
> 
> 3.在Spring的配置文件中加载properties文件
> 
> 4.使用加载到的值实现属性注入
> 
> 其中第3，4步骤是需要大家重点关注，具体是如何实现。

#### 2.1.2 实现步骤 ####

##### 步骤1:准备properties配置文件 #####

resources下创建一个jdbc.properties文件,并添加对应的属性键值对

jdbc.driver=com.mysql.jdbc.Driver
    jdbc.url=jdbc:mysql://127.0.0.1:3306/spring
    jdbc.username=root
    jdbc.password=123456

![在这里插入图片描述][f3c30a523d354641a77cac4cbdbe470f.png_pic_center]

##### 步骤2:开启`context`命名空间 #####

在applicationContext.xml中开`context`命名空间

##### 步骤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 https://www.springframework.org/schema/context/spring-context.xsd">
    
        <context:property-placeholder location="jdbc.properties"/>
        
        <bean name="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource" >
            <property name="driverClass" value="${jdbc.driver}" />
            <property name="jdbcUrl" value="${jdbc.url}" />
            <property name="user" value="${jdbc.username}" />
            <property name="password" value="${jdbc.password}" />
            <property name="maxPoolSize" value="1000"/>
        </bean>
    
    </beans>

至此，读取外部properties配置文件中的内容就已经完成。

### 2.2 读取单个属性 ###

#### 2.2.1 实现思路 ####

对于上面的案例，效果不是很明显，我们可以换个案例来演示下:  
UserDao和UserDaoImpl类，并在UserDaoImpl类中添加`name`属性与setter方法

public interface UserDao {
        
        public void select();
    }
    public class UserDaoImpl implements UserDao {
        
    
        private String userName;
    
        public void setUserName(String userName) {
        
            this.userName = userName;
        }
    
        public void select() {
        
            System.out.println("UserDao select , running ,,,,,,");
            System.out.println("userName : " + userName);
        }
    }

##### 步骤2:完成配置文件的读取与注入 #####

在applicationContext.xml添加配置，`bean的配置管理`、`读取外部properties`、`依赖注入`:

##### 步骤3:运行程序 #####

在App类中，从IOC容器中获取userDao对象，调用方法，查看值是否已经被获取到并打印控制台

public class SpringDatesource {
        
        public static void main(String[] args) {
        
            ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
    //        DataSource dataSource = (DataSource) context.getBean("dataSource");
    //        System.out.println(dataSource);
            UserDao userDao = (UserDao) context.getBean("userDao");
            userDao.select();
        }
    }

![在这里插入图片描述][7d5f5a9d83bc4ea8b533c52faedfc966.png_pic_center]

#### 2.2.3 注意事项 ####

至此，读取properties配置文件中的内容就已经完成，但是在使用的时候，有些注意事项:

*  问题一:键值对的key为`username`引发的问题  
    1.在properties中配置键值对的时候，如果key设置为`username`
    
        username=root2022
    
    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 https://www.springframework.org/schema/context/spring-context.xsd">
        
            <context:property-placeholder location="jdbc.properties"/>
            
            <bean name="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource" >
                <property name="driverClass" value="${jdbc.driver}" />
                <property name="jdbcUrl" value="${jdbc.url}" />
                <property name="user" value="${jdbc.username}" />
                <property name="password" value="${jdbc.password}" />
                <property name="maxPoolSize" value="1000"/>
            </bean>
        
            <bean id="userDao" class="com.dcxuexi.dao.impl.UserDaoImpl" >
                <property name="userName" value="${username}" />
            </bean>
        
        </beans>
    
    3.运行后，在控制台打印的却不是`root2022`，而是自己电脑的用户名  
    ![在这里插入图片描述][e0d08a351c3345679b3468b60b7adf41.png_pic_center]  
    4.出现问题的原因是`<context:property-placeholder/>`标签会加载系统的环境变量，而且环境变量的值会被优先加载，如何查看系统的环境变量?
    
        public static void main(String[] args) throws Exception{
              
            Map<String, String> env = System.getenv();
            System.out.println(env);
        }

![在这里插入图片描述][58dfdf3930f74763b9e0489c761f697a.png_pic_center]  
大家可以自行运行，在打印出来的结果中会有一个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 https://www.springframework.org/schema/context/spring-context.xsd">
    
        <context:property-placeholder location="jdbc.properties" system-properties-mode="NEVER"/>
        
        <bean name="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource" >
            <property name="driverClass" value="${jdbc.driver}" />
            <property name="jdbcUrl" value="${jdbc.url}" />
            <property name="user" value="${jdbc.username}" />
            <property name="password" value="${jdbc.password}" />
            <property name="maxPoolSize" value="1000"/>
        </bean>
    
        <bean id="userDao" class="com.dcxuexi.dao.impl.UserDaoImpl" >
            <property name="userName" value="${username}" />
        </bean>
    
    </beans>

system-properties-mode:设置为NEVER,表示不加载系统属性，就可以解决上述问题。  
当然还有一个解决方案就是避免使用`username`作为属性的`key`。  
![在这里插入图片描述][c0bbe7ba564842d1bd9b4ad41a5a81e0.png_pic_center]

*  问题二:当有多个properties配置文件需要被加载，该如何配置?  
    1.调整下配置文件的内容，在resources下添加`jdbc.properties`,`common.properties`,内容如下:  
    jdbc.properties
    
        jdbc.driver=com.mysql.jdbc.Driver
        jdbc.url=jdbc:mysql://127.0.0.1:3306/spring
        jdbc.username=root
        jdbc.password=123456
    
    common.properties
    
        userName=xiaochuang
        userAge=2
    
    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 https://www.springframework.org/schema/context/spring-context.xsd">
        
            
            <context:property-placeholder location="jdbc.properties,common.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"/>
        
        
            
            <bean name="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource" >
                <property name="driverClass" value="${jdbc.driver}" />
                <property name="jdbcUrl" value="${jdbc.url}" />
                <property name="user" value="${jdbc.username}" />
                <property name="password" value="${jdbc.password}" />
                <property name="maxPoolSize" value="1000"/>
            </bean>
        
            <bean id="userDao" class="com.dcxuexi.dao.impl.UserDaoImpl" >
                <property name="userName" value="${userName}" />
            </bean>
        
        </beans>
    
    **说明:**
    
     *  方式一:可以实现，如果配置文件多的话，每个都需要配置
     *  方式二:`*.properties`代表所有以properties结尾的文件都会被加载，可以解决方式一的问题，但是不标准
     *  方式三:标准的写法，`classpath:`代表的是从根路径下开始查找，但是只能查询当前项目的根路径
     *  方式四:不仅可以加载当前项目还可以加载当前项目所依赖的所有项目的根路径下的properties配置文件

### 2.3 加载properties文件小结 ###

*  如何开启`context`命名空间  
    ![在这里插入图片描述][bc2be2fb15604a20994a0a8411ea35b7.png_pic_center]
 *  如何加载properties配置文件
    
        <context:property-placeholder location="" system-properties-mode="NEVER"/>
 *  如何在applicationContext.xml引入properties配置文件中的值
    
        ${key}

## 项目代码 ##

*  [gitee 项目代码下载][gitee]
 *  [github 项目代码下载][github]

[7f57fb28acb7471a86cc0aa8b3689ee0.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/237e99a6e8bd4ef3befba1d32a90d443.png
[6d16b786d4e6425cb1cfe16ed341481b.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/9e97f1b524914fd0b84ae021a00a54cc.png
[15faafef70214bf595e65b7aa89f46a2.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/fdc6766fca8f46db83543d1d79dc24d2.png
[76ec3db2ce0a47bd92e4d54892c0fa19.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/7c02ab44bd634e49881d4bc1158f5166.png
[f3c30a523d354641a77cac4cbdbe470f.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/d6fd61486abe47b3ac394de2ac95270a.png
[7d5f5a9d83bc4ea8b533c52faedfc966.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/4d142ded396144099a21f7985a4c5316.png
[e0d08a351c3345679b3468b60b7adf41.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/da97232c27044db08e6b76cca65ab283.png
[58dfdf3930f74763b9e0489c761f697a.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/4f24c0ab766e4cca96e0622dbc354c12.png
[c0bbe7ba564842d1bd9b4ad41a5a81e0.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/b81265626bdd41d284d73fac1ca1cc44.png
[bc2be2fb15604a20994a0a8411ea35b7.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/e73db4d711fb4a2a84941ac7a01983aa.png
[gitee]: https://gitee.com/DchuangDB/sping-projeck
[github]: https://github.com/dcbut/spring