Spring Boot 2从入门到入坟 | 底层注解篇：使用@ImportResource注解导入Spring配置文件

缺乏、安全感 2023-01-17 09:24 65阅读 0赞

在这篇文章中，我们再来看一个Spring Boot的底层注解，即@ImportResource。

# @ImportResource注解概述 #

@ImportResource，翻译过来就是导入资源的意思。

# @ImportResource注解的使用场景 #

该注解的使用场景是什么呢？我们不妨来看一下。我们以前一般是在Spring的配置文件里面使用`<bean>`标签来给容器中导入非常多的组件的，就像下面这样。

<?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 id="haha" class="com.meimeixia.boot.bean.User">
            <property name="name" value="zhangsan"></property>
            <property name="age" value="18"></property>
        </bean>
    
        <bean id="hehe" class="com.meimeixia.boot.bean.Pet">
            <property name="name" value="tomcat"></property>
        </bean>
    
    </beans>

如果现在某个公司里面还是有很多人依旧在使用这种XML配置文件的方式，而且还配置了非常多的组件，那么现在想要挨个的迁移替换成注解这种方式，仔细想一想，是不是感觉有点麻烦啊！或者，我们项目中引入了人家第三方包，而且人家还是用的比较老的方式，即仍然还是使用XML配置文件的方式来配置组件。对于这些组件而言，它们在容器中默认肯定是没有的。不妨我来给大家确认一下容器中到底有没有名字为`haha`和`hehe`的这两组件。注意，在我maven项目的`src > main > resources`目录下有一个beans.xml配置文件，而且文件内容如上。

package com.meimeixia.boot;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.SpringBootConfiguration;
    import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
    import org.springframework.context.ConfigurableApplicationContext;
    import org.springframework.context.annotation.ComponentScan;
    
    /** * 主程序类，也叫主配置类 * @author liayun * @create 2021-04-19 4:02 */
    //@SpringBootApplication
    @SpringBootConfiguration
    @EnableAutoConfiguration
    @ComponentScan("com.meimeixia.boot")
    public class MainApplication { 
    
        public static void main(String[] args) { 
            // 1. 返回IoC容器，IoC容器里面就包含了当前应用的所有组件
            ConfigurableApplicationContext run = SpringApplication.run(MainApplication.class, args); // 这是固定写法哟
            // 2. 我们可以来查看下IoC容器里面所有的组件，只要能查找到某一个组件，就说明这个组件是能工作的，至于怎么工作，这就是我们后来要阐述的原理了
            String[] names = run.getBeanDefinitionNames(); // 获取所有组件定义的名字
            for (String name : names) { 
                System.out.println(name);
            }
            
            // 3. 从容器中获取组件
    // Pet tom01 = run.getBean("tom", Pet.class);
    // Pet tom02 = run.getBean("tom", Pet.class);
    // System.out.println("组件是否为单实例：" + (tom01 == tom02));
    //
    // // 配置类打印：com.meimeixia.boot.config.MyConfig$$EnhancerBySpringCGLIB$$4559f04d@49096b06
    // MyConfig bean = run.getBean(MyConfig.class);
    // System.out.println(bean);
    //
    // // 如果@Configuration(proxyBeanMethods = true)，代理对象调用方法
    // User user = bean.user01();
    // User user1 = bean.user01();
    // System.out.println("(user == user1) = " + (user == user1));
    //
    // User user01 = run.getBean("user01", User.class);
    // Pet tom = run.getBean("tom", Pet.class);
    // System.out.println("用户的宠物：" + (user01.getPet() == tom));
    //
    // // 4. 获取组件
    // System.out.println("=====================");
    // String[] beanNamesForType = run.getBeanNamesForType(User.class); // 获取我们给容器中注册的User类型的组件的名字
    // for (String s : beanNamesForType) { 
    // System.out.println(s);
    // }
    //
    // DBHelper bean1 = run.getBean(DBHelper.class);
    // System.out.println(bean1);
    
    // boolean tom_pet = run.containsBean("tom");
    // System.out.println("容器中tom组件：" + tom_pet);
    //
    // boolean user01 = run.containsBean("user01");
    // System.out.println("容器中user01组件：" + user01);
    //
    // boolean tom666 = run.containsBean("tom666");
    // System.out.println("容器中tom666组件：" + tom666);
    
            boolean haha = run.containsBean("haha");
            boolean hehe = run.containsBean("hehe");
            System.out.println("haha：" + haha);
            System.out.println("hehe：" + hehe);
    
        }
    
    }

运行主程序类，发现IDEA控制台打印结果如下。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70_pic_center]

可以看到，容器中目前肯定是没有名字为`haha`和`hehe`的这两组件的，这是因为Spring Boot也不知道咱们写的beans.xml这个文件到底是干嘛的。

我们现在是有beans.xml这样一个文件，没错！但是我们不想一点一点的迁移成使用@Bean这些注解的这样子的写法，那么该怎么办呢？这时，@ImportResource注解就应运而生了，也就是说我们只须随便在某一个配置类上标注上一个@ImportResource注解即可，这样，就能导入外部的一个资源了。

那怎么导入外部的一个资源呢？我们只须在@ImportResource注解里面指定资源的路径即可，例如类路径下的某一个Spring XML配置文件，即`classpath:beans.xml`，如下所示。

package com.meimeixia.boot.config;
    
    import ch.qos.logback.core.db.DBHelper;
    import com.meimeixia.boot.bean.Pet;
    import com.meimeixia.boot.bean.User;
    import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.context.annotation.Import;
    import org.springframework.context.annotation.ImportResource;
    
    /** * @author liayun * @create 2021-04-23 19:42 * */
    @Import({ User.class, DBHelper.class}) // 这时，就会给容器中自动创建出这两个类型的组件了
    @Configuration(proxyBeanMethods = true) // 告诉Spring Boot这是一个配置类 == 配置文件
    //@ConditionalOnBean(name = "tom")
    @ConditionalOnMissingBean(name = "tom")
    @ImportResource("classpath:beans.xml")
    public class MyConfig { 
    
        @Bean // @Bean注解是给容器中添加组件的。添加什么组件呢？以方法名作为组件的id，返回类型就是组件类型，返回的值就是组件在容器中的实例
        public User user01() { 
            User zhangsan = new User("zhangsan", 18);
            // User类型的组件依赖了Pet类型的组件
            zhangsan.setPet(tomcatPet());
            return zhangsan;
        }
    
    // @Bean("tom")
        @Bean("tom666")
        public Pet tomcatPet() { 
            return new Pet("tomcat");
        }
    
    }

这就相当于把Spring配置文件里面的内容重新给我们解析了一遍，这个Spring配置文件里面配的是什么，那么就给我们解析成什么，并将解析出来的东东放到容器里面。现在，我们不妨来确认一下容器里面是不是有名字为`haha`和`hehe`的这两组件了。

我们再次重新运行主程序类，发现IDEA控制台打印结果如下。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70_pic_center 1]

可以看到，现在确实是有了。

所以，我们可以得出这样一个结论，**@ImportResource注解允许我们依旧还能使用Spring以前的XML配置文件这种方式，因为它可以导入该Spring配置文件，让其生效**。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70_pic_center]: /images/20221021/e4353a8da6a64e06b351d60eadbd4b2b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221021/014c6bd5d2ec4178b8c49477bec6264e.png