详解SpringBoot如何自定义一个Starter

更新时间：2022年11月16日 08:22:14 作者：一只小coder

小伙伴们曾经可能都经历过整天写着CURD的业务，都没写过一些组件相关的东西，这篇文章记录一下SpringBoot如何自定义一个Starter。原理和理论就不用多说了，可以在网上找到很多关于该方面的资料，这里主要分享如何自定义

需求

在一个项目中，用户需要发送消息，可以通过邮件，QQ，微信，钉钉，飞书等，目前这些发送消息的方式都已经提供了公开的API，想要实现在项目中通过简单的配置各个发发送方的发送方信息，然后直接调用发送的API，发送信息即可，下面举个例子：

配置

message:
  email:
    username: Aden
    password: 123456
    key: HJFHADJSFBDASFHUADSINF
    api-url: http://blog.qiyuan.run
  feishu:
    user-name: Aden
    pass-word: 654321
    key: HFJKADSBFJKADSJFKADSNFAD
    api-url: http://blog.qiyuan.run

调用

    @Autowired
    SendEmailMessageServiceImpl emailMessageService;
    
    @Autowired
    SendFeishuMessageServiceImpl feishuMessageService;

    public boolean sendEmail(String msg) {
        return emailMessageService.sendMessage(msg);
    }
    
    public boolean sendFeishu(String msg){
        return feishuMessageService.sendMessage(msg);
    }

效果的就是以上这样，只要通过配置需要发送消息的配置，自动注入发送消息的API，就可以实现发送消息了，以下是实现过程。

starter创建

第一步，需要为你的starter取一个响亮的名字，spring的官方文档中说明，官方的 starter 的命名格式为 spring-boot-starter-{xxxx} 比如spring-boot-starter-activemq第三方我们自己的命名格式为 {xxxx}-spring-boot-starter。比如mybatis-spring-boot-starter，此处，我命名为message-spring-boot-starter

自定义配置信息类

因为要在项目中的配置文件中写配置信息，所以在这个starter中，我们需要通过一个配置信息类来接收配置的信息。

@ConfigurationProperties(prefix = "message")
@Data
public class MessageProperties {
    /**
     * 邮箱消息
     */
    private MessageConfigInfo email = new MessageConfigInfo();
    /**
     * 飞书消息
     */
    private MessageConfigInfo feishu = new MessageConfigInfo();

    @Data
    public static class MessageConfigInfo {
        /**
         * 用户名
         */
        private String userName;
        /**
         * 密码
         */
        private String passWord;
        /**
         * 秘钥
         */
        private String key;
        /**
         * 消息发送API
         */
        private String apiUrl;
    }
}

发送消息的实现

由于需要通过这个starter实现发送消息，所以这里可能得要引入发送邮件，发送飞书的官方API，这里就不搞这么复杂了，主要还是看过程，自定义一个接口模拟一下即可。

模拟接口定义

public interface SendMessageService {
    Boolean sendMessage(String message);
}

模拟接口实现

public class SendEmailMessageServiceImpl implements SendMessageService {

    private MessageProperties messageProperties;

    public SendEmailMessageServiceImpl(MessageProperties messageProperties) {
        this.messageProperties = messageProperties;
    }

    @Override
    public Boolean sendMessage(String message) {
        System.out.println(messageProperties.toString() + "  开发发送邮件，发送内容为：" + message);
        return true;
    }
}

public class SendFeishuMessageServiceImpl implements SendMessageService {

    private MessageProperties messageProperties;

    public SendFeishuMessageServiceImpl(MessageProperties messageProperties) {
        this.messageProperties = messageProperties;
    }

    @Override
    public Boolean sendMessage(String message) {
        System.out.println(messageProperties.toString() + "  开发发送邮件，发送内容为：" + message);
        return true;
    }
}

自动配置类

@EnableConfigurationProperties(value = MessageProperties.class)
@Configuration
public class MessageAutoConfiguration {
    /**
     * 给发送邮件的实现类，注入配置信息
     * @param messageProperties
     * @return
     */
    @Bean
    public SendEmailMessageServiceImpl emailMessageConfig(MessageProperties messageProperties){
        return new SendEmailMessageServiceImpl(messageProperties);
    }


