小說軟體原始碼的快取設計，保證服務的正常執行

小說軟體原始碼快取設計原理

• 先刪除快取，再更新DB

• 先更新DB，再刪除快取

小說軟體原始碼快取程式碼解讀

func (cc CachedConn) QueryRow(v interface{}, key string, query QueryFn) error {
  return cc.cache.Take(v, key, func(v interface{}) error {
    return query(cc.db, v)
  })
}

func (c cacheNode) Take(v interface{}, key string, query func(v interface{}) error) error {
  return c.doTake(v, key, query, func(v interface{}) error {
    return c.SetCache(key, v)
  })
}

• 用 key 從小說軟體原始碼快取裡查詢資料
• 如果找到，則返回資料
• 如果找不到，用 query 方法去讀取資料
• 讀到後呼叫 c.SetCache(key, v) 設定快取

// v - 需要讀取的資料物件
// key - 快取key
// query - 用來從DB讀取完整資料的方法
// cacheVal - 用來寫快取的方法
func (c cacheNode) doTake(v interface{}, key string, query func(v interface{}) error,
  cacheVal func(v interface{}) error) error {
  // 用barrier來防止快取擊穿，確保一個程式內只有一個請求去載入key對應的資料
  val, fresh, err := c.barrier.DoEx(key, func() (interface{}, error) {
    // 從cache裡讀取資料
    if err := c.doGetCache(key, v); err != nil {
      // 如果是預先放進來的placeholder（用來防止快取穿透）的，那麼就返回預設的errNotFound
      // 如果是未知錯誤，那麼就直接返回，因為我們不能放棄快取出錯而直接把所有請求去請求DB，
      // 這樣在高併發的場景下會把DB打掛掉的
      if err == errPlaceholder {
        return nil, c.errNotFound
      } else if err != c.errNotFound {
        // why we just return the error instead of query from db,
        // because we don't allow the disaster pass to the DBs.
        // fail fast, in case we bring down the dbs.
        return nil, err
      }
      // 請求DB
      // 如果返回的error是errNotFound，那麼我們就需要在快取裡設定placeholder，防止快取穿透
      if err = query(v); err == c.errNotFound {
        if err = c.setCacheWithNotFound(key); err != nil {
          logx.Error(err)
        }
        return nil, c.errNotFound
      } else if err != nil {
        // 統計DB失敗
        c.stat.IncrementDbFails()
        return nil, err
      }
      // 把資料寫入快取
      if err = cacheVal(v); err != nil {
        logx.Error(err)
      }
    }
    
    // 返回json序列化的資料
    return jsonx.Marshal(v)
  })
  if err != nil {
    return err
  }
  if fresh {
    return nil
  }
  // got the result from previous ongoing query
  c.stat.IncrementTotal()
  c.stat.IncrementHit()
  // 把資料寫入到傳入的v物件裡
  return jsonx.Unmarshal(val.([]byte), v)
}

• 此時就直接用主鍵走 block 2 的邏輯了，後續同上面基於主鍵的快取邏輯

• 通過小說軟體原始碼索引從DB裡查詢完整行記錄，如有 error，返回
• 查到完整行記錄後，會把主鍵到完整行記錄的快取和索引到主鍵的快取同時寫到 redis 裡
• 返回所需的行記錄資料

// v - 需要讀取的資料物件
// key - 通過索引生成的快取key
// keyer - 用主鍵生成基於主鍵快取的key的方法
// indexQuery - 用索引從DB讀取完整資料的方法，需要返回主鍵
// primaryQuery - 用主鍵從DB獲取完整資料的方法
func (cc CachedConn) QueryRowIndex(v interface{}, key string, keyer func(primary interface{}) string,
  indexQuery IndexQueryFn, primaryQuery PrimaryQueryFn) error {
  var primaryKey interface{}
  var found bool
  // 先通過索引查詢快取，看是否有索引到主鍵的快取
  if err := cc.cache.TakeWithExpire(&primaryKey, key, func(val interface{}, expire time.Duration) (err error) {
    // 如果沒有索引到主鍵的快取，那麼就通過索引查詢完整資料
    primaryKey, err = indexQuery(cc.db, v)
    if err != nil {
      return
    }
    // 通過索引查詢到了完整資料，設定found，後面直接使用，不需要再從快取讀取資料了
    found = true
    // 將主鍵到完整資料的對映儲存到快取裡，TakeWithExpire方法已經將索引到主鍵的對映儲存到快取了
    return cc.cache.SetCacheWithExpire(keyer(primaryKey), v, expire+cacheSafeGapBetweenIndexAndPrimary)
  }); err != nil {
    return err
  }
  // 已經通過索引找到了資料，直接返回即可
  if found {
    return nil
  }
  // 通過主鍵從快取讀取資料，如果快取沒有，通過primaryQuery方法從DB讀取並回寫快取再返回資料
  return cc.cache.Take(v, keyer(primaryKey), func(v interface{}) error {
    return primaryQuery(cc.db, v, primaryKey)
  })
}

func (m *defaultUserModel) FindOneByUser(user string) (*User, error) {
  var resp User
  // 生成基於索引的key
  indexKey := fmt.Sprintf("%s%v", cacheUserPrefix, user)
  
  err := m.QueryRowIndex(&resp, indexKey,
    // 基於主鍵生成完整資料快取的key
    func(primary interface{}) string {
      return fmt.Sprintf("user#%v", primary)
    },
    // 基於索引的DB查詢方法
    func(conn sqlx.SqlConn, v interface{}) (i interface{}, e error) {
      query := fmt.Sprintf("select %s from %s where user = ? limit 1", userRows, m.table)
      if err := conn.QueryRow(&resp, query, user); err != nil {
        return nil, err
      }
      return resp.Id, nil
    },
    // 基於主鍵的DB查詢方法
    func(conn sqlx.SqlConn, v, primary interface{}) error {
      query := fmt.Sprintf("select %s from %s where id = ?", userRows, m.table)
      return conn.QueryRow(&resp, query, primary)
    })
  
  // 錯誤處理，需要判斷是否返回的是sqlc.ErrNotFound，如果是，我們用本package定義的ErrNotFound返回
  // 避免使用者感知到有沒有使用快取，同時也是對底層依賴的隔離
  switch err {
    case nil:
      return &resp, nil
    case sqlc.ErrNotFound:
      return nil, ErrNotFound
    default:
      return nil, err
  }
}