1、基础配置

1.1、工程结构

使用maven的聚合模式创建多个module

1.2、集成插件POM改造

主程序pom中引入依赖:
 
<dependency>    
    <groupId>com.gitee.starblues</groupId>
    <artifactId>spring-brick</artifactId>
    <version>${spring-brick.version}</version>
</dependency>
 
主程序打包方式:
 
<plugin>   
     <groupId>com.gitee.starblues</groupId>
        <artifactId>spring-brick-maven-packager</artifactId>
        <version>${spring-brick.version}</version>
        <configuration>
                <mode>main</mode>
                <mainConfig>
                    <mainClass>com.demo.main.Application</mainClass>
                </mainConfig>
            </configuration>
        <executions>
                <execution>
                    <goals>
                        <goal>repackage</goal>
                    </goals>
                </execution>
            </executions>
</plugin>


其中configuration配置中的mode固定写成 main

mainClass则是主程序的启动类的全路径

插件pom中引入依赖
 
<dependency>   
    <groupId>com.gitee.starblues</groupId>
    <artifactId>spring-brick-bootstrap</artifactId>
    <version>${spring-brick.version}</version>
</dependency>
 
插件打包方式
 
<plugin>   
        <groupId>com.gitee.starblues</groupId>
        <artifactId>spring-brick-maven-packager</artifactId>
        <version>${spring-brick.version}</version>
        <configuration>
                <mode>prod</mode>
                <pluginInfo>
                    <id>preprocess-plugin</id>
                    <bootstrapClass> com.demo.preprocess.plugin.PreprocessPluginApplication</bootstrapClass>
                    <version>1.0.0</version>
                    <provider>auto</provider>
                    <description>demo插件</description>
                <configFileName>application.properties</configFileName>
                </pluginInfo>
                <prodConfig>
                    <packageType>jar</packageType>
                </prodConfig>
            </configuration>
        <executions>
                <execution>
                    <goals>
                        <goal>repackage</goal>
                    </goals>
                </execution>
            </executions>
</plugin>


重点参数说明:

mode :提供了两种模式dev/prod,固定写成prod,每次安装都会生成可以在线上部署的jar,同时也不影响本地程序的正常启动

id :写插件的工程名称

bootstrapClass:插件启动类的全路径

configFileName:插件内配置文件的名称如果是application-dev.properties则文件名称也要写成这个名称,不支持spring.profiles.active 配置做切换

1.3、集成插件启动类改造

主程序启动类实现插件框架的SpringBootstrap:
 
public class Application implements SpringBootstrap {
    public static void main(String[] args) {
        SpringMainBootstrap.launch(Application.class, args);
    }

    @Override
    public void run(String[] args) throws Exception {
        SpringApplication.run(Application.class, args);
    }
}
 
插件启动类继承SpringPluginBootstrap:
 
public class PluginApplication extends SpringPluginBootstrap {
    public static void main(String[] args) {
        SpringApplication.run(PluginApplication.class, args);
    }
}


1.4、集成插件配置修改


只需要在主程序的配置文件中配置即可
 ###############【插件的配置】################## 插件运行模式. dev: 开发环境, prod: 生产环境
 plugin.runMode= dev
 # 主程序的启动类所在包
 plugin.mainPackage= com.demo.preprocess.main
 # 插件rest接口前缀
 plugin.pluginRestPathPrefix= /
 # 插件存放的目录
 plugin.pluginPath[0]= ~\preprocess-plugins
 参数说明:
 plugin.runMode:插件模式支持dev/prod 两种 默认写成dev
 plugin.mainPackage: 主程序的启动类所在包
 plugin.pluginRestPathPrefix: 插件的rest接口前缀配置 默认/
 plugin.pluginPath[0]:插件存档的目录 写成1.1中说明的插件pom的父工程的名称“~”表示相对主程序的相对路径,也支持全路径,建议写成
 ~/插件的父pom工程名

2、三方组件集成
2.1、Nacos远程的配置注册中心
前提:需要有Nacos服务,目前使用版本2.0.1
主程序pom 引入nacos配置

<!--nacos配置中心--><dependency>
     <groupId>com.alibaba.cloud</groupId>
     <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
     <version>2.2.6.RELEASE</version>
 </dependency>
 <!--nacos注册中心-->
 <dependency>
     <groupId>com.alibaba.cloud</groupId>
     <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
     <version>2.2.6.RELEASE</version>
 </dependency>
 <dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-starter-bootstrap</artifactId>
 </dependency>

主程序的配置文件新增 bootstrap.properties:

