# cedis

**Repository Path**: yang_chen112358/cedis

## Basic Information

- **Project Name**: cedis
- **Description**: Redis所有场景应用
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-07-08
- **Last Updated**: 2023-02-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Cedis



### 简介

致力于打造依赖Redis/pika全部企业应用场景服务



### SpringBoot整合Cedis

Cedis提供了Spring boot Starter，对于Maven项目，请引入Maven坐标：

```xml
	<cedis.spring.boot.version>2.3.5-SNAPSHOT</cedis.spring.boot.version>
```

```xml
    <dependency>
      <groupId>org.example</groupId>
      <artifactId>cedis-spring-boot-starter</artifactId>
      <version>${cedis.spring.boot.version}</version>
    </dependency>
```

对于其他项目，请引入jar包：

http://cymal.upload.com/cedis-spring-boot-starter-2.3.5-SNAPSHOT.jar



### 内置Redis客户端

Cedis内置了现在主流的Redis客户端，并且也自创了客户端，目前支持的客户端有：

- jedis
- lettuce
- cedis



### Cedis配置文件

Cedis配置文件为xml类型，请在类路径（resources）下创建文件名为cedis.xml的文件，当springboot自动配置cedis后会扫描该路径，并把配置文件的集群信息导入到内存中。



##### redis-conf

代表一个cedis配置文件，是cedis.xml的根结点



##### redis-colony

代表一个redis/pika集群，一个redis-conf中必须有一个redis-colony结点

- name属性：集群名称
- type：redis/pika，默认值为redis，其他值报错



##### master

代表一个redis/pika集群的主结点，一个redis-colony集群结点下必须有且仅有一个master结点

- host：主结点ip地址
- port：主节点端口
- auth：主节点密码，可以缺省，默认值为空



##### slave

代表一个redis/pika集群的从结点，一个redis-colony集群可以没有slave结点

- host：主结点ip地址
- port：主节点端口
- auth：主节点密码，可以缺省，默认值为空

具体的示例如下：

```xml
<!--集群根结点-->
<redis-conf>
    <!--Object对象集群-->
    <redis-colony name="objColony">
        <!--主节点-->
        <master host="127.0.0.1" port="6379" auth="cedis"/>
        <!--从结点-->
        <slave  host="127.0.0.1" port="6380" auth="cedis"/>
        <!--从结点-->
        <slave  host="127.0.0.1" port="6381" auth="cedis"/>
    </redis-colony>

    <!--共享session集群-->
    <redis-colony name="session">
        <!--主节点-->
        <master host="127.0.0.1" port="6379" auth="cedis"/>
        
    </redis-colony>

    <!--分布式锁集群-->
    <redis-colony name="objColony">
        <!--主节点-->
        <master host="127.0.0.1" port="6379" auth="cedis"/>
        
    </redis-colony>

    <!--全局id集群-->
    <redis-colony name="uuid">
        <!--主节点-->
        <master host="127.0.0.1" port="6379" auth="cedis"/>
        
    </redis-colony>

    <!--计数器集群-->
    <redis-colony name="counter">
        <!--主节点-->
        <master host="127.0.0.1" port="6379" auth="cedis"/>
        
    </redis-colony>

    <!--限流集群-->
    <redis-colony name="limit">
        <!--主节点-->
        <master host="127.0.0.1" port="6379" auth="cedis"/>
        <!--从结点-->
        <slave  host="127.0.0.1" port="6380" auth="cedis"/>
        <!--从结点-->
        <slave  host="127.0.0.1" port="6381" auth="cedis"/>
    </redis-colony>

    <!--位统计集群-->
    <redis-colony name="bitstat">
        <!--主节点-->
        <master host="127.0.0.1" port="6379" auth="cedis"/>
        <!--从结点-->
        <slave  host="127.0.0.1" port="6380" auth="cedis"/>
        <!--从结点-->
        <slave  host="127.0.0.1" port="6381" auth="cedis"/>
    </redis-colony>


    <!--时间轴集群-->
    <redis-colony name="timeline">
        <!--主节点-->
        <master host="127.0.0.1" port="6379" auth="cedis"/>
        <!--从结点-->
        <slave  host="127.0.0.1" port="6380" auth="cedis"/>
        <!--从结点-->
        <slave  host="127.0.0.1" port="6381" auth="cedis"/>
    </redis-colony>


    <!--消息队列集群-->
    <redis-colony name="mq">
        <!--主节点-->
        <master host="127.0.0.1" port="6379" auth="cedis"/>
        <!--从结点-->
        <slave  host="127.0.0.1" port="6380" auth="cedis"/>
        <!--从结点-->
        <slave  host="127.0.0.1" port="6381" auth="cedis"/>
    </redis-colony>


    <!--抽奖集群-->
    <redis-colony name="luckdraw">
        <!--主节点-->
        <master host="127.0.0.1" port="6379" auth="cedis"/>
        <!--从结点-->
        <slave  host="127.0.0.1" port="6380" auth="cedis"/>
        <!--从结点-->
        <slave  host="127.0.0.1" port="6381" auth="cedis"/>
    </redis-colony>

    <!--标签集群-->
    <redis-colony name="tags">
        <!--主节点-->
        <master host="127.0.0.1" port="6379" auth="cedis"/>
        <!--从结点-->
        <slave  host="127.0.0.1" port="6380" auth="cedis"/>
        <!--从结点-->
        <slave  host="127.0.0.1" port="6381" auth="cedis"/>
    </redis-colony>
    
    <!--pika集群-->
    <redis-colony name="pika" type="pika">
        <!--主节点-->
        <master host="127.0.0.1" port="6379" auth="cedis"/>
        <!--从结点-->
        <slave  host="127.0.0.1" port="6380" auth="cedis"/>
        <!--从结点-->
        <slave  host="127.0.0.1" port="6381" auth="cedis"/>
    </redis-colony>

</redis-conf>
```



### Cedis能力

Cedis支持任意切换客户端，并且支持一个项目中动态配置场景



##### CedisTemplate

```java
// todo
```



##### CedisScenarioService

```java
// todo
```



##### application.yml

- cedis.client：redis/pika客户端
- secene：本次项目支持的redis场景，所有的场景值默认为false

```yml
cedis:
  client: cedis # cedis or lettuce or jedis
  scene:
    cache: true
    lock: true
```



### 场景枚举表

| 场景    | 含义                                                         |
| ------- | ------------------------------------------------------------ |
| cache   | 缓存：指的是持久化对象，序列化后存入redis/pika中，充当缓存或者其他作用的场景 |
| session | 共享session：指的是共享session的场景                         |