TEnv (Voovan-码云(gitee.com))

java.lang.Object
- org.voovan.tools.TEnv

```
public class TEnv
extends Object
```
系统环境相关

Author:

helyho Voovan Framework. WebSite: https://github.com/helyho/Voovan Licence: Apache v2 License

Field Summary

Fields
Modifier and Type	Field and Description
`static Instrumentation`	`instrumentation`
`static boolean`	`IS_SHUTDOWN`
`static Float`	`JDK_VERSION`
`static Thread`	`MAIN_THREAD`
`static String`	`OS_NAME`
`static Vector<Runnable>`	`SHUT_DOWN_HOOKS`

Constructor Summary

Constructors
Constructor and Description

TEnv()

Constructors
Constructor and Description
`TEnv()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addShutDownHook(Runnable hook)` 增加进程结束的 hook 操作
`static Instrumentation`	`agentAttach(String agentJarPath)` 附加 Agentjar 到目标地址
`static boolean`	`classInCurrentStack(String clazzName, String method)` 判断指定的 Class 的方法是否在当前的线程栈中
`static String`	`classToResource(Class clazz)` 将class 转换成资源资源文件路径
`static Process`	`createSysProcess(String command, String[] env, File workDir)` 构造一个系统进程
`static Process`	`createSysProcess(String command, String[] env, String workDir)` 构造一个系统进程
`static String`	`getClassLocation(Class clazz)` 获取 Class 在物理设备上的文件位置
`static long`	`getClassModifyTime(Class clazz)` 获取 Class 的修改时间
`static List<String>`	`getClassPath()` 获取类 Class Path 因部分 ide 会自动增加全部的 jvm 的 classpath, 所以这里会自动剔除 classpath 中 jvm 的 classPath
`static long`	`getCurrentPID()` 获取当前进程 PID
`static List<Class>`	`getDirectorClass(File rootfile, String pattern, Class[] filters)` 从指定 File 对象寻找 Class
`static String`	`getEnvName()` 获取环境的配置名
`static List<Class>`	`getJarClass(File jarFile, String pattern, Class[] filters)` 从指定jar 文件中寻找 Class
`static String`	`getJavaHome()` 返回当前 jvm 的 JAVA_HOME 参数
`static Thread`	`getMainThread()` 获取进程的主线程
`static StackTraceElement[]`	`getStackElements()` 获取当前栈信息
`static String`	`getStackElementsMessage(StackTraceElement[] stackTraceElements)` 获取当前栈信息
`static String`	`getStackMessage()` 获取当前栈信息会自动过滤掉栈里的第一行,即当前类的信息
`static <T> T`	`getSystemProperty(String propertyName, Class clazz)`
`static <T> T`	`getSystemProperty(String propertyName, T defVal)`
`static Thread[]`	`getThreads()` 获取JVM中的所有线程
`static byte[]`	`loadClassBytes(Class clazz)` 读取 Class 的字节码
`static long`	`measure(Runnable runnable)` 性能测试方法不需要响应
`static void`	`measure(String msg, Runnable runnable)` 性能测试方法
`static void`	`measure(String msg, Runnable runnable, TimeUnit timeUnit)` 性能测试方法
`static List`	`measure(String msg, Supplier supplier)` 性能测试方法
`static List`	`measure(String msg, Supplier supplier, TimeUnit timeUnit)` 性能测试方法
`static List`	`measure(Supplier supplier)` 性能测试方法
`static Class`	`resourceToClass(String resourcePath)` 将资源文件路径转换成 Class
`static List<Class>`	`searchClassInEnv(String pattern, Class[] filters)` 从当前进程的ClassPath中寻找 Class
`static void`	`setEnvName(String envName)` 设置环境的配置名
`static boolean`	`sleep(int sleepTime)` 休眠函数
`static boolean`	`sleep(TimeUnit timeUnit, int sleepTime)` 休眠函数
`static boolean`	`wait(int waitTime, boolean isCLH, Supplier<Boolean> supplier)` 等待函数
`static boolean`	`wait(int waitTime, Supplier<Boolean> supplier)` 等待函数
`static boolean`	`wait(Supplier<Boolean> supplier)` 等待函数
`static void`	`waitThrow(int waitTime, Supplier<Boolean> supplier)` 等待函数

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - JDK_VERSION
```
public static Float JDK_VERSION
```
  - OS_NAME
