# Tworice轻量数据库备份

**Repository Path**: StandFast/tworice-backup-starter

## Basic Information

- **Project Name**: Tworice轻量数据库备份
- **Description**: 引入依赖即可完成定时数据库备份。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-07-23
- **Last Updated**: 2025-09-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## Tworice轻量数据库备份

### 简言

此组件是工作中需要，所言就写了一个简单的组件，目前仅支持`mysql`和`mongodb`，有能力的朋友可以进行扩展。

支持根据设定的时间安排进行数据库备份，比如设定每天的凌晨3点、每隔一个小时进行一次备份等。

备份的数据库文件可发送到指定的邮箱，随时可进行下载。



### 使用

① 引入依赖

```xml
<dependency>
    <groupId>cn.tworice</groupId>
    <artifactId>tworice-backup-starter</artifactId>
    <version>1.0.0</version>
</dependency>
```



② 加载配置类

在你的服务启动类上加入以下注解：

```java
@MapperScan(basePackages = "cn.tworice.backup")
```



③ 配置

```yml
# 邮箱配置，用于发送备份邮件，可选
string:
	mail:
        host: smtp.163.com
        username: tworice_0811@163.com
        password: XXXXXXXXXXX # 换成邮箱的授权密钥
# 数据库备份组件配置
tworice:
	enable: true # 是否开启
	email: xxxxx@qq.com # 接收备份邮件
	databaseType: mysql # 数据库类型
```



### 常见问题

Q：启动后报异常：com.mongodb.MongoSocketOpenException: Exception opening socket

A：是因为在SpringBoot应用中引入Mongo依赖后，SpringBoot会主动尝试连接Mongo，但可能你使用的是MySQL，所以这里需要我们手动排除一下Mongo的相关配置。

```java
@SpringBootApplication(scanBasePackages = {"cn.tworice.backup"},exclude = {
                MongoAutoConfiguration.class,
                MongoDataAutoConfiguration.class
        }
)
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}
```