SpringBoot自己开发一个starter

提示:本文主要讲述如何自行开发一个SpringBoot的starter

文章目录

目录

文章目录

前言

一、Starter是什么

二、创建一个SpringBoot项目

1.创建一个基本的SpringBoot项目

2.选择要下载的库

三、设置项目

1.提示

2.配置pom.xml

3.重点代码

1.创建一个User类

 2.创建一个modelConfig类

3.创建一个DemoClient类

 4.目录结构

5.创建一个resources目录

 6.生成Starter

 四、使用

 1.配置文件

application.yml

 获取配置文件中的值

 获取传递过去的值

 五.结果

前言

开发这个主要是为了以后的工作可以更加轻松一点,能够快速的实现一些业务代码


一、Starter是什么

相信大家在学习的时候都有使用过Starter,但是应该还没有人自己动手制作过一个Starter吧,希望这期搭建一个简单的博客,可以帮助到大家

二、创建一个SpringBoot项目

1.创建一个基本的SpringBoot项目

2.选择要下载的库

 上面的这个库是必须下载的,是为了你将来给配置文件的写入的时候有代码提示的

 这个包我就不多介绍了,应该学习SpringBoot的都知道这个包

三、设置项目

1.提示

设置项目的maven的路径提示啊,JDK什么的我就这里不做了

2.配置pom.xml

    <groupId>com.xinggui</groupId>
    <artifactId>starter-demo</artifactId>
    <version>0.0.1</version>    

<build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>${java.version}</source>
                    <target>${java.version}</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

 

3.重点代码

1.创建一个User类

@Data
public class User {

    private String name;

    private Integer age;

    public User(String name, Integer age) {
        this.name = name;
        this.age = age;
    }


}

 2.创建一个modelConfig类

/**
 * 配置类,用于管理模型相关的配置属性。
 * 通过@ConfigurationProperties注解,指定了配置属性的前缀为"xinggui.demo"。
 * 使用@ComponentScan注解,指示Spring扫描指定包下的组件。
 */
@Configuration
@ConfigurationProperties(prefix = "xinggui.demo")
@Data
@ComponentScan
public class modelConfig {

    /**
     * 用户名称属性。
     */
    private String name;

    /**
     * 用户年龄属性。
     */
    private Integer age;

    /**
     * 定义一个Bean方法,返回一个User对象的字符串表示。
     * 此方法通过注入name和age属性创建一个新的User对象,并将其转换为字符串形式返回。
     * @return 返回一个包含用户姓名和年龄信息的字符串。
     */
    @Bean
    public String user(){
        return new User(name,age).toString();
    }
}

3.创建一个DemoClient类

public class DemoClient {

    private String name;

    private Integer age;

    public DemoClient(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    public String setUser(String userName, Integer passWord){
        return new User(name,age).toString();
    }

}

 4.目录结构

5.创建一个resources目录

 

# spring boot starter
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.xinggui.starterdemo.modelConfig
# com.xinggui.starterdemo.modelConfig位置写你自己的配置路径配置类

 6.生成Starter

 四、使用

打开另一个项目引入这个依赖

引入的依赖内容应该是

 1.配置文件

application.yml

xinggui:
  demo:
    name: xinggui
    age: 18

 获取配置文件中的值

 测试方式写法

 获取传递过去的值

 五.结果


要制作一个 Spring Boot Starter,首先需要了解什么是 Starter。 在 Spring Boot 中,Starter 是一种可重用的依赖项,它封装了特定功能的自动配置和相关依赖项。它使得在项目中引入某个功能变得非常简便,并且可以减少配置的复杂性。 下面是制作一个 Spring Boot Starter 的基本步骤: 1. 创建一个 Maven 或 Gradle 项目:首先创建一个空的 Maven 或 Gradle 项目作为 Starter 的基础。 2. 添加相关依赖:在项目的 pom.xml(或 build.gradle)文件中添加 Spring Boot Starter 相关的依赖项。你可以根据你的 Starter 需要封装的功能来选择合适的依赖项。 3. 创建自动配置类:创建一个自动配置类,命名为 `XxxAutoConfiguration`(Xxx 是你的 Starter 的名称),该类负责配置和初始化相关的组件和功能。 4. 创建 Starter 类:创建一个 Starter 类,命名为 `XxxStarter`,用于对外提供 Starter 功能的启动点。该类可以使用 `@EnableAutoConfiguration` 注解来启用自动配置。 5. 打包和发布:使用 Maven 或 Gradle 将项目打包成 JAR 文件,并发布到 Maven 仓库或本地仓库中,以供其他项目使用。 6. 添加文档和示例:编写清晰的文档和示例代码,帮助其他开发者了解如何使用你的 Starter。 以上是制作一个 Spring Boot Starter 的基本步骤,你可以根据具体的功能需求来定制你的 Starter。制作一个好的 Starter 可以提高开发效率,减少重复配置,使得项目更加模块化和可维护。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值