GlobalOptions.java

package com.github.ompc.greys.core;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 全局开关
 * Created by oldmanpushcart@gmail.com on 15/6/4.
 */
public class GlobalOptions {

    /**
     * 是否支持系统类<br/>
     * 这个开关打开之后将能代理到来自JVM的部分类，由于有非常强的安全风险可能会引起系统崩溃<br/>
     * 所以这个开关默认是关闭的，除非你非常了解你要做什么，否则请不要打开
     */
    @Option(level = 0,
            name = "unsafe",
            summary = "Option to support system-level class",
            description =
                    "This option enables to proxy functionality of JVM classes. "
                            + "Due to serious security risk a JVM crash is possibly be introduced. "
                            + "Do not activate it unless you are able to manage."
    )
    public static volatile boolean isUnsafe = false;

    /**
     * 是否支持dump被增强的类<br/>
     * 这个开关打开这后，每次增强类的时候都将会将增强的类dump到文件中，以便于进行反编译分析
     */
    @Option(level = 1,
            name = "dump",
            summary = "Option to dump the enhanced classes",
            description =
                    "This option enables the enhanced classes to be dumped to external file for further de-compilation and analysis."
    )
    public static volatile boolean isDump = false;

    /**
     * 是否支持批量增强<br/>
     * 这个开关打开后，每次均是批量增强类
     */
    @Option(level = 1,
            name = "batch-re-transform",
            summary = "Option to support batch reTransform Class",
            description = "This options enables to reTransform classes with batch mode."
    )
    public static volatile boolean isBatchReTransform = true;

    /**
     * 是否支持json格式化输出<br/>
     * 这个开关打开后，使用json格式输出目标对象，配合-x参数使用
     */
    @Option(level = 2,
            name = "json-format",
            summary = "Option to support JSON format of object output",
            description = "This option enables to format object output with JSON when -x option selected."
    )
    public static volatile boolean isUsingJson = false;

    /**
     * 是否在asm中输出
     */
    @Option(level = 1,
            name = "debug-for-asm",
            summary = "Option to print DEBUG message if ASM is involved",
            description = "This option enables to print DEBUG message of ASM for each method invocation."
    )
    public static volatile boolean isDebugForAsm = false;

    @Option(
            level = 1,
            name = "ptrace-class-matcher-lru-capacity",
            summary = "...",
            description = "..."
    )
    public static volatile int ptraceClassMatcherLruCapacity = 1024;

    @Option(
            level = 1,
            name = "ptrace-method-matcher-lru-capacity",
            summary = "...",
            description = "..."
    )
    public static volatile int ptraceMethodMatcherLruCapacity = 2048;


    @Option(
            level = 1,
            name = "session-write-queue-capacity",
            summary = "...",
            description = "..."
    )
    public static volatile int sessionWriteQueueCapacity = 2048;

    @Option(
            level = 3,
            name = "is-display-object-size",
            summary = "...",
            description = "..."
    )
    public static volatile boolean isDisplayObjectSize = false;

    @Option(
            level = 1,
            name = "is-disable-sub-class",
            summary = "Option to control include sub class when class matching",
            description = "This option disable to include sub class when matching class."
    )
    public static volatile boolean isDisableSubClass = false;

//    @Option(
//            level = 0,
//            name = "is-enable-fast-enhance",
//            summary = "Option to control enable fast enhance class",
//            description = "This option enable fast enhance class, maybe some class will enhance failed."
//    )
//    public static volatile boolean isEnableFastEnhance = false;

//    @Option(
//            level = 2,
//            name = "is-tracing-sub-class",
//            summary = "try to fix #94",
//            description = "try to fix #94"
//    )
//    public static volatile boolean isTracingSubClass = false;

    @Option(
            level = 1,
            name = "is-enable-trace-id",
            summary = "Option to control enable traceId display.",
            description = "This option enable to control traceId display."
    )
    public static volatile boolean isEnableTraceId = true;

    /**
     * 选项
     */
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.FIELD)
    public @interface Option {

        /*
         * 选项级别，数字越小级别越高
         */
        int level();

        /*
         * 选项名称
         */
        String name();

        /*
         * 选项摘要说明
         */
        String summary();

        /*
         * 命令描述
         */
        String description();

    }

}