Spring Boot 约定大于配置：实现自定义配置

文章目录

• [Spring Boot 约定大于配置：实现自定义配置](#Spring Boot 约定大于配置：实现自定义配置)
• • 引言
  • [1. Spring Boot 的约定大于配置](#1. Spring Boot 的约定大于配置)
  • [2. 自定义配置的需求](#2. 自定义配置的需求)
  • [3. 实现自定义配置的步骤](#3. 实现自定义配置的步骤)
  • [4. 示例：自定义 Spring MVC 配置](#4. 示例：自定义 Spring MVC 配置)
  • • [4.1 创建自定义配置类](#4.1 创建自定义配置类)
    • [4.2 创建自定义拦截器](#4.2 创建自定义拦截器)
    • [4.3 测试自定义配置](#4.3 测试自定义配置)
  • [5. 其他自定义配置场景](#5. 其他自定义配置场景)
  • • [5.1 自定义数据源配置](#5.1 自定义数据源配置)
    • [5.2 自定义 Spring Security 配置](#5.2 自定义 Spring Security 配置)
  • [6. 总结](#6. 总结)

---

Spring Boot 约定大于配置：实现自定义配置

引言

Spring Boot 是一个基于 Spring 框架的快速开发框架，它的核心理念之一是 "约定大于配置" 。这意味着 Spring Boot 提供了许多默认配置，开发者只需要关注自己的业务逻辑，而不需要手动配置大量的细节。然而，在某些情况下，我们可能需要自定义配置来满足特定的需求。本文将介绍如何在 Spring Boot 中实现自定义配置，并通过实现接口和添加 @Configuration 注解来完成这一过程。

---

1. Spring Boot 的约定大于配置

Spring Boot 的"约定大于配置"理念体现在以下几个方面：

• 自动配置 ：Spring Boot 根据项目的依赖自动配置应用程序。例如，如果项目中引入了 spring-boot-starter-web，Spring Boot 会自动配置 Tomcat 和 Spring MVC。
• 默认配置 ：Spring Boot 提供了许多默认配置，例如默认的端口号是 8080，默认的静态资源路径是 classpath:/static 等。
• 简化配置 ：通过 application.properties 或 application.yml 文件，开发者可以轻松覆盖默认配置。

这种设计大大减少了开发者的配置工作量，使得开发者可以更专注于业务逻辑的实现。

---

2. 自定义配置的需求

尽管 Spring Boot 提供了许多默认配置，但在实际开发中，我们可能需要自定义一些配置。例如：

• 自定义 Bean 的加载顺序。
• 自定义某些组件的初始化逻辑。
• 根据环境变量动态加载配置。

为了实现这些需求，Spring Boot 提供了灵活的扩展机制，允许开发者通过实现接口和添加注解来自定义配置。

---

3. 实现自定义配置的步骤

在 Spring Boot 中，实现自定义配置通常需要以下步骤：

1. 实现 WebMvcConfigurer 或其他相关接口：根据需求选择合适的接口。
2. 添加 @Configuration 注解：将自定义配置类标记为 Spring 的配置类。
3. 重写接口方法：在配置类中重写接口的方法，实现自定义逻辑。

下面通过一个具体的示例来演示如何实现自定义配置。

---

4. 示例：自定义 Spring MVC 配置

假设我们需要自定义 Spring MVC 的配置，例如添加一个拦截器或修改静态资源路径。可以通过以下步骤实现：

4.1 创建自定义配置类

首先，创建一个类并实现 WebMvcConfigurer 接口。WebMvcConfigurer 是 Spring MVC 提供的接口，用于自定义 MVC 配置。

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration // 标记为配置类
public class CustomWebMvcConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 添加自定义拦截器
        registry.addInterceptor(new CustomInterceptor())
                .addPathPatterns("/**"); // 拦截所有请求
    }

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 自定义静态资源路径
        registry.addResourceHandler("/static/**")
                .addResourceLocations("classpath:/custom-static/");
    }
}

4.2 创建自定义拦截器

在上面的配置类中，我们添加了一个自定义拦截器。拦截器的实现如下：

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Component
public class CustomInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("CustomInterceptor: 请求被拦截");
        return true; // 继续执行后续逻辑
    }
}

4.3 测试自定义配置

启动 Spring Boot 应用程序后，访问任意路径，控制台会输出 CustomInterceptor: 请求被拦截，说明拦截器已生效。同时，静态资源路径也会被映射到 classpath:/custom-static/。

---

5. 其他自定义配置场景

除了自定义 Spring MVC 配置外，Spring Boot 还支持许多其他自定义配置场景。以下是一些常见的示例：

5.1 自定义数据源配置

通过实现 DataSourceInitializer 接口，可以自定义数据源的初始化逻辑。

import org.springframework.context.annotation.Configuration;
import javax.sql.DataSource;

@Configuration
public class CustomDataSourceConfig {

    @Bean
    public DataSource dataSource() {
        // 自定义数据源配置
        return new HikariDataSource();
    }
}

5.2 自定义 Spring Security 配置

通过继承 WebSecurityConfigurerAdapter 类，可以自定义 Spring Security 的配置。

import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@Configuration
@EnableWebSecurity
public class CustomSecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
            .antMatchers("/public/**").permitAll()
            .anyRequest().authenticated();
    }
}

---

6. 总结

Spring Boot 的"约定大于配置"理念极大地简化了开发流程，但在实际项目中，我们仍然需要根据需求自定义配置。通过实现相关接口（如 WebMvcConfigurer）并添加 @Configuration 注解，开发者可以灵活地扩展和定制 Spring Boot 的默认行为。

自定义配置的核心步骤如下：

1. 选择合适的接口（如 WebMvcConfigurer）。
2. 创建配置类并添加 @Configuration 注解。
3. 重写接口方法，实现自定义逻辑。

希望本文能帮助你更好地理解 Spring Boot 的自定义配置机制，并在实际项目中灵活运用！