thinkphp5.1redis主從配置

桔子愛笑發表於2020-09-24

專案要求的大概意思是,redis主從讀寫分離,寫要在主機上執行,讀要在從機上執行,主機當機了之後,哨兵模式自動選擇一臺從機,這一切操作都不能影響前臺php業務邏輯的操作

一環境配置

首先需要再伺服器上配置開啟三個redis服務模擬三臺redis伺服器,埠分別是6379,6380,6381(主:6379,從:6380,6381),並開啟哨兵模式(關於如何開啟,參考b站狂神說的redis精講-哨兵模式詳解)

二 專案相關檔案

1 專案config目錄下新建redis.php、

return [
    'host' => '127.0.0.1,127.0.0.1,127.0.0.1',
    'port' => '6379,6380,6381'
];

2 extend資料夾下新建資料夾和檔案redis/redis.php

<?php
/**
 * Created by PhpStorm.
 * User: Administrator
 * Date: 2019/5/23
 * Time: 18:56
 */

namespace Redis;

use think\Exception;
use think\exception\ClassNotFoundException;
use think\Log;

class Redis
{

    static protected $instance;
    protected $index = 0;
    protected $port = 6379;
    protected $host = "127.0.0.1";
    protected $options;
    protected $handler;


    public function __construct($options=[]){
        if ( !extension_loaded('redis') ) {
            E(L('_NOT_SUPPERT_').':redis');
        }
        if(empty($options)) {
            $options = array (
                'host'          => config('redis.host') ? config('redis.host') : '127.0.0.1',
                'port'          => config('redis.port') ? config('redis.port') : 6379,
                'timeout'       => config('redis.timeout') ? config('redis.timeout') : false,
                'persistent'    => config('redis.persistent') ? config('redis.persistent') : false,
                'auth'          => config('redis.password') ? config('redis.password') : false,
            );
        }
        $options['host'] = explode(',', $options['host']);

        $options['port'] = explode(',', $options['port']);
        $options['auth'] = explode(',', $options['auth']);
        foreach ($options['host'] as $key=>$value) {
            if (!isset($options['port'][$key])) {
                $options['port'][$key] = $options['port'][0];
            }
            if (!isset($options['auth'][$key])) {
                $options['auth'][$key] = $options['auth'][0];
            }
        }
        $this->options =  $options;
        $expire = config('redisd.expire');
        $this->options['expire'] =  isset($expire) ? (int)$expire : (int)ini_get('session.gc_maxlifetime');;
        $this->options['prefix'] =  isset($options['prefix']) ?  $options['prefix']  :   config('SESSION_PREFIX');
        $this->handler  = new \Redis;
    }

    /**
     * 連線Redis服務端
     * @access public
     * @param bool $is_master : 是否連線主伺服器
     */
    public function connect($is_master = true) {

       //主要是這個方法 判斷主從就是在這裡執行並連線的
        $func = $this->options['persistent'] ? 'pconnect' : 'connect';
        for($i=0;$i<=2;$i++){
            echo $i;
            try {
                if ($this->options['timeout'] === false) {

                    $result = $this->handler->$func($this->options['host'][$i], $this->options['port'][$i]);
                    //if (!$result) throw new ClassNotFoundException('Redis Error', 100);
                } else {
                    $result = $this->handler->$func($this->options['host'][$i], $this->options['port'][$i], $this->options['timeout']);
                   // if (!$result) throw new ClassNotFoundException('Redis Error', 101);
                }
                if ($this->options['auth'][$i]) {
                    $result = $this->handler->auth($this->options['auth'][$i]);
                }
                if (!$result) throw new ClassNotFoundException('Redis Error', 102);
                if($is_master&&$this->handler->info('replication')['role']=='master'){

                   break;
                }
                if(!$is_master&&($this->handler->info('replication')['role']=='slave')){
                    break;
                }
                $this->handler->close();
            } catch ( \Exception $e ) {
                exit('Error Message:'.$e->getMessage().'<br>Error Code:'.$e->getCode().'');
            }

        }

    }
    /**
     * Power: Mikkle
     * Email:776329498@qq.com
     * @param array $options
     * @return Redis
     */
    public static function instance($options = [])
    {
        return new Redis($options);
    }

