springboot自定義redis-starter的實現(xiàn)
更新時間：2020年10月15日 15:20:05 作者：zhouhouxing
這篇文章主要介紹了springboot自定義redis-starter的實現(xiàn),文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
spring時代整合redis
spring我相信只要是一個Java開發(fā)人員我相信再熟悉不過了，幾乎壟斷了整個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">
<!-- 最大連接數(shù)-->
<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、這樣子以后我們就可以在業(yè)務層通過 @Autowired 引用redis操作模板了
@Autowired
RedisTemplate<String,String> redisTemplate;
3、上面就是spring使用redis的大致流程。
這樣子看起來也還好啊？
但是每個項目都要去經(jīng)過這么一系列繁瑣的xml配置，這就是重復工作了。這時候就出現(xiàn)了“springboot” 就是專門去做這些整合的事情了，讓我們不需要整合這些只需幾行基礎配置即可。
springboot 實現(xiàn)自動裝配redis
在開始spring boot之前我們首先要來看幾個注解，spring boot實現(xiàn)自定義裝配的核心就是這幾個注解：
1、@Import：Import注解的主要的作用是將bean導入到spring容器中，比如說要自定義一些bean交spring容器托管，這是我們就可以建一個配置類使用import注解專門去導入你自定義的一些bean到spring容器中。
2、@Bean：Bean注解告訴Spring這個方法將會返回一個對象，這個對象要注冊為Spring應用上下文中的bean。通常方法體中包含了最終產(chǎn)生bean實例的邏輯。
3、@Component：通常是通過類路徑掃描來自動偵測以及自動裝配到Spring容器中。
4、@Configuration：來聲明一個spring的配置類等同于spring中的xml文件，ConfigurationClassPostProcessor::enhanceConfigurationClasses這個方法是Configuration注解工作的核心方法，spring應用啟動時所有的被@Configuration注解的類都會被spring cglib庫生成cglib動態(tài)代理，然后其他地方通過@Autowired注解引入Student類對象就會被生成的configuration配置類生成的動態(tài)代理攔截，處理完后再調(diào)用原configuration注解類的student方法獲取到Student實例。
5、@Conditiona：個人感覺主要是做一些判斷條件的、只有當condition的machet匹配方法為 true 的時候【該方法內(nèi)也是我們實現(xiàn)一些自定義邏輯判斷的擴展點】，才會去加載該bean 否則不加載該bean。
----- condition又繁衍出很多子類（方便我們直接使用）
@ConditionalOnMissingBean：當容器下有當前這個bean就不加載沒有則加載
@ConditionalOnExpression：當括號中的內(nèi)容為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的時候，就執(zhí)行下面操作
@ConditionalOnBean：只有當給定的bean存在時、則實例化當前bean。
1、新建兩個項目：一個autoconfig一個starter項目
注：【maven項目即可】。
starter：主要是做讓其他項目依賴的start。
autoconfig：實現(xiàn)具體自動裝配邏輯處理。
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項目中創(chuàng)建一個包configuration、再創(chuàng)建一個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、創(chuàng)建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、創(chuàng)建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優(yōu)雅擴展的入口
我們打開springboot自動配置jar里面的源碼：
springboot自動裝配主要是掃描
【META-INF 下的 spring.factories 文件下 # Auto Configure】下的所有類
因此我們照葫蘆畫瓢【在starter下創(chuàng)建META-INF 再創(chuàng)建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的實現(xiàn)的文章就介紹到這了,更多相關springboot自定義redis-starter內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
您可能感興趣的文章:
相關文章
java中對字符串每個字符統(tǒng)計的方法，需要的朋友可以參考一下2013-03-03
log4j是一個常用的日志框架，用于記錄應用程序的執(zhí)行過程或異常等記錄在日志文件中。本文將利用Log4j記錄日志，感興趣的可以了解一下2022-03-03
這篇文章主要介紹了java 動態(tài)代理的的相關資料，文中講解非常細致，代碼幫助大家更好的理解和學習，感興趣的朋友可以了解下2020-06-06
這篇文章主要介紹了從內(nèi)存地址解析Java的static關鍵字的作用,包括靜態(tài)成員變量和靜態(tài)方法等重要內(nèi)容,需要的朋友可以參考下2015-10-10
這篇文章主要介紹了Java Socket實現(xiàn)單線程通信的方法,結合具體實例形式分析了java socket單線程通信的原理與客戶端、服務器端相關實現(xiàn)技巧,需要的朋友可以參考下2017-06-06
這篇文章主要介紹了Java設計模式之代理模式詳解,文中有非常詳細的代碼示例,對正在學習java的小伙伴們有很好的幫助,需要的朋友可以參考下2021-05-05
JSON（JavaScript Object Notation）是數(shù)據(jù)交換的輕量級格式,它以易于人類閱讀和機器解析的方式組織數(shù)據(jù),基于鍵值對,在Java開發(fā)中,處理JSON數(shù)據(jù)通常涉及使用Jackson、Gson、Fastjson等庫,本文給大家介紹JSON數(shù)據(jù)操作與處理全面指南,感興趣的朋友一起看看吧2024-10-10
JVM啟動時分配的內(nèi)存稱為堆內(nèi)存,與之相對的,在代碼中還可以使用堆外內(nèi)存,比如Netty,廣泛使用了堆外內(nèi)存,下面這篇文章主要給大家介紹了關于JVM分配和回收堆外內(nèi)存的方式與注意點,需要的朋友可以參考下2022-07-07
這里僅僅舉個簡單例子來說明原理，不是完全針對MyBatis的，這種思想我們也可以應用在其他地方。地mybatis接口實現(xiàn)原理感興趣的朋友一起看看吧2017-07-07
這篇文章主要介紹了Springboot Activemq整合過程代碼圖解,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-02-02