SpringBoot 自定义 starter

素颜马尾好姑娘i 2022-01-20 11:49 444阅读 0赞

一、简介

SpringBoot 最强大的功能就是把我们常用的场景抽取成了一个个starter（场景启动器），我们通过引入SpringBoot 为我提供的这些场景启动器，我们再进行少量的配置就能使用相应的功能。即使是这样，SpringBoot也不能囊括我们所有的使用场景，往往我们需要自定义starter，来简化我们对SpringBoot的使用。

二、如何自定义starter

1.实例

如何编写自动配置 ？

我们参照@WebMvcAutoConfiguration为例，我们看看需要准备哪些东西，下面是WebMvcAutoConfiguration的部分代码：

  1. @Configuration
  2. @ConditionalOnWebApplication
  3. @ConditionalOnClass({Servlet.class, DispatcherServlet.class, WebMvcConfigurerAdapter.class})
  4. @ConditionalOnMissingBean({WebMvcConfigurationSupport.class})
  5. @AutoConfigureOrder(-2147483638)
  6. @AutoConfigureAfter({DispatcherServletAutoConfiguration.class, ValidationAutoConfiguration.class})
  7. public class WebMvcAutoConfiguration {
  9.     @Import({WebMvcAutoConfiguration.EnableWebMvcConfiguration.class})
  10.     @EnableConfigurationProperties({WebMvcProperties.class, ResourceProperties.class})
  11.     public static class WebMvcAutoConfigurationAdapter extends WebMvcConfigurerAdapter {
  13.         @Bean
  14.         @ConditionalOnBean({View.class})
  15.         @ConditionalOnMissingBean
  16.         public BeanNameViewResolver beanNameViewResolver() {
  17.             BeanNameViewResolver resolver = new BeanNameViewResolver();
  18.             resolver.setOrder(2147483637);
  19.             return resolver;
  20.         }
  21.     }
  22. }
  23. 复制代码

我们可以抽取到我们自定义starter时,同样需要的一些配置。

  1. @Configuration  //指定这个类是一个配置类
  2. @ConditionalOnXXX  //指定条件成立的情况下自动配置类生效
  3. @AutoConfigureOrder  //指定自动配置类的顺序
  4. @Bean  //向容器中添加组件
  5. @ConfigurationProperties  //结合相关xxxProperties来绑定相关的配置
  6. @EnableConfigurationProperties  //让xxxProperties生效加入到容器中
  8. 自动配置类要能加载需要将自动配置类，配置在META-INF/spring.factories中
  9. org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  10. org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
  11. org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
  12. 复制代码

模式

我们参照 spring-boot-starter 我们发现其中没有代码：

我们在看它的pom中的依赖中有个 springboot-starter

  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter</artifactId>
  4. </dependency>
  5. 复制代码

我们再看看 spring-boot-starter 有个 spring-boot-autoconfigure

  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-autoconfigure</artifactId>
  4. </dependency>
  5. 复制代码

关于web的一些自动配置都写在了这里 ，所以我们有以下总结：

  1. 启动器starter只是用来做依赖管理
  2. 需要专门写一个类似spring-boot-autoconfigure的配置模块
  3. 用的时候只需要引入启动器starter，就可以使用自动配置了
  4. 复制代码

命名规范

官方命名空间

  • 前缀：spring-boot-starter-
  • 模式：spring-boot-starter-模块名
  • 举例：spring-boot-starter-web、spring-boot-starter-jdbc

自定义命名空间

  • 后缀：-spring-boot-starter
  • 模式：模块-spring-boot-starter
  • 举例：mybatis-spring-boot-starter

三、自定义starter实例

我们需要先创建两个工程 hello-spring-boot-starter 和 hello-spring-boot-starter-autoconfigurer

1. hello-spring-boot-starter