添加nacos的配置
 #服务发现nacos地址
 spring.cloud.nacos.discovery.server-addr=ip
 #服务发现分组
 spring.cloud.nacos.discovery.group=demo
 #服务配置nacos地址
 spring.cloud.nacos.config.server-addr=${spring.cloud.nacos.server-addr}
 #配置文件的文件后缀
 spring.cloud.nacos.config.fileExtension= properties
 #配置文件配置自动刷新
 spring.cloud.nacos.config.refresh-enabled=true
 #扩展的配置文件
 spring.cloud.nacos.config.shared-configs[0].data-id= demo-common.properties
 #开启扩展的配置自动刷新
 spring.cloud.nacos.config.shared-configs[0].refresh= true
 #项目名称
 spring.application.name= demo-preprocess
 插件改造和主程序一样添加,需要去掉配置中心的配置

去除引入的注册中心的依赖包

<dependency>    
            <groupId>com.alibaba.cloud</groupId>
     <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
     <version>2.2.6.RELEASE</version>
 </dependency>

去掉配置:

  #服务发现nacos地址
   spring.cloud.nacos.discovery.server-addr=ip
   #服务发现分组
   spring.cloud.nacos.discovery.group=demo

2.2、Swagger可视化RESTful风格Web服务
在项目的顶层的pom中引入Swagger需要的依赖:

<!--swagger依赖, 3.0.2版本会报错--><dependency>
     <groupId>com.github.xiaoymin</groupId>
     <artifactId>knife4j-spring-boot-starter</artifactId>
     <version>2.0.7</version>
     <exclusions>
         <exclusion>
             <groupId>org.springframework</groupId>
             <artifactId>spring-core</artifactId>
         </exclusion>
         <exclusion>
             <groupId>org.springframework</groupId>
             <artifactId>spring-aop</artifactId>
         </exclusion>
         <exclusion>
             <groupId>org.springframework</groupId>
             <artifactId>spring-beans</artifactId>
         </exclusion>
         <exclusion>
             <groupId>org.springframework</groupId>
             <artifactId>spring-context</artifactId>
         </exclusion>
     </exclusions>
 </dependency>

在主程序配置swagger即可:

@Configuration@EnableSwagger2WebMvc
 public class Swagger2Config {    @Value("${server.port}")
     private String port;
     @Value("${plugin.runMode}")
     private String runMode;
     @Bean
     public Docket createRestApi() {
         return new Docket(DocumentationType.SWAGGER_2)
                 .useDefaultResponseMessages(false)
                 .apiInfo(apiInfo())
                 .groupName(runMode)
                 .select()
                 .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                 .paths(PathSelectors.any())
                 .build();
     }    private ApiInfo apiInfo() {
         return new ApiInfoBuilder()
                 .title("QBFX-PREPROCESS接口文档")
                 .description("接口说明文档")
                 .termsOfServiceUrl("http://ip:" + port + "/**")
                 .contact(new Contact("qbfx-preprocess", "", ""))
                 .version("1.0")
                 .build();
     }    /**
      * 解决springboot2.6.x集成swagger报错
      *
      * @param webEndpointsSupplier
      * @param servletEndpointsSupplier
      * @param controllerEndpointsSupplier
      * @param endpointMediaTypes
      * @param corsProperties
      * @param webEndpointProperties
      * @param environment
      * @return
      */
     @Bean
     public WebMvcEndpointHandlerMapping webEndpointServletHandlerMapping(WebEndpointsSupplier webEndpointsSupplier
             , ServletEndpointsSupplier servletEndpointsSupplier, ControllerEndpointsSupplier controllerEndpointsSupplier
             , EndpointMediaTypes endpointMediaTypes, CorsEndpointProperties corsProperties
             , WebEndpointProperties webEndpointProperties, Environment environment) {
         List allEndpoints = new ArrayList<>();
         Collection webEndpoints = webEndpointsSupplier.getEndpoints();
         allEndpoints.addAll(webEndpoints);
         allEndpoints.addAll(servletEndpointsSupplier.getEndpoints());
         allEndpoints.addAll(controllerEndpointsSupplier.getEndpoints());
         String basePath = webEndpointProperties.getBasePath();
         EndpointMapping endpointMapping = new EndpointMapping(basePath);
         boolean shouldRegisterLinksMapping = webEndpointProperties.getDiscovery().isEnabled()
                 && (org.springframework.util.StringUtils.hasText(basePath)
                 || ManagementPortType.get(environment).equals(ManagementPortType.DIFFERENT));
         return new WebMvcEndpointHandlerMapping(endpointMapping, webEndpoints, endpointMediaTypes, corsProperties.toCorsConfiguration()
                 , new EndpointLinksResolver(allEndpoints, basePath), shouldRegisterLinksMapping);
     }
 }


主程序配置文件中配置:
# 路径匹配
spring.mvc.pathmatch.matching-strategy= ant_path_matcher
访问地址:http://ip:port/doc.html
查看插件的rest接口也注册成功,可以正常使用,注意请求的路径多一个插件的项目名