```
public static String OS_NAME
```
  - MAIN_THREAD
```
public static Thread MAIN_THREAD
```
  - IS_SHUTDOWN
```
public static volatile boolean IS_SHUTDOWN
```
  - SHUT_DOWN_HOOKS
```
public static Vector<Runnable> SHUT_DOWN_HOOKS
```
  - instrumentation
```
public static Instrumentation instrumentation
```
- Constructor Detail
  - TEnv
```
public TEnv()
```
- Method Detail
  - addShutDownHook
```
public static void addShutDownHook(Runnable hook)
```
    增加进程结束的 hook 操作
    
    Parameters:
    
    hook - 进程结束时的操作对象
  - getEnvName
```
public static String getEnvName()
```
    获取环境的配置名
    
    Returns:
    
    环境的配置名
  - setEnvName
```
public static void setEnvName(String envName)
```
    设置环境的配置名
    
    Parameters:
    
    envName - 环境的配置名
  - getCurrentPID
```
public static long getCurrentPID()
```
    获取当前进程 PID
    
    Returns:
    
    当前进程 ID
  - createSysProcess
```
public static Process createSysProcess(String command,
                                       String[] env,
                                       File workDir)
                                throws IOException
```
    构造一个系统进程
    
    Parameters:
    
    command - 命令行
    
    env - 环境变量参数
    
    workDir - 工作目录
    
    Returns:
    
    Process 对象
    
    Throws:
    
    IOException - IO 异常
  - createSysProcess
```
public static Process createSysProcess(String command,
                                       String[] env,
                                       String workDir)
                                throws IOException
```
    构造一个系统进程
    
    Parameters:
    
    command - 命令行
    
    env - 环境变量参数
    
    workDir - 工作目录
    
    Returns:
    
    Process 对象
    
    Throws:
    
    IOException - IO 异常
  - sleep
```
public static boolean sleep(int sleepTime)
```
    休眠函数
    
    Parameters:
    
    sleepTime - 休眠时间
    
    Returns:
    
    true: 超时结束, false: sleep 被打断
  - sleep
```
public static boolean sleep(TimeUnit timeUnit,
                            int sleepTime)
```
    休眠函数
    
    Parameters:
    
    timeUnit - 休眠时间单位
    
    sleepTime - 休眠时间
    
    Returns:
    
    true: 超时结束, false: sleep 被打断
  - getStackElements
```
public static StackTraceElement[] getStackElements()
```
    获取当前栈信息
    
    Returns:
    
    当前栈信息
  - classInCurrentStack
```
public static boolean classInCurrentStack(String clazzName,
                                          String method)
```
    判断指定的 Class 的方法是否在当前的线程栈中
    
    Parameters:
    
    clazzName - 类对象
    
    method - 方法名
    
    Returns:
    
    true: 在当前的线程栈中, false: 不在当前的线程栈中
  - getStackMessage
```
public static String getStackMessage()
```
    获取当前栈信息会自动过滤掉栈里的第一行,即当前类的信息
    
    Returns:
    
    当前栈信息
  - getStackElementsMessage
```
public static String getStackElementsMessage(StackTraceElement[] stackTraceElements)
```
    获取当前栈信息
    
    Parameters:
    
    stackTraceElements - 栈信息对象数组
    
    Returns:
    
    当前栈信息
  - getThreads
```
public static Thread[] getThreads()
```
    获取JVM中的所有线程
    
    Returns:
    
    线程对象数组
  - getMainThread
```
public static Thread getMainThread()
```
    获取进程的主线程
    
    Returns:
    
    进程的主线程
  - searchClassInEnv
