springboot中的配置类Configuration

一、配置类的定义和作用

配置类是用来配置 Spring 应用程序上下文的 Java 类。它通过使用特定的注解和方法，为应用程序提供各种配置信息，使得 Spring 容器能够正确地初始化和管理应用程序的各个组件。

主要作用

1. 替代传统 XML 配置

   • 在传统的 Spring 应用中，通常使用 XML 文件来配置 bean、数据源、事务管理等。而在 Spring Boot 中，配置类可以替代大部分的 XML 配置，使得配置更加简洁、易读和易于维护。
   • 通过 Java 代码的方式进行配置，可以更好地利用现代编程语言的特性，如类型安全、面向对象编程等。

2. 定制化配置

   • 配置类可以根据应用程序的特定需求进行定制化配置。例如，可以配置数据源、事务管理器、安全设置、缓存策略等。
   • 可以根据不同的环境（开发、测试、生产）进行不同的配置，通过条件化配置注解（如@Profile）来实现环境特定的配置。

3. 整合第三方库

   • 当应用程序需要整合第三方库时，配置类可以提供必要的配置来集成这些库。例如，配置数据库连接池、消息队列、缓存服务器等。
   • 通过配置类，可以将第三方库的配置与 Spring Boot 的自动配置相结合，实现更加灵活和高效的应用程序配置。

常见的配置类注解和方法

1. @Configuration注解

   • 标记一个类为配置类。被标记的类将被 Spring 容器识别为配置类，并在启动时进行处理。
   • 配置类中可以包含@Bean方法，用于定义和配置 Spring bean。

2. @Bean方法

   • 在配置类中，使用@Bean注解的方法用于定义和配置 Spring bean。这些方法返回的对象将被 Spring 容器管理，并可以在其他地方通过依赖注入的方式使用。
   • @Bean方法可以接受参数，这些参数可以是其他 Spring bean 或者配置值，从而实现复杂的配置逻辑。

3. @ConditionalOnXXX注解

   • 条件化配置注解，用于根据特定的条件来决定是否创建某个 bean 或者进行特定的配置。例如，@ConditionalOnProperty注解可以根据配置文件中的属性值来决定是否进行配置。
   • 这些注解可以帮助实现环境特定的配置，使得应用程序在不同的环境下可以有不同的行为。

4. @EnableXXX注解

   • 启用特定的功能模块。例如，@EnableWebMvc注解用于启用 Spring MVC 功能，@EnableAsync注解用于启用异步方法执行功能等。
   • 这些注解通常会触发一些自动配置，使得应用程序能够使用相应的功能模块。

配置类的优势

1. 提高开发效率

   • 配置类使得配置更加直观和易于理解，减少了配置错误的可能性。开发人员可以直接在 Java 代码中看到配置的逻辑，而不需要在 XML 文件中查找和理解复杂的配置。
   • 配置类可以与代码一起进行版本控制，方便团队协作和项目维护。

2. 灵活性和可扩展性

   • 配置类可以根据应用程序的需求进行灵活的配置和扩展。可以通过添加新的@Bean方法或者修改现有方法的逻辑来满足不断变化的需求。
   • 可以通过继承和组合配置类的方式来实现更加复杂的配置逻辑，提高了配置的可扩展性。

3. 与自动配置相结合

   • Spring Boot 的自动配置功能可以根据应用程序的依赖和环境自动配置很多常见的功能模块。配置类可以与自动配置相结合，进行定制化的配置，使得应用程序既可以享受自动配置的便利，又可以满足特定的需求。
     以下是编写 Spring Boot 配置类的详细步骤：

二、配置类的编写

一、创建配置类

1. 创建一个普通的 Java 类，并使用@Configuration注解将其标记为配置类。

   @Configuration
   public class MyConfig {
       // 配置逻辑将在这里添加
   }
   

二、定义 Bean

1. 使用@Bean注解在配置类中定义 Spring Bean。这些方法返回的对象将被 Spring 容器管理。

   @Configuration
   public class MyConfig {
   
       @Bean
       public MyService myService() {
           return new MyServiceImpl();
       }
   }
   

   在上面的例子中，定义了一个名为myService的 Bean，它的实现类是MyServiceImpl。

三、配置属性

1. 可以使用@Value注解从配置文件中读取属性值，并将其注入到 Bean 中。

   @Configuration
   public class MyConfig {
   
       @Value("${my.property}")
       private String myProperty;
   
       @Bean
       public MyService myService() {
           MyServiceImpl service = new MyServiceImpl();
           service.setProperty(myProperty);
           return service;
       }
   }
   

   这里假设在配置文件中有一个属性my.property，通过@Value注解将其注入到MyService的实现类中。