1.pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <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">
  3.     <modelVersion>4.0.0</modelVersion>
  5.     <groupId>com.gf</groupId>
  6.     <artifactId>hello-spring-boot-starter</artifactId>
  7.     <version>0.0.1-SNAPSHOT</version>
  8.     <packaging>jar</packaging>
  10.     <name>hello-spring-boot-starter</name>
  12.     <!-- 启动器 -->
  13.     <dependencies>
  14.         <!-- 引入自动配置模块 -->
  15.         <dependency>
  16.             <groupId>com.gf</groupId>
  17.             <artifactId>hello-spring-boot-starter-autoconfigurer</artifactId>
  18.             <version>0.0.1-SNAPSHOT</version>
  19.         </dependency>
  20.     </dependencies>
  23. </project>
  25. 复制代码

同时删除 启动类、resources下的文件，test文件。

2. hello-spring-boot-starter-autoconfigurer

1. pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <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">
  3.     <modelVersion>4.0.0</modelVersion>
  5.     <groupId>com.gf</groupId>
  6.     <artifactId>hello-spring-boot-starter-autoconfigurer</artifactId>
  7.     <version>0.0.1-SNAPSHOT</version>
  8.     <packaging>jar</packaging>
  10.     <name>hello-spring-boot-starter-autoconfigurer</name>
  11.     <description>Demo project for Spring Boot</description>
  13.     <parent>
  14.         <groupId>org.springframework.boot</groupId>
  15.         <artifactId>spring-boot-starter-parent</artifactId>
  16.         <version>1.5.9.RELEASE</version>
  17.         <relativePath/> <!-- lookup parent from repository -->
  18.     </parent>
  20.     <properties>
  21.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  22.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  23.         <java.version>1.8</java.version>
  24.     </properties>
  26.     <dependencies>
  27.         <!-- 引入spring-boot-starter，所有starter的基本配合 -->
  28.         <dependency>
  29.             <groupId>org.springframework.boot</groupId>
  30.             <artifactId>spring-boot-starter</artifactId>
  31.         </dependency>
  33.     </dependencies>
  36. </project>
  38. 复制代码

2. HelloProperties

  1. package com.gf.service;
  3. import org.springframework.boot.context.properties.ConfigurationProperties;
  5. @ConfigurationProperties(prefix = "gf.hello")
  6. public class HelloProperties {
  8.     private String prefix;
  9.     private String suffix;
  11.     public String getPrefix() {
  12.         return prefix;
  13.     }
  15.     public void setPrefix(String prefix) {
  16.         this.prefix = prefix;
  17.     }
  19.     public String getSuffix() {
  20.         return suffix;
  21.     }
  23.     public void setSuffix(String suffix) {
  24.         this.suffix = suffix;
  25.     }
  27. }
  29. 复制代码

3. HelloService

  1. package com.gf.service;
  4. public class HelloService {
  6.     HelloProperties helloProperties;
  8.     public HelloProperties getHelloProperties() {
  9.         return helloProperties;
  10.     }
  12.     public void setHelloProperties(HelloProperties helloProperties) {
  13.         this.helloProperties = helloProperties;
  14.     }
  16.     public String sayHello(String name ) {
  17.         return helloProperties.getPrefix()+ "-" + name + helloProperties.getSuffix();
  18.     }
  19. }
  21. 复制代码

4. HelloServiceAutoConfiguration

  1. package com.gf.service;
  3. import org.springframework.beans.factory.annotation.Autowired;
  4. import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
  5. import org.springframework.boot.context.properties.EnableConfigurationProperties;
  6. import org.springframework.context.annotation.Bean;
  7. import org.springframework.context.annotation.Configuration;
  9. @Configuration
  10. @ConditionalOnWebApplication //web应该生效
  11. @EnableConfigurationProperties(HelloProperties.class)
  12. public class HelloServiceAutoConfiguration {
  14.     @Autowired
  15.     HelloProperties helloProperties;
  17.     @Bean
  18.     public HelloService helloService() {
  19.         HelloService service = new HelloService();
  20.         service.setHelloProperties( helloProperties  );
  21.         return service;
  22.     }
  25. }
  27. 复制代码

