4.客户端端接入文档

深碍√TFBOYSˉ_ 2022-06-16 14:36 222阅读 0赞

*  [一、客户端接入流程图][Link 1]
 *  [二、接入方法][Link 2]
    
     *  [1. REST API][]
     *  [2. Java客户端][2. Java]
 *  [三、扩展][Link 3]

## 一、客户端接入流程图 ##

CacheCloud服务不是客户端的代理，只是通过Http的形式获取到应用的信息(Redis各种类型实例的基本信息)，客户端仍然直接调用Redis服务，这点无需担心。

![687474703a2f2f75706c6f61642d696d616765732e6a69616e7368752e696f2f75706c6f61645f696d616765732f313439333837382d653133383034383135393337613333652e706e673f696d6167654d6f6772322f6175746f2d6f7269656e742f7374726970253743696d61676556696577322f322f772f31323430][]

## 二、接入方法 ##

### 1. REST API ###

#### (1) 接口地址 ####

http://ip:port/cache/client/redis/${appType}/{appId}.json?clientVersion=1.0-SNAPSHOT
    
    appType=cluster|sentinel|standalone    
    
    appId是应用id
    
    Cachecloud项目中，clientVersion中版本是必须参数，CacheCloud会根据\src\main\resources\client.properties来决定当前用户客户端是否是较好的，这里甚至可以做强制更新。
    client.properties
    redis_good_versions = 1.0-SNAPSHOT
    warn_versions = 0.1
    error_versions = 0.0

#### (2) REST接口结果 ####

{
      message: "client is up to date, Cheers!",
      shardNum: 10,
      appId: 10192,
      status: 1,
      shardInfo: "10.10.xx.xx:6390,10.10.xx.xx:6382 10.10.xx.xx:6387,10.10.xx.xx:6379 10.10.xx.xx:6387,10.10.xx.xx:7382 10.10.xx.xx:6380,10.10.xx.xx:6392"
    }

### 2. Java客户端 ###

Cachecloud为Java开发者提供了Redis的客户端，基本实现原理也是调用上面的REST接口，解析，初始化对应Jedis代码(JedisPool, JedisSentinelPool, JedisCluster)

如果需要使用改客户端，请注意如下：

修改\src\main\resources\cacheCloudClient.properties中的domain_url为你的域名，这个域名是作为获取REST接口用。

## 三、扩展 ##

### 1. redis客户端耗时的统计： ###

相比于redis服务端的耗时统计，客户端和实例、应用多维度的耗时统计更能方便定位问题。

### 2. redis中value大小区间的统计： ###

帮助确定系统中是否存在不合理的kv值。

### 3. redis客户端的异常统计： ###

帮助用户快速发现redis异常（例如超时，poolconfig分配不合理等等）。

使用方法详见：[http://cachecloud.github.io/2016/05/31/cachecloud%E5%AE%A2%E6%88%B7%E7%AB%AF%E7%BB%9F%E8%AE%A1%E4%B8%8A%E6%8A%A5%E5%8A%9F%E8%83%BD/][http_cachecloud.github.io_2016_05_31_cachecloud_E5_AE_A2_E6_88_B7_E7_AB_AF_E7_BB_9F_E8_AE_A1_E4_B8_8A_E6_8A_A5_E5_8A_9F_E8_83_BD] ![687474703a2f2f69332e6974632e636e2f32303136303132362f333038345f66343764343561625f643562625f646463325f386666625f3633373538326531643434665f312e6a7067][]

[Link 1]: https://github.com/sohutv/cachecloud/wiki/4.%E5%AE%A2%E6%88%B7%E7%AB%AF%E7%AB%AF%E6%8E%A5%E5%85%A5%E6%96%87%E6%A1%A3#cc1
[Link 2]: https://github.com/sohutv/cachecloud/wiki/4.%E5%AE%A2%E6%88%B7%E7%AB%AF%E7%AB%AF%E6%8E%A5%E5%85%A5%E6%96%87%E6%A1%A3#cc2
[1. REST API]: https://github.com/sohutv/cachecloud/wiki/4.%E5%AE%A2%E6%88%B7%E7%AB%AF%E7%AB%AF%E6%8E%A5%E5%85%A5%E6%96%87%E6%A1%A3#cc2-1
[2. Java]: https://github.com/sohutv/cachecloud/wiki/4.%E5%AE%A2%E6%88%B7%E7%AB%AF%E7%AB%AF%E6%8E%A5%E5%85%A5%E6%96%87%E6%A1%A3#cc2-2
[Link 3]: https://github.com/sohutv/cachecloud/wiki/4.%E5%AE%A2%E6%88%B7%E7%AB%AF%E7%AB%AF%E6%8E%A5%E5%85%A5%E6%96%87%E6%A1%A3#cc3
[687474703a2f2f75706c6f61642d696d616765732e6a69616e7368752e696f2f75706c6f61645f696d616765732f313439333837382d653133383034383135393337613333652e706e673f696d6167654d6f6772322f6175746f2d6f7269656e742f7374726970253743696d61676556696577322f322f772f31323430]: /images/20220616/acbca23e06144219841e5c4873bb4164.png
[http_cachecloud.github.io_2016_05_31_cachecloud_E5_AE_A2_E6_88_B7_E7_AB_AF_E7_BB_9F_E8_AE_A1_E4_B8_8A_E6_8A_A5_E5_8A_9F_E8_83_BD]: http://cachecloud.github.io/2016/05/31/cachecloud%E5%AE%A2%E6%88%B7%E7%AB%AF%E7%BB%9F%E8%AE%A1%E4%B8%8A%E6%8A%A5%E5%8A%9F%E8%83%BD/
[687474703a2f2f69332e6974632e636e2f32303136303132362f333038345f66343764343561625f643562625f646463325f386666625f3633373538326531643434665f312e6a7067]: /images/20220616/f02f54a7c1ba471dbf270c8698278c29.png