# potato-common-server

**Repository Path**: bruce_potato/potato-common-server

## Basic Information

- **Project Name**: potato-common-server
- **Description**: 公用服务->信鸽(短信,钉钉,邮件,推送)、字典、仓库(OSS、Fast Dfs)
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-09
- **Last Updated**: 2021-08-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# potato-common-server

### 介绍
公用服务->信鸽(短信,钉钉,邮件,推送)、字典、仓库(OSS、Fast Dfs)

### Dict

说明:
统一的字典配置服务,目的是为了解决,微服务体系下每个工程结构中,都配置了很多的业务常量值。导致系统整体冗余,乱草丛生这些常量值。
所以，我们构建了统一处理常量值的能力服务

基础表结构 
![基础表结构](https://images.gitee.com/uploads/images/2021/0309/104300_c4af81a6_7508426.png "屏幕截图.png")

表说明:
为了严格意义上划分表的领域模型,精细度,使业务更加灵活,所以用字典类型来管理字典项,一个字典类型对应多个字典项

服务基础能力 
| 字典类型     | 字典项       | 通过字典类型查询字典项 |
|----------|-----------|-------------|
| 新建字典类型   | 添加字典项     | 获取字典类型和字典项  |
| 修改字典类型   | 修改字典项     | 获取字典项列表     |
| 修改字典类型状态 | 修改字典项显示状态 |             |
| 移动字典类型   | 移动字典项     |             |
| 获取字典类型   | 获取字典项列表分页 |             |
| 获取字典类型分页 |           |             |


### Pigeon

说明:
为了统一管理短信、邮件、推送、机器人推送...等功能,所以将此类发信业务全部抽象为一个pigeon(信鸽)集中去处理。

SMS
```
potato:
  pigeon:
    sms:
      alibaba: true # 对应短信厂商
      enabled: true # 是否开启此能力
      account: LTAI4GAPAJqJQLKgtQJ6HZS7 # 账号
      secret: pn7AFqbGA0t9FbEF4YZ4XQwCpKm9ba  # 密钥
```

Email
```
spring:
  mail:
    enabled: true
    username: xxxx
    host: xxxx
    port: xxxx
    properties.mail.smtp.auth: true
    properties.mail.smtp.starttls.enable: true
    properties.mail.smtp.starttls.required: true
    password: xxxx
    company: 公司名称
```

ValidCode
```
potato:
  pigeon:
    valid:
      test_flag: false # 验证码测试标识
      test_text: 6666 # 验证码测试默认文本
      expire: 300 # 过期时间
      length: 4 # 验证码长度
      sign_name: HEALS助手 # 验证码主体
      template_code: SMS_125016531 # 短信模板
```

Robot
基础表结构
![Robot基础表结构](https://images.gitee.com/uploads/images/2021/0309/104746_a714a84e_7508426.png "屏幕截图.png")

表说明:
每次需要钉钉发送消息之前,需要新增对应的钉钉信息,然后通过对应的参数发送消息。


###  warehouse
说明:
为了统一管理上传文件,访问文件,下载文件...等其他功能,所有关于文件的能力全权由warehouse(仓库)来处理。
![warehouse](https://images.gitee.com/uploads/images/2021/0309/104843_3d22bf0b_7508426.png "屏幕截图.png")

表说明:
每次成功上传一个资源的时候，都会 insert into此表，实现了业务与资源隔离的设计，这样做的好处是，业务有业务的操作范畴，系统能力有系统的能力，之间毫无联系。

| 接口名称    | 备注                      |
|---------|-------------------------|
| OSS文件上传 | 多文件上传&支持大文件上传           |
| DFS文件上传 | 多文件上传&支持大文件上传           |
| 删除文件    | 根据资源ID 去OSS/DFS中删除文件  # |


###  area

说明:
当今市面上基本上所有的软件服务已经全部覆盖行政区划的管理能力,同样，所有关于行政区划的能力全权由 area 来处理。