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


相关推荐

  • ipad 的android模拟器,iPad Simulator:免费Web版iPad模拟器

    iPadSimulator相关图片(图片来源:Techweb.com.cn)【TechWeb报道】1月6日消息,新酷网站:免费web版iPad模拟器看过SteveJobs演示iPad视频的朋友,肯定都非常想亲手把玩一下iPad,看看是什么感觉。之前体验过iPhone模拟器TestiPhone。今天介绍的alexw.me「iPadSimulator」是一个Web版的jQueryiPad…

    2022年4月6日
    155
  • idea激活码永久有效_最新在线免费激活[通俗易懂]

    (idea激活码永久有效)好多小伙伴总是说激活码老是失效,太麻烦,关注/收藏全栈君太难教程,2021永久激活的方法等着你。IntelliJ2021最新激活注册码,破解教程可免费永久激活,亲测有效,下面是详细链接哦~https://javaforall.net/100143.html08G05E7DZH-eyJsaWNlbnNlSW…

    2022年3月28日
    57
  • #Java算法设计与分析1–递归算法

    #Java算法设计与分析1–递归算法1.递归算法1.1递归的概念所谓递归,就是程序方法在运行过程中自身调用自身。定义如下所示。fn(){ if(递归出口条件){ returnx;}else{ //somecodes…returnfn();}}1.2递归的使用条件1.2.1必须要有明确的递归出口所谓递归出口就是需要有明确的结束条件。1.2.2每次递归都要使问题的规模减小1.2.3递归的规模…

    2022年7月8日
    21
  • Spring AOP 最热门面试题及答案「建议收藏」

    Spring AOP 最热门面试题及答案「建议收藏」译者的话前几天去京东面试,被问到AOP相关的问题,之前一直没有系统地学习相关的知识,答得不是很好。趁着假期,找了一下相关的资料,CSDN上有很多不错的文章,看了之后对AOP有比较好的理解了。然后Google了一下AOP相关面试题(AOPinterview),搜出来的第一条结果是一个叫HowToDoInJava的网站上的一篇文章TopSpringAOPIntervie…

    2022年8月11日
    7
  • DHCP简单配置-CISCO

    DHCP简单配置-CISCO

    2021年8月1日
    57
  • centos 7.5 内核版本_内核版本多少算好手机

    centos 7.5 内核版本_内核版本多少算好手机实验环境CentOS-7-x86_64-Minimal-1708.isoCentOSLinuxrelease7.4.1708(Core)Kernel3.10.0-693.el7.x86_64方案一:小版本升级连接并同步CentOS自带yum源,更新内核版本。此方法适用于更新内核补丁。具体实验步骤:sudoyumlistkernelsudoyumupdate-yke…

    2022年8月23日
    8

发表回复

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

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