四、条件化配置

1. 使用@ConditionalOnXXX注解根据特定条件进行配置。例如，根据某个属性的值来决定是否创建某个 Bean。

   @Configuration
   public class MyConfig {
   
       @Value("${my.condition}")
       private boolean condition;
   
       @Bean
       @ConditionalOnProperty(name = "my.condition", havingValue = "true")
       public MyService myService() {
           return new MyServiceImpl();
       }
   }
   

   在这个例子中，只有当配置文件中的属性my.condition的值为true时，才会创建MyService这个 Bean。

五、启用特定功能

1. 使用@EnableXXX注解启用特定的功能模块。例如，启用 Spring MVC 的功能。

   @Configuration
   @EnableWebMvc
   public class WebConfig implements WebMvcConfigurer {
       // 可以在这里进行 Spring MVC 的定制化配置
   }
   

六、配置数据源等复杂对象

1. 对于像数据源这样的复杂对象，可以使用专门的配置方法。

   @Configuration
   public class DataSourceConfig {
   
       @Value("${spring.datasource.url}")
       private String url;
   
       @Value("${spring.datasource.username}")
       private String username;
   
       @Value("${spring.datasource.password}")
       private String password;
   
       @Bean
       public DataSource dataSource() {
           DriverManagerDataSource dataSource = new DriverManagerDataSource();
           dataSource.setUrl(url);
           dataSource.setUsername(username);
           dataSource.setPassword(password);
           return dataSource;
       }
   }
   

   这里配置了一个简单的数据源，从配置文件中读取数据库连接信息。

七、配置类的组织和继承

1. 如果有多个配置类，可以根据功能进行组织。例如，可以有专门的配置类用于数据库配置、安全配置、缓存配置等。

2. 配置类可以继承其他配置类，以复用配置逻辑。

   @Configuration
   public class BaseConfig {
   
       @Bean
       public CommonService commonService() {
           return new CommonServiceImpl();
       }
   }
   
   @Configuration
   public class AppConfig extends BaseConfig {
       // 可以添加特定于应用的配置
   }
   

三、具体案例

以下是一个具体的 Spring Boot 配置类案例，假设我们有一个图书管理系统，需要配置数据源和一个自定义的服务类。

1. 配置数据源

创建一个DataSourceConfig配置类来配置数据源：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jdbc.datasource.DriverManagerDataSource;

import javax.sql.DataSource;

@Configuration
public class DataSourceConfig {

    @Value("${spring.datasource.url}")
    private String url;

    @Value("${spring.datasource.username}")
    private String username;

    @Value("${spring.datasource.password}")
    private String password;

    @Bean
    public DataSource dataSource() {
        DriverManagerDataSource dataSource = new DriverManagerDataSource();
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
    }
}

在这个配置类中，从应用的配置文件中读取数据库连接信息，并创建一个DriverManagerDataSource作为数据源的 Bean。

2. 自定义服务类配置

创建一个BookServiceConfig配置类来配置自定义的图书服务类：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class BookServiceConfig {

    @Bean
    public BookService bookService() {
        return new BookServiceImpl();
    }
}

这里定义了一个名为bookService的 Bean，它的实现类是BookServiceImpl。

3. 实体类

假设我们有一个图书实体类Book：

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class Book {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String title;
    private String author;

    // 构造函数、getter 和 setter 方法
}

4. Mapper 接口

创建一个图书的 Mapper 接口BookMapper：

import org.apache.ibatis.annotations.Mapper;
import java.util.List;

@Mapper
public interface BookMapper {

    List<Book> findAll();
    Book findById(Long id);
    void save(Book book);
    void update(Book book);
    void deleteById(Long id);
}

5. Service 接口和实现类

BookService接口：

import java.util.List;

public interface BookService {

    List<Book> findAllBooks();
    Book findBookById(Long id);
    void addBook(Book book);
    void updateBook(Book book);
    void deleteBookById(Long id);
}

BookServiceImpl实现类：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class BookServiceImpl implements BookService {

    @Autowired
    private BookMapper bookMapper;

    @Override
    public List<Book> findAllBooks() {
        return bookMapper.findAll();
    }

    // 其他方法的实现
}

6. Controller 类

创建一个图书的控制器BookController：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/books")
public class BookController {

    @Autowired
    private BookService bookService;

    @GetMapping
    public List<Book> getAllBooks() {
        return bookService.findAllBooks();
    }

    // 其他 HTTP 方法的处理
}