Spring @Import注解的使用

2024-10-01 11:34:22

认识@Import注解

先看一下源码

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Import {

	/**
	 * {@link Configuration}, {@link ImportSelector}, {@link ImportBeanDefinitionRegistrar}
	 * or regular component classes to import.
	 */
	Class<?>[] value();

}

@Import表示要导入的一个或多个@Configuration类

看注释value通常是一个普通的组件，Configuration，ImportSelector，ImportBeanDefinitionRegistrar。

搭建项目结构用于测试

先创建一个maven工程
加入依赖

<dependencies>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.18</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>4.3.24.RELEASE</version>
    </dependency>
</dependencies>

编写测试代码
Tom.java

@Data
public class Tom {
    private String color;
    private Integer age;
}

AppConfig.java

@Configuration
public class AppConfig {
}

App.java

public class App {
    public static void main(String[] args) {
        // 创建容器
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);
        // 获取bean
        Tom tom = context.getBean(Tom.class);
        System.out.println(tom);
    }
}

@Import用法

第一种普通组件
@Import（{ 要导入的容器中的组件 } ）

CustomConfiguration.java

@Configuration
public class CustomConfiguration {
    @Bean
    public Tom tom() {
        Tom tom = new Tom();
        tom.setAge(11);
        tom.setColor("红色");
        return tom;
    }
}

将AppConfig.java加上@Import({ CustomConfiguration.class })

@Import({ CustomConfiguration.class })
@Configuration
public class AppConfig {
}

这个时候运行App已经可以获取到Tom

第二种ImportSelector
CustomSelector.java

public class CustomSelector implements ImportSelector {

    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[] { "com.moli.pojo.Tom" };
    }
}

将AppConfig.java加上@Import({ CustomRegistrar.class })

@Import({ CustomRegistrar.class })
@Configuration
public class AppConfig {
}

这个时候运行App已经可以获取到Tom

第三种ImportBeanDefinitionRegistrar
CustomRegistrar.java

public class CustomRegistrar implements ImportBeanDefinitionRegistrar {
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(Tom.class);
        builder.setScope(BeanDefinition.SCOPE_SINGLETON);
        builder.addPropertyValue("color", "灰色");
        builder.addPropertyValue("age", "12");
        registry.registerBeanDefinition("tom", builder.getBeanDefinition());
    }
}

将AppConfig.java加上@Import({ CustomSelector.class })

@Import({ CustomSelector.class })
@Configuration
public class AppConfig {
}

这个时候运行App已经可以获取到Tom

最佳搭档 - @Import通用形式

在开源软件中大部分@Import中是伴随着一个@EnableXXX使用的

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import({ CustomRegistrar.class })
public @interface EnableTom {
}

将AppConfig.java加上@EnableTom

@EnableTom
@Configuration
public class AppConfig {
}

这样看起来，是不是有那味了。

其实SpringBoot的自动配置就是@Import的一个应用

@SuppressWarnings("deprecation")
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(EnableAutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
    ...
}

总结

直白一点使用@Import注解可以快速把实例加入Spring的IOC容器中

其实这三种用法也算是一种用法，就是导入一个类到容器，容器根据类的注解类型等信息对不同类进行不同处理；

方法一：导入一个Configuration组件，组件创建了一个Tom类的Bean；

方法二：CustomSelector返回的类的全限定类名，实际上要导入到容器中的组件全类名；

方法三：ImportBeanDefinitionRegistrar类似于第二种ImportSelector用法，只不过这种用法能自定义化注册，往容器内注入一个BeanDefinition，然后BeanDeiniton在容器内转为一个实例bean；

以上就是Spring @Import注解的使用的详细内容，更多关于Spring @Import注解的资料请关注我们其它相关文章！

Spring中@Import的各种用法以及ImportAware接口详解

