springboot自定義redis-starter的實現

阿新 • • 發佈：2020-10-17

spring時代整合redis

spring我相信只要是一個Java開發人員我相信再熟悉不過了，幾乎壟斷了整個JavaEE的市場份額，話不多說進入正題。

首先看看我們在spring中整合redis需要做什麼

1、首先maven工程的話不用想先匯入依賴

<!-- jedis -->
  <dependency>
   <groupId>redis.clients</groupId>
   <artifactId>jedis</artifactId>
   <version>2.4.2</version>
  </dependency>
<!-- 2、spring整合Redis的jar包 -->
  <dependency>
   <groupId>org.springframework.data</groupId>
   <artifactId>spring-data-redis</artifactId>
   <version>1.4.2.RELEASE</version>
  </dependency>

2、在spring-xml中配置

<!-- 1、配置jedis連線池資訊 -->
  <bean id="jedisPoolConfig" class="redis.clients.jedis.JedisPoolConfig">
    <!-- 最大連線數-->
    <property name="maxTotal" value="50"></property>
    <property name="maxIdle" value="5"></property>
   	....... 這裡省略一些更多配置
  </bean>
  
  <!--2、配置連線工廠JedisConnectionFactory-->
  <bean id="jedisConnectionFactory" class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory">
    <!--需要自定義一些工廠屬性配置資訊-->
    <!-- 伺服器地址 -->
    <property name="hostName" value="127.0.0.1"></property>
    <!-- 服務埠號 -->
    <property name="port" value="6379"></property>
    <!-- 密碼 -->
    <property name="password" value="yichun"></property>
    <!-- 連線池配置：再把第一步配置好的連線池資訊通過屬性注入進來 否則會採用預設的連線池-->
    <property name="poolConfig" ref="jedisPoolConfig"></property>
  </bean>
  
	<!--  3、配置RedisTemplate模板  把第二步配置好的連線工廠JedisConnectionFactory通過屬性注入到RedisTemplate模板中-->
  <bean id="redisTemplate" class="org.springframework.data.redis.core.RedisTemplate">
    <property name="connectionFactory" ref="jedisConnectionFactory"></property>
 
  	  <!-- 配置一些key和value的序列化操作，可選操作 -->
    <property name="keySerializer">
      <bean class="org.springframework.data.redis.serializer.StringRedisSerializer"></bean>
    </property>
    <property name="valueSerializer">
      <bean class="org.springframework.data.redis.serializer.StringRedisSerializer"></bean>
    </property>
  </bean>

	4、這樣子以後我們就可以在業務層通過 @Autowired 引用redis操作模板了
	 @Autowired
   RedisTemplate<String,String> redisTemplate;

3、上面就是spring使用redis的大致流程。

這樣子看起來也還好啊？
但是每個專案都要去經過這麼一系列繁瑣的xml配置，這就是重複工作了。這時候就出現了“springboot” 就是專門去做這些整合的事情了，讓我們不需要整合這些只需幾行基礎配置即可。

springboot 實現自動裝配redis

在開始spring boot之前我們首先要來看幾個註解，spring boot實現自定義裝配的核心就是這幾個註解：

1、@Import：Import註解的主要的作用是將bean匯入到spring容器中，比如說要自定義一些bean交spring容器託管，這是我們就可以建一個配置類使用import註解專門去匯入你自定義的一些bean到spring容器中。

2、@Bean：Bean註解告訴Spring這個方法將會返回一個物件，這個物件要註冊為Spring應用上下文中的bean。通常方法體中包含了最終產生bean例項的邏輯。

3、@Component：通常是通過類路徑掃描來自動偵測以及自動裝配到Spring容器中。

4、@Configuration：來宣告一個spring的配置類等同於spring中的xml檔案，ConfigurationClassPostProcessor::enhanceConfigurationClasses這個方法是Configuration註解工作的核心方法，spring應用啟動時所有的被@Configuration註解的類都會被spring cglib庫生成cglib動態代理，然後其他地方通過@Autowired註解引入Student類物件就會被生成的configuration配置類生成的動態代理攔截，處理完後再呼叫原configuration註解類的student方法獲取到Student例項。

