聊一聊带智能提示的spring-boot-starter

前言

前几个月和隔壁组的老王闲聊,他说项目的供应商离职率居高不下,最近还有开发刚接手ESB订阅发布接口才两周就提出离职,而他能做的就只有苦笑和默默地接过这个烂摊子了。
而然幸福的家庭总是相似的,而不幸的我却因业务变革走上了和老王一样的道路。单单是接口的开发居然能迫使一位开发毅然决然地离职,我既不相信是人性的扭曲,更不信是道德的沦丧。
抛开这个富有色彩的故事而言,我发现原来的项目存在如下问题:

  • 有使用任何现代依赖管理和构建工具(如Maven, Gradle),直接把所依赖的Jar包存放在项目目录下的lib目录中,日积月累导致lib目录下存放大量无用Jar包;
  • 没有使用代码版本管理工具管理代码;
  • 技术文档欠缺,全靠师傅带徒弟的方式传授框架使用方式和开发流程;
  • 机械性配置项多,而后来的开发人员大多只能依葫芦画瓢添加配置,既容易出错同时又增加问题排查的难度。
  • 针对前两个问题,我们只需梳理出必须的依赖项并加入Maven或Gradle管理,然后托管到Git即可。
  • 而后两者则可以通过spring-boot-starter将必选依赖项和配置统一管理,并附上相关技术文档;然后通过模板模式和注解简化开发流程,提供Demo降低入门难度。
  • 最后就可以把具体的业务功能开发交给供应商处理,我们专心做好过程管理和验收即可。

本文将着重分享spring-boot-starter开发的事项,请坐好扶稳!

命名规范

在自定义starter前我们总要思考如何命名我们的starter,而官方提供如下的命名规范:

1.官方的starter以spring-boot-starter作为前缀命名项目
如:spring-boot-starter-web

2.非官方的则以spring-boot-starter作为后缀命名项目
如:mybatis-spring-boot-starter

项目结构

通过Spring Initializr或Spring Boot CLI创建项目结构后,将pom.xml的相关项目修改为如下内容

<parent>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-parent</artifacId>
 <version>2.3.1.RELEASE</version>
 <relativePath/>
</parent>

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

 <!-- 下面为自定义Starter的依赖项 -->
</dependencies>

<build>
 <plugins>
  <plugin>
   <groupId>org.apache.maven.plugins</groupId>
   <artifactId>maven-compiler-plugin</artifactId>
   <configuration>
	<source>1.8</source>
	<target>1.8</target>
   </configuration>
  </plugin>
  <plugin>
   <groupId>org.apache.maven.plugins</groupId>
   <artifactId>maven-source-plugin</artifactId>
   <version>2.4</version>
   <executions>
	<execution>
	 <goals>
	  <goal>jar</goal>
	 </goals>
	</execution>
   </executions>
  </plugin>
 </plugins>
</build>

在starter中我们会定义SpringBean的注册配置和属性配置,如ESB订阅服务的配置项目为

@Configuration
@EnableConfigurationProperties({EsbServerProperties.class})
public class EsbServerConfiguration {
  @Bean
  public SpringBus springBus(){
    return new SpringBus();
  }

  @Bean
  public LoggingFeature loggingFeature(){
    return new LoggingFeature();
  }

  @Bean
  public List<JMSConfigFeature> jmsConfigFeatures(EsbServerProperties props) throws JMSException {
    List<JMSConfigFeature> features = new ArrayList<>();

    /**
     * 这里会使用EsbServerProperties的属性构建Bean实例
     */

    return features;
  }
}

属性配置项

// 从application.yml等配置文件中读取并绑定esb.server.destination等属性值
@Data
@ConfigurationProperties("esb.server")
public class EsbServerProperties {
  String destination;
  int currConsumers = 1;
  String channel;
  int ccsid = 1205;
  int transportType = 1;
  List<String> connectionNameLists;
  boolean replyError = false;
  String replySuccessText = "Success";
  String replyErrorText = "Failure";
}

到这里我们已经完成一个基本的starter的功能

  1. 通过@ConfigurationProperties定义该starter注册bean时需要的属性集合
  2. 通过@Configuration定义该starter注册的bean

但引用该starter的项目要如何启用配置呢?其实有两种方式,分别为手动和自动,其中我们会着重讲解自动启用配置。

手动启用配置

所谓手动启用配置其实就是在SpringBoot入口类上添加启用配置用的自定义注解,针对上面的EsbServerConfiguration我们可以自定义EnableESBSrv注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import({EsbServerConfiguration.class})
public @interface EnableEsbSrv {
}

然后入口类的@SpringBootApplication注解前后添加@EnableEsbSrv即可。

让人省心省力的自动启用配置

