SendableLruCache<K, V>

SendableLruCache在缓存空间不足时，会用新数据替换近期最少使用的数据。此设计基于资源访问的考虑：近期访问的数据可能在不久的将来再次访问，因此最少访问的数据价值最小，应优先移出缓存。SendableLruCache支持Sendable特性，可保存Sendable对象，确保跨线程安全访问。

说明：

本模块首批接口从API version 12开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

SendableLruCache首批接口从API version 18开始支持。

此模块仅支持在ArkTS文件（文件后缀为.ets）中导入使用。

装饰器类型：@Sendable

导入模块

import { ArkTSUtils } from '@kit.ArkTS'

属性

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

名称	类型	只读	可选	说明
length¹⁸⁺	number	是	否	当前缓冲区中值的总数。

示例：

let pro = new ArkTSUtils.SendableLruCache<number, number>();
pro.put(2, 10);
pro.put(1, 8);
let result = pro.length;
console.info('result = ' + result);
// 期望输出：result = 2

constructor¹⁸⁺

constructor(capacity?: number)

默认构造函数用于创建一个新的SendableLruCache实例，默认容量为64。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
capacity	number	否	指示缓冲区的自定义容量。不传时，默认值为64，最大值不能超过2147483647；小于等于0时会抛出异常。

示例：

let pro = new ArkTSUtils.SendableLruCache<number, number>();

updateCapacity¹⁸⁺

updateCapacity(newCapacity: number): void

将缓冲区容量设置为指定值。如果缓冲区中值的总数超过指定容量，将删除最少使用的键值对。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
newCapacity	number	是	指示要为缓冲区自定义的容量，最大值不能超过2147483647；小于等于0时会抛出异常。

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified;2.Incorrect parameter types.

示例：

let pro = new ArkTSUtils.SendableLruCache<number, number>();
pro.updateCapacity(100);

toString¹⁸⁺

toString(): string

返回对象的字符串表示形式。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

返回值：

类型	说明
string	返回对象的字符串表示形式。返回字符串格式是：SendableLruCache[ maxSize = (maxSize), hits = (hitCount), misses = (missCount), hitRate = (hitRate) ]。 (maxSize)表示缓存区最大值，(hitCount)表示查询值匹配成功的次数，(missCount)表示查询值匹配失败的次数，(hitRate)表示查询值匹配率。

示例：

let pro = new ArkTSUtils.SendableLruCache<number, number>();
pro.put(2, 10);
pro.get(2);
pro.get(3);
console.info(pro.toString());
// 预期输出：SendableLruCache[ maxSize = 64, hits = 1, misses = 1, hitRate = 50% ]
// maxSize: 缓存区最大值 hits: 查询值匹配成功的次数 misses: 查询值匹配失败的次数 hitRate: 查询值匹配率

getCapacity¹⁸⁺

getCapacity(): number

获取当前缓冲区的容量。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

返回值：

类型	说明
number	返回当前缓冲区的容量。

示例：

let pro = new ArkTSUtils.SendableLruCache<number, number>();
let result = pro.getCapacity();
console.info('result = ' + result);
// 预期输出：result = 64

clear¹⁸⁺

clear(): void

从当前缓冲区清除所有键值对。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

示例：

let pro = new ArkTSUtils.SendableLruCache<number, number>();
pro.put(2, 10);
let result = pro.length;
pro.clear();
let res = pro.length;
console.info('result = ' + result);
console.info('res = ' + res);
// 预期输出：result = 1
// 预期输出：res = 0

getCreateCount¹⁸⁺

getCreateCount(): number

获取调用内部默认接口创建对象的次数。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

返回值：

类型	说明
number	返回使用内部默认接口创建对象的次数。

示例：

@Sendable
class ChildLRUCache extends ArkTSUtils.SendableLruCache<number, number> {
  constructor() {
    super();
  }
  createDefault(key: number): number {
    return key;
  }
}

let lru = new ChildLRUCache();
lru.put(2, 10);
lru.get(3);
lru.get(5);
let res = lru.getCreateCount();
console.info('res = ' + res);
// 预期输出：res = 2
// 执行get操作时，如果键值不存在，调用createDefault接口判断返回值是否等于undefined
// 如果不等于，则需要把key和返回值作为键值对添加到cache中，并且创建次数加1

