@import注解的三种用法

最新推荐文章于 2024-08-04 11:07:52 发布
最新推荐文章于 2024-08-04 11:07:52 发布
阅读量1.5k 收藏 11
点赞数 5
分类专栏： springboot 文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/afggg_/article/details/129178649
版权

@Import是一个非常有用的注解，它的长处在于你可以通过配置来控制是否注入该Bean，也可以通过条件来控制注入哪些Bean到Spring容器中。

比如我们熟悉的：@EnableAsync 、@EnableCaching、@EnableScheduling等等统一采用的都是借助@Import注解来实现的。

一、引入普通类

有个用户类如下

public class Test implements InitializingBean {
    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println("注入成功");
    }
}

那么如何通过@Import注入容器呢？

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
@Import({Test.class})
@Configuration
public class Myclass2  {
   
}

当在@Configuration标注的类上使用@Import引入了一个类后，就会把该类注入容器中。

当然除了@Configuration 比如@Component、@Service等一样也可以。
测试效果如下：
在这里插入图片描述

二、引入ImportSelector的实现类

1、静态import场景（注入已知的类）
我们先将上面的示例改造下：

自定义MyImportSelector实现ImportSelector接口，重写selectImports方法

public class MyImportSelector implements ImportSelector {


    @Override
    public String[] selectImports(AnnotationMetadata annotationMetadata) {
        return new String[]{"com.example.eureka.config.Test"};
    }
}

然后在配置类引用

package com.example.eureka.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
@Import({MyImportSelector.class})
@Configuration
public class Myclass2  {

}

2、动态import场景（注入指定条件的类）
我们来思考一种场景，就是你想通过开关来控制是否注入该Bean，或者说通过配置来控制注入哪些Bean，这个时候就有了ImportSelector的用武之地了。
我们来举个例子，通过ImportSelector的使用实现条件选择是注入本地缓存还是Redis缓存。

1)、定义缓存接口和实现类

package com.example.eureka.cache;

public interface CacheService {
    void setData(String key);
}

本地缓存 实现类

package com.example.eureka.cache.impl;

import com.example.eureka.cache.CacheService;

public class LocalServicempl implements CacheService {
    @Override
    public void setData(String key) {
        System.out.println("本地存储数据成功，key="+key);
    }
}

redis缓存实现类

public class RedisServicempl implements CacheService {

    @Override
    public void setData(String key) {
        System.out.println("redis存储数据成功 key= " + key); 
    }
}

2)、定义ImportSelector实现类

以下代码中根据EnableMyCache注解中的不同值来切换缓存的实现类再spring中的注册。

public class MyCacheSelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata annotationMetadata) {
        Map<String, Object> annotationAttributes = annotationMetadata.getAnnotationAttributes(EnableMyCache.class.getName());
        CacheType  type = (CacheType)annotationAttributes.get("type");

       switch (type){
           case LOCAL:
               return new String[]{
               LocalServicempl.class.getName()
           };
           case REDIS:
               return new String[]{
                       RedisServiceImpl.class.getName()
               };
           default:
               throw new RuntimeException();
       }

    }
    
}

3)、定义注解

package com.example.eureka.cache.Annotion;

import com.example.eureka.cache.Enums.CacheType;
import org.springframework.context.annotation.Import;

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Import({com.example.eureka.cache.MyCacheSelector.class})
public @interface EnableMyCache {
    CacheType type() default  CacheType.REDIS;
}

4)定义枚举

package com.example.eureka.cache.Enums;

public enum CacheType {
    LOCAL,REDIS;
}

三、引入ImportBeanDefinitionRegister的实现类

当配置类实现了 ImportBeanDefinitionRegistrar 接口，你就可以自定义往容器中注册想注入的Bean。
这个接口相比与 ImportSelector 接口的主要区别就是，ImportSelector接口是返回一个类，你不能对这个类进行任何操作，但是 ImportBeanDefinitionRegistrar 是可以自己注入 BeanDefinition，可以添加属性之类的。
1.定义实体

public class UserConfig implements InitializingBean {

    private String username;
    private String password;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println(this.username+"-"+this.password);
    }
}

我们通过实现ImportBeanDefinitionRegistrar的方式来完成注入。

package com.example.eureka.config;

import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.BeanNameGenerator;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.type.AnnotationMetadata;

@Configuration
@Import({MyImportBean.class})
public class MyImportBean implements ImportBeanDefinitionRegistrar {
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry, BeanNameGenerator importBeanNameGenerator) {
        AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(UserConfig.class).addPropertyValue("username", "fengmin").addPropertyValue("password", "12222").getBeanDefinition();
        registry.registerBeanDefinition("userconfig",beanDefinition);

    }
}

四、复杂运行