```
public static List<Class> searchClassInEnv(String pattern,
                                           Class[] filters)
                                    throws IOException
```
    从当前进程的ClassPath中寻找 Class
    
    Parameters:
    
    pattern - 确认匹配的正则表达式
    
    filters - 过滤的 class, 满足这些条件的 class 才会被搜索到(注解,接口,继承的类)
    
    Returns:
    
    匹配到的 class 集合
    
    Throws:
    
    IOException - IO 异常
  - getDirectorClass
```
public static List<Class> getDirectorClass(File rootfile,
                                           String pattern,
                                           Class[] filters)
                                    throws IOException
```
    从指定 File 对象寻找 Class
    
    Parameters:
    
    rootfile - 文件目录 File 对象
    
    pattern - 确认匹配的正则表达式
    
    filters - 过滤的 class, 满足这些条件的 class 才会被搜索到(注解,接口,继承的类)
    
    Returns:
    
    匹配到的 class 集合
    
    Throws:
    
    IOException - IO 异常
  - getJarClass
```
public static List<Class> getJarClass(File jarFile,
                                      String pattern,
                                      Class[] filters)
                               throws IOException
```
    从指定jar 文件中寻找 Class
    
    Parameters:
    
    jarFile - jar 文件 File 对象
    
    pattern - 确认匹配的正则表达式
    
    filters - 过滤的 class, 满足这些条件的 class 才会被搜索到(注解,接口,继承的类)
    
    Returns:
    
    匹配到的 class
    
    Throws:
    
    IOException - IO 异常
  - loadClassBytes
```
public static byte[] loadClassBytes(Class clazz)
```
    读取 Class 的字节码
    
    Parameters:
    
    clazz - Class 对象
    
    Returns:
    
    字节码
  - getClassLocation
```
public static String getClassLocation(Class clazz)
```
    获取 Class 在物理设备上的文件位置
    
    Parameters:
    
    clazz - Class 对象
    
    Returns:
    
    在物理设备上的文件位置
  - getClassModifyTime
```
public static long getClassModifyTime(Class clazz)
```
    获取 Class 的修改时间
    
    Parameters:
    
    clazz - Class 对象
    
    Returns:
    
    修改时间, 返回: -1 文件不存在 / 文件不是 Class 文件 / IO 异常
  - getClassPath
```
public static List<String> getClassPath()
```
    获取类 Class Path 因部分 ide 会自动增加全部的 jvm 的 classpath, 所以这里会自动剔除 classpath 中 jvm 的 classPath
    
    Returns:
    
    获得用户的类加载路径
  - classToResource
```
public static String classToResource(Class clazz)
```
    将class 转换成资源资源文件路径
    
    Parameters:
    
    clazz - Class对象
    
    Returns:
    
    资源文件路径
  - resourceToClass
```
public static Class resourceToClass(String resourcePath)
                             throws ClassNotFoundException
```
    将资源文件路径转换成 Class
    
    Parameters:
    
    resourcePath - 资源资源文件路径
    
    Returns:
    
    Class对象
    
    Throws:
    
    ClassNotFoundException - 类未找到异常
  - getJavaHome
```
public static String getJavaHome()
```
    返回当前 jvm 的 JAVA_HOME 参数
    
    Returns:
    
    当前 jvm 的 JAVA_HOME 参数
  - agentAttach
```
public static Instrumentation agentAttach(String agentJarPath)
                                   throws IOException,
                                          com.sun.tools.attach.AttachNotSupportedException,
                                          com.sun.tools.attach.AgentLoadException,
                                          com.sun.tools.attach.AgentInitializationException
```
    附加 Agentjar 到目标地址
    
    Parameters:
    
    agentJarPath - AgentJar 文件
    
    Returns:
    
    Instrumentation 对象
    
    Throws:
    
    IOException - IO 异常
    
    com.sun.tools.attach.AttachNotSupportedException - 附加指定进程失败
    
    com.sun.tools.attach.AgentLoadException - Agent 加载异常
    
    com.sun.tools.attach.AgentInitializationException - Agent 初始化异常
  - waitThrow