    public function getKeys($key = '*')
    {
        $this->connect(false);
        return $this->handler->getKeys($key);
    }


    public function setExpire($key, $time = 0)
    {

        if (!$key) {
            return false;
        }
        $this->connect(true);

        switch (true) {
            case ($time == 0):
                return $this->handler->expire($key, 0);
                break;
            case ($time > time()):
                $this->handler->expireAt($key, $time);
                break;
            default:
                return $this->handler->expire($key, $time);
        }
    }


    /*------------------------------------start 1.string結構----------------------------------------------------*/
    /**
     * 增,設定值  構建一個字串
     * @param string $key KEY名稱
     * @param string $value 設定值
     * @param int $timeOut 時間  0表示無過期時間
     * @return true【總是返回true】
     */
    public function set($key, $value, $timeOut = 0)
    {
        $this->connect(true);
        $setRes = $this->handler->set($key, $value);
        if ($timeOut > 0) $this->handler->expire($key, $timeOut);
        return $setRes;
    }

    /**
     * 查,獲取 某鍵對應的值,不存在返回false
     * @param $key ,鍵值
     * @return bool|string ,查詢成功返回資訊,失敗返回false
     */
    public function get($key)
    {
        $this->connect(false);
        $setRes = $this->handler->get($key);//不存在返回false
        if ($setRes === 'false') {
            return false;
        }
        return $setRes;
    }
    /*------------------------------------1.end string結構----------------------------------------------------*/


    /*------------------------------------2.start list結構----------------------------------------------------*/
    /**
     * 增,構建一個列表(先進後去,類似棧)
     * @param String $key KEY名稱
     * @param string $value 值
     * @param $timeOut |num  過期時間
     */
    public function lPush($key, $value, $timeOut = 0)
    {
//          echo "$key - $value \n";
        $this->connect(true);

        $re = $this->handler->LPUSH($key, $value);

        if ($timeOut > 0) $this->handler->expire($key, $timeOut);
        return $re;
    }

    /**
     * 增,構建一個列表(先進先去,類似佇列)
     * @param string $key KEY名稱
     * @param string $value 值
     * @param $timeOut |num  過期時間
     */
    public function rPush($key, $value, $timeOut = 0)
    {
        $this->connect(true);

        $re = $this->handler->RPUSH($key, $value);
        if ($timeOut > 0) $this->handler->expire($key, $timeOut);
        return $re;
    }

    /**
     * 查,獲取所有列表資料(從頭到尾取)
     * @param string $key KEY名稱
     * @param int $head 開始
     * @param int $tail 結束
     */
    public function lRanges($key, $head, $tail)
    {    $this->connect(false);
        return $this->handler->lrange($key, $head, $tail);
    }

    /**
     * Power by Mikkle
     * QQ:776329498
     * @param $key
     * @return mixed
     */

    public function rPop($key)
    {  $this->connect(true);
        $this->handler->rPop($key);

    }

    public function lPop($key)
    {   $this->connect(true);
        return $this->handler->lpop($key);
    }

    /*------------------------------------2.end list結構----------------------------------------------------*/


    /*------------------------------------3.start set結構----------------------------------------------------*/

    /**
     * 增,構建一個集合(無序集合)
     * @param string $key 集合Y名稱
     * @param string|array $value 值
     * @param int $timeOut 時間  0表示無過期時間
     * @return
     */
    public function sAdd($key, $value, $timeOut = 0)
    {
        $this->connect(true);
        $re = $this->handler->sadd($key, $value);
        if ($timeOut > 0) $this->handler->expire($key, $timeOut);
        return $re;
    }