5、@Conditiona：個人感覺主要是做一些判斷條件的、只有當condition的machet匹配方法為 true 的時候【該方法內也是我們實現一些自定義邏輯判斷的擴充套件點】，才會去載入該bean 否則不載入該bean。
----- condition又繁衍出很多子類（方便我們直接使用）
@ConditionalOnMissingBean：當容器下有當前這個bean就不載入沒有則載入

@ConditionalOnExpression：當括號中的內容為true時，使用該註解的類被例項化。
示例：
@ConditionalOnExpression("KaTeX parse error: Expected 'EOF',got '&' at position 25: …mer.enabled}==1&̲&{rabbitmq.comsumer.enabled:true}")
@ConditionalOnExpression("'${mq.comsumer}'.equals(‘rabbitmq')")

@ConditionalOnClass：當classpath下有某個class的時候，就執行下面操作

@ConditionalOnBean：只有當給定的bean存在時、則例項化當前bean。

1、新建兩個專案：一個autoconfig一個starter專案

注：【maven專案即可】。
starter：主要是做讓其他專案依賴的start。
autoconfig：實現具體自動裝配邏輯處理。

在這裡插入圖片描述

2、新增 autoconfig 專案中的pom檔案如下：

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>org.xing.modules</groupId>
  <artifactId>spring-boot-redis-autoconfig</artifactId>
  <version>1.0.0</version>

  <properties>
    <!-- Environment Settings -->
    <java.version>1.8</java.version>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>

    <jedis.version>2.9.0</jedis.version>
    <springboot.version>2.1.4.RELEASE</springboot.version>
  </properties>

  <dependencies>
    <!-- springboot-stater -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
      <version>${springboot.version}</version>
    </dependency>

    <!-- spring-data-redis -->
    <dependency>
      <groupId>org.springframework.data</groupId>
      <artifactId>spring-data-redis</artifactId>
      <version>${springboot.version}</version>
    </dependency>

    <!-- Jedis -->
    <dependency>
      <groupId>redis.clients</groupId>
      <artifactId>jedis</artifactId>
      <version>${jedis.version}</version>
    </dependency>

	
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-autoconfigure-processor</artifactId>
      <version>${springboot.version}</version>
      <optional>true</optional>
    </dependency>
  </dependencies>
</project>

3、starter 專案中pom 只需新增autoconfig依賴即可。

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>org.xing.modules</groupId>
  <artifactId>spring-boot-redis-starter</artifactId>
  <version>1.0.0</version>

  <properties>
    <!-- Environment Settings -->
    <java.version>1.8</java.version>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.xing.modules</groupId>
      <artifactId>spring-boot-redis-autoconfig</artifactId>
      <version>1.0.0</version>
    </dependency>
  </dependencies>
</project>

4、autoconfig專案中建立一個包configuration、再建立一個RedisConfiguration類。

package org.xing.modules.configuration;

import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
import org.springframework.data.redis.core.RedisOperations;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPool;
import redis.clients.jedis.JedisPoolConfig;
import java.net.ConnectException;

/**
 * {@like @ConditionalOnClass:
 * This annotation indicates that there must be RedisOperations in the current classpath to inject this Bean}
 *
 * @ConditionalOnClass(Jedis.class)
 * 此註解表示當前ClassPath必須包含有Jedis這個類才會入這個配置類到spring容器中
 * 意思就是專案當中存在了jedis客戶端依賴才覺得你需要使用，否則就沒必要去注入.
 *
 * @author Created by John on 2020/10/12
 */
@Configuration
@ConditionalOnClass(Jedis.class)
public class RedisConfiguration {

  // 載入配置檔案資訊 這裡使用properties類去做配置載入。
  // @src = org.xing.modules.configuration.RedisProperties
  