```
public static void waitThrow(int waitTime,
                             Supplier<Boolean> supplier)
                      throws TimeoutException
```
    等待函数
    
    Parameters:
    
    waitTime - 等待时间
    
    supplier - 满足条件时一直等待, 如果该方法返回 true 一直等待, false 达到预期退出等待
    
    Throws:
    
    TimeoutException - 超时异常
  - wait
```
public static boolean wait(int waitTime,
                           Supplier<Boolean> supplier)
```
    等待函数
    
    Parameters:
    
    waitTime - 等待时间
    
    supplier - 满足条件时一直等待, 如果该方法返回 true 一直等待, false 达到预期退出等待
    
    Returns:
    
    true: 等待达到预期, false: 等待超时
  - wait
```
public static boolean wait(int waitTime,
                           boolean isCLH,
                           Supplier<Boolean> supplier)
```
    等待函数
    
    Parameters:
    
    waitTime - 等待时间
    
    isCLH - 是否启用自旋
    
    supplier - 满足条件时一直等待, 如果该方法返回 true 一直等待, false 达到预期退出等待
    
    Returns:
    
    true: 等待达到预期, false: 等待超时
  - wait
```
public static boolean wait(Supplier<Boolean> supplier)
```
    等待函数
    
    Parameters:
    
    supplier - 满足条件时一直等待, 如果该方法返回 true 一直等待, false 达到预期退出等待
    
    Returns:
    
    true: 等待达到预期, false: 等待超时
  - measure
```
public static List measure(Supplier supplier)
```
    性能测试方法
    
    Parameters:
    
    supplier - 执行器
    
    Returns:
    
    [0]: supplier 的执行结果, [1]: 执行时间
  - measure
```
public static long measure(Runnable runnable)
```
    性能测试方法不需要响应
    
    Parameters:
    
    runnable - 执行器
    
    Returns:
    
    执行时间
  - measure
```
public static List measure(String msg,
                           Supplier supplier,
                           TimeUnit timeUnit)
```
    性能测试方法
    
    Parameters:
    
    msg - 输出的消息
    
    supplier - 执行器
    
    timeUnit - 输出的时间单位
    
    Returns:
    
    [0]: supplier 的执行结果, [1]: 执行时间
  - measure
```
public static List measure(String msg,
                           Supplier supplier)
```
    性能测试方法
    
    Parameters:
    
    msg - 输出的消息
    
    supplier - 执行器
    
    Returns:
    
    [0]: supplier 的执行结果, [1]: 执行时间
  - measure
```
public static void measure(String msg,
                           Runnable runnable)
```
    性能测试方法
    
    Parameters:
    
    msg - 输出的消息
    
    runnable - 执行器
  - measure
```
public static void measure(String msg,
                           Runnable runnable,
                           TimeUnit timeUnit)
```
    性能测试方法
    
    Parameters:
    
    msg - 输出的消息
    
    runnable - 执行器
    
    timeUnit - 输出的时间单位
  - getSystemProperty
```
public static <T> T getSystemProperty(String propertyName,
                                      T defVal)
```
  - getSystemProperty
```
public static <T> T getSystemProperty(String propertyName,
                                      Class clazz)
```

Class TEnv

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JDK_VERSION

OS_NAME

MAIN_THREAD

IS_SHUTDOWN

SHUT_DOWN_HOOKS

instrumentation

Constructor Detail

TEnv

Method Detail

addShutDownHook

getEnvName

setEnvName

getCurrentPID

createSysProcess

createSysProcess

sleep

sleep

getStackElements

classInCurrentStack

getStackMessage

getStackElementsMessage

getThreads

getMainThread

searchClassInEnv

getDirectorClass

getJarClass

loadClassBytes

getClassLocation

getClassModifyTime

getClassPath

classToResource

resourceToClass

getJavaHome

agentAttach

waitThrow

wait

wait

wait

measure

measure

measure

measure

measure

measure

getSystemProperty

getSystemProperty