starter的创建与引用

一.创建starter项目

首先在vscode里面创建一个spring boot项目，不需要添加任何依赖。把依赖配置文件里面的start依赖删除。

默认的pom.xml如下所示。

html 复制代码

<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>3.5.14</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.example</groupId>
	<artifactId>demo</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>demo</name>
	<description/>
	<url/>
	<licenses>
		<license/>
	</licenses>
	<developers>
		<developer/>
	</developers>
	<scm>
		<connection/>
		<developerConnection/>
		<tag/>
		<url/>
	</scm>
	<properties>
		<java.version>17</java.version>
	</properties>
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>

需要删除plugin和test,因为starter本质类似一个方法，不需要运行。

修改后的代码如下所示：

html 复制代码

<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>3.5.14</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.wuxianyang</groupId>
	<artifactId>hello</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>hello</name>
	  <description>一个简单的示例 Starter</description>

	<url/>
	<licenses>
		<license/>
	</licenses>
	<developers>
		<developer/>
	</developers>
	<scm>
		<connection/>
		<developerConnection/>
		<tag/>
		<url/>
	</scm>
	<properties>
		<java.version>17</java.version>
	</properties>
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</artifactId>
		</dependency>

		
	</dependencies>

	

</project>

这里的这一部分就是相当于声明这是一个starter,需要和引用它的项目pom.xml里面配置的依赖保持一致。

html 复制代码

<groupId>com.wuxianyang</groupId>
	<artifactId>hello</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>hello</name>
	  <description>一个简单的示例 Starter</description>

接着，正常写要用的工具方法，我的项目里面写了一个Hello方法，用来打印hello语句。

java 复制代码

package com.wuxianyang.hello;

public class MyService {
    
    public String sayHello(String name) {
        return "你好, " + name + "! 这是你的第一个 Starter！";
    }
}

接着，再写一个对应的自动配置类 ：这个类的作用是告诉 Spring Boot 如何创建我们的 HelloService 对象。它就像一个"生产车间"，负责把 HelloService 造出来，交给 Spring 管理。这样别人引用我们的 Starter 时，直接用 @Autowired 就能拿到 HelloService 了。你也可以把它理解为这个 Starter 对外提供的"使用接口"（不是 Java 中的 interface 关键字，而是宏观上的调用入口）。它的作用是把我们的 HelloService 创建出来并交给 Spring 管理。对于引用这个 Starter 的项目来说，只需要跟这个"接口"打交道，就能获得 HelloService 了。

java 复制代码

package com.wuxianyang.hello;

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

@Configuration
public class MyAutoConfiguration {

    @Bean
    public MyService myService() {
        return new MyService();
    }
}

另外，要配置一下org.springframework.boot.autoconfigure.AutoConfiguration.imports这个文件（Spring Boot 2.7 之后，官方推荐使用

META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports 文件来注册自动配置类，而不是旧的 spring.factories。新方式只需要在文件里一行写一个自动配置类的全限定名即可），这个文件要建立在resource/META-INF/spring下。这个文件里面的内容就是需要提供给使用该starter项目里面的工具类对应的自动配置类路径，可以写多个。这里我写的是com.wuxianyang.hello.MyAutoConfiguration。

我的项目目录结构如下：

当然，这里是需要动态注入（调用带参数的方法），所以要写自动配置类，如果是静态方法，就不用写了。

这里加一个静态的Myservice2来举个例子。

java 复制代码

package com.wuxianyang.hello;

public class MyService2{

    public static String sayHello2() {
        return "Hello, welcome to my starter!";
    }
}

如果有项目要引用这个方法，那就直接用类.方法名调用就行，不需要用@Autowired注入。

最后还需要打包放进maven仓库里面，才可以被引用，命令是mvn clean install

说一下mvn clean package 和mvn clean install的区别：

mvn clean package： 打包，生成 .jar 文件，放在 target 目录下。只打包，不安装。

mvn clean install： 打包 + 安装，生成的 .jar 文件会被复制到你本地的 Maven 仓库。这样其他项目才能引用它。

二.引用starter项目

这里我写了一个简单的测试项目。还是新建一个简单的spring boot项目，首先修改pom.xml文件。

加入依赖。

html 复制代码

<dependency>
			<groupId>com.wuxianyang</groupId>
	<artifactId>hello</artifactId>
	<version>0.0.1-SNAPSHOT</version>
		</dependency>

然后，编写一个简单的controller来测试是否引用成功

java 复制代码

package use.use;
import com.wuxianyang.hello.MyService;  // 注意：import 的是你 starter 里的包
import com.wuxianyang.hello.MyService2; 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {

    @Autowired
    private MyService myService;  // Spring 会自动把 starter 里的 MyService 注入进来

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

三.访问测试

在浏览器里面输入http://localhost:8080/hello,出现如下界面，代表访问成功

四.项目源码

大家感兴趣可以访问我的gitee:https://gitee.com/its-raining-heavily-outside-j/learning-java/tree/stater