0、安裝redis需要注意的點:
由於項目可能是分佈式環境下的,所以需要配置redis.conf中的:
> bind 0.0.0.0
這樣配置後就可以讓任意服務器都能訪問redis。
開啓後臺執行:
> daemonize yes
啓動redis服務:
> redis-server ./redis.conf
查看redis進程:
>ps -ef | grep redis
訪問redis:
> redis-cli
設置key:
> set key1 123
獲取key對應的value:
> get key1
退出:
> exit
其他操作以及配置不做介紹。
一、好了下面開始講解redis的集成。
添加Jedis、fastjson依賴(可以將 Java 對象轉換爲 JSON 格式)。
由於fastjson序列化之後是一個json格式的,可讀的所以選擇使用它。
接着需要在properties中配置下redis:
redis.host=localhost
redis.port=6379
redis.timeout=10
redis.password=12345
redis.poolMaxTotal=1000
redis.poolMaxIdle=500
redis.poolMaxWait=500
接着根據配置來定義一個類,這個類的作用就是把上面的配置數據給加載進來的:(setter、getter省略)
@Component
@ConfigurationProperties(prefix="redis")
public class RedisConfig {
private String host;
private int port;
private int timeout;
private String password;
private int poolMaxTotal;
private int poolMaxIdle;
private int poolMaxWait;
}
系統登錄的時候就會把配置信息加載到該類中去。
創建RedisService來提供redis的服務,因爲我們的controller中大概需要這樣的功能:
@RequestMapping("/redis/get")
@ResponseBody
public Result<User> redisGet() {
User user = redisService.get(UserKey.getById, ""+1, User.class);
return Result.success(user);
}
在redisService中去封裝一些操作:從JedisPool對象中去獲取一些操作方法:
獲取單個對象,通過jedisPool獲取jedis對象,然後進行get,set操作:
@Autowired
JedisPool jedisPool;
public <T> T get(KeyPrefix prefix, String key, Class<T> clazz) {
Jedis jedis = null;
try {
jedis = jedisPool.getResource();
String realKey = prefix.getPrefix() + key;
String str = jedis.get(realKey);
T t = stringToBean(str, clazz);
return t;
}finally {
returnToPool(jedis);
}
}
private void returnToPool(Jedis jedis) {
if(jedis != null) {
jedis.close();
}
}
解讀:1、首先注入獲取jedisPool對象,然後在get方法中創建jedis對象,再根據jedisPool.getResource()方法來獲取jedis對象,然後才能實現set、get方法。2、因爲連接池用完需要釋放掉,所以使用try{},來釋放連接池。3、在returnToPool方法中,如果jedis不爲空,則close掉,實際上並沒有關閉,只是把他返回到連接池裏面。4、由於jedis.get返回的是一個String類型的,所以需要轉化爲一個bean的對象。
爲了更好的封裝以及避免循環依賴(因爲如果JedisPool依賴於redisService,但是在redisService中又注入了jedisPools,這樣就出現衝突了),定義一個RedisPoolFactory類,通過JedisPoolFactory方法將jedisPool加載到spring容器中去:
@Service
public class RedisPoolFactory {
@Autowired
RedisConfig redisConfig;
@Bean
public JedisPool JedisPoolFactory() {
JedisPoolConfig poolConfig = new JedisPoolConfig();
poolConfig.setMaxIdle(redisConfig.getPoolMaxIdle());
poolConfig.setMaxTotal(redisConfig.getPoolMaxTotal());
poolConfig.setMaxWaitMillis(redisConfig.getPoolMaxWait() * 1000);
JedisPool jp = new JedisPool(poolConfig, redisConfig.getHost(), redisConfig.getPort(),
redisConfig.getTimeout()*1000, redisConfig.getPassword(), 0);
return jp;
}
}
解讀:通過jedisPool的bean注入到spring的容器裏面,在set、get的時候就通過jedisPoo來獲取jedis對象,然後通過jedis對象就能進行get、set操作了。
上面講到了字符串需要轉化爲一個bean對象,但是在設置值的時候,set進去的是String類型的,所以又需要講bean對象轉化成String類型:
public static <T> String beanToString(T value) {
if(value == null) {
return null;
}
Class<?> clazz = value.getClass();
if(clazz == int.class || clazz == Integer.class) {
return ""+value;
}else if(clazz == String.class) {
return (String)value;
}else if(clazz == long.class || clazz == Long.class) {
return ""+value;
}else {
return JSON.toJSONString(value);
}
}
@SuppressWarnings("unchecked")
public static <T> T stringToBean(String str, Class<T> clazz) {
if(str == null || str.length() <= 0 || clazz == null) {
return null;
}
if(clazz == int.class || clazz == Integer.class) {
return (T)Integer.valueOf(str);
}else if(clazz == String.class) {
return (T)str;
}else if(clazz == long.class || clazz == Long.class) {
return (T)Long.valueOf(str);
}else {
return JSON.toJavaObject(JSON.parseObject(str), clazz);
}
}
解讀:1、beanToString:如果是int和long類型,則直接寫入,如果是String類型,則直接返回,如果是其他類型則通JSON.toJSONString()去轉換。
2、stringToBean:首先判斷字符串以及對象是否爲空,接着根據bean的具體什麼類型去進行轉化。
這裏不對set進行展示了,和get一樣,只不過步驟不一樣,set方法在jedis.set()之前需要講bean對象轉化成字符串。
二、這裏需要考慮一個問題:在controller中如果是多人開發,key有可能會被覆蓋掉。
思路:給key拼上一個前綴,以防止被覆蓋,例如部門有部門的key,用戶有用戶的key,所以需要對key做一個封裝,通用緩存key封裝。
接口<-抽象類<-實現類。
首先定義Prefix前綴接口,比如用戶緩存,就用用戶的Prefix前綴key緩存,公司就用公司的Prefix前綴key緩存。
public interface KeyPrefix {
public int expireSeconds();
public String getPrefix();
}
有:有效期以及前綴這兩個屬性。
接着是抽象類:
public abstract class BasePrefix implements KeyPrefix{
private int expireSeconds;
private String prefix;
public BasePrefix(String prefix) {
this(0, prefix);
}
public BasePrefix( int expireSeconds, String prefix) {
this.expireSeconds = expireSeconds;
this.prefix = prefix;
}
public int expireSeconds() {
return expireSeconds;
}
public String getPrefix() {
String className = getClass().getSimpleName();
return className+":" + prefix;
}
}
解讀:首先定義兩個屬性(key的時間有效期+key的前綴),接着定義一個構造方法,這樣用戶就沒法new了,通過構造函數,對變量進行賦值,需要定義一個有效期的方法,用來返回有效期時間,默認0代表永不過期,接着需要一個設置前綴的方法,獲取類名,然後就是類名拼上prefix。
實現類:例如user模塊。
public class UserKey extends BasePrefix{
private UserKey(String prefix) {
super(prefix);
}
public static UserKey getById = new UserKey("id");
public static UserKey getByName = new UserKey("name");
}
解讀:這樣在redisService中的get()方法裏,就能生成一個真正的key:
String realKey = prefix.getPrefix() + key;
getPrefix首先會拿到實際類的名稱,然後再拼上前綴。
需要對前面的set()方法重新完善,因爲set一個對象需要給他配置上一個有效期:
public <T> boolean set(KeyPrefix prefix, String key, T value) {
Jedis jedis = null;
try {
jedis = jedisPool.getResource();
String str = beanToString(value);
if(str == null || str.length() <= 0) {
return false;
}
String realKey = prefix.getPrefix() + key;
int seconds = prefix.expireSeconds();
if(seconds <= 0) {
jedis.set(realKey, str);
}else {
jedis.setex(realKey, seconds, str);
}
return true;
}finally {
returnToPool(jedis);
}
}
如果小於0,則是永不過期的,調用set,否則調用setex:先設置一個值,然後設置一個過期時間。
封裝的好處:不一樣的模塊,可以有不一樣的key,同一個模塊內部只要保證id不一樣,就肯定不會出現重複了。
後面是進行一些完善:在redisService中添加一些方法(exists:判斷key是否存在、delete:刪除、incr:增加值 、decr:減少值)
例如根據jedis.exists命令去判斷,其他方法也是直接通過jedis命令去操作,不進行一一列舉了。
public <T> boolean exists(KeyPrefix prefix, String key) {
Jedis jedis = null;
try {
jedis = jedisPool.getResource();
String realKey = prefix.getPrefix() + key;
return jedis.exists(realKey);
}finally {
returnToPool(jedis);
}
}