springboot自定义starter(十二)

秒速五厘米 2023-10-07 16:02 1阅读 0赞

### springboot自动装配原理 ###

链接: [SpringBoot：认认真真梳理一遍自动装配原理][SpringBoot].  
链接: [使用springboot自定义starter][springboot_starter]

SpringBoot所有自动配置类都是在启动的时候进行扫描并加载，通过spring.factories可以找到自动配置类的路径，但是不是所有存在于spring,factories中的配置都进行加载，而是通过@ConditionalOnClass注解进行判断条件是否成立（只要导入相应的stater，条件就能成立），如果条件成立则加载配置类，否则不加载该配置类。

### 创建项目zm-map-spring-boot-starter ###

#### pom.xml ####

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.3.4.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.zm</groupId>
        <artifactId>zm-map-spring-boot-starter</artifactId>
        <version>1.0-SNAPSHOT</version>
        <name>zm-map-spring-boot-starter</name>
        <description>整合各大地图web-API</description>
        <properties>
            <java.version>1.8</java.version>
        </properties>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-configuration-processor</artifactId>
                <optional>true</optional>
            </dependency>
        </dependencies>
    </project>

package com.zm.map.sdk.properties;
    
    import org.springframework.boot.context.properties.ConfigurationProperties;
    
    /**
     * 高德地图web-API配置
     */
    @ConfigurationProperties(prefix = "zm.map.amap")
    public class AmapKeyProperty {
        
    
        /**
         * 开发秘钥
         */
        private String key;
    
        /**
         * 签名秘钥
         */
        private String sign;
    
        public String getKey() {
        
            return key;
        }
    
        public void setKey(String key) {
        
            this.key = key;
        }
    
        public String getSign() {
        
            return sign;
        }
    
        public void setSign(String sign) {
        
            this.sign = sign;
        }
    }

package com.zm.map.sdk.clent;
    
    import com.zm.map.sdk.properties.AmapKeyProperty;
    
    /**
     * 高德web-API实现类
     */
    public class AmapClent {
        
    
        private AmapKeyProperty amapKeyProperty;
    
        public AmapClent(AmapKeyProperty amapKeyProperty) {
        
            this.amapKeyProperty = amapKeyProperty;
        }
    
        public String sayHello() {
        
            System.out.println(amapKeyProperty.getKey());
            System.out.println(amapKeyProperty.getSign());
            return "高德地图:"+amapKeyProperty.getKey() + ","+amapKeyProperty.getSign();
        }
        
        // 高德各个web-API在这里编写.....
    
    }

package com.zm.map.sdk.configuration;
    
    import com.zm.map.sdk.clent.AmapClent;
    import com.zm.map.sdk.properties.AmapKeyProperty;
    import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
    import org.springframework.boot.context.properties.EnableConfigurationProperties;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    /**
     * 如果@ConfigurationProperties是在第三方包中，那么@component是不能注入到容器的。
     * 只有@EnableConfigurationProperties才可以注入到容器。
     */
    @EnableConfigurationProperties(AmapKeyProperty.class)
    @Configuration
    public class AmapConfiguration {
        
    
        @Bean
        @ConditionalOnMissingBean(AmapClent.class) //仅仅在当前上下文中不存在某个对象时，才会实例化一个Bean
        public AmapClent amapClient(AmapKeyProperty amapKeyProperty) {
        
        	// 将实现类注入到spring容器中，这样就能调用了
            return new AmapClent(amapKeyProperty);
        }
    
    }

#### resources目录下新建 META-INF/spring.factories ####

# Auto Configure
    org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    com.zm.map.sdk.configuration.AmapConfiguration

#### clean后install 进行打包 ####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNjA0ODkw_size_16_color_FFFFFF_t_70]

![在这里插入图片描述][9d69903605b445e597dd18a34f33eb35.png]

配置多个

![在这里插入图片描述][220f2a289ede489c81b9f8bfe499ef98.png]

#### 就可以在项目中导入自己的启动器了 ####

<dependency>
        <groupId>com.zm</groupId>
        <artifactId>zm-map-spring-boot-starter</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>

#### 可以使用yml配置 ####

zm:
      map:
        amap:
          key: 222
          sign: 333

#### 也可以使用javaConfig配置 ####

package com.zm.web.Config;
    
    import com.zm.map.sdk.clent.AmapClent;
    import com.zm.map.sdk.clent.BmapClent;
    import com.zm.map.sdk.properties.AmapKeyProperty;
    
    import com.zm.map.sdk.properties.BmapKeyProperty;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    @Configuration
    public class AmapConfig {
        
    
        @Bean
        public AmapClent amapClient() {
        
            AmapKeyProperty amapKeyProperty = new AmapKeyProperty();
            amapKeyProperty.setKey("111");
            amapKeyProperty.setSign("2222");
            return new AmapClent(amapKeyProperty);
        }
    
    }

@SpringBootTest
    class WebApplicationTests {
        
    
        @Autowired
        private AmapClent amapClent;
    
        @Test
        void test() {
        
            System.out.println(amapClent.sayHello());
        }
        
    ｝

[SpringBoot]: https://zhuanlan.zhihu.com/p/95217578
[springboot_starter]: https://blog.csdn.net/qq_21150865/article/details/83504780
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNjA0ODkw_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20210328095020305.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNjA0ODkw,size_16,color_FFFFFF,t_70
[9d69903605b445e597dd18a34f33eb35.png]: https://img-blog.csdnimg.cn/9d69903605b445e597dd18a34f33eb35.png
[220f2a289ede489c81b9f8bfe499ef98.png]: https://img-blog.csdnimg.cn/220f2a289ede489c81b9f8bfe499ef98.png