# sherry

**Repository Path**: a_code_dog/sherry

## Basic Information

- **Project Name**: sherry
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 2
- **Created**: 2022-03-27
- **Last Updated**: 2022-03-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# sherry

> 或许已经完成了历史使命，不在继续开发，之后会将其修改成 kotlin 版本

#### 介绍

sherry 是风控项目。

#### 软件架构

- sherry-util 一些工具类
- sherry-core 必要的 API 和核心代码的实现
- sherry-repository 一些仓库的配置，包括 DB
- sherry-ms-starter
- sherry-test 项目验证性测试的一些功能
- sherry-fetcher-module 关于一些 fetcher 的实现
  - sherry-fetcher-config 一些配置
  - sherry-fetcher-http http 实现
  - sherry-fetcher-mysql mysql 实现
  - sherry-fetcher-redis redis 实现
  - sherry-fetcher-mongodb mongodb 实现
- sherry-rules-module 规则引擎模块
  - sherry-rules-engine 规则引擎的实现
  - sherry-rules-java java 脚本的规则
  - sherry-rules-jexl3 jexl3 脚本的规则

- sherry-console 控制台的后端
- sherry-console-ui 控制台的前端

#### 计划功能

- [ ] fetcher 开发和配置
  - [x] MySQL
  - [ ] MongoDB
  - [ ] Redis
  - [ ] HTTP
- [ ] 风控规则执行功能

# 内部实现相关

## 全局常量的定义

| 名称 | 可选值 | 意义 |
|:---|:---|:---|
| fetcher | 1 | HTTP |
|  | 2 | MySQL |
|  | 3 | Redis |
|  | 4 | MongoDB |
|  | 5 | HBase |
|  | 6 | Bairong |
|  | 7 | ClickHouse |
|  | 8 | TiDB |
|  | 9 | ORACLE |
|  | 10 | SQL Server |
|  | 11 | ... |

#### 安装教程

**0. IDEA 插件安装**

为了简化部分 setter、getter、toString 等模板方法使用了 Lombok，建议安装 Lombok 插件。

**1. 初始化数据库**

```sql
create database sherry DEFAULT CHARACTER SET utf8mb4;
```

1. xxxx
2. xxxx
3. xxxx

#### 使用说明

![](./docs/index.png)

1. xxxx
2. xxxx
3. xxxx

#### 参与贡献

1. Fork 本仓库
2. 新建 feature_xxx 分支
3. 提交代码
4. 新建 Pull Request

#### 特技