进阶注解探秘:深入Spring高级注解的精髓与实际运用

简介: 进阶注解探秘:深入Spring高级注解的精髓与实际运用


@Configuration

@Configuration 注解是一个类级别的注解,也是 @Component 的衍生注解,它指示 Spring 容器该类是一个配置类并且应该被处理以生成 Bean 定义和服务请求。@Configuration 注解告诉 Spring 容器这个类是一个 Bean 配置文件,其中可能包含了多个 Bean 的定义。

通过 @Configuration 注解,我们就可以完全替换掉 XML 配置的方式。

需要注意的是,在原来的测试类中,创建 Spring 工厂使用的是 ClassPathXmlApplicationContext,当我们想要使用 @Configuration 配置 Bean 来创建工厂时,我们需要使用 AnnotationConfigApplicationContext。在使用这个类的时候,我们可以直接传入配置 Bean 的 Class,也可以指定一个包路径。

创建配置类

package world.xuewei.config;
import org.springframework.context.annotation.Configuration;
/**
 * Spring 配置 Bean
 *
 * @author 薛伟
 * @since 2023/10/27 14:42
 */
@Configuration
public class AppConfig {
}

创建测试类

package world.xuewei;
import org.junit.Before;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import world.xuewei.config.AppConfig;
/**
 * 配置 Bean 测试
 *
 * @author 薛伟
 * @since 2023/10/26 10:17
 */
public class ConfigurationTest {
    private ApplicationContext context;
    @Before
    public void before() {
        // 指定配置类的 Class,创建 Spring 工厂
        context = new AnnotationConfigApplicationContext(AppConfig.class);
        // 指定配置类所在的包路径,配置 Bean 需要在此包或者子包下
        context = new AnnotationConfigApplicationContext("world.xuewei");
    }
    @Test
    public void test1() {
    }
}

@Bean

在 Spring 框架中,@Bean 注解用于将方法标记为 Bean 定义提供程序。通过在 @Configuration 注解的类中使用 @Bean 注解,您可以告诉 Spring 容器该方法将返回一个对象,该对象应该被注册为 Spring 上下文中的 Bean。

@Bean 注解有以下特点和用途:

  1. 方法级别的注解:@Bean 注解是一个方法级别的注解,它通常用于 @Configuration 注解的类中的方法上。
  2. Bean 定义:当使用 @Bean 注解标记一个方法时,该方法的返回值将被注册为一个 Spring Bean。Spring 容器将根据方法返回的对象类型自动创建 Bean,并将其添加到应用程序上下文中。
  3. 自定义 Bean 名称:默认情况下,Bean 的名称与带有 @Bean 注解的方法名称相同。您可以通过在 @Bean 注解中指定 name 属性来自定义 Bean 的名称。
  4. 依赖注入:@Bean 注解还可以处理依赖注入。如果 @Bean 方法需要其他 Bean 作为参数,Spring 容器将自动解析并注入这些依赖项。
  5. 单例作用域:默认情况下,通过 @Bean 注解注册的 Bean 是单例的。这意味着每次从 Spring 容器获取该 Bean 时,都会返回同一个实例。可以搭配 @Scope 注解改变对象的作用域。
  6. 配置外部库:@Bean 注解非常适合用于配置第三方库或外部组件,您可以将其实例化并注册为 Spring Bean,以便在应用程序中使用。

注意:当 @Bean 标记在一个方法上的时候,这个方法必须是 public 的。返回值就是 Bean 的类型,方法名默认就是 Bean 的 id。如果有参数,那么参数会自动的注入。

示例 Demo

package world.xuewei.config;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import org.springframework.context.annotation.Scope;
import world.xuewei.dao.AccountDao;
import world.xuewei.entity.Account;
import world.xuewei.service.AccountService;
import world.xuewei.service.AccountServiceImpl;
import java.sql.Connection;
import java.sql.DriverManager;
/**
 * Spring 配置 Bean
 *
 * @author 薛伟
 * @since 2023/10/27 14:42
 */
