程序包 ohos.hiviewdfx

类 ResourceTag

java.lang.Object

ohos.hiviewdfx.ResourceTag

public class ResourceTag
extends Object

Represents a resource tag, which helps mark resources to avoid the situation where resources are not released as supposed or are not released in a timely manner.

This tag is attached upon resource requests and detached upon resource release. If resources are supposed to be released but actually not released, a caution is generated.

For example, if an object is reclaimed by a virtual machine (VM) but its resources are not released, the corresponding caution is generated.

Sample code for using ResourceTag:

 public class XxxResource {
     private final ResourceTag resTag = ResourceTag.get();
     private final String TAG_MSG = "XxxResource opened by the get method, but not closed by the close method";

     public void get() {
         ...;
         resTag.markInUse(TAG_MSG);
     }

     public void close() {
         resTag.release();
         ...;
     }

     protected void finalize() {
         resTag.warnIfNeed();
         ...;
     }
 }
 

从以下版本开始:

5

另请参阅:

Rule#CHECK_VM_RELEASE_MISS

方法概要

限定符和类型	方法	说明
static ResourceTag	get()	Obtains a new ResourceTag object.
void	markInUse(String resourceTag)	Marks a resource tag as in use so that it is attached to the paired resource.
void	release()	Releases a resource tag so that it is detached from the paired resource.
void	warnIfNeed()	Determines whether to generate a caution based on the resource tag state.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

方法详细资料

get

public static ResourceTag get()

Obtains a new ResourceTag object.

To use the resource tag mechanism for resources, you need to call this method and attach the obtained resource tag to resources via markInUse(java.lang.String).

返回:

Returns the obtained ResourceTag object.

从以下版本开始:

5

markInUse

public void markInUse(String resourceTag)

Marks a resource tag as in use so that it is attached to the paired resource.

参数:

resourceTag - Indicates the custom resource description, which is used to notify you of details about the resource not correctly released. The following format is recommended: Resources are requested by the xxx class name#open() method and need to be closed by the xxx class name#close() method

从以下版本开始:

5

release

public void release()

Releases a resource tag so that it is detached from the paired resource.

If the resource tag is released, resources attached to the tag will also be closed or released.

从以下版本开始:

5

warnIfNeed

public void warnIfNeed()

Determines whether to generate a caution based on the resource tag state.

If the resource tag is in use and the detection rule Rule.VM_CHECK_RESOUCE_LEAK was added for your application, calling this method will generate a caution unless you have called the release() method.

从以下版本开始:

5

另请参阅:

Rule#CHECK_VM_RELEASE_MISS