介绍

DiskLruCache 是一款硬盘内容存储管理工具，它基于最近最少使用（LRU）算法对硬盘存储文件进行管理。当存储空间不足时，会优先删除最近最少使用的文件，从而释放可用硬盘空间。

特性

• 🚀 支持将数据写入硬盘缓存

• 🚀 支持从硬盘缓存读取数据

• 💪 支持从硬盘缓存删除指定 key 值的缓存文件

• 🛠️ 支持将缓存文件的操作记录同步至 journal 以及关闭缓存

软件架构

架构图

源码目录

.
├── README.md
├── doc
│   ├── assets
│   └── feature_api.md
├── src
│   └── disklrucache
├── test
│    ├── HLT
│    └── LLT
├── CHANGELOG.md
├── gitee_gate.cfg
├── LICENSE.txt
├── module.json
├── README.md
└── README.OpenSource

• doc 文档目录，用于存放API接口文档
• src 库源码目录
• test 存放HLT测试用例、LLT自测用例

接口说明

主要类和函数接口说明详见 API

使用说明

编译（win/linux）

两种编译方式

1. 使用脚本编译
   1. 下载配置编译脚本
   2. ciTest build
2. 使用cjpm编译
   1. 该三方库依赖stdx，请参考stdx文档配置CANGJIE_STDX_PATH路径
   2. cjpm build

执行用例

编译用例并执行，步骤如下：

1. 进入 disklrucache4cj/test/ 目录下创建 tmp 文件夹，然后编译测试用例

cd disklrucache4cj/test/
mkdir tmp
cjc -O2 --import-path xxxxx/disklrucache4cj/target/release  -L xxxxx/disklrucache4cj/target/release/disklrucache -L xxxxx/disklrucache4cj/target/release/charset -l charset_charset.singlebyte -l charset_charset.korean -l charset_charset.traditionchinese -l charset_charset -l disklrucache_disklrucache -l charset_charset.unicode -l charset_charset.simplechinese -l charset_charset.encoding -l charset_charset.exception -l charset_charset.japanese  LLT/test.cj -o tmp/test.cj.out --test

1.1 具体说明

• cjc命令，-O2表示开启优化

cjc -O2

• --import-path 导入disklrucache4cj库编译生成的库文件地址，注意地址末尾需添加“.”
• -L 导入库文件的完整路径
• 若需导入多个库，每个库均需分别指定--import-path和 -L

--import-path xxxxx/disklrucache4cj/target/release -L xxxxx/disklrucache4cj/target/release/disklrucache -L xxxxx/disklrucache4cj/target/release/charset

• -l 要导入的具体包，格式为“库名_包名”
• 导入一个库中的多个包时，使用多个 -l

--import-path xxxxx/disklrucache4cj/target/release -L xxxxx/disklrucache4cj/target/release/disklrucache -L xxxxx/disklrucache4cj/target/release/charset -l charset_charset.singlebyte -l charset_charset.korean -l charset_charset.traditionchinese -l charset_charset -l disklrucache_disklrucache -l charset_charset.unicode -l charset_charset.simplechinese -l charset_charset.encoding -l charset_charset.exception -l charset_charset.japanese

• 测试用例的完整路径和用例中引入文件的完整路径
• -o 用例编译后输出的位置和名称，以.out结尾，通常使用“用例名称.out”
• --test 用例编译命令结尾

xxxxx/disklrucache4cj/test/LLT/test.cj  -o xxxxx/disklrucache4cj/test/tmp/test.cj.out --test

2. 把编译好的文件复制到 .out 文件下(disklrucache4cj/test/tmp/)

• disklrucache4cj/build/disklrucache/、disklrucache4cj/build/charset/ 目录中的文件都复制到 .out 文件位置(disklrucache4cj/test/tmp/ 中)

3. 进入到.out文件位置，执行用例

• 进入到.out文件位置执行用例

cd xxxxx/disklrucache4cj/test/tmp/

• 在Windows系统中打开cmd，输入.out文件的完整名称即可执行

test.cj.out

