SpringBoot自定义starters

SpringBoot自定义startersSpringBoot自定义starters1、简介2、如何自定义starter1、简介SpringBoot最强大的功能就是把我们常用的场景 抽象成一个个starter(场景启动器),我们通过引入springBoot为我们提供这些场景启动器,我们再进行少量的配置就能使用相应的功能。但是,SpringBoot不能包含所有的场景,经常需要我们自定义starter,来简化我们对springBoot的使用。2、如何自定义starter…

大家好,又见面了,我是你们的朋友全栈君。如果您正在找激活码,请点击查看最新教程,关注关注公众号 “全栈程序员社区” 获取激活教程,可能之前旧版本教程已经失效.最新Idea2022.1教程亲测有效,一键激活。

Jetbrains全家桶1年46,售后保障稳定

1、简介

SpringBoot最强大的功能就是把我们常用的场景抽象成一个个starter(场景启动器),我们通过引入springBoot为我们提供这些场景启动器,我们再进行少量的配置就能使用相应的功能。但是,SpringBoot不能包含所有的场景,经常需要我们自定义starter,来简化我们对springBoot的使用。

2、如何自定义starter

2.1、编写自定义模块

根据SpringBoot官方的介绍,一般情况下我们需要创建两个模块,一个是autoconfigure,一个是starter,autoconfigure里面装着自定义配置类,而starter只是负责向外提供调用的接口,所以下面我们先创建了几个模块

2.1.1、一个父模块和两个子模块

SpringBoot创建父子级Maven项目

在这里插入图片描述

2、创建完成之后,我们需要在starter的pom文件中引入autoconfigure,又因为我们这个是以web首页为例子,所以还要在autoconfigure里面引入web的starter启动器。

<!-- 还需要检查父项目的pom文件是否有 -->
<packaging>pom</packaging>

Jetbrains全家桶1年46,售后保障稳定

starter的pom文件:

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>springboot_custom_starter</artifactId>
        <groupId>cool.ale</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <description>
        自定义启动器starter
    </description>

    <artifactId>dujlc-spring-boot-starter</artifactId>

    <dependencies>
        <!-- 引入autoconfigure -->
        <dependency>
            <groupId>cool.ale</groupId>
            <version>0.0.1-SNAPSHOT</version>
            <artifactId>dujlc-spring-boot-autoconfigure</artifactId>
        </dependency>

        <!-- 如果需要引用其它的类库,可以在这里引用 -->
    </dependencies>


</project>

autoconfigure的pom文件:

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>springboot_custom_starter</artifactId>
        <groupId>cool.ale</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

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

        <!-- 导入配置文件处理器,配置文件进行绑定就会又提示 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>


</project>

2.1.2、写上相应的配置类等等

一共涉及到三个Java类

类名称 含义
HelloAutoConfiguration 自动配置类,可调用我们自动配置实现的具体功能
HelloProperties 自动配置属性文件,配置着我们的这个自动配置可设置哪些属性
IndexController HelloAutoConfiguration 调用的具体实现

代码举例如下:

HelloAutoConfiguration

package com.starter.ale;

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

@Configuration
// 必须要配置这个属性才会生效
@ConditionalOnProperty("cool.ale.starter.name")
@EnableConfigurationProperties(HelloProperties.class)
public class HelloAutoConfiguration { 
   

    @Autowired
    private HelloProperties helloProperties;

    /** * 为web应用添加一个首页 */
    @Bean
    public IndexController indexController(){ 
   
        return new IndexController(helloProperties);
    }
}

HelloProperties

package com.starter.ale;

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

@ConfigurationProperties("cool.ale.starter")
public class HelloProperties { 
   

    private String name;

