获取进程相关的信息

About 6 min

获取进程相关的信息

icon-note.gif 说明: 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import process from '@ohos.process';
1

权限

属性

名称 类型 可读 可写 说明
egid number 进程的有效组标识。
euid number 进程的有效用户身份。
gid number 进程的组标识。
uid number 进程的用户标识。
groups number[] 带有补充组id的数组。
pid number 当前进程的pid。
ppid number 当前进程的父进程的pid。
tid8+ number 当前进程的tid。

ChildProcess

主进程可以获取子进程的标准输入输出,以及发送信号和关闭子进程。

属性

名称 类型 可读 可写 说明
pid number 子进程的pid。
ppid number 子进程的父进程的pid。
exitCode number 子进程的退出码。
killed boolean 父进程给子进程发信号是否成功。

wait

wait(): Promise<number>

等待子进程运行结束,返回promise对象,其值为子进程的退出码。

  • 返回值:

    类型 说明
    Promise<number> 异步返回子进程的退出码。
  • 示例:

    import process from '@ohos.process';
    var child = process.runCmd('ls');
    var result = child.wait();
    result.then(val=>{
        console.log("result = " + val);
    })
    
    1
    2
    3
    4
    5
    6

getOutput

getOutput(): Promise<Uint8Array>

获取子进程的标准输出。

  • 返回值:

    类型 说明
    Promise<Uint8Array> 异步返回标准输出的字节流。
  • 示例:

    import process from '@ohos.process';
    var child = process.runCmd('ls');
    var result = child.wait();
    child.getOutput.then(val=>{
        console.log("child.getOutput = " + val);
    })
    
    1
    2
    3
    4
    5
    6

getErrorOutput

getErrorOutput(): Promise<Uint8Array>

getErrorOutput函数用来获取子进程的标准错误输出。

  • 返回值:

    类型 说明
    Promise<Uint8Array> 异步返回标准错误输出的字节流。
  • 示例:

    import process from '@ohos.process';
    var child = process.runCmd('madir test.text');
    var result = child.wait();
    child.getErrorOutput.then(val=>{
        console.log("child.getErrorOutput= " + val);
    })
    
    1
    2
    3
    4
    5
    6

close

close(): void

关闭正在运行的子进程。

  • 示例:
    import process from '@ohos.process';
    var child = process.runCmd('sleep 5; ls');
    child.close();
    
    1
    2
    3

kill

kill(signal: number | string): void

kill函数用来发送信号给子进程,结束指定进程。

  • 参数:

    参数名 类型 必填 说明
    signal number | string 数字或字符串。
  • 示例:

    import process from '@ohos.process';
    var child = process.runCmd('sleep 5; ls');
    child.kill(9);
    
    1
    2
    3

process.isIsolatedProcess8+

isIsolatedProcess(): boolean

检查进程是否被隔离。

  • 返回值:

    类型 说明
    boolean 进程是否隔离
  • 示例:

    import process from '@ohos.process';
    var result = process.isIsolatedProcess();
    
    1
    2

process.isAppUid8+

isAppUid(v:number): boolean

判断是否特定程序的uid。

  • 参数:

    参数名 类型 必填 说明
    v number 进程的id。
  • 返回值:

    类型 说明
    boolean 是否是当前app的uid
  • 示例:

    import process from '@ohos.process';
    var result = process.isAppUid(688);
    
    1
    2

process.is64Bit8+

is64Bit(): boolean

判断运行环境是不是64位。

  • 返回值:

    类型 说明
    boolean 是不是64位环境
  • 示例:

    import process from '@ohos.process';
    var ressult = process.is64Bit();
    
    1
    2

process.getUidForName8+

getUidForName(v:string): number

通过进程名获取进程uid。

  • 参数:

    参数名 类型 必填 说明
    v string 进程name
  • 返回值:

    类型 说明
    number 进程的uid
  • 示例:

    import process from '@ohos.process'
    var pres = process.getUidForName("tool")
    
    1
    2

process.getThreadPriority8+

getThreadPriority(v:number): number

根据指定的 TID 获取线程优先级。

  • 参数:

    参数名 类型 必填 说明
    v number 进程的id
  • 返回值:

    类型 说明
    number 进程的优先级
  • 示例:

    import process from '@ohos.process'
    var tid = process。getTid();
    var pres = process.getThreadPriority(tid);
    
    1
    2
    3

process.getStartRealtime8+

getStartRealtime() :number

获取从系统启动到进程启动所经过的实时时间(以毫秒为单位)。

  • 返回值:

    类型 说明
    number 时间
  • 示例:

    import process from '@ohos.process';
    var realtime = process.getStartRealtime();
    
    1
    2

process.getAvailableCores8+

getAvailableCores() :number[]

获取多核设备上当前进程可用的 CPU 内核。

  • 返回值:

    类型 说明
    number[] 可用内核数
  • 示例:

    import process from '@ohos.process';
    var result = getAvailableCores();
    
    1
    2