自动启用配置即只需在pom.xml中引入所依赖的starter,然后启用应用即可自动启用该starter的@Configuration所注解的类从而注册Bean和读取属性配置。
而这一切都是由AutoConfigurationImportSelector来操刀,而我们可以通过@EnableAutoConfiguration@SpringBootApplication等实例化AutoConfigurationImportSelector类,配合菜谱resources/META-INF/spring.factories实现自动化配置的功能。
具体手法就是:将EsbServerConfiguration的全限类名称写在resources/META-INF/spring.factories的org.springframework.boot.autoconfigure.EnableAutoConfiguration下, 若存在多个则用逗号分隔。

org.springframework.boot.autoconfigure.EnableAutoConfiguration = \
com.john.starter.EsbServerConfiguration,\
com.john.starter.OtherConfiguration

好与更好——集成IDE智能提示

应用启动时会将application.yml中对应的配置项绑定到@ConfigurationProperties标注的类实例上,那么对于应用开发人员而言日常工作就是修改application.yml的配置项。但IDE又缺少配置项的智能提示,那就很低效了。幸亏Spring Boot早就为我们提供好解决方案,分为手工和自动两种。为了效率当然是可以自动就不用手动的了。

1.Starter项目的工作引入spring-boot-configuration-processor依赖项;

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-configuration-processor</artifactId>
 <optional>true</optional>
</dependency>

2.若src/resources/META-INF/spring-configuration-metadata.json不存在,那么执行mvn compile时会生成target/classes/META-INF/spring-configuration-metadata.json;

3.复制target/classes/META-INF/spring-configuration-metadata.json到src/resources/META-INF/spring-configuration-metadata.json即可。

业务系统项目的工作

1.引入spring-boot-configuration-processor依赖项;

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-configuration-processor</artifactId>
 <optional>true</optional>
</dependency>

IDEA安装Spring Assistant插件,并启用Enable annotation processing(勾选 Settings/Build, Execution & Deployment/Compiles/Annotation Processors/Enable annotation processing)。

总结

spring-boot-starter非常适合用于团队的技术积累和沉淀,不过想恰到好处地应用起来,不仅要需要深入Spring内部原理还要梳理清楚业务逻辑。后续我们再深入探讨Spring内核的事情吧!