@Import 注解 @Import注解提供了和XML中<import/>元素等价的功能,实现导入的一个或多个配置类.@Import即可以在类上使用,也可以作为元注解使用. @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Import { /** * {@link Configuration}, {@link ImportSelector}, {@link I
spring注解@Import用法详解

[1]@Import 参数value接收一个Class数组,将你传入的类以全类名作为id加入IOC容器中比较简单,此处不做详细解释 [2]ImportSelector ImportSelector强调的是复用性,使用它需要创建一个类实现ImportSelector接口,实现方法的返回值是字符串数组,也就是需要注入容器中的组件的全类名.id同样也是全类名. 上代码: //自定义逻辑返回需要导入的组件 public class MyImportSelector implements Impo
详解SpringBoot开发使用@ImportResource注解影响拦截器

问题描述今天在给SpringBoot项目配置拦截器的时候发现怎么都进不到拦截器的方法里面,在搜索引擎上看了无数篇关于配置拦截器的文章都没有找到解决方案. 就在我准备放弃的时候,在 CSDN 上发现了一篇文章,说的是SpringBoot 用了@ImportResource 配置的拦截器就不起作用了.于是我就赶紧到Application启动类看了一眼,果然项目中使用了@ImportResource 注解用于配置系统的参数. 代码如下: 启动类配置 package com.xx.xxx; impor
浅谈Spring中@Import注解的作用和使用

@Import用来导入@Configuration注解的配置类.声明@Bean注解的bean方法.导入ImportSelector的实现类或导入ImportBeanDefinitionRegistrar的实现类. @Import注解的作用查看Import注解源码 /** * Indicates one or more {@link Configuration @Configuration} classes to import. * * <p>Provides functionality eq
详解Spring 注解之@Import 注入的各种花活

今天来分享一下 pig4cloud 中涉及的 @Import 的注入形式.通过不同形式的注入方式,最大程度使得架构简洁. @Import导入一个组件来看 EnablePigxDynamicRoute 这个注解,当我们需要开始动态数据源时,只需要在main 方法加上此注解即可. @Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited @Import(DynamicRouteAut
如何利用Spring的@Import扩展点与spring进行无缝整合

利用Spring的@Import扩展与spring进行无缝整合前言BeanFactoryPostProcessor@Import实现POM文件定义数据层Resource(dao)层的扫描注解定义我的数据层Resource使用的注解ArteryResourceImportBeanDefinitionRegistrar实现自定义扫描类ClassPathArteryResourceScanner代理注册工厂ResourceRegistryResouce的代理工厂真正的代理类方法调用类AbstractB
Springboot @Import 详解

SpringBoot 的 @Import 用于将指定的类实例注入之Spring IOC Container中. 今天抽空在仔细看了下Springboot 关于 @Import 的处理过程, 记下来以后看. 1. @Import 先看Spring对它的注释 (文档贴过来的), 总结下来作用就是和xml配置的 <import />标签作用一样,允许通过它引入 @Configuration 注解的类 (java config), 引入ImportSelector接口(这个比较重要, 因为要通过它去判
Spring @Import注解的使用

认识@Import注解先看一下源码 @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Import { /** * {@link Configuration}, {@link ImportSelector}, {@link ImportBeanDefinitionRegistrar} * or regular component classes to impor
使用Spring的注解方式实现AOP实例

spring对AOP的实现提供了很好的支持.下面我们就使用Spring的注解来完成AOP做一个例子. 首先,为了使用Spring的AOP注解功能,必须导入如下几个包.aspectjrt.jar,aspectjweaver.jar,cglib-nodep.jar.然后我们写一个接口 package com.bird.service; public interface PersonServer { public void save(String name); public void update(S
JSP 中Spring组合注解与元注解实例详解

JSP 中Spring组合注解与元注解实例详解摘要: 注解(Annotation),也叫元数据.一种代码级别的说明.它与类.接口.枚举是在同一个层次.它可以声明在包.类.字段.方法.局部变量.方法参数等的前面,用来对这些元素进行说明 1. 可以注解到别的注解上的注解称为元注解,被注解的注解称为组合注解,通过组合注解可以很好的简化好多重复性的注解操作 2. 示例组合注解 import org.springframework.context.annotation.ComponentScan; im
Spring基于注解整合Redis完整实例

在<Redis之--Spring整合Redis>一文中,向大家介绍了如何将spring与Redis整合起来,但不是基于注解的形式,很多同学都希望能够通过注解的形式来简单的将Spring与Redis整合起来,这样,在使用的时候,只需要在相应的方法上加上注解,便可以使方法轻松的调用Redis的缓存.那么今天就来向大家介绍如何用基于注解的形式来整合Spring与Redis. 一.项目搭建今天,我们不使用hibernate来操作数据库了,我们今天选择的框架是: Spring4(包括mvc.conte
基于Spring@Autowired注解与自动装配详谈

1 配置文件的方法我们编写spring 框架的代码时候.一直遵循是这样一个规则:所有在spring中注入的bean 都建议定义成私有的域变量.并且要配套写上 get 和 set方法. Boss 拥有 Office 和 Car 类型的两个属性: 清单 3. Boss.java package com.baobaotao; public class Boss { private Car car; private Office office; // 省略 get/setter @Override p
详解spring mvc(注解)上传文件的简单例子

spring mvc(注解)上传文件的简单例子. 这有几个需要注意的地方 1.form的enctype="multipart/form-data" 这个是上传文件必须的 2.applicationContext.xml中 <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver"/> 关于
spring aop注解配置代码实例

本文实例为大家分享了spring aop注解配置的具体代码,供大家参考,具体内容如下 Demo.java package cn.itcast.e_annotation; import javax.annotation.Resource; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.context.ApplicationContext; import org.springfra
Spring条件注解用法案例分析

本文实例讲述了Spring条件注解用法.分享给大家供大家参考,具体如下: 一点睛 Spring 4 提供了一个更通用的基于条件的Bean的创建,即使用@Conditional注解. @Conditional根据满足仅一个特定条件创建一个特定的Bean.也就是根据特定的条件来控制Bean的创建行为,这样就可以利用这个特性进行一些自动的配置. 二项目说明以不同的操作系统为条件,通过实现@Condition接口,并重写matches方法来构造条件.若在windows系统下运行,则输出列表命令为d
通过实例解析Spring组合注解与元注解

这篇文章主要介绍了通过实例解析Spring组合注解与元注解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 1.概述 1.1.Spring提供了大量的注解, 尤其是相同的注解用到各个类中,会相当的啰嗦: 1.2.元注解: 可以注解到别的注解上的注解: 组合注解: 被注解注解的注解称为组合注解: 组合注解具备元注解的功能,Spring的很多注解都可以作为元注解: 1.3.案例 package com.an.config; import co

Spring @Import注解的使用

认识@Import注解

搭建项目结构用于测试

@Import用法

最佳搭档 - @Import通用形式

总结

相关推荐

随机推荐