SpringBoot手写自定义starter源码

 更新时间:2023年10月25日 09:53:08   作者:刻苦的樊同学  
这篇文章主要介绍了SpringBoot手写自定义starter源码,SpringBoot拥有很多方便使用的starter,比如spring-boot-starter-log4j、mybatis-spring-boot-starter.jar等,各自都代表了一个相对完整的功能模块,需要的朋友可以参考下

1,前言

(1)SpringBoot的优点

SpringBoot是新一代流行的Spring应用开发框架,它具有更多的优点:

  • 创建独立的Spring应用
  • 内嵌Tomcat、Jetty或Undertow(无需部署war包)
  • 提供自用的starter来简化构建配置
  • 提供指标监控、运行状况检查和外部化配置
  • 没有代码生成,也不需要XML配置(约定大于配置)

(2)SpringBoot-starter的作用

SpringBoot拥有很多方便使用的starter(Spring提供的starter命名规范spring-boot-starter-xxx.jar,第三方提供的starter命名规范xxx-spring-boot-starter.jar),比如spring-boot-starter-log4j、mybatis-spring-boot-starter.jar等,各自都代表了一个相对完整的功能模块。

SpringBoot-starter是一个集成接合器,完成两件事:

  • 引入模块所需的相关jar包
  • 自动配置各自模块所需的属性

2,为什么要自定义starter?

在我们的日常开发工作中,经常会有一些独立于业务之外的配置模块,我们经常将其放到一个特定的包下,然后如果另一个工程需要复用这块功能的时候,需要将代码硬拷贝到另一个工程,重新集成一遍,麻烦至极。如果我们将这些可独立于业务代码之外的功配置模块封装成一个个starter,复用的时候只需要将其在pom中引用依赖即可,SpringBoot为我们完成自动装配,简直不要太爽。

3,自定义starter的实现方式

首先新建一个maven工程,切记,只是一个maven工程而已,并非springboot工程!

(1)引入自动配置依赖和自动提示依赖

自动提示就是在properties或yml配置文件中输入时自动提示!

		<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
            <version>2.0.3.RELEASE</version>
        </dependency>
        <!--输入properties或yml会自动提示-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <version>2.1.3.RELEASE</version>
        </dependency>

(2)写一个TestBean,装载信息

public class TestBean {
    private String msg;
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
    @Override
    public String toString() {
        return "TestBean{" +
                "msg='" + msg + '\'' +
                '}';
    }
}

(3)写一个Properties类

该类上面的注解@ConfigurationProperties(prefix = "hello")是获取配置文件的配置前缀为hello的值,然后赋值给msg变量