Mybatis的@MapperScan就是用这种方式实现的，@MapperScan注解，指定basePackages，扫描Mybatis Mapper接口类注入到容器中。

  1. 这里我们自定义一个注解@MyMapperScan来扫描包路径下所以带@MyMapperBean注解的类，并将它们注入到IOC容器中。
package com.example.eureka.exmple;

import org.springframework.context.annotation.Import;

import java.lang.annotation.*;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(MyMapperBeanImport.class)
public @interface MyMapperScan {
    /**
     * 扫描包路径
     */
    String[] basePackages() default {};
}
  1. 定义MyMapperBean注解
package com.example.eureka.exmple;

import java.lang.annotation.*;

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

}
  1. 定义ImportBeanDefinitionRegister的实现类
package com.example.eureka.exmple;

import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.context.ResourceLoaderAware;
import org.springframework.context.annotation.ClassPathBeanDefinitionScanner;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.annotation.AnnotationAttributes;
import org.springframework.core.io.ResourceLoader;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.core.type.filter.AnnotationTypeFilter;

public class MyMapperBeanImport implements ImportBeanDefinitionRegistrar, ResourceLoaderAware {
    private final static String PACKAGE_NAME_KEY="basePackages";
    private ResourceLoader resourceLoader;
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        AnnotationAttributes annotationAttributes = AnnotationAttributes.fromMap(importingClassMetadata.getAnnotationAttributes(MyMapperScan.class.getName()));
        if(annotationAttributes ==null||annotationAttributes.isEmpty() ){
            return;
        }
        String[] basePackages  =(String[]) annotationAttributes.get(PACKAGE_NAME_KEY);
        ClassPathBeanDefinitionScanner scanner=new ClassPathBeanDefinitionScanner(registry,false);
        scanner.setResourceLoader(resourceLoader);
        //路径包含MapperBean的注解的bean
        scanner.addIncludeFilter(new AnnotationTypeFilter(MyMapperBean.class));
        scanner.scan(basePackages);
    }

    @Override
    public void setResourceLoader(ResourceLoader resourceLoader) {
      this.resourceLoader=resourceLoader;
    }
}
  1. 测试
package com.example.eureka.exmple;

import com.example.eureka.exmple.mapper.UserMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.stereotype.Component;

@Component
public class TestRunnerApi2 implements ApplicationRunner {
    @Autowired
    private UserMapper userMapper;
    @Override
    public void run(ApplicationArguments args) throws Exception {
        userMapper.select("user");
    }
}

效果如下：
在这里插入图片描述