    public String getName() { 
   
        return name;
    }

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

IndexController

package com.starter.ale;


import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class IndexController { 
   

    HelloProperties helloProperties;

    public IndexController() { 
   }

    public IndexController(HelloProperties helloProperties) { 
   
        this.helloProperties = helloProperties;
    }

    /** * 首页 * @return */
    @RequestMapping("/")
    public String index(){ 
   
        return helloProperties.getName() + "欢迎你";
    }
}

在这里我们发现一个问题,就是HelloProperties类里面的注解报错,我们需要做如下操作:

在这里插入图片描述

我们发现勾选之后还报错,这个其实已经和编码没有关系了,只是一个提示,我们可以通过下面的方法让报错不提示:

在这里插入图片描述

在报错行上alt+enter键,弹出如下图所示框,依次选中即可(先忽略图中代码,这是我从另一个项目截的图),原来的代码是第二张图的@ConfigurationProperties报错:

在这里插入图片描述
在这里插入图片描述

2.1.3、定义spring.factories

定义这个文件的目的就是让SpringBoot找到我们的自定义的自动配置类,如下所示:

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.starter.ale.HelloAutoConfiguration

在这里插入图片描述

2.1.4、依次打包

代码书写完之后,我们将这三个打包,一定要注意打包顺序,starter在最后打包,依次点击三个包的install,如下图所示:

在这里插入图片描述

2.1.5、使用其它模块进行调用

1、在其它模块中的全局配置文件中配置下面属性:

cool.ale.starter.name="ale"

2、启动首页访问,如下图所示:

在这里插入图片描述

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/203465.html原文链接:https://javaforall.net

(0)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • java xml与实体类转换「建议收藏」

    java xml与实体类转换「建议收藏」@XmlRootElement注解定义xml的根节点通过name改变根节点的xml值          @XmlRootElement(name=”amimal_test”)@XmlType注解指定序列生成的xml节点顺序         @XmlType(propOrder={“id”,”age”,”name”,”bir

    2022年7月21日
    15
  • 十大经典排序算法+sort排序

    十大经典排序算法+sort排序本文转自:"十大经典排序算法",其中有动图+代码详解,本文简单介绍+个人理解。排序算法经典的算法问题,也是面试过程中经常被问到的问题。排序算法简单分类如下:这些排序算法的

    2022年7月4日
    23
  • 完美的 jpa 多表 原生sql 分页查询[通俗易懂]

    多表分页查询,强烈推荐原生sql一般需要两个方法,一个查条数,一个查当前页数据Page使用spring的page类@Query(value=””+””+”select”+”a.id,”+”a.title,”+”a.article…

    2022年4月14日
    73
  • 多进程多线程的区别_多进程和多线程效率

    多进程多线程的区别_多进程和多线程效率前一篇文章介绍了单任务的HTTP服务器,那么如何实现多任务的呢,本篇文章将实现HTTP服务的并发处理,分别从多进程,多线程,协程的方法来实现,代码有点多,引入了3个文件,重复度有点高,读者只看关键部分,就好了,主要是服务端的数据收发阶段。测试方法:将html文件方法和代码同路径下,运行代码,在浏览器中输入IP:端口/XX.html即可看到成功解析html文件(这里不讨论html中的内容,只需明白实现思路即可)如图:****1. 多进程实现HTTP服务器的并发import socketimport

    2022年8月8日
    9
  • c语言和java哪个好学_学java前要学C语言吗?java和C语言哪个好学?

    c语言和java哪个好学_学java前要学C语言吗?java和C语言哪个好学?在编程世界,只要一提到java,总会有人联想到C语言,仿佛这两者之间有着一种密不可分的联系,那么也会有外行人在选择学习编程时,会有类似于学java前是否需要学习C语言呢?或者说java和C语言哪个会比较好学?等等之类的问题。其实大家会有这样的问题倒也不奇怪,因为学习C语言就是在学习Java,因为C语言中至少80%的语法知识都被Java继承了。Java刚开始的前半部分,如数据类型、变量、流…

    2022年7月7日
    26
  • checkedListBox如何获得选中项的text

    checkedListBox如何获得选中项的text最近的项目中用到了 checkedListB 这个控件 并且需要获得选中项的文本 直接贴代码 privatevoidb Click objectsender EventArgse stringchecke string Empty for inti 0 ithis my

    2025年11月9日
    3

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号