springboot实现自定义starter

最新推荐文章于 2024-08-23 08:20:27 发布

原创最新推荐文章于 2024-08-23 08:20:27 发布 · 179 阅读

0 ·

CC 4.0 BY-SA版权

springboot 专栏收录该内容

2 篇文章

订阅专栏

本文介绍了Spring Boot实现自定义Starter的方法。在上文阐述Spring Boot原理后，详细说明了创建Maven工程、编写配置文件类、配置类、自动配置类，创建spring.factories文件等步骤，还介绍了安装Starter及新建工程测试的过程。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

springboot实现自定义starter

上一篇文章说了springboot的原理，接下来就来实现自定义的starter

创建一个maven工程，名称为hello-starter，pom如下

<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>springboot-starter</groupId>
	<artifactId>hello-starter</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-autoconfigure</artifactId>
			<version>2.0.0.RELEASE</version>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-configuration-processor</artifactId>
			<version>2.1.6.RELEASE</version>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-compiler-plugin</artifactId>
				<configuration>
					<source>1.8</source>
					<target>1.8</target>
				</configuration>
			</plugin>
		</plugins>


	</build>
</project>

编写配置文件类HelloServiceProperties

package com.property;

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

@ConfigurationProperties
public class HelloServiceProperties {
	private String name;

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}
}

编写配置类HelloServiceConfiguration

package com.configuration;
public class HelloServiceConfiguration {
	private String name;

	public String getName() {
		return "name is:"+name;
	}

	public void setName(String name) {
		this.name = name;
	}
}

编写自动配置类HelloServiceAutoConfiguration

package com.configuration;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.property.HelloServiceProperties;

@Configuration
@EnableConfigurationProperties(HelloServiceProperties.class)
@ConditionalOnClass(HelloServiceConfiguration.class)
public class HelloServiceAutoConfiguration {
    @Autowired
    private HelloServiceProperties helloServiceProperties;

	@Bean
	@ConditionalOnMissingBean(HelloServiceConfiguration.class)
	public HelloServiceConfiguration helloServiceConfiguration() {
		HelloServiceConfiguration helloService = new HelloServiceConfiguration();
		helloService.setName(helloServiceProperties.getName());
		return helloService;
	}
}

src/main/resources目录下创建META-INF目录，然后创建spring.factories文件

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
 com.configuration.HelloServiceAutoConfiguration

配置文件application.properties内容如下

name=weir

运行mvn-install安装starter

新建一个maven工程来测试starter pom如下

<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>springboot-starter</groupId>
	<artifactId>hello-starter-test</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>1.5.4.RELEASE</version>
		<relativePath />
	</parent>
	
	<dependencies>
 		<dependency>
			<groupId>springboot-starter</groupId>
			<artifactId>hello-starter</artifactId>
			<version>0.0.1-SNAPSHOT</version>
		</dependency> 
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
	</dependencies>
	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-compiler-plugin</artifactId>
				<configuration>
					<source>1.8</source>
					<target>1.8</target>
				</configuration>
			</plugin>
		</plugins>


	</build>
</project>

启动类如下

package com.application;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.configuration.HelloServiceConfiguration;



@SpringBootApplication
@RestController
public class SpringbootApplication {
	@Autowired
	private HelloServiceConfiguration helloService;

	public static void main(String[] args) {
		SpringApplication.run(SpringbootApplication.class, args);
	}

	@RequestMapping("/name")
	public String getName() {
		return helloService.getName();
	}

}

启动工程访问http://localhost:9001/name 结果如下