Spring Boot 约定大于配置之如何实现自定义配置_Java

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 中，实现自定义配置通常需要以下步骤：

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

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

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();
    }
}