    /**
     * 给发送飞书的实现类，注入配置信息
     * @param messageProperties
     * @return
     */
    @Bean
    public SendFeishuMessageServiceImpl feishuMessageConfig(MessageProperties messageProperties){
        return new SendFeishuMessageServiceImpl(messageProperties);
    }
}

spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=run.qiyuan.message.config.MessageAutoConfiguration

项目结构

编写完之后，mvn install即可。

如何使用该starter

在我们的项目中，引入自定义starter的坐标

        <dependency>
            <groupId>run.qiyuan</groupId>
            <artifactId>message-spring-boot-starter</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

然后在配置文件中配置相关的信息

message:
  email:
    username: Aden
    password: 123456
    key: HJFHADJSFBDASFHUADSINF
    api-url: http://blog.qiyuan.run
  feishu:
    user-name: Aden
    pass-word: 654321
    key: HFJKADSBFJKADSJFKADSNFAD
    api-url: http://blog.qiyuan.run

测试

@SpringBootApplication
public class TeachApplication {

    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(TeachApplication.class, args);
        SendEmailMessageServiceImpl emailMessageService = context.getBean(SendEmailMessageServiceImpl.class);
        emailMessageService.sendMessage("你好，Starter!，这是一封邮件信息！\n\n");
        SendFeishuMessageServiceImpl feishuMessageService = context.getBean(SendFeishuMessageServiceImpl.class);
        feishuMessageService.sendMessage("你好，Starter!，这是一封飞书信息！");
    }
}

以上就是详解SpringBoot如何自定义一个Starter的详细内容，更多关于SpringBoot自定义Starter的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

使用jib插件为Java应用构建镜像的方法
这篇文章主要介绍了使用jib插件为Java应用构建镜像,要是用户本地没安装docker，可以使用jib制作出带有镜像的tar文件，本文通过实例代码给大家介绍的非常详细，需要的朋友可以参考下
2022-08-08
CentOS7和8中安装Maven3.8.4的简单步骤
maven是属于apache的一个工具,主要是对java进行编译打包,解决依赖关系,下面这篇文章主要给大家介绍了关于CentOS7和8中安装Maven3.8.4的相关资料,需要的朋友可以参考下
2022-04-04
一文带你搞懂Java中的泛型和通配符
泛型机制在项目中一直都在使用，甚至很多源码中都用到了泛型机制。但是里面很多的机制和特性一直没有明白，尤其通配符这块，经常忘记。本文对此做了一些总结，具有一定借鉴价值，希望有所帮助
2022-09-09
JavaWeb实现邮件发送接收功能
这篇文章主要为大家详细介绍了JavaWeb邮件发送接收功能的实现，邮件发送和接收功能是非常常用的功能，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2015-12-12
SWT(JFace)体验之List演示汇总
SWT(JFace)体验之List演示代码汇总
2009-06-06
java字符串反转的7种方法
本文主要介绍了java字符串反转的7种方法，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-02-02
一文深入理解Java中的深拷贝机制
在Java编程中,我们经常需要处理对象的复制问题,深拷贝和浅拷贝是两种常见的复制方式,它们在内存管理和对象引用方面存在不同特点,本文将带大家深入探究Java中的深拷贝机制,需要的朋友可以参考下
2023-09-09
JDBC获取元数据demo
这篇文章主要为大家介绍了JDBC获取元数据实现示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-11-11
Filter在springboot中的使用方法详解
这篇文章主要介绍了Filter在springboot中的使用方法详解,filter（过滤器）作用于在intreceptor(拦截器)之前，不像intreceptor一样依赖于springmvc框架，只需要依赖于serverlet,需要的朋友可以参考下
2023-08-08
全网最精细详解二叉树,2万字带你进入算法领域
大家好,我是哪吒,一个热爱编码的Java工程师,本着"欲速则不达,欲达则欲速"的学习态度,在程序猿这条不归路上不断成长,所谓成长,不过是用时间慢慢擦亮你的眼睛,少时看重的,年长后却视若鸿毛,少时看轻的,年长后却视若泰山,成长之路,亦是渐渐放下执念,内心归于平静的旅程
2021-08-08