功能说明
COS Migration 是一个集成了 COS 数据迁移功能的一体化工具。通过简单的配置操作，用户可以将本地数据迁移至 COS 中，它具有以下特点：
断点续传：工具支持上传时断点续传。对于一些大文件，如果中途退出或者因为服务故障，可重新运行工具，会对未上传完成的文件进行续传。
分块上传：将对象按照分块的方式上传到 COS。
并行上传：支持多个对象同时上传。
注意：
COS Migration 的编码格式只支持 UTF-8 格式。
若源数据中有空目录、软链接文件或目录，此类数据不会被迁移。
使用该工具上传同名文件，默认会覆盖较旧的同名文件，需要额外设置以跳过同名文件。
COS Migration 是用来做一次性迁移服务的，不适合于持续同步的场景。例如本地每天新增文件，需要持续同步至 COS 中，COS Migration 为了避免重复迁移任务，会保存迁移成功的记录，持续同步后，扫描记录时间会持续增大。此种场景可以尝试使用 文件同步。
使用环境
系统环境
Windows 和 Linux 系统。
软件依赖
JDK 1.8 X64或以上，有关 JDK 的安装与配置请参见 Java 安装与配置。
Linux 环境需要 IFUNC 支持，确保环境 binutils 版本大于 2.20 。
使用方法
1. 获取工具
2. 解压缩工具包
Windows
解压并保存到某个目录，例如：
C:\\Users\\Administrator\\Downloads\\cos_migrate
Linux
解压并保存到某个目录：
unzip cos_migrate_tool_v5-master.zip && cd cos_migrate_tool_v5-master
迁移工具结构
正确解压后的 COS Migration 工具目录结构如下所示：
COS_Migrate_tool|——conf #配置文件所在目录| |——config.ini #迁移配置文件|——db #存储迁移成功的记录|——dep #程序主逻辑编译生成的 JAR 包|——log #工具执行中生成的日志|——opbin #用于编译的脚本|——result #用于保存迁移成功记录的目录，记录文件名为 "日期.out"，格式为 "绝对路径\\t文件大小\\t最后修改时间"|——src #工具的源码|——tmp #临时文件存储目录|——.gitignore #git版本管理忽略的文件与文件夹|——pom.xml #项目配置文件|——README #说明文档|——start_migrate.sh #Linux 下迁移启动脚本|——start_migrate.bat #Windows 下迁移启动脚本
说明：
db 目录主要记录工具迁移成功的文件标识，每次迁移任务会优先对比 db 中的记录，若当前文件标识已被记录，则会跳过当前文件，否则进行文件迁移。
log 目录记录着工具迁移时的所有日志，若在迁移过程中出现错误，请先查看该目录下的 error.log。
3. 修改 config.ini 配置文件
在执行迁移启动脚本之前，需先进行 config.ini 配置文件修改（路径：
./conf/config.ini），config.ini 内容可以分为以下几部分：3.1 配置迁移类型
type 表示迁移类型，固定填写
type=migrateLocal。[migrateType]type=migrateLocal
3.2 配置迁移任务
用户根据实际的迁移需求进行相关配置，主要包括迁移至目标 COS 信息配置及迁移任务相关配置。
# 迁移工具的公共配置分节，包含了需要迁移到目标 COS 的账户信息。[common]secretId=COS_SECRETIDsecretKey=COS_SECRETKEYbucketName=examplebucket-1250000000region=ap-guangzhoustorageClass=StandardcosPath=/https=offtmpFolder=./tmpsmallFileThreshold=5242880smallFileExecutorNum=64bigFileExecutorNum=8entireFileMd5Attached=offexecuteTimeWindow=00:00,24:00outputFinishedFileFolder=./resultresume=falseskipSamePath=falserequestTryCount=5
名称 | 描述 | 默认值 |
secretId | - | |
secretKey | - | |
bucketName | 目的 Bucket 的名称, 命名格式为 <BucketName-APPID>，即 Bucket 名必须包含 APPID，例如 examplebucket-1250000000 | - |
region | 目的 Bucket 的 Region 信息。COS 的地域简称请参照 地域和访问域名 | - |
storageClass | 数据迁移后的存储类型，可选值为 Standard（标准存储）、Standard_IA（低频存储）、Archive（归档存储）、Maz_Standard（标准存储多 AZ）、Maz_Standard_IA（低频存储多 AZ），相关介绍请参见 存储类型概述 | Standard |
cosPath | 要迁移到的 COS 路径。 / 表示迁移到 Bucket 的根路径下，/folder/doc/ 表示要迁移到 Bucket的 /folder/doc/ 下，若 /folder/doc/ 不存在，则会自动创建路径 | / |
https | 是否使用 HTTPS 传输：on 表示开启，off 表示关闭。开启传输速度较慢，适用于对传输安全要求高的场景 | off |
tmpFolder | 从其他云存储迁移至 COS 的过程中，用于存储临时文件的目录，迁移完成后会删除。要求格式为绝对路径： Linux 下分隔符为单斜杠，例如 /a/b/cWindows 下分隔符为两个反斜杠，例如 E:\\\\a\\\\b\\\\c默认为工具所在路径下的 tmp 目录 | ./tmp |
smallFileThreshold | 小文件阈值的字节，大于等于这个阈值使用分块上传，否则使用简单上传，默认5MB（5242880 Byte） | 5242880 |
smallFileExecutorNum | 小文件（文件小于 smallFileThreshold）的并发度，使用简单上传。如果是通过外网来连接 COS，且带宽较小，请减小该并发度 | 64 |
bigFileExecutorNum | 大文件（文件大于等于 smallFileThreshold）的并发度，使用分块上传。如果是通过外网来连接 COS，且带宽较小，请减小该并发度 | 8 |
entireFileMd5Attached | 表示迁移工具将全文的 MD5 计算后，存入文件的自定义头部 x-cos-meta-md5 中，用于后续的校验，因为 COS 的分块上传的大文件的 etag 不是全文的 MD5 | off |
executeTimeWindow | 执行时间窗口，时刻粒度为分钟，该参数定义迁移工具每天执行的时间段。例如： 参数 03:30,21:00，表示在凌晨 03:30 到晚上 21:00 之间执行任务，其他时间则会进入休眠状态，休眠状态暂停迁移会保留迁移进度，直到下一个时间窗口自动继续执行。注意后面的时间点必须大于前面的时间点。 | 00:00,24:00 |
outputFinishedFileFolder | 这个目录保存迁移成功的结果，结果文件会按照日期命名，例如 ./result/2021-05-27.out，其中./result 为已创建的目录。文件内容每一行的格式为：绝对路径\\t文件大小\\t最后修改时间。设置为空，则不输出结果。 | ./result |
resume | 是否接着最后一次运行的结果，继续往下遍历源的文件列表。默认从头开始。 | false |
skipSamePath | 如果 COS 上已经有相同的文件名，是否直接跳过。默认不跳过，即覆盖原有文件。 | false |
requestTryCount | 每个文件上传总的尝试次数。 | 5 |
3.3 配置数据源信息
3.3.1 配置本地数据源 migrateLocal
若从本地迁移至 COS，则进行该部分配置，具体配置项及说明如下：
# 从本地迁移到 COS 配置分节[migrateLocal]localPath=E:\\\\code\\\\java\\\\workspace\\\\cos_migrate_tool\\\\test_dataexcludes=ignoreModifiedTimeLessThanSeconds=
配置项 | 描述 |
localPath | 本地目录，要求格式为绝对路径： Linux 下分隔符为单斜杠，例如 /a/b/cWindows 下分隔符为两个反斜杠，例如 E:\\\\a\\\\b\\\\c注意：此参数只能填目录的路径，不能填具体文件的路径，否则会导致目标对象名解析错误，在 cosPath=/ 情况下，还会错误地解析成创桶请求 |
excludes | 要排除的目录或者文件的绝对路径，表示将 localPath 下面某些目录或者文件不进行迁移，多个绝对路径之前用分号分割，不填表示 localPath 下面的全部迁移 |
ignoreModifiedTimeLessThanSeconds | 排除更新时间与当前时间相差不足一定时间段的文件，单位为秒，默认不设置，表示不根据 lastmodified 时间进行筛选，适用于客户在更新文件的同时又在运行迁移工具，并要求不把正在更新的文件迁移上传到 COS，例如设置为300，表示只上传更新了5分钟以上的文件 |
4. 运行迁移工具
Windows
双击 start_migrate.bat 即可运行。
Linux
1.从 config.ini 配置文件读入配置，运行命令为：
sh start_migrate.sh
2.部分参数从命令行读入配置，运行命令为：
sh start_migrate.sh -Dcommon.cosPath=/savepoint0403_10/
说明：
工具支持配置项读取方式有两种：命令行读取或配置文件读取。
命令行优先级高于配置文件，即相同配置选项会优先采用命令行里的参数。
命令行中读取配置项的形式方便用户同时运行不同的迁移任务，但前提是两次任务中的关键配置项不完全一样，例如 Bucket 名称，COS 路径，要迁移的源路径等。因为不同的迁移任务写入的是不同的 db 目录，可以保证并发迁移。请参照前文中的工具结构中的 db 信息。
配置项的形式为 -D{sectionName}.{sectionKey}={sectionValue} 的形式。其中 sectionName 是配置文件的分节名称，sectionKey 表示分节中配置项名称，sectionValue 表示分节中配置项值。如设置要迁移到的 COS 路径，则以 -Dcommon.cosPath=/bbb/ddd 表示。
迁移机制及流程
迁移机制原理
COS 迁移工具是有状态的，已经迁移成功的会记录在 db 目录下，以 KV 的形式存储在 leveldb 文件中。每次迁移前对要迁移的路径，先查找下 db 中是否存在， 如果存在，且 mtime 和 db 中存在的一致， 则跳过迁移，否则进行迁移。因此，我们参照 db 中是否有过迁移成功的记录，而不是查找 COS，如果绕过了迁移工具，通过别的方式（如 COSCMD 或者控制台）删除修改了文件，那么运行迁移工具由于不会察觉到这种变化，是不会重新迁移的。
迁移流程步骤
1. 读取配置文件，根据迁移 type，读取相应的配置分节，并执行参数的检查。
2. 扫描对比 db 下对所要迁移文件的标识，判断是否允许上传。
3. 迁移执行过程中会打印执行结果，其中 inprogress 表示迁移中，skip 表示跳过，fail 表示失败，ok 表示成功， condition_not_match 表示因不满足迁移条件而跳过的文件（如 lastmodifed 和 excludes）。失败的详细信息可以在 log 的 error 日志中查看。
4. 整个迁移结束后会打印统计信息，包括累积的迁移成功量，失败量，跳过量，耗时。对于失败的情况，请查看 error 日志，或重新运行，因为迁移工具会跳过已迁移成功的，对未成功的会重新迁移。