5. spring.factories

在 resources 下创建文件夹 META-INF 并在 META-INF 下创建文件 spring.factories ，内容如下：

  1. # Auto Configure
  2. org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  3. com.gf.service.HelloServiceAutoConfiguration
  4. 复制代码

到这儿，我们的配置自定义的starter就写完了 ，我们把 hello-spring-boot-starter-autoconfigurer、hello-spring-boot-starter 安装成本地jar包。

三、测试自定义starter

我们创建个项目 hello-spring-boot-starter-test，来测试系我们写的stater。

1. pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <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">
  3.     <modelVersion>4.0.0</modelVersion>
  5.     <groupId>com.gf</groupId>
  6.     <artifactId>hello-spring-boot-starter-test</artifactId>
  7.     <version>0.0.1-SNAPSHOT</version>
  8.     <packaging>jar</packaging>
  10.     <name>hello-spring-boot-starter-test</name>
  11.     <description>Demo project for Spring Boot</description>
  13.     <parent>
  14.         <groupId>org.springframework.boot</groupId>
  15.         <artifactId>spring-boot-starter-parent</artifactId>
  16.         <version>1.5.9.RELEASE</version>
  17.         <relativePath/> <!-- lookup parent from repository -->
  18.     </parent>
  20.     <properties>
  21.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  22.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  23.         <java.version>1.8</java.version>
  24.     </properties>
  26.     <dependencies>
  27.         <dependency>
  28.             <groupId>org.springframework.boot</groupId>
  29.             <artifactId>spring-boot-starter-web</artifactId>
  30.         </dependency>
  32.         <!-- 引入自定义starter -->
  33.         <dependency>
  34.             <groupId>com.gf</groupId>
  35.             <artifactId>hello-spring-boot-starter</artifactId>
  36.             <version>0.0.1-SNAPSHOT</version>
  37.         </dependency>
  39.         <dependency>
  40.             <groupId>org.springframework.boot</groupId>
  41.             <artifactId>spring-boot-starter-test</artifactId>
  42.             <scope>test</scope>
  43.         </dependency>
  44.     </dependencies>
  46.     <build>
  47.         <plugins>
  48.             <plugin>
  49.                 <groupId>org.springframework.boot</groupId>
  50.                 <artifactId>spring-boot-maven-plugin</artifactId>
  51.             </plugin>
  52.         </plugins>
  53.     </build>
  56. </project>
  58. 复制代码

2. HelloController

  1. package com.gf.controller;
  3. import com.gf.service.HelloService;
  4. import org.springframework.beans.factory.annotation.Autowired;
  5. import org.springframework.web.bind.annotation.GetMapping;
  6. import org.springframework.web.bind.annotation.PathVariable;
  7. import org.springframework.web.bind.annotation.RestController;
  9. @RestController
  10. public class HelloController {
  12.     @Autowired
  13.     HelloService helloService;
  15.     @GetMapping("/hello/{name}")
  16.     public String hello(@PathVariable(value = "name") String name) {
  17.         return helloService.sayHello( name + " , " );
  18.     }
  20. }
  22. 复制代码

3. application.properties

  1. gf.hello.prefix = hi
  2. gf.hello.suffix = what's up man ? 复制代码

我运行项目访问 http://127.0.0.1:8080/hello/zhangsan，结果如下：

  1. hi-zhangsan , what's up man ? 复制代码

源码下载: github.com/gf-huanchup…

发表评论

表情：
评论列表 （有 0 条评论，444人围观）

还没有评论，来说两句吧...

相关阅读

    相关 SpringBoot自定义starter

    SpringBoot自定义starter 按照一般的模式, 我们创建一个启动器, 但是该启动器只用来做依赖导入 然后创建另外一个自动配置模块, 用来定义自动配置 启动

    r囧r小猫r囧r小猫/ 0 赞/ 543 阅读