到此这篇关于聊一聊带智能提示的spring-boot-starter的文章就介绍到这了,更多相关springboot starter智能提示内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • SpringBoot入坑笔记之spring-boot-starter-web 配置文件的使用

    经过上一篇的介绍,相信小伙伴们已经按奈不住内心对springboot的向往,本篇我将继续向小伙伴介绍springboot配置文件的配置,已经全局配置参数如何使用,好了下面开始我们今天的内容介绍. 我们知道Spring Boot支持容器的自动配置,默认是Tomcat,当然我们也是可以进行修改的: 1.首先我们排除spring-boot-starter-web依赖中的Tomcat:在pom文件中排除tomcat的starter <dependency> <groupId>org.spr

  • SpringBoot封装自己的Starter的实现方法

    一.说明 我们在使用SpringBoot的时候常常要引入一些Starter,例如spring-boot-starter-web,官方为我们提供了几乎所有的默认配置,很好的降低了使用框架时的复杂度,所以在用xxx-starter的时候,可以不用费心去写一些繁琐的配置文件,即使必要的配置在application.properties或application.yml中配置就可以了,当你实现了一个Starter,可以在不同的项目中复用,非常方便,今天我们来编写自己的Starter以之前的短信业务为例.

  • springboot手写一个自己的starter源码

    springboot的最强大的就是那些xxxAutoconfiguration,但是这些xxxAutoConfiguration又依赖那些starter,只有导入了这些场景启动器(starter),我们很多自动配置类才能有用,并且还会新增一些功能,这次就来一起写个简单的starter,来看看内部到底是什么原理! 脑中大概有个印象:我们要用一个场景(比如web),直接导入下图所示的依赖,但是在jar包里面去看这个,你会发现里面只有一些基本的配置文件,什么类都没有,就能够想到这个一类就类似一个公司前

  • 聊一聊带智能提示的spring-boot-starter

    前言 前几个月和隔壁组的老王闲聊,他说项目的供应商离职率居高不下,最近还有开发刚接手ESB订阅发布接口才两周就提出离职,而他能做的就只有苦笑和默默地接过这个烂摊子了. 而然幸福的家庭总是相似的,而不幸的我却因业务变革走上了和老王一样的道路.单单是接口的开发居然能迫使一位开发毅然决然地离职,我既不相信是人性的扭曲,更不信是道德的沦丧. 抛开这个富有色彩的故事而言,我发现原来的项目存在如下问题: 有使用任何现代依赖管理和构建工具(如Maven, Gradle),直接把所依赖的Jar包存放在项目目录下

  • 详解spring boot starter redis配置文件

    spring-boot-starter-Redis主要是通过配置RedisConnectionFactory中的相关参数去实现连接redis service. RedisConnectionFactory是一个接口,有如下4个具体的实现类,我们通常使用的是JedisConnectionFactory. 在spring boot的配置文件中redis的基本配置如下: # Redis服务器地址 spring.redis.host=192.168.0.58 # Redis服务器连接端口 spring.

  • 深入浅析 Spring Boot Starter

    Spring Boot 简介 Spring框架功能很强大,但是就算是一个很简单的项目,我们也要配置很多东西.因此就有了Spring Boot框架,它的作用很简单,就是帮我们自动配置.Spring Boot框架的核心就是自动配置,只要存在相应的jar包,Spring就帮我们自动配置.如果默认配置不能满足需求,我们还可以替换掉自动配置类,使用我们自己的配置.另外,Spring Boot还集成了嵌入式的Web服务器,系统监控等很多有用的功,让我们快速构建企业及应用程序. 依赖管理是任何复杂项目的关键部

  • spring boot starter actuator(健康监控)配置和使用教程

    添加POM依赖: <!-- spring-boot-监控--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> <dependency> <groupId>org.springframework.bo

  • 如何手写一个Spring Boot Starter

    何为 Starter ? 想必大家都使用过 SpringBoot,在 SpringBoot 项目中,使用最多的无非就是各种各样的 Starter 了.那何为 Starter 呢?你可以理解为一个可拔插式的插件(组件).或者理解为场景启动器. 通过 Starter,能够简化以前繁杂的配置,无需过多的配置和依赖,它会帮你合并依赖,并且将其统一集成到一个 Starter 中,我们只需在 Maven 或 Gradle 中引入 Starter 依赖即可.SpringBoot 会自动扫描需要加载的信息并启动

  • 手撸一个Spring Boot Starter并上传到Maven中央仓库

    目录 打包上传到中央仓库 第一步 在issues.sonatype.org注册一个账号 第二步 在issues.sonatype.org提交Issue 第三步 配置Maven Setting.xml 第四步 配置项目的pom.xml 第五步 安装和配置GPG 第六步 项目打包上传 第七步 处理验证 问题 我1.0.1版本发布错了,有办法修改或者删除吗? 先手撸一个Spring Boot Starter 准备搞个项目,包含以下几个功能后边还会加新功能. 配置项加密(已实现) 服务调用链 数据脱敏

  • PowerShell使用枚举变量定义带智能提示功能的函数参数

    本文介绍在自定义PowerShell函数时,如何设置函数可以使用枚举变量智能提示参数值.枚举类型可以是.NET框架下的系统枚举类型. 在PowerShell 3.0版本中,出现了一项新的功能,那就是参数值的智能提示.当然,不是随便在哪里都会智能提示参数值,而是只能在ISE中.当然,所谓的ISE就是PowerShell自带的一个集成开发环境. 本文要介绍的是,使用系统自带的枚举变量来作为智能提示的列举选项. 我们把之前的Select-Color再拿出来看看, 复制代码 代码如下: function

  • 如何实现自己的spring boot starter

    前言 在使用spring boot开发的时候,我们有时候想要把自己的代码打包成类似spring-boot-starter-web的样式来导入到自己的中央仓库,然后其他项目就可以引用类似springboot那样的引用了,下面我们就实现一个类似的项目. 1.新建一个spring boot 项目,取名为mybootspringbootstarter,groupId和artifactId如下所示 <groupId>com.my.boot</groupId> <artifactId&g

  • spring boot集成p6spy的最佳实践

    目录 前言 p6spy-spring-boot-starter快速集成 第一步:导入依赖 第二步:配置application.properties 配置智能提示 兼容原生所有配置项 前言 P6Spy是一个框架,它可以无缝地拦截和记录数据库活动,而无需更改现有应用程序的代码.一般我们使用的比较多的是使用p6spy打印我们最后执行的sql语句.常用的数据框架也会自带打印sql的功能,比如jpa,mybatis等,但是一般都会有缺陷,比如打印的sql是不带执行参数拼接的sql,这种sql不完整,不具有

  • Spring Boot自定义配置实现IDE自动提示功能

    一.背景 官方提供的spring boot starter的配置项,我们用IDE配置的时候一般都有自动提示的,如下图所示 而我们自己自定义的配置却没有,对开发非常不友好容易打错配置, 那这个是怎样实现的呢? 二.提示原理 IDE是通过读取配置信息的元数据而实现自动提示的,而元数据在目录 META-INF 中的 spring-configuration-metadata.json 或者 additional-spring-configuration-metadata.json 三.实现自动提示 以

随机推荐