自定義redis-spring-boot-starter

寫本文的原因

1）某大佬問我有沒有自定義過starter?沒有

2）因爲不會，所以學習

3)  沒有整合其它技術的小案例不完整，所以選擇了個人認爲簡單的redis，自定義myredis-spring-boot -starter

自定義starter的命名規範

SpringBoot提供的starter以spring-boot-starter-xxx的方式命名的。

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
            <version>1.2.2</version>
        </dependency>

官方建議自定義的starter使用xxx-spring-boot-starter命名規則。以區分SpringBoot生態提供的starter。

        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.2.2</version>
        </dependency>

 

項目結構及介紹

項目結構

項目介紹

1）此項目爲定義一個redis整合SpringBoot的starter,爲了方便區別用my前綴標記自定義的類。

2）myredis-spring-boot-autoconfigure：自定義myredis-starter的核心，核心都在這個module中

3）myredis-spring-boot-starter: 僅僅添加了myredis-spring-boot-autoconfigure的依賴 ，目的是隱藏 細節

4）springboot-demo : 引入自定義的starter依賴,進行測試

項目下載

url：

https://github.com/cbeann/share/tree/master/StarterDemo

注意：

先install 父工程，

在install 子工程 myredis-spring-boot-autoconfigure

在install 子工程 myredis-spring-boot-starter

在添加依賴在運行測試

項目構建

myredis-spring-boot-autoconfigure模塊(Maven項目)

添加依賴

        <!-- 引入spring-boot-starter，所有starter的基本配合 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <version>2.2.2.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
            <version>2.2.2.RELEASE</version>
        </dependency>


        <!--自定義的yml提示-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <version>2.2.2.RELEASE</version>
            <optional>true</optional>
        </dependency>


        <!-- jedis -->
        <dependency>
            <groupId>redis.clients</groupId>
            <artifactId>jedis</artifactId>
            <version>3.0.1</version>
        </dependency>

連接redis的參數配置類

package com.myredis;
import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * @author CBeann
 * @create 2020-05-30 14:51
 */
@ConfigurationProperties(prefix = "myredis")
public class MyRedisProperties {


    //ip
    private String host;
    //密碼
    private String password;


    public String getHost() {
        return host;
    }

    public void setHost(String host) {
        this.host = host;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

自定義myredisTemplate 

package com.myredis;

import redis.clients.jedis.Jedis;

/**
 * @author CBeann
 * @create 2020-05-30 15:03
 */
public class MyRedisTemplate {

    private Jedis jedis;

    public MyRedisTemplate(Jedis jedis) {
        this.jedis = jedis;
    }


    public String  setString(String key ,String val){

        String set = jedis.set(key, val);
        return set;

    }

    public Long  delKey(String key){
        Long del = jedis.del(key);
        return del;

    }

    public MyRedisTemplate() {
    }
}

MyRedisAutoConfigulation自動配置類

package com.myredis;

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import redis.clients.jedis.Jedis;

/**
 * @author CBeann
 * @create 2020-05-30 14:59
 */
@Configuration
@EnableConfigurationProperties(MyRedisProperties.class)
@ConditionalOnProperty(prefix = "myredis",name = "host",
        matchIfMissing =false)//如果application.yml或者properties中沒有myredis.host屬性，則此類MyRedisAutoConfigulation不注入IOC容器
public class MyRedisAutoConfigulation {

    @Bean
    public Jedis jedis(MyRedisProperties myRedisProperties) {

        //獲取redis的參數
        String host = myRedisProperties.getHost();
        String password = myRedisProperties.getPassword();
        // 連接redis服務
        Jedis jedis = new Jedis(host, 6379);
        jedis.auth(password);

        return jedis;


    }

    @Bean
    public MyRedisTemplate myRedisTemplate(Jedis jedis) {
        return new MyRedisTemplate(jedis);
    }


}

創建spring.factories

在resources下創建目錄META-INF，在META-INF下創建spring.factories，即resources/META-INF/spring.factories

其中等號（=）左邊爲固定值，右邊爲自定義的自動配置類

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.myredis.MyRedisAutoConfigulation

 安裝到本地倉庫

clean->install

myredis-spring-boot-starter(Maven項目)

添加上面模塊的依賴

 <dependency>
           <groupId>com.cbeann</groupId>
           <artifactId>myredis-spring-boot-autoconfigure</artifactId>
           <version>1.0-SNAPSHOT</version>
       </dependency>

安裝到本地倉庫

clean->install

springboot-demo模塊（SpringBoot項目+web）

項目基礎

SpringBoot+web

修改pom文件

  <!--自定義starter-->
        <dependency>
            <groupId>com.cbeann</groupId>
            <artifactId>myredis-spring-boot-starter</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>

添加application.yml配置信息

myredis.host=39.105.30.146
myredis.password=123456

創建controller進行測試

package com.example.springbootdemo.controller;

import com.myredis.MyRedisTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.time.LocalTime;

/**
 * @author CBeann
 * @create 2020-05-30 15:25
 */
@RestController
public class HelloController {

    @Autowired
    private MyRedisTemplate myRedisTemplate;


    @RequestMapping("/hello")
    public String hello(){
        myRedisTemplate.setString("key2", LocalTime.now().toString());
        return LocalTime.now().toString();
    }

//    @RequestMapping("/hello")
//    public String hello2(){
//        return LocalTime.now().toString();
//    }
}

測試結果

http://localhost:8080/hello

redis中添加了key,value數據

 

總結

1）yml提示

在myredis-spring-boot-autoconfigure中添加依賴，並且類（MyRedisProperties ）上有註解

<!--自定義yml提示-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <version>2.2.2.RELEASE</version>
            <optional>true</optional>
        </dependency>

參考：https://blog.csdn.net/weixin_42214548/article/details/104294305

2）如果沒有上圖中的屬性，證明我不用redis,系統不應該報錯

如果我沒有配置myredis的屬性，我也沒用redis，正常的邏輯是不能報錯。

報錯的原因是你沒有配置myredis的信息，但是他還是加載Jedis並且創建連接，那肯定是報錯了，所以不讓他加載MyRedisAutoConfigulation這個類，那麼這個關於自定義Starter的類就全不讓它加載，那麼就和沒有引入這個依賴一樣

如下面代碼所示， 如果application.yml或者properties中沒有myredis.host屬性，則此類MyRedisAutoConfigulation不注入IOC容器

@ConditionalOnProperty(prefix = "myredis",name = "host",
        matchIfMissing =false)//如果application.yml或者properties中沒有myredis.host屬性，則此類MyRedisAutoConfigulation不注入IOC容器
public class MyRedisAutoConfigulation {

參考

關與 @EnableConfigurationProperties 註解

https://www.jianshu.com/p/7f54da1cb2eb

自定義starter並在springboot配置文件中生成提示

https://blog.csdn.net/weixin_42214548/article/details/104294305

SpringBoot 自定義starter

https://www.jianshu.com/p/b5794bbd4b54