getMissCount¹⁸⁺

getMissCount(): number

获取查询值不匹配的次数。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

返回值：

类型	说明
number	返回查询值不匹配的次数。

示例：

let pro = new ArkTSUtils.SendableLruCache<number, number>();
pro.put(2, 10);
pro.get(2);
let result = pro.getMissCount();
console.info('result = ' + result);
// 预期输出：result = 0

getRemoveCount¹⁸⁺

getRemoveCount(): number

获取缓冲区键值对的回收次数。当缓冲区数量超过容量限制时，最少使用的键值对将被回收。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

返回值：

类型	说明
number	返回缓冲区键值对回收的次数。

示例：

let pro = new ArkTSUtils.SendableLruCache<number, number>();
pro.put(2, 10);
pro.updateCapacity(2);
pro.put(50, 22);
let result = pro.getRemoveCount();
console.info('result = ' + result);
// 预期输出：result = 0

getMatchCount¹⁸⁺

getMatchCount(): number

获取查询值匹配成功的次数。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

返回值：

类型	说明
number	返回查询值匹配成功的次数。

示例：

let pro = new ArkTSUtils.SendableLruCache<number, number>();
pro.put(2, 10);
pro.get(2);
let result = pro.getMatchCount();
console.info('result = ' + result);
// 预期输出：result = 1

getPutCount¹⁸⁺

getPutCount(): number

获取将值添加到缓冲区的次数。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

返回值：

类型	说明
number	返回将值添加到缓冲区的次数。

示例：

let pro = new ArkTSUtils.SendableLruCache<number, number>();
pro.put(2, 10);
let result = pro.getPutCount();
console.info('result = ' + result);
// 预期输出：result = 1

isEmpty¹⁸⁺

isEmpty(): boolean

检查当前缓冲区是否为空。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

返回值：

类型	说明
boolean	返回true表示当前缓冲区为空，不包含任何键值对；返回false表示当前缓冲区不为空。

示例：

let pro = new ArkTSUtils.SendableLruCache<number, number>();
pro.put(2, 10);
let result = pro.isEmpty();
console.info('result = ' + result);
// 预期输出：result = false

get¹⁸⁺

get(key: K): V|undefined

返回键对应的值。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
key	K	是	要查询的键。

返回值：

类型	说明
V \|undefined	如果指定的键存在于缓冲区中，则返回与键关联的值；否则调用内部默认接口，生成一个键与值相同的对象，并返回其值。如果内部默认接口返回undefined，则最终返回undefined。

示例：

let pro = new ArkTSUtils.SendableLruCache<number, number>();
pro.put(2, 10);
let result  = pro.get(2);
console.info('result = ' + result);
// 预期输出：result = 10

put¹⁸⁺

put(key: K,value: V): V

将键值对添加到缓冲区，并返回与添加的键关联的值。当缓冲区中值的数量超过容量时，会执行删除操作。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
key	K	是	要添加的键。
value	V	是	与要添加的键关联的值。

返回值：

类型	说明
V	返回与添加的键关联的值。

示例：

let pro = new ArkTSUtils.SendableLruCache<number, number>();
let result = pro.put(2, 10);
console.info('result = ' + result);
// 预期输出：result = 10

values¹⁸⁺

values(): V[]

获取当前缓冲区中所有值的列表，按从最近访问到最少访问的顺序排列，最近访问的键值对表示有最新操作。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

返回值：

类型	说明
V []	返回当前缓冲区中所有值的列表，按从最近访问到最少访问的顺序排列。

示例：

let pro = new ArkTSUtils.SendableLruCache<number|string,number|string>();
pro.put(2, 10);
pro.put(2, "anhu");
pro.put("afaf", "grfb");
let result = pro.values();
console.info('result = ' + result);
// 预期输出：result = anhu,grfb

keys¹⁸⁺

keys(): K[]

获取当前缓冲区中所有键，按从最近访问到最少访问的顺序排列。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

返回值：

类型	说明
K []	返回当前缓冲区中所有键的列表，按从最近访问到最少访问的顺序排列。

示例：