@ConfigurationProperties(prefix = "hello")
public class HelloServiceProperties {
    private static final String MSG="hello world";
    private String msg=MSG;
    public static String getMSG() {
        return MSG;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
}

(4)写一个自动配置类 MyAutoConfiguration

引用定义好的配置信息;在AutoConfiguration中实现所有starter应该完成的操作,并且把这个类加入spring.factories配置文件中进行声明

@Configuration
@ConditionalOnClass({TestBean.class})//判断当前classpath下是否存在指定类,若是则将当前的配置装载入spring容器
@EnableConfigurationProperties(HelloServiceProperties.class)//激活自动配置(指定文件中的配置)
public class MyAutoConfiguration {
    @Autowired
    HelloServiceProperties helloServiceProperties;//注入测试的配置信息类
    @Bean
    @ConditionalOnMissingBean(TestBean.class) //当前上下文中没有TestBean实例时创建实例
    public TestBean getTestService(){
        TestBean testBean=new TestBean();
        testBean.setMsg(helloServiceProperties.getMsg());
        return testBean;
    }
}

完成上面的操作还不够,最重要的一步是接下来的一步 在resources文件夹下新建文件夹META-INF/spring.factories,将上面的自定义配置类MyAutoConfiguration的全路径名+类名配置到该文件中(遵循spring.factories的格式),这样随着项目的启动就可以实现自动装配! 文件内容

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.ftx.tomcat.bean.MyAutoConfiguration

(5)把本maven项目打包,上传到maven私服

使用maven构建工具打包自定义starter项目

mvn clean install

然后上传到maven私服上,再新建一个springboot项目,把私服和starter项目的maven依赖配置到pom文件中

<dependency>
            <groupId>com.ftx.starter</groupId>
            <artifactId>write-starter</artifactId>
            <version>1.3</version>
        </dependency>
<repositories>
        <repository>
            <id>nexus</id>
            <name>nexus</name>
            <url>http://nexus.tiger2.cn/nexus/content/groups/public/</url>
            <releases>
                <enabled>true</enabled>
            </releases>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </repository>
    </repositories>

可以找到对应的jar包

在这里插入图片描述

(6)测试

在新建的springboot项目中写一个TestController进行测试 注入TestBean,并使用TestBean

@RestController
@RequestMapping("/test")
public class TestController {
    @Autowired
    TestBean testBean;
    @RequestMapping("/user")
    public String user(){
        User user=new User();
        user.setName(testBean.getMsg());
        return user.toString();
    }
}

然后启动项目,访问//localhost:8080/test/user

在这里插入图片描述

因为TestBean的msg默认是hello world,可以在配置文件中自定义TestBean的msg信息

在这里插入图片描述

这就是自动提示的效果

在这里插入图片描述

然后重启项目,重新访问//localhost:8080/test/user

在这里插入图片描述

到这里就已经结束了!还没看出来starter的好处吗?

到此这篇关于SpringBoot手写自定义starter源码的文章就介绍到这了,更多相关自定义starter源码内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Spring中@EnableScheduling注解的工作原理详解

    Spring中@EnableScheduling注解的工作原理详解

    这篇文章主要介绍了Spring中@EnableScheduling注解的工作原理详解,@EnableScheduling是 Spring Framework 提供的一个注解,用于启用Spring的定时任务(Scheduling)功能,需要的朋友可以参考下
    2024-01-01
  • 使用Java7的Files工具类和Path接口来访问文件的方法

    使用Java7的Files工具类和Path接口来访问文件的方法

    下面小编就为大家分享一篇使用Java7的Files工具类和Path接口来访问文件的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2017-11-11
  • Servlet实现简单文件上传功能

    Servlet实现简单文件上传功能

    这篇文章主要为大家详细介绍了Servlet实现简单文件上传功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-10-10
  • Java生成唯一id的几种实现方式

    Java生成唯一id的几种实现方式

    本文主要介绍了Java生成唯一id的几种实现方式,主要介绍了5种方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-01-01
  • Linux下JDK安装教程

    Linux下JDK安装教程

    这篇文章主要为大家详细介绍了Linux下JDK安装教程,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-06-06
  • SpringBoot动态导出word文档实整教程(复制即可使用)

    SpringBoot动态导出word文档实整教程(复制即可使用)

    在我们做项目的时候会需要把数据库中的数据导出到word当中,下面这篇文章主要给大家介绍了关于SpringBoot动态导出word文档实整教程的相关资料,文中的代码复制即可使用,需要的朋友可以参考下
    2023-06-06
  • MyBatis-Plus中如何实现动态表名

    MyBatis-Plus中如何实现动态表名

    这篇文章主要介绍了MyBatis-Plus中如何实现动态表名问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-07-07
  • 项目管理利器-Maven(Windows安装)图文教程

    项目管理利器-Maven(Windows安装)图文教程

    下面小编就为大家带来一篇项目管理利器-Maven(Windows安装)图文教程。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-06-06
  • Java数据结构BFS广搜法解决迷宫问题

    Java数据结构BFS广搜法解决迷宫问题

    广搜BFS的基本思想是: 首先访问初始点v并将其标志为已经访问。接着通过邻接关系将邻接点入队。然后每访问过一个顶点则出队。按照顺序,访问每一个顶点的所有未被访问过的顶点直到所有的顶点均被访问过。广度优先遍历类似与层次遍历
    2022-04-04
  • SpringMVC框架中使用Filter实现请求日志打印方式

    SpringMVC框架中使用Filter实现请求日志打印方式

    这篇文章主要介绍了SpringMVC框架中使用Filter实现请求日志打印方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-10-10

最新评论