• Linux系统使用 ./.out文件完整名称

./test.cj.out

功能示例

数据写入硬盘缓存中 功能示例

import disklrucache.*
import std.fs.*
import std.math.*
import std.os.posix.*
import std.unittest.*
import std.unittest.testmacro.*

main() {

    let lrucache = LruCacheOpen1Test()
    lrucache.open1Test()
    return 0
}

@Test
public class LruCacheOpen1Test {
    @TestCase
    public func open1Test(): Unit {

        var path: String = getcwd()
        var TmpDir = Path(path + "/DiskLruCacheTest")
        let appVersion = 100
        Directory.create(TmpDir) 
        var cache = DiskLruCache.open(TmpDir, appVersion, 2, Int64(Int32.Max))
        let key = "k1"
        let src = cache.edit(key).getOrThrow()
        src.set(0, "ABC")
        src.set(1, "DE")
        let pc = src.getString(0).isEmpty()
        src.commit()
        println("success")
        @Assert(true, pc)    
    }
}

执行结果如下：

success

从缓存中读取数据 功能示例

import disklrucache.*
import std.fs.*
import std.math.*
import std.os.posix.*
import std.unittest.*
import std.unittest.testmacro.*

main() {

    let lrucache = LruCacheOpen1Test()
    lrucache.open1Test()
    return 0
}

@Test
public class LruCacheOpen1Test {
    @TestCase
    public func open1Test(): Unit {

        var path: String = getcwd()
        var TmpDir = Path(path + "/DiskLruCacheTest37")
        let appVersion = 100
        Directory.create(TmpDir) 
        var cache = DiskLruCache.open(TmpDir, appVersion, 2, Int64(Int32.Max))
        let key = "k1"
        let src = cache.edit(key).getOrThrow()
        src.set(0, "OP")
        src.set(1, "LKll")
        src.commit()
        let sc = cache.get("k1").getOrThrow().getString(0)
        println("success")
        @Assert("OP", sc)
    }
}

执行结果如下：

success

缓存中删除指定key值的缓存文件 功能示例

import disklrucache.*
import std.fs.*
import std.math.*
import std.os.posix.*
import std.unittest.*
import std.unittest.testmacro.*

main() {

    let lrucache = LruCacheOpen1Test()
    lrucache.open1Test()
    return 0
}

@Test
public class LruCacheOpen1Test {
    @TestCase
    public func open1Test(): Unit {

        var path: String = getcwd()
        var TmpDir = Path(path + "/DiskLruCacheTest")
        let appVersion = 100
        Directory.create(TmpDir) 
        var cache = DiskLruCache.open(TmpDir, appVersion, 2, Int64(Int32.Max))
        let key = "k1"
        let src = cache.edit(key).getOrThrow()
        src.set(0, "ABC")
        src.set(1, "DE")
        src.getString(0).isEmpty()
        src.commit()
        let cq = cache.remove("k1")
        println("success")
        @Assert(true, cq)    
    }
}

执行结果如下：

success

同步缓存文件的操作记录至journal和关闭缓存 功能示例

import disklrucache.*
import std.fs.*
import std.math.*
import std.os.posix.*
import std.unittest.*
import std.unittest.testmacro.*

main() {

    let lrucache = LruCacheOpen1Test()
    lrucache.open1Test()
    return 0
}

@Test
public class LruCacheOpen1Test {
    @TestCase
    public func open1Test(): Unit {

        var path: String = getcwd()
        var TmpDir = Path(path + "/DiskLruCacheTest")
        let appVersion = 100
        Directory.create(TmpDir)
        var cache = DiskLruCache.open(TmpDir, appVersion, 2, Int64(Int32.Max))
        cache.close()
        cache.isClosed()
        println("success")
        @Assert(true, cache.isClosed())

    }
}

执行结果如下：

success

在下述版本验证通过：

Cangjie Version: 1.0.0

开源协议

本项目基于 Apache License 2.0 ，请自由地享受和参与开源。

参与贡献

欢迎给我们提交PR，欢迎给我们提交Issue，欢迎参与任何形式的贡献。