    /**
     * 查,取集合對應元素
     * @param string $key 集合名字
     */
    public function sMembers($key)
    {
        $this->connect(false);
        $re = $this->handler->exists($key);//存在返回1,不存在返回0

        if (!$re) return false;
        return $this->handler->smembers($key);
    }

    /*------------------------------------3.end  set結構----------------------------------------------------*/


    /*------------------------------------4.start sort set結構----------------------------------------------------*/
    /*
     * 增,改,構建一個集合(有序集合),支援批量寫入,更新
     * @param string $key 集合名稱
     * @param array $score_value key為scoll, value為該權的值
     * @return int 插入操作成功返回插入數量【,更新操作返回0】
     */
    public function zadd($key, $score_value, $timeOut = 0)
    {
        $this->connect(true);

        if (!is_array($score_value)) return false;
        $a = 0;//存放插入的數量
        foreach ($score_value as $score => $value) {
            $re = $this->handler->zadd($key, $score, $value);//當修改時,可以修改,但不返回更新數量
            $re && $a += 1;
            if ($timeOut > 0) $this->handler->expire($key, $timeOut);
        }

        return $a;
    }

    /**
     * 查,有序集合查詢,可升序降序,預設從第一條開始,查詢一條資料
     * @param $key ,查詢的鍵值
     * @param $min ,從第$min條開始
     * @param $max,查詢的條數
     * @param $order ,asc表示升序排序,desc表示降序排序
     * @return array|bool 如果成功,返回查詢資訊,如果失敗返回false
     */
    public function zRange($key, $min = 0, $num = 1, $order = 'desc')
    { $this->connect(false);
        $re = $this->handler->exists($key);//存在返回1,不存在返回0

        if (!$re) return false;//不存在鍵值
        if ('desc' == strtolower($order)) {
            $re = $this->handler->zrevrange($key, $min, $min + $num - 1);
        } else {
            $re = $this->handler->zrange($key, $min, $min + $num - 1);
        }
        if (!$re) return false;//查詢的範圍值為空
        return $re;
    }

    /**
     * 返回集合key中,成員member的排名
     * @param $key,鍵值
     * @param $member,scroll值
     * @param $type ,是順序查詢還是逆序
     * @return bool,鍵值不存在返回false,存在返回其排名下標
     */
    public function zrank($key, $member, $type = 'desc')
    {
        $this->connect(false);
        $type = strtolower(trim($type));
        if ($type == 'desc') {
            $re = $this->handler->zrevrank($key, $member);//其中有序整合員按score值遞減(從大到小)順序排列,返回其排位
        } else {
            $re = $this->handler->zrank($key, $member);//其中有序整合員按score值遞增(從小到大)順序排列,返回其排位
        }

        if (!is_numeric($re)) return false;//不存在鍵值

        return $re;
    }

    /**
     * 返回名稱為key的zset中score >= star且score <= end的所有元素
     * @param $key
     * @param $member
     * @param $star,
     * @param $end ,
     * @return array
     */
    public function zrangbyscore($key, $star, $end)
    {   $this->connect(false);
        return $this->handler->ZRANGEBYSCORE($key, $star, $end);
    }

    /**
     * 返回名稱為key的zset中元素member的score
     * @param $key
     * @param $member
     * @return string ,返回查詢的member值
     */
    function zScore($key, $member)
    {
        $this->connect(false);
        $this->handler->ZSCORE($key, $member);
    }
    /*------------------------------------4.end sort set結構----------------------------------------------------*/


    /*------------------------------------5.hash結構----------------------------------------------------*/

    public function hSetJson($redis_key, $field, $data, $timeOut = 0)
    {
        $this->connect(true);
        $redis_info = json_encode($data);                           //field的資料value,以json的形式儲存
        $re = $this->handler->hSet($redis_key, $field, $redis_info);//存入快取
        if ($timeOut > 0) $this->handler->expire($redis_key, $timeOut);//設定過期時間
        return $re;
    }

