Spring @Configuration 注解详解:用 Java 代码替代 XML 配置

简介: `@Configuration` 是 Spring 实现 Java 配置的核心注解,替代传统 XML,通过 `@Bean` 注册 Bean,结合 `@Import`、`@ComponentScan` 等实现类型安全、可维护的配置方式,推动 Spring 应用现代化。


在 Spring 框架中,传统的 Bean 管理依赖于 applicationContext.xml 等 XML 配置文件。随着 Spring 对注解和 Java 配置的支持日益完善,基于 Java 的配置方式已成为主流。其中,@Configuration 注解是实现这一转变的核心。


一、什么是 @Configuration

@Configuration 标注的类,会被 Spring 的 IOC 容器识别为一个配置类(Configuration Class),其作用等同于一个 XML 配置文件。在这个类中,你可以通过 @Bean 方法声明并注册 Spring 容器管理的 Bean。

示例:定义配置类
@Configuration
public class ConfigurationDemo {
    
    @Bean
    public Date currentDate() {
        return new Date();
    }
}

✅ 上述代码等价于以下 XML 配置:

<bean id="currentDate" class="java.util.Date"/>
  • 方法名 currentDate 默认作为 Bean 的名称(id);
  • 返回值对象由 Spring 容器管理,具备单例、依赖注入等特性。

二、启动基于 Java 配置的 IOC 容器

使用 AnnotationConfigApplicationContext 加载配置类,即可初始化 Spring 容器:

public class MainApp {
    public static void main(String[] args) {
        // 加载 ConfigurationDemo 配置类
        AnnotationConfigApplicationContext ctx = 
            new AnnotationConfigApplicationContext(ConfigurationDemo.class);
        
        // 打印容器中所有 Bean 的名称
        String[] beanNames = ctx.getBeanDefinitionNames();
        Arrays.stream(beanNames).forEach(System.out::println);
    }
}
输出结果:
org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.event.internalEventListenerProcessor
org.springframework.context.event.internalEventListenerFactory
configurationDemo
currentDate

🔍 关键说明

  • configurationDemo:配置类本身的 Bean(默认首字母小写);
  • currentDate:通过 @Bean 方法注册的自定义 Bean;
  • 其余为 Spring 内部自动注册的后处理器(如处理 @Autowired@EventListener 等)。

三、@Configuration 的核心特性

  1. 替代 XML 配置
    无需编写 <beans> 文件,全部配置通过 Java 代码完成,类型安全、易于重构。
  2. 支持依赖注入与方法调用
    在配置类内部,可通过方法调用实现 Bean 之间的依赖关系(得益于 CGLIB 代理):
@Configuration
public class AppConfig {
    @Bean
    public UserService userService() {
        return new UserService(userRepository()); // 直接调用另一个 @Bean 方法
    }
    @Bean
    public UserRepository userRepository() {
        return new UserRepository();
    }
}

⚠️ 注意:这种调用会经过 Spring 代理,确保返回的是容器中的单例 Bean,而非新实例。

  1. 可组合与导入
    使用 @Import 可将多个配置类组合:
@Configuration
@Import({DatabaseConfig.class, WebConfig.class})
public class RootConfig { }
  1. 与组件扫描结合
    配合 @ComponentScan,可同时管理配置类和注解驱动的组件(如 @Service@Repository):
@Configuration
@ComponentScan("com.example.service")
public class AppConfig { }

四、最佳实践建议

  • 命名规范:配置类建议以 ConfigConfiguration 结尾,如 DataSourceConfig
  • 职责单一:按功能拆分配置类(如数据库、缓存、Web),避免“上帝配置类”;
  • 优先使用 Java 配置:相比 XML,Java 配置更安全、可调试、支持 IDE 自动补全;
  • 避免在 @Bean 方法中使用 new 外部依赖:应通过参数注入或调用其他 @Bean 方法获取依赖。

总结

@Configuration 是 Spring 实现“无 XML”配置的关键注解。它让开发者能够以类型安全、结构清晰、易于维护的方式构建 Spring 应用上下文。结合 @Bean@Import@ComponentScan 等注解,你可以完全告别 XML,拥抱现代化的 Spring 开发体验。


相关文章
|
SQL 关系型数据库 数据库
学习分布式事务Seata看这一篇就够了,建议收藏
学习分布式事务Seata看这一篇就够了,建议收藏
24855 2
|
5月前
|
安全 Java jenkins
Spring Boot 多环境配置与 Profile 实战
Spring Boot通过Profile实现多环境配置,支持dev、test、prod等环境的独立配置。通过application-{profile}.yml分离配置,结合spring.profiles.active动态激活,实现一套代码适配多套环境,提升部署效率与安全性。
|
XML Java 数据库
探索 Spring Boot 中的 @Configuration 注解:核心概念与应用
【4月更文挑战第20天】在 Spring Boot 项目中,@Configuration 注解扮演了一个关键角色,它标识一个类作为配置源,这些配置用于定义和管理 Spring 应用程序中的 Bean
2938 7
|
5月前
|
JSON 前端开发 安全
用自定义注解 + 拦截器实现登录鉴权
通过自定义注解 `@Login` 结合 Spring 拦截器,实现声明式登录校验。无需重复编码,自动拦截未登录请求,提升代码可维护性与安全性,适用于前后端分离架构的权限控制实践。
|
5月前
|
Java API Spring
Spring Boot 中的 @PathVariable:获取 RESTful 路径参数
在Spring Boot中,`@PathVariable`用于提取RESTful API URL中的动态参数。支持单个或多个路径变量,参数名一致时可省略value属性,不一致时需显式绑定,是构建清晰、语义化接口的关键注解之一。
|
5月前
|
JSON 前端开发 Java
Spring Boot 中的 @RequestMapping 与快捷映射注解
`@RequestMapping` 是 Spring MVC 中用于映射 HTTP 请求路径与处理方法的核心注解,可标注在类或方法上。类上使用定义公共前缀,方法上指定具体路径和请求方式。常用属性包括 `value`(路径)、`method`(请求类型)、`produces`(响应类型)。Spring 还提供了 `@GetMapping`、`@PostMapping` 等快捷注解,语义更清晰,推荐优先使用。
|
5月前
|
SQL 安全 Java
了解 SQL 注入:原理、危害与防御
SQL注入是Web安全头号威胁,攻击者通过恶意SQL代码窃取、篡改或删除数据。本文详解其原理、危害及防御方案,强调预编译、输入校验、最小权限等核心防护措施,助你筑牢数据库安全防线。
|
5月前
|
Java Spring
Spring Boot 中的 @RequestParam:获取查询参数与表单数据
`@RequestParam` 用于提取 HTTP 请求中的查询参数或表单数据,支持设置参数名、是否必填及默认值。适用于 `?key=value` 形式或 POST 表单,字段多时推荐封装为实体类自动绑定,与 `@PathVariable` 按路径取值不同,用途明确,是处理 Web 请求的常用方式。
|
5月前
|
JSON 前端开发 Java
Spring Boot 封装统一返回的数据结构
本课讲解如何设计统一的JSON响应结构,通过泛型类`JsonResult&lt;T&gt;`封装返回数据,规范包含code、msg、data的标准格式,提升前后端协作效率与API可维护性。
|
5月前
|
监控 前端开发 Java
Spring Boot 统一异常处理与全局响应增强
本文介绍如何在Spring Boot中实现全局异常处理,通过`@RestControllerAdvice`和自定义`BusinessException`统一拦截异常,结合`JsonResult`标准化响应格式,避免信息泄露,提升前后端协作效率与系统健壮性。

热门文章

最新文章