let pro = new ArkTSUtils.SendableLruCache<number, number>();
pro.put(2, 10);
pro.put(3, 1);
let result = pro.keys();
console.info('result = ' + result);
// 预期输出：result = 2,3

remove¹⁸⁺

remove(key: K): V|undefined

从当前缓冲区中删除指定键及其关联值，返回该键关联的值。若键不存在，则返回undefined。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
key	K	是	要删除的键值。

返回值：

类型	说明
V \| undefined	返回与key关联的值；若key不存在，则返回undefined。

示例：

let pro = new ArkTSUtils.SendableLruCache<number, number>();
pro.put(2, 10);
let result = pro.remove(20);
console.info('result = ' + result);
// 预期输出：result = undefined

contains¹⁸⁺

contains(key: K): boolean

检查当前缓冲区是否包含指定的键，如果存在，返回true；否则，返回false。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
key	K	是	表示要检查的键。

返回值：

类型	说明
boolean	如果缓冲区包含指定的键，则返回true，否则返回false。

示例：

let pro = new ArkTSUtils.SendableLruCache<number, number>();
pro.put(2, 10);
let result = pro.contains(2);
console.info('result = ' + result);
// 预期输出：result = true

entries¹⁸⁺

entries(): IterableIterator<[K,V]>

允许迭代包含在这个对象中的所有键值对。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

返回值：

类型	说明
IterableIterator<[K, V]>	返回一个可迭代数组。

示例：

let pro = new ArkTSUtils.SendableLruCache<number, number>();
pro.put(2, 10);
pro.put(3, 15);
let pair:Iterable<Object[]> = pro.entries();
let arrayValue = Array.from(pair);
for (let value of arrayValue) {
  console.info(value[0]+ ', '+ value[1]);
  // 预期输出：
  // 2, 10
  // 3, 15
}

你可能感兴趣的鸿蒙文章

openharmony 鸿蒙 arkts-apis-arkts-collections-Float32Array

openharmony 鸿蒙 arkts-apis-arkts-collections-ArrayBuffer

openharmony 鸿蒙 js-apis-lightweightset

openharmony 鸿蒙 errorcode-source-obfuscation

openharmony 鸿蒙 arkts-apis-arkts-utils-ASON

openharmony 鸿蒙 arkts-apis-arkts-collections-Uint8ClampedArray

openharmony 鸿蒙 errorcode-tsc

openharmony 鸿蒙 js-apis-deque

openharmony 鸿蒙 arkts-apis-arkts-collections-BitVector

openharmony 鸿蒙 js-apis-worker

openharmony 鸿蒙 arkts-apis-arkts-utils-SendableLruCache

SendableLruCache<K, V>

导入模块

属性

constructor¹⁸⁺

updateCapacity¹⁸⁺

toString¹⁸⁺

getCapacity¹⁸⁺

clear¹⁸⁺

getCreateCount¹⁸⁺

getMissCount¹⁸⁺

getRemoveCount¹⁸⁺

getMatchCount¹⁸⁺

getPutCount¹⁸⁺

isEmpty¹⁸⁺

get¹⁸⁺

put¹⁸⁺

values¹⁸⁺

keys¹⁸⁺

remove¹⁸⁺

contains¹⁸⁺

entries¹⁸⁺

你可能感兴趣的鸿蒙文章

标签云

最热博客

最新博客

SendableLruCache<K, V>

导入模块

属性

constructor18+

updateCapacity18+

toString18+

getCapacity18+

clear18+

getCreateCount18+

getMissCount18+

getRemoveCount18+

getMatchCount18+

getPutCount18+

isEmpty18+

get18+

put18+

values18+

keys18+

remove18+

contains18+

entries18+

你可能感兴趣的鸿蒙文章

标签云

最热博客

最新博客

constructor¹⁸⁺

updateCapacity¹⁸⁺

toString¹⁸⁺

getCapacity¹⁸⁺

clear¹⁸⁺

getCreateCount¹⁸⁺

getMissCount¹⁸⁺

getRemoveCount¹⁸⁺

getMatchCount¹⁸⁺

getPutCount¹⁸⁺

isEmpty¹⁸⁺

get¹⁸⁺

put¹⁸⁺

values¹⁸⁺

keys¹⁸⁺

remove¹⁸⁺

contains¹⁸⁺

entries¹⁸⁺