    public function hGetJson($redis_key, $field)
    {
        $this->connect(false);
        $info = $this->handler->hget($redis_key, $field);
        if ($info) {
            $info = json_decode($info, true);
        } else {
            $info = false;
        }
        return $info;
    }

    public function hSet($redis_key, $name, $data, $timeOut = 0)
    {
        $this->connect(true);
        $re = $this->handler->hset($redis_key, $name, $data);
        if ($timeOut > 0) $this->handler->expire($redis_key, $timeOut);
        return $re;
    }

    public function hSetNx($redis_key, $name, $data, $timeOut = 0)
    {
        $this->connect(true);
        $re = $this->handler->hsetNx($redis_key, $name, $data);
        if ($timeOut > 0) $this->handler->expire($redis_key, $timeOut);
        return $re;
    }


    /**
     * 增,普通邏輯的插入hash資料型別的值
     * @param $key ,鍵名
     * @param $data |array 一維陣列,要儲存的資料
     * @param $timeOut |num  過期時間
     * @return $number 返回OK【更新和插入操作都返回ok】
     */
    public function hMset($key, $data, $timeOut = 0)
    {
        $this->connect(true);
        $re = $this->handler->hmset($key, $data);
        if ($timeOut > 0) $this->handler->expire($key, $timeOut);
        return $re;
    }

    /**
     * 查,普通的獲取值
     * @param $key ,表示該hash的下標值
     * @return array 。成功返回查詢的陣列資訊,不存在資訊返回false
     */
    public function hVals($key)
    {
        $this->connect(true);
        $re = $this->handler->exists($key);//存在返回1,不存在返回0
        if (!$re) return false;
        $vals = $this->handler->hvals($key);
        $keys = $this->handler->hkeys($key);
        $re = array_combine($keys, $vals);
        foreach ($re as $k => $v) {
            if (!is_null(json_decode($v))) {
                $re[$k] = json_decode($v, true);//true表示把json返回成陣列
            }
        }
        return $re;
    }

    /**
     *
     * @param $key
     * @param $filed
     * @return bool|string
     */
    public function hGet($key, $filed = [])
    {
        $this->connect(false);
        if (empty($filed)) {
            $re = $this->handler->hgetAll($key);
        } elseif (is_string($filed)) {
            $re = $this->handler->hget($key, $filed);
        } elseif (is_array($filed)) {
            $re = $this->handler->hMget($key, $filed);
        }
        if (!$re) {
            return false;
        }
        return $re;
    }

    public function hDel($redis_key, $name)
    {
        $this->connect(true);
        $re = $this->handler->hdel($redis_key, $name);
        return $re;
    }

    public function hLan($redis_key)
    {
        $this->connect(false);
        $re = $this->handler->hLen($redis_key);
        return $re;
    }

    public function hIncre($redis_key, $filed, $value = 1)
    {
        $this->connect(true);
        return $this->handler->hIncrBy($redis_key, $filed, $value);
    }

    /**
     * 檢驗某個鍵值是否存在
     * @param $keys keys
     * @param string $type 型別,預設為常規
     * @param string $field 若為hash型別,輸入$field
     * @return bool
     */
    public function hExists($keys, $field = '')
    {
        $this->connect(false);
        $re = $this->handler->hexists($keys, $field);//有返回1,無返回0
        return $re;
    }



    /*------------------------------------end hash結構----------------------------------------------------*/


