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)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • Android学习路线指南

    Android学习路线指南前言看到一篇文章中提到“最近几年国内的初级Android程序员已经很多了,但是中高级的Android技术人才仍然稀缺“,这的确不假,从我在百度所进行的一些面试来看,找一个适合的高级Android工程师的确不容易,一般需要进行大量的面试才能挑选出一个比较满意的。为什么中高级Android程序员不多呢?这是一个问题,我不好回答,但是我想写一篇文章来描述下Android的学习路线,期望可以帮助更多的…

    2022年6月11日
    36
  • fcn全卷积神经网络搭建_区域卷积神经网络

    fcn全卷积神经网络搭建_区域卷积神经网络文章目录简介核心思想网络结构上采样Upsampling跳级结构CNN与FCN的区别与联系网络训练过程存在问题【参考】简介全卷积网络(FullyConvolutionalNetworks,FCN)是JonathanLong等人于2015年在FullyConvolutionalNetworksforSemanticSegmentation一文中提出的用于图像语义分割的一种框架,是深度学习用于语义分割领域的开山之作。FCN将传统CNN后面的全连接层换成了卷积层,这样网络的输出将是热力图而非类

    2022年9月25日
    0
  • 网页在线视频下载教程(m3u8格式介绍及下载教程)「建议收藏」

    简介:m3u8文件是苹果公司使用的HTTPLiveStreaming(HLS)协议格式的基础。HLS是新一代流媒体传输协议,其基本实现原理为将一个大的媒体文件进行分片,将该分片文件资源路径记录与m3u8文件(即playlist)内,其中附带一些额外描述(比如该资源的多带宽信息等…)用于提供给客户端。客户端依据该m3u8文件可获取对应的媒体资源,进行播放。因此,客户端获取HLS流文件,主…

    2022年4月4日
    116
  • typescript web_jenkins自动编译

    typescript web_jenkins自动编译前言上一篇我们讲到如何手动编译TypeScript,如果我们每次都要手动编译,那么这样会很累,接下来就介绍自动编译TypeScript。mac自动编译typescript在Typescript文

    2022年8月7日
    2
  • docker搭建kafka集群

    docker搭建kafka集群docker搭建kafka集群我在M1mbp上使用的以下镜像新建文件zk-kafka-docker-compose.ymlversion:”2″services:zookeeper:user:rootimage:docker.io/zookeeperports:-“12181:2181″environment:-ALLOW_ANONYMOUS_LOGIN=yesvolumes:-zoo

    2022年4月25日
    26
  • c语言字符串去重_putchar输出字符串

    c语言字符串去重_putchar输出字符串输入一串字符,然后去重。如:输入aaabbbbd;输出应为abd;#include<iostream>#include<string>usingnamespacestd;intmain(){intn;cin>>n;//n表示你要处理多少组stringa;//定义字符串for(inti=0;i<n;…

    2025年6月16日
    0

发表回复

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

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