Spring配置扩展之JavaConfig的使用小结

JavaConfig 的概念

什么是JavaConfig？

JavaConfig 是 Spring 框架中基于纯 Java 代码的配置方式，用于替代传统的 XML 配置。通过注解（如 @Configuration、@Bean）定义 Spring 容器的组件和依赖关系，使配置更加类型安全且易于维护。

为什么使用 JavaConfig？

类型安全：Java 代码在编译时即可检查类型错误，而 XML 配置需运行时才能发现潜在问题。
可读性强：逻辑清晰的 Java 代码比 XML 更直观，便于理解组件之间的关系。
便于重构：IDE 对 Java 代码的支持更完善（如自动补LmUnofI全、引用跳转），而 XML 缺乏此类工具支持。
模块化配置：通过 @Import 注解可拆分多个配置类，灵活组合不同模块。
与注解驱动开发协同：结合 @ComponentScan 等注解，能无缝整合自动扫描和显式配置。

JavaConfig 的核心注解

• @Configuration：标记类为配置类，替代 XML 配置文件。
• @Bean：在方法上声明返回的对象由 Spring 容器管理，替代 <bean> 标签。
• @ComponentScan：自动扫描指定包下的组件（如 @Service、@Repository）。

示例代码：

@Configuration
@ComponentScan("com.example")
public class AppConfig {
    @Bean
    public DataSource dataSource() {
        return new DriverManagerDataSource("jdbc:mysql://localhost:3306/db");
    }
}

JavaConfig配置常用注解

@Configuration

标注一个类为配置类，替代传统的XML配置文件。Spring容器会将该类中定义的Bean纳入管理。

@Bean

在配置类的方法上使用，将方法返回值注册为Spring容器中的Bean。默认以方法名作为Bean名称，可通过name属性指定别名。

@Configuration
public class AppConfig {
    @Bean(name = "dataSource")
    public DataSource createDataSource() {
        return new DruidDataSource();
    }
}

@Qualifier

当存在多个同类型Bean时，通过指定Bean名称解决依赖注入的歧义性问题。需配合@Autowired或@Resource使用。

@Autowired
@Qualifier("mysqlDataSource")
private DataSource dataSource;

@Primary

标注在Bean定义上，表示当存在多个同类型Bean时优先注入被标记的Bean。与@Qualifier的区别在于这是提供方标记而非消费方指定。

@Bean
@Primary
public DataSource primaryDawww.chinasem.cntaSource() {
    return new HikariDataSource();
}

@PropertySource

加载指定的properties或YAML配置文件到Spring环境。支持classpath前缀和文件系统路径，多个文件可用数组形式配置。

@Configuration
@PropertySource({"classpath:db.properties", "file:/etc/app/config.yml"})
public class PropertyConfig {}

@Value

注入配置文件中的属性值，支持SpEL表达式。可设置默认值避免属性不存在时报错。

@Value("${jdbc.url:jdbc:mysql://localhost/default}")
private String dbUrl;

@Value("#{systemProperties['user.timezone']}")
private String timezone;

@ComponentScan

自动扫描指定包路径下的组件（@Component/@Service/@Repository等）。可通过excludeFilters排除特定http://www.chinasem.cn组件。

@Configuration
@ComponentScan(
    basePackages = "com.example",
    excludeFilters = @Filter(type = FilterType.REGEX, pattern = ".*Test.*")
)
public class ScanConfig {}

在Spring框架中，JavaConfig可以通过注解方式加载其他配置，包括XML或JavaConfig。以下是两种核心方法的具体使用方式：

JavaConfig加载其他配置

@ImportResource注解加载XML配置

该注解用于在JavaConfig中引入XML格式的配置文件，适用于需要兼容旧版XML配置或混合配置的场景。

@Configuration
@ImportResource("classpath:application-context.xml")
public class AppConfig {
    // 主配置类内容
}

• 路径格式：支持classpath:、file:等Spring资源前缀。
• 多文件加载：可通过数组形式指定多个文件：

  @ImportResource({"classpath:config1.xml", "classpath:config2.xml"})
  

@Import注解加载其编程他JavaConfig

该注解用于引入其他Java配置类，实现配置模块化。

@Configuration
@Imjavascriptport({DatabaseConfig.class, SecurityConfig.class})
public class AppConfig {
    // 主配置类内容
}

• 链式导入：被导入的配置类可以继续使用@Import嵌套其他配置。
• 自动装配：导入的配置类中定义的Bean会被自动注册到容器。

混合使用场景

两种注解可以同时使用，实现XML与JavaConfig的混合配置：

@Configuration
@Import(DatabaseConfig.class)
@ImportResource("classpath:services.xml")
public class AppConfig {
    // 综合配置类
}

注意事项

• 路径解析：XML文件需放在资源目录下，确保编译后存在于classpath中。
• 循环依赖：避免配置类之间相互导入形成循环引用。
• Bean覆盖：后加载的配置中同名Bean会覆盖先前定义的Bean。

到此这篇关于Spring配置扩展之JavaConfig的使用小结的文章就介绍到这了,更多相关Spring JavaConfig内容请搜索China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程China编程(www.chinasem.cn)！