RocketMq源码随笔-过期文件的删除

引言

RocketMQ中文件的存储是分为3个不同的部分：

• CommitLog，提交日志。所有主题、队列的消息数据都是直接写入这一文件。
• ConsumeQueue，消费队列。按照主题和队列的方式进行区分，消费队列中写入定长20字节的消费条目信息，消费条目中指向了该信息对应在提交日志中的偏移量。
• IndexFile，索引文件。索引文件中写入定长20字节的索引信息，索引信息中指向了消息在提交日志中的偏移量。

RocketMQ不会无限制的将消息存储下去，而是采取一定的策略清除过期文件或者在磁盘不足的时候触发文件的删除，或者是手动的方式触发文件的删除。

在启动一个Broker的时候，会调用BrokerController的start方法，而这个start方法中也会调用到DefaultMessageStore#start方法。这个方法在最后会启动一个默认间隔为10秒的周期任务，这个周期任务中会调用CleanCommitLogService#run和CleanConsumeQueueService#run两个方法，实现提交日志、消费队列、索引文件的过期删除。

欢迎加入技术交流群186233599讨论交流，也欢迎关注技术公众号：风火说。

提交日志的过期删除

提交日志的删除主要依托方法CleanCommitLogService#run。该方法内部调用了两个方法，分别是deleteExpiredFiles和redeleteHangedFile。前者用于删除过期的文件，后者用于再次可能存在的删除失败的文件（仅删除第一个）。

deleteExpiredFiles

这个方法是用于删除过期文件。执行步骤如下：

1. 首先是需要判断是否需要删除文件，通过两个方法的调用isTimeToDelete和isSpaceToDelete判断是否达到定时删除时间以及是否磁盘已满需要删除，以及判断属性DefaultMessageStore.CleanCommitLogService#manualDeleteFileSeveralTimes是否大于0意味着需要手动删除。如果这三个条件任意为真，意味着需要执行删除，那就继续后续的流程。否则结束当前方法。
2. 如果是手动删除，则属性DefaultMessageStore.CleanCommitLogService#manualDeleteFileSeveralTimes减1.
3. 如果属性MessageStoreConfig#cleanFileForciblyEnable和DefaultMessageStore.CleanCommitLogService#cleanImmediately为真，声明cleanAtOnece为true，否则为false。
4. 调用方法CommitLog#deleteExpiredFile进行文件删除。方法需要4个入参，分别是：
   1. expiredTime：过期时间或者说文件删除前的保留时间，默认为72小时。
   2. deleteFilesInterval：文件删除间隔，这里取值为100.
   3. intervalForcibly：该参数用于强制文件强制释放时间间隔，单位是毫秒。这里取值为120*1000，
   4. cleanImmediately：是否立即执行删除，这边使用的就是步骤3中的数据。

isSpaceToDelete

判断磁盘空间是否满足删除的条件，判断要求如下：

1. 使用提交日志的路径，检查其所在的磁盘空间的使用率。默认情况下，使用率超过90%，设置磁盘不可用标志位，并且设置属性DefaultMessageStore.CleanCommitLogService#cleanImmediately为true。使用率超过85%，设置属性DefaultMessageStore.CleanCommitLogService#cleanImmediately为true。其他情况，设置运行状态位为磁盘可用。
2. 磁盘使用率小于0或者大于属性MessageStoreConfig#diskMaxUsedSpaceRatio的要求，默认是75%，则返回true给调用。
3. 针对消费队列的文件路径，上述步骤重复一次。
4. 如果步骤1~3都没有返回true，则返回false给调用者。意味着此时磁盘空间有剩余，不要求删除。

isTimeToDelete

RocketMQ会配置执行删除工作的时间，默认是早上四点。如果当前时间在04:00~04:59之间，就返回true。

redeleteHangedFile

这个方法用于删除可能存在的应该被删除，但是没有删除成功的文件。执行逻辑如下：

1. 如果当前时间与上次执行重试删除lastRedeleteTimestamp的时间间隔120秒，则尝试执行重试删除。否则方法结束。
2. 为属性lastRedeleteTimestamp赋值为当前时间。
3. 调用方法org.apache.rocketmq.store.CommitLog#retryDeleteFirstFile执行重试删除。

消费队列的过期删除

CLeanConsumeQueueService的run方法就是直接委托这个方法来实现。这个方法的作用就是删除无效的消费队列条目内容或者文件本身。其代码逻辑如下：

1. 通过方法CommitLog#getMinOffset获取提交日志最小的偏移量，声明为minOffset。
2. 如果minOffset大于类属性lastPhysicalMinOffset，那么意味着当前提交日志的最小偏移量对比上一次查询的值发生了变化，也就是说必然是最少一个提交日志文件被删除，那么相应的在消费队列中的过期数据也可以被删除，就执行后面的流程。反之，则意味着不需要执行任何操作，结束方法即可。
3. 将minOffset赋值给lastPhysicalMinOffset。
4. 对属性consumeQueueTable进行遍历，遍历其中每一个ConsumeQueue对象。使用本次的minOffset作为入参，调用方法ConsumeQueue#deleteExpiredFile删除过期的消费队列文件以及更新消费队列的最小偏移量。如果有删除到文件，则休眠MessageStoreConfig#deleteConsumeQueueFilesInterval配置的时间，继续对下一个消费队列执行删除。
5. 当循环执行完毕，使用参数minOffset作为入参，调用方法IndexService#deleteExpiredFile(long)来删除索引文件中已经完全无效的索引文件。

索引文件的删除

索引文件的删除是在消费队列删除完成后，调用方法deleteExpiredFile完成的。

deleteExpiredFile

该方法是用于删除索引文件中的无效文件。执行流程如下：

1. 首先需要确认，索引文件中是否存在无效文件。获取第一个索引文件，获取其endPhyOffset属性，判断该属性的值是否小于入参的offset。如果是的话，至少意味着有一个文件是无效的，则执行后续流程。否则没有无效文件，则直接结束整个方法。
2. 声明一个局部变量fileList，遍历索引文件IndexFile对象，如果其endPhyOffset小于入参的offset，说明该文件是无效的，添加到fileList中。
3. 使用第二步的fileList作为入参，调用方法IndexService#deleteExpiredFile(List<IndexFile>)。该方法内部调用了IndexFile#destory方法，内部也是委托了MappedFile#destory方法实现的文件销毁。并且删除成功的IndexFile还会从属性indexFileList列表中删除对应的对象。