@Configuration
@PropertySource("classpath:db.properties")
public class AppConfig {
    /**
     * 连接驱动
     */
    @Value("${jdbc.driveName}")
    private String driveName;
    /**
     * 连接地址
     */
    @Value("${jdbc.url}")
    private String url;
    /**
     * 用户名
     */
    @Value("${jdbc.username}")
    private String username;
    /**
     * 密码
     */
    @Value("${jdbc.password}")
    private String password;
    /**
     * 创建一个 id 为默认方法名 account 的 Bean
     */
    @Bean
    public Account account() {
        return new Account(1, "xw", "123456");
    }
    /**
     * 创建一个 id 为 acc 的 Bean,并且为多实例
     */
    @Bean(name = "acc")
    @Scope("prototype")
    public Account account1() {
        return new Account(1, "xw", "123456");
    }
    /**
     * 创建复杂对象 Bean
     */
    @Bean
    public Connection connection() {
        Connection connection = null;
        try {
            Class.forName(driveName);
            connection = DriverManager.getConnection(url, username, password);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
        return connection;
    }
    @Bean
    public AccountDao accountDao() {
        return new AccountDao();
    }
    /**
     * 创建 AccountService Bean
     *
     * @param accountDao 自动注入 AccountDao
     */
    @Bean
    public AccountService accountService(AccountDao accountDao) {
        AccountServiceImpl accountService = new AccountServiceImpl();
        accountService.setAccountDao(accountDao);
        return accountService;
    }
}

@ComponentScan

@ComponentScan 注解是 Spring 提供的一种基于注解的配置方式,它可以在 Java 类上直接使用,也可以在配置类上使用。

@ComponentScan 注解包含几个重要的属性:basePackagesexcludeFiltersincludeFiltersuseDefaultFilters。作用和上述 XML 方式一样。

@ComponentScan(basePackages = "world.xuewei", excludeFilters = {
        @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, value = Account.class),
        @ComponentScan.Filter(type = FilterType.ANNOTATION, value = Service.class),
        @ComponentScan.Filter(type = FilterType.REGEX, pattern = ".*Test"),
        @ComponentScan.Filter(type = FilterType.ASPECTJ, pattern = "world.xuewei.dao..*"),
        @ComponentScan.Filter(type = FilterType.CUSTOM, classes = MyCustomFilter.class),
})
@Component
public class AnnotationTest {
  // ...
}

具体配置内容可查看前面整理的《Spring注解扫描》

@Import

在 Spring 框架中,@Import 注解用于将其他配置类导入当前配置类中。通过使用 @Import 注解,您可以将其他配置类中的 Bean 定义引入到当前配置类中,从而实现 Bean 的组合和重用。

@Import 注解有以下特点和用途:

  1. 导入其他配置类:@Import 注解允许您将其他配置类导入到当前配置类中。这意味着您可以将其他配置类中定义的 Bean 引入到当前配置类中,并将其注册为 Spring 上下文中的 Bean。
  2. 组合和重用 Bean:通过 @Import 注解,您可以将多个配置类中定义的 Bean 组合在一起,以创建更复杂的应用程序上下文。这使得 Bean 的重用和组合变得更加容易。
  3. 多态性:@Import 注解支持多态性,这意味着您可以使用父类或接口类型来引用导入的 Bean。这使得应用程序更加灵活和易于扩展。
  4. 条件导入:@Import 注解还支持条件导入,这意味着您可以根据特定条件选择性地导入配置类。例如,您可以根据运行时环境的不同导入不同的配置类。

配置类的引入

@Configuration
public class AppConfig1 {
    // 配置类1的内容
}
@Configuration
public class AppConfig2 {
    // 配置类2的内容
}
@Configuration
@Import({AppConfig1.class, AppConfig2.class})
public class MainConfig {
    // 主配置类的内容
}

普通类的引入

@Configuration
@Import({UtilClass1.class, UtilClass2.class, ...})
public class AppConfig {
    // 配置类的内容
}

@Import 注解导入了多个普通类,这些类将被自动注册为 Spring 容器中的 Bean,可以在其他组件中进行依赖注入或使用。

@ImportResource

@ImportResource 注解是 Spring 框架中的一个注解,用于在配置类中引入 XML 配置文件。通过 @ImportResource 注解,我们可以将 XML 配置文件中定义的 bean 引入到当前的配置类中,从而实现 XML 配置文件与 Java 配置类的混合使用。

@Configuration
@ImportResource("classpath:example.xml")
public class AppConfig {
    // 配置类的内容
}
@Configuration
@ImportResource({"classpath:example1.xml", "classpath:example2.xml"})
public class AppConfig {
    // 配置类的内容
}

注意:@ImportResource 注解只能用于 @Configuration 注解标记的配置类中。


