文章詳情頁

springboot自定義redis-starter的實現

瀏覽：23日期：2023-04-17 10:25:13

spring時代整合redis

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

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

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

<dependency> <groupId>redis.clients</groupId> <artifactId>jedis</artifactId> <version>2.4.2</version> </dependency> <dependency> <groupId>org.springframework.data</groupId> <artifactId>spring-data-redis</artifactId> <version>1.4.2.RELEASE</version> </dependency>

2、在spring-xml中配置

<bean class='redis.clients.jedis.JedisPoolConfig'>  <property name='maxTotal' value='50'></property> <property name='maxIdle' value='5'></property> ....... 這里省略一些更多配置 </bean>  <bean 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 class='org.springframework.data.redis.core.RedisTemplate'> <property name='connectionFactory' ref='jedisConnectionFactory'></property>  <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：實現具體自動裝配邏輯處理。

springboot自定義redis-starter的實現

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>  <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>  <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> <version>${springboot.version}</version> </dependency>  <dependency> <groupId>org.springframework.data</groupId> <artifactId>spring-data-redis</artifactId> <version>${springboot.version}</version> </dependency>  <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依賴即可。

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 配置流程雷同**】 /** *  * <bean 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); } /**  * <bean 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 /**  * <bean class='org.springframework.data.redis.core.RedisTemplate'> * <property name='connectionFactory' ref='jedisConnectionFactory'></property> * *  * <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 */@Configurationpublic class RedisTemplateConfiguration { @Bean @ConditionalOnMissingBean public RedisTemplate redisTemplate(JedisConnectionFactory jedisConnectionFactory){ RedisTemplate redisTemplate = new RedisTemplate(); redisTemplate.setConnectionFactory(jedisConnectionFactory); return redisTemplate; } // 更多模板注入.....}

7、Redis對外出口配置類

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

8、springboot優雅擴展的入口

我們打開springboot自動配置jar里面的源碼：springboot自動裝配主要是掃描【META-INF 下的 spring.factories 文件下 # Auto Configure】下的所有類

springboot自定義redis-starter的實現

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

springboot自定義redis-starter的實現

讓后在maven里面先后 autoconfig -> starter install一下。

springboot自定義redis-starter的實現

9、demo使用自定義starter

1、在demo項目中加入自定義starter的依賴

springboot自定義redis-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 屬性。

springboot自定義redis-starter的實現

10、全劇終

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

到此這篇關于springboot自定義redis-starter的實現的文章就介紹到這了,更多相關springboot自定義redis-starter內容請搜索好吧啦網以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持好吧啦網！

Spring

上一條：SpringBoot+Redis實現數據字典的方法下一條：Springboot基于maven打包分離lib及resource

相關文章：

1. 使用Maven 搭建 Spring MVC 本地部署Tomcat的詳細教程2. IntelliJ IDEA配置Tomcat服務器的方法3. idea刪除項目的操作方法4. IntelliJ IDEA導入jar包的方法5. IntelliJ IDEA設置默認瀏覽器的方法6. IntelliJ IDEA恢復刪除文件的方法7. idea重置默認配置的方法步驟8. idea導入maven項目的方法9. Docker 部署 Prometheus的安裝詳細教程10. IntelliJ IDEA調整字體大小的方法

排行榜

					
					使用Maven 搭建 Spring MVC 本地部署Tomcat的詳細教程
IntelliJ IDEA恢復刪除文件的方法
IntelliJ IDEA設置默認瀏覽器的方法
IntelliJ IDEA配置Tomcat服務器的方法
IntelliJ IDEA導入jar包的方法
idea刪除項目的操作方法
Docker 部署 Prometheus的安裝詳細教程
idea導入maven項目的方法
idea重置默認配置的方法步驟
IntelliJ IDEA調整字體大小的方法
IntelliJ IDEA設置背景圖片的方法步驟
				