  【**如下步驟 跟 spring 配置流程雷同**】
  /**
   *	  <!-- 1、配置jedis連線池資訊 -->
   *   <bean id="jedisPoolConfig" class="redis.clients.jedis.JedisPoolConfig">
   *     <property name="maxTotal" value="50"></property>
   *     <property name="maxIdle" value="5"></property>
   *   </bean>
   */
  @Bean
  public JedisPool jedisPool(RedisProperties redisProperties) throws ConnectException {
    JedisPoolConfig jedisPoolConfig = new JedisPoolConfig();
    jedisPoolConfig.setMinIdle(redisProperties.getMinIdle());
    jedisPoolConfig.setMaxIdle(redisProperties.getMaxIdle());
    jedisPoolConfig.setMaxWaitMillis(redisProperties.getMaxWait());
    jedisPoolConfig.setMaxTotal(redisProperties.getMaxActive());
    String password = isBlank(redisProperties.getPassword()) ? null:redisProperties.getPassword();

    return new JedisPool(jedisPoolConfig,redisProperties.getHost(),redisProperties.getPort(),redisProperties.getTimeout(),password);
  }

  /**   <!--2、配置連線工廠JedisConnectionFactory-->
   *   <bean id="jedisConnectionFactory" class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory">
   *     <!-- 伺服器地址 -->
   *     <property name="hostName" value="127.0.0.1"></property>
   *     <!-- 服務埠號 -->
   *     <property name="port" value="6379"></property>
   *     <!-- 密碼 -->
   *     <property name="password" value="yichun"></property>
   *     <!-- 連線池配置：再把第一步配置好的連線池資訊通過屬性注入進來 否則會採用預設的連線池-->
   *     <property name="poolConfig" ref="jedisPoolConfig"></property>
   *   </bean>
   */
  @Bean
  public JedisConnectionFactory redisConnectionFactory(RedisProperties redisProperties) {
    JedisConnectionFactory jedisConnectionFactory = new JedisConnectionFactory();
    jedisConnectionFactory.setHostName(redisProperties.getHost());
    jedisConnectionFactory.setPort(redisProperties.getPort());
    jedisConnectionFactory.setPassword(redisProperties.getPassword());
    jedisConnectionFactory.setDatabase(redisProperties.getDatabase());
    return jedisConnectionFactory;
  }

  // 第三步抽離出：@src = org.xing.modules.template.RedisTemplateConfiguration
  /** 	<!--  3、配置RedisTemplate模板  把第二步配置好的連線工廠JedisConnectionFactory通過屬性注入到RedisTemplate模板中-->
   *   <bean id="redisTemplate" class="org.springframework.data.redis.core.RedisTemplate">
   *     <property name="connectionFactory" ref="jedisConnectionFactory"></property>
   *
   *  	  <!-- 配置一些key和value的序列化操作，可選操作 -->
   *     <property name="keySerializer">
   *       <bean class="org.springframework.data.redis.serializer.StringRedisSerializer"></bean>
   *     </property>
   *     <property name="valueSerializer">
   *       <bean class="org.springframework.data.redis.serializer.StringRedisSerializer"></bean>
   *     </property>
   *   </bean>
   */


  public static boolean isBlank(String str) {
    return str == null || "".equals(str.trim());
  }
}

5、建立properties配置檔案載入類

package org.xing.modules.configuration;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * @author Created by mr_zhou on 2020/10/12
 *
 * @TODO: "my.springboot.redis" Qualified redis configuration must begin with this prefix
 * 限定使用此starter的redis配置必須以“my.springboot.redis.”為字首
 * 示例: 
 * my.springboot.redis.host
 * my.springboot.redis.prot
 */
@Component
@ConfigurationProperties(prefix = "my.springboot.redis")
public class RedisProperties {

  private int port;
  private String host;
  private String password;
  private int timeout;
  private int database;
  @Value("${redis.pool.max-active}")
  private int maxActive;
  @Value("${redis.pool.max-wait}")
  private int maxWait;
  @Value("${redis.pool.max-idle}")
  private int maxIdle;
  @Value("${redis.pool.min-idle}")
  private int minIdle;
  