无名小厨
关注
  • 5
    点赞
  • 踩
  • 11
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
@Import注解使用
m0_55806905的博客
11-21 1545
@Import注解的使用
Spring中@Import的各种用法以及ImportAware接口详解
08-25
Spring 中 @Import 的各种用法以及 ImportAware 接口详解 @Import 注解是 Spring 框架中一个非常重要的注解，它提供了和 XML 中 `<import/>` 元素等价的功能，实现导入的一个或多个配置类。@Import 即可以在类上...
详解Spring 注解之@Import 注入的各种花活
08-25
主要介绍了详解Spring 注解之@Import 注入的各种花活，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
spring注解@Import用法详解
08-25
主要介绍了spring注解@Import用法详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
Spring：了解@Import注解的三种用法
永远保持随时离开的技术能力！
05-15 775
@Import注解的三种用法
@Import注解的四种使用方式
bluemysky的博客
02-01 973
@Import注解的四种使用方式。
spring注解之@Import注解的三种使用方式
zhijingzhi的博客
06-03 2315
@Import的三种用法主要包括：2.1、第一种用法：直接填class数组直接填对应的class数组，class数组可以有0到多个。语法如下： 对应的import的bean都将加入到spring容器中，这些在容器中bean名称是该类的全类名 ，比如com.yc.类名2.2、第二种用法：ImportSelector方式【重点】这种方式的前提就是一个类要实现ImportSelector接口，假如我要用这种方法，目标对象是Myclass这个类，分析具体如下：创建Myclass类并实现ImportSelecto
@Import注解详解
怪咖@的博客
10-22 8189
@Import这个注解非常重要，而且在springboot项目当中随处可见，就拿springboot启动类来说，我们经常会遇到一些@Enable相关的注解，例如开启异步@EnableAsync、开启缓存支持@EnableCaching、开启定时任务@EnableScheduling等等...
@Import注解的作用
热门推荐
一直打铁
01-31 9万+
这里写自定义目录标题欢迎使用Markdown编辑器新的改变功能快捷键合理的创建标题，有助于目录的生成如何改变文本的样式插入链接与图片如何插入一段漂亮的代码片生成一个适合你的列表创建一个表格设定内容居中、居左、居右SmartyPants创建一个自定义列表如何创建一个注脚注释也是必不可少的KaTeX数学公式新的甘特图功能，丰富你的文章UML 图表FLowchart流程图导出与导入导出导入 欢迎使用Ma...
【Spring】@Import注解
caokai1992的专栏
10-17 1232
@Import @Enable Spring
浅谈Spring中@Import注解的作用和使用
08-19
@Import 注解是 Spring 框架中的一种重要注解，主要用于导入@Configuration 注解的配置类、声明@Bean 注解的 bean 方法、导入 ImportSelector 的实现类或导入 ImportBeanDefinitionRegistrar 的实现类。本篇文章将...
Springboot @Import 详解
08-26
在本篇文章中，我们将详细介绍 @Import 的作用和使用方法。 什么是 @Import？ @Import 是 Spring Boot 中的一个注解，用于将指定的类实例注入到 Spring IOC Container 中。它的作用类似于 Spring XML 中的 `...
@import注解用法
相信明天的博客
11-06 8239
@Import只能用在类上 ，@Import通过快速导入的方式实现把实例加入spring的IOC容器中 @Import注解的作用和在使用spring的xml配置时用到的类似。但应注意是@Import在使用时, 必须要保证能被IOC容器扫描到，所以通常它会和@Configuration或者@ComponentScan配套使用。 @Import在使用时可以声明在JAVA类上，或者作为元注解使用（即声明在其他注解上） @Import注解有三种用法 直接导入@Configuration配置类 public cl.
枚举工具类
qq_43049583的博客
08-04 322
java枚举工具类
等待唤醒机制两种实现方法-阻塞队列
最新发布
泰勒今天想展开的博客
08-04 358
桌子上有面条-》吃货执行桌子上没面条-》生产者制造执行。
社区养老服务小程序的设计
Karen198的博客
07-31 688
管理员账户功能包括：系统首页，个人中心，用户管理，服务人员管理，服务产品管理，服务预约管理，服务状态管理，服务退订管理，活动管理，视频管理。主要技术：Java,Spring,mybatis,mysql,jquery,html。服务器：SpringBoot自带 apache tomcat。微信端账号功能包括：系统首页，服务产品，活动，视频，我的。JDK版本：Java JDK1.8。数据库可视化工具： navicat。数据库版本： mysql5.7。开发工具：IDEA(推荐)开发系统：Windows。
深入理解Java注解
weixin_55745942的博客
08-01 684
Java注解是用来描述程序元素（如类、方法、变量等）的一种机制。它们可以提供关于程序的补充信息，帮助编译器、框架或其他工具更好地理解和处理代码。注解通常以符号开头，后跟注解名称和可能的参数。要创建自定义注解，需要使用@interface关键字定义一个接口，并在接口中声明注解的属性。这个注解名为，可以被用来标记方法。它有一个名为value的属性，具有默认值"default"。
spring中@Import注解的使用方法
04-01
@Import注解是Spring中的注解之一，用于导入其他的配置类或者普通的类，从而使它们成为当前配置类中的一个Bean。可以用在@Configuration注解的类中，或者用在普通的类中作为一个注解。 使用方法： 1. 导入配置类：可以将一个或多个@Configuration注解的配置类导入到当前配置类中，以便使用其中的Bean。示例代码如下： ```java @Configuration @Import({Config1.class, Config2.class}) public class AppConfig { // ... } ``` 2. 导入普通类：可以将一个或多个非@Configuration注解的普通类导入到当前配置类中，以便使用其中的Bean。示例代码如下： ```java @Configuration @Import({Service1.class, Service2.class}) public class AppConfig { // ... } ``` 3. 导入ImportSelector实现类：可以将一个实现了ImportSelector接口的类导入到当前配置类中，该类可以动态地选择要导入的类。示例代码如下： ```java @Configuration @Import(MyImportSelector.class) public class AppConfig { // ... } ``` 4. 导入ImportBeanDefinitionRegistrar实现类：可以将一个实现了ImportBeanDefinitionRegistrar接口的类导入到当前配置类中，该类可以动态地注册Bean定义。示例代码如下： ```java @Configuration @Import(MyImportBeanDefinitionRegistrar.class) public class AppConfig { // ... } ``` 5. 导入FactoryBean：可以将一个实现了FactoryBean接口的类导入到当前配置类中，以便使用其中的Bean。示例代码如下： ```java @Configuration @Import(MyFactoryBean.class) public class AppConfig { // ... } ``` 需要注意的是，@Import注解只是将其他的类导入到当前配置类中，而并不会自动将其实例化为Bean。如果需要使用导入的类中的Bean，需要在当前配置类中通过@Bean注解手动创建相应的Bean。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值