相关文章
|
7月前
|
XML Java 测试技术
Spring IOC—基于注解配置和管理Bean 万字详解(通俗易懂)
Spring 第三节 IOC——基于注解配置和管理Bean 万字详解!
487 26
|
3月前
|
Java 测试技术 数据库
说一说 SpringBoot 整合 Junit5 常用注解
我是小假 期待与你的下一次相遇 ~
|
8月前
|
缓存 Java 数据库
SpringBoot缓存注解使用
Spring Boot 提供了一套方便的缓存注解,用于简化缓存管理。通过 `@Cacheable`、`@CachePut`、`@CacheEvict` 和 `@Caching` 等注解,开发者可以轻松地实现方法级别的缓存操作,从而提升应用的性能和响应速度。合理使用这些注解可以大大减少数据库的访问频率,优化系统性能。
464 89
|
6月前
|
JSON 前端开发 Java
Spring MVC常用的注解
@RequestMapping:用于处理请求 url 映射的注解,可用于类或方法上。用于类上,则表示类中 的所有响应请求的方法都是以该地址作为父路径。 @RequestBody:注解实现接收http请求的json数据,将json转换为java对象。 @ResponseBody:注解实现将conreoller方法返回对象转化为json对象响应给客户。 @Controller:控制器的注解,表示是表现层,不能用用别的注解代替 @RestController : 组合注解 @Conntroller + @ResponseBody @GetMapping , @PostMapping , @Put
|
6月前
|
Java Spring
Spring Boot的核心注解是哪个?他由哪几个注解组成的?
Spring Boot的核心注解是@SpringBootApplication , 他由几个注解组成 : ● @SpringBootConfiguration: 组合了- @Configuration注解,实现配置文件的功能; ● @EnableAutoConfiguration:打开自动配置的功能,也可以关闭某个自动配置的选项 ● @ComponentScan:Spring组件扫描
|
6月前
|
Java 测试技术 Spring
SpringBoot+@Async注解一起用,速度提升
本文介绍了异步调用在高并发Web应用性能优化中的重要性,对比了同步与异步调用的区别。同步调用按顺序执行,每一步需等待上一步完成;而异步调用无需等待,可提升效率。通过Spring Boot示例,使用@Async注解实现异步任务,并借助Future对象处理异步回调,有效减少程序运行时间。
173 3
|
5月前
|
人工智能 缓存 自然语言处理
保姆级Spring AI 注解式开发教程,你肯定想不到还能这么玩!
这是一份详尽的 Spring AI 注解式开发教程,涵盖从环境配置到高级功能的全流程。Spring AI 是 Spring 框架中的一个模块,支持 NLP、CV 等 AI 任务。通过注解(如自定义 `@AiPrompt`)与 AOP 切面技术,简化了 AI 服务集成,实现业务逻辑与 AI 基础设施解耦。教程包含创建项目、配置文件、流式响应处理、缓存优化及多任务并行执行等内容,助你快速构建高效、可维护的 AI 应用。
|
7月前
|
监控 Java Spring
SpringBoot:SpringBoot通过注解监测Controller接口
本文详细介绍了如何通过Spring Boot注解监测Controller接口,包括自定义注解、AOP切面的创建和使用以及具体的示例代码。通过这种方式,可以方便地在Controller方法执行前后添加日志记录、性能监控和异常处理逻辑,而无需修改方法本身的代码。这种方法不仅提高了代码的可维护性,还增强了系统的监控能力。希望本文能帮助您更好地理解和应用Spring Boot中的注解监测技术。
241 16
|
6月前
|
XML Java 数据库连接
微服务——SpringBoot使用归纳——Spring Boot集成MyBatis——基于注解的整合
本文介绍了Spring Boot集成MyBatis的两种方式:基于XML和注解的形式。重点讲解了注解方式,包括@Select、@Insert、@Update、@Delete等常用注解的使用方法,以及多参数时@Param注解的应用。同时,针对字段映射不一致的问题,提供了@Results和@ResultMap的解决方案。文章还提到实际项目中常结合XML与注解的优点,灵活使用两者以提高开发效率,并附带课程源码供下载学习。
492 0
|
9月前
|
Java Spring 容器
【SpringFramework】Spring IoC-基于注解的实现
本文主要记录基于Spring注解实现IoC容器和DI相关知识。
139 21