  // 省略 get/set方法

6、建立redis操作模板類

這裡其實也可以 RedisConfiguration 類中注入到spring容器中，但是為了職責劃分就單獨使用。

package org.xing.modules.template;

import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;

/**
 * TODO: Redis Template Configuration Class
 *
 * @author Created by mr_zhou on 2020/10/12
 */
@Configuration
public class RedisTemplateConfiguration {
  @Bean
  @ConditionalOnMissingBean
  public RedisTemplate redisTemplate(JedisConnectionFactory jedisConnectionFactory){
    RedisTemplate redisTemplate = new RedisTemplate();
    redisTemplate.setConnectionFactory(jedisConnectionFactory);
    return redisTemplate;
  }
  // 更多模板注入.....
}

7、Redis對外出口配置類

該類主要作用於spring容器載入入口

package org.xing.modules.template;

import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;

/**
 * TODO: Redis Template Configuration Class
 *
 * @author Created by mr_zhou on 2020/10/12
 */
@Configuration
public class RedisTemplateConfiguration {
  @Bean
  @ConditionalOnMissingBean
  public RedisTemplate redisTemplate(JedisConnectionFactory jedisConnectionFactory){
    RedisTemplate redisTemplate = new RedisTemplate();
    redisTemplate.setConnectionFactory(jedisConnectionFactory);
    return redisTemplate;
  }
  // 更多模板注入.....
}

8、springboot優雅擴充套件的入口

我們開啟springboot自動配置jar裡面的原始碼：
springboot自動裝配主要是掃描
【META-INF 下的 spring.factories 檔案下 # Auto Configure】下的所有類

在這裡插入圖片描述

因此我們照葫蘆畫瓢【在starter下建立META-INF 再建立spring.factories】

在這裡插入圖片描述

讓後在maven裡面先後 autoconfig -> starter install一下。

在這裡插入圖片描述

9、demo使用自定義starter

1、在demo專案中加入自定義starter的依賴

在這裡插入圖片描述

2、最後就可以直接在專案中注入使用redis。
【pom裡面可以看到我們沒有加任何redis依賴的只加了自定義的starter】

/**
 * @author Created by mr_zhou on 2020/10/12
 */
public class MyService {

  @Autowired
  private RedisTemplate redisTemplate;

}

3、配置redis連線資訊即可操作 - 對應 RedisProperties 屬性。

在這裡插入圖片描述

10、全劇終

最後我們就可以慢慢完善自己的starter做到以後直接使用自己的redis封裝一些常用的操作。

到此這篇關於springboot自定義redis-starter的實現的文章就介紹到這了,更多相關springboot自定義redis-starter內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！

springboot自定義redis-starter的實現

springboot自定義redis-starter的實現

springboot自定義攔截器實現

SpringBoot自定義監聽器來實現訊息的推送與接收

基於SpringBoot自定義第三方starter

springboot自定義starter實現過程圖解

基於springboot自定義註解+redis實現分散式鎖

SpringBoot-dubbo自定義負載均衡實現簡單灰度

springboot 自定義LocaleResolver實現切換語言

《Java Spring框架》SpringBoot 自定義監聽器（含模擬實現監聽管理器）

springboot自定義starter

SpringBoot --- 自定義 Starter

java SpringBoot自定義註解,及自定義解析器實現物件自動注入操作

使用SpringBoot自定義starter的完整步驟

SpringBoot自定義場景啟動器(starter)

Springboot自定義mvc元件如何實現

SpringBoot中幹掉Whitelabel Error Page返回自定義內容的實現

SpringBoot自定義starter入門

SpringBoot -- 自定義starter （狂神視訊學習筆記）

SpringBoot自定義starter-統一上傳服務

SpringBoot自定義starter操作

springboot自定義redis-starter的實現

相關推薦