Java高频面试题：SpringBoot如何自定义Starter？

大家好，我是锋哥。今天分享关于【Java高频面试题：SpringBoot如何自定义Starter？】面试题。希望对大家有帮助；

Java高频面试题：SpringBoot如何自定义Starter？

在Spring Boot中，自定义Starter是一种非常好的方式来封装、配置和共享常用的功能或库，以便在多个Spring Boot应用程序之间重用。自定义Starter可以打包成一个独立的JAR文件，包含你应用所需的配置、自动装配和依赖管理。

自定义Starter的步骤

1. 创建新项目

首先，你可以使用Spring Initializr或者手动创建一个新的Maven或Gradle项目。

使用Maven创建项目结构：

2. 编写 pom.xml

在Maven项目中，pom.xml 需要包含必要的依赖项，通常包括Spring Boot的spring-boot-autoconfigure和spring-boot-starter。以下是一个简单的pom.xml示例：

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>my-spring-boot-starter</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
    </dependencies>
</project>

3. 创建自动配置类

在你的MyAutoConfiguration.java中，定义想要自动配置的Bean。你必须在类上添加@Configuration注解，且通常会包括@EnableConfigurationProperties来读取配置属性。

package com.example.starter;

import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableAutoConfiguration
public class MyAutoConfiguration {

    @Bean
    public MyService myService() {
        return new MyService(); // 创建Service实例
    }
}

4. 创建业务逻辑类

在MyService.java中，编写你的业务逻辑。示例：

package com.example.starter;

public class MyService {
    public String sayHello() {
        return "Hello from MyService!";
    }
}

5. 创建配置属性类（可选）

如果你需要自定义的配置，可以创建一个属性类来绑定配置文件中的属性：

package com.example.starter;

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix = "my.config")
public class MyConfigProperties {
    private String message;

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

在MyAutoConfiguration.java中，记得将其注册成一个Bean：

@Bean
@ConfigurationProperties(prefix = "my.config")
public MyConfigProperties myConfigProperties() {
    return new MyConfigProperties();
}

6. META-INF/spring.factories

为了使Spring Boot能够识别你的自动配置类，需要在src/main/resources/META-INF目录下创建一个spring.factories文件，并添加以下内容：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.example.starter.MyAutoConfiguration

7. 发布自定义Starter

使用mvn clean install命令将你的Starter发布到本地Maven仓库，或者将其发布到远程仓库。

8. 使用自定义Starter

在你的Spring Boot应用中，添加对你自定义Starter的依赖。在应用的pom.xml中：

<dependency>
    <groupId>com.example</groupId>
    <artifactId>my-spring-boot-starter</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</dependency>

9. 配置和使用服务

在你的application.properties中，可以添加一些自定义的配置：

my.config.message=Hello, custom starter!

在你的应用中，通过依赖注入使用自定义服务 MyService：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    @Autowired
    private MyService myService;

    @GetMapping("/hello")
    public String hello() {
        return myService.sayHello();
    }
}

通过以上步骤，你就可以创建一个自定义的Spring Boot Starter了。这可以极大地提高代码的复用性和模块化，同时使得项目的依赖和配置变得更加集中和易于管理。