    /*------------------------------------其他結構----------------------------------------------------*/
    /**
     * 設定自增,自減功能
     * @param $key ,要改變的鍵值
     * @param int $num ,改變的幅度,預設為1
     * @param string $member ,型別是zset或hash,需要在輸入member或filed欄位
     * @param string $type,型別,default為普通增減 ,還有:zset,hash
     * @return bool|int 成功返回自增後的scroll整數,失敗返回false
     */
    public function incre($key, $num = 1, $member = '', $type = '')
    {
        $this->connect(true);
        $num = intval($num);
        switch (strtolower(trim($type))) {
            case "zset":
                $re = $this->handler->zIncrBy($key, $num, $member);//增長權值
                break;
            case "hash":
                $re = $this->handler->hincrby($key, $member, $num);//增長hashmap裡的值
                break;
            default:
                if ($num > 0) {
                    $re = $this->handler->incrby($key, $num);//預設增長
                } else {
                    $re = $this->handler->decrBy($key, -$num);//預設增長
                }
                break;
        }
        if ($re) return $re;
        return false;
    }


    /**
     * 清除快取
     * @param int $type 預設為0,清除當前資料庫;1表示清除所有快取
     */
    function flush($type = 0)
    {
        $this->connect(true);
        if ($type) {
            $this->handler->flushAll();//清除所有資料庫
        } else {
            $this->handler->flushdb();//清除當前資料庫
        }
    }

    /**
     * 檢驗某個鍵值是否存在
     * @param $keys keys
     * @param string $type 型別,預設為常規
     * @param string $field 若為hash型別,輸入$field
     * @return bool
     */
    public function exists($keys, $type = '', $field = '')
    {
        $this->connect(false);
        switch (strtolower(trim($type))) {
            case 'hash':
                $re = $this->handler->hexists($keys, $field);//有返回1,無返回0
                break;
            default:
                $re = $this->handler->exists($keys);
                break;
        }
        return $re;
    }

    /**
     * 刪除快取
     * @param string|array $key 鍵值
     * @param $type 型別 預設為常規,還有hash,zset
     * @param string $field ,hash=>表示$field值,set=>表示value,zset=>表示value值,list型別特殊暫時不加
     * @return int |  返回刪除的個數
     */
    public function delete($key, $type = "default", $field = '')
    {
        $this->connect(true);
        switch (strtolower(trim($type))) {
            case 'hash':
                $re = $this->handler->hDel($key, $field);//返回刪除個數
                break;
            case 'set':
                $re = $this->handler->sRem($key, $field);//返回刪除個數
                break;
            case 'zset':
                $re = $this->handler->zDelete($key, $field);//返回刪除個數
                break;
            default:
                $re = $this->handler->del($key);//返回刪除個數
                break;
        }
        return $re;
    }

    //日誌記錄
    public function logger($log_content, $position = 'user')
    {
        $this->connect(true);
        $max_size = 1000000;   //宣告日誌的最大尺寸1000K

        $log_dir = './log';//日誌存放根目錄

        if (!file_exists($log_dir)) mkdir($log_dir, 0777);//如果不存在該資料夾,建立

        if ($position == 'user') {
            $log_filename = "{$log_dir}/User_redis_log.txt";  //日誌名稱
        } else {
            $log_filename = "{$log_dir}/Wap_redis_log.txt";  //日誌名稱
        }

        //如果檔案存在並且大於了規定的最大尺寸就刪除了
        if (file_exists($log_filename) && (abs(filesize($log_filename)) > $max_size)) {
            unlink($log_filename);
        }

        //寫入日誌,內容前加上時間, 後面加上換行, 以追加的方式寫入
        file_put_contents($log_filename, date('Y-m-d_H:i:s') . " " . $log_content . "\n", FILE_APPEND);
    }


    function flushDB()
    {
        $this->connect(true);
        $this->handler->flushDB();
    }

    function __destruct()
    {
        $this->handler->close();
    }

    /**
     * 魔術方法 有不存在的操作的時候執行
     * @access public
     * @param string $method 方法名
     * @param array $args 引數
     * @return mixed
     */
    public function __call($method, $args)
    {
        call_user_func_array([$this->handler, $method], $args);
    }


}

專案的控制器中就可以直接 new redis()–>方法名()使用了,

相關文章