process.getPastCputime8+

getPastCputime() :number

获取进程启动到当前时间的CPU时间(以毫秒为单位)。

  • 返回值:

    类型 说明
    number 时间
  • 示例:

    import process from '@ohos.process';
    var result = process.getPastCputime() ;
    
    1
    2

process.getSystemConfig8+

getSystemConfig(name:number): number

用该方法发送signal到指定的进程。

  • 参数:

    参数名 类型 必填 说明
    name number 系统配置参数名
  • 返回值:

    类型 说明
    number 配置信息
  • 示例:

    import process from '@ohos.process'
    var _SC_ARG_MAX = 0
    var pres = process.getSystemConfig(_SC_ARG_MAX)
    
    1
    2
    3

process.getEnvironmentVar8+

getEnvironmentVar(name:string): string

用该方法获取环境变量对应的值。

  • 参数:

    参数名 类型 必填 说明
    name string 环境名
  • 返回值:

    类型 说明
    string 环境名对应的value
  • 示例:

    import process from '@ohos.process'
    var pres = process.getEnvironmentVar("PATH")
    
    1
    2

process.runCmd

runCmd(command: string, options?: { timeout : number, killSignal :number | string, maxBuffer : number }) : ChildProcess

通过runcmd可以fork一个新的进程来运行一段shell,并返回ChildProcess对象。

  • 参数:

    参数名 类型 必填 说明
    command string shell命令。
    options Object 相关选项参数。

    表1 options

    名称 参数类型 必填 说明
    timeout number 子进程运行的ms数,当子进程运行时间超出此时间,则父进程发送killSignal信号给子进程。timeout默认为0。
    killSignal number  | string 子进程运行时间超出timeout时,父进程发送killSignal 信号给子进程。killSignal 默认为'SIGTERM'。
    maxBuffer number 子进程标准输入输出的最大缓冲区大小,当超出此大小时则终止子进程。maxBuffer默认1024*1024。
  • 返回值:

    类型 说明
    ChildProcess 子进程对象。
  • 示例:

    import process from '@ohos.process';
    var child = process.runCmd('ls', { maxBuffer : 2 });
    var result = child.wait();
    child.getOutput.then(val=>{
        console.log("child.getOutput = " + val);
    }
    
    1
    2
    3
    4
    5
    6

process.abort

abort(): void

该方法会导致进程立即退出并生成一个核心文件,谨慎使用。

  • 示例:
    import process from '@ohos.process';
    process.abort();
    
    1
    2

process.on

on(type: string, listener: EventListener): void

用该方法来存储用户所触发的事件。

  • 参数:

    参数名 类型 必填 说明
    type string 存储事件的type。
    listener EventListener 回调的事件。

    表2 EventListener

    名称 说明
    EventListener = (evt: Object) => void 用户存储的事件。
  • 示例:

    import process from '@ohos.process';
    process.on("data", (e)=>{
        console.log("data callback");
    })
    
    1
    2
    3
    4

process.off

off(type: string): boolean

用该方法来删除用户存储的事件。

  • 参数:

    参数名 类型 必填 说明
    type string 删除事件的type。
  • 返回值:

    类型 说明
    boolean 事件是否删除成功。
  • 示例:

    import process from '@ohos.process';
    process.on("data", (e)=>{
        console.log("data callback");
    })
    var result = process.off("data");
    
    1
    2
    3
    4
    5

process.exit

exit(code: number): void

用该方法终止程序,谨慎使用。

  • 参数:

    参数名 类型 必填 说明
    code number 进程的退出码。
  • 示例:

    import process from '@ohos.process';
    process.exit(0);
    
    1
    2

process.cwd

cwd(): string

用该方法获取进程的工作目录。

  • 示例:
    import process from '@ohos.process';
    var path = process.cwd();
    
    1
    2

process.chdir

chdir(dir: string): void

用该方法更改进程的当前工作目录。

  • 参数:

    参数名 类型 必填 说明
    dir string 路径。
  • 示例:

    import process from '@ohos.process';
    process.chdir('/system');
    
    1
    2

process.uptime

uptime(): number

获取当前系统已运行的秒数。

  • 返回值:

    类型 说明
    number 当前系统已运行的秒数。
  • 示例:

    import process from '@ohos.process';
    var time = process.uptime();
    
    1
    2

process.kill

kill(pid: number,signal: number ): boolean

用该方法发送signal到指定的进程,结束指定进程。

  • 参数:

    参数名 类型 必填 说明
    pid number 进程的id。
    signal number 发送的信号。
  • 返回值:

    类型 说明
    boolean 信号是否发送成功。
  • 示例:

    import process from '@ohos.process'
    var pres = process.pid
    var result = that.kill(pres, 28)
    
    1
    2
    3