Skip to content

Latest commit

 

History

History
138 lines (87 loc) · 4.85 KB

run_by_code.md

File metadata and controls

138 lines (87 loc) · 4.85 KB

1. 说明

有时可能需要使用java-all-call-graph进行二次开发，调用写入数据库、生成方法完整调用链、生成包含关键字的所有方法到起始方法之间的调用链等方法，可以按照以下说明。

从0.7.7版本开始，java-all-call-graph会尝试读取jar包中的配置文件，相关的配置文件可以不释放到项目中，可以通过Java代码对配置参数进行设置（进行二次开发时可能需要使用）。

从0.8.0版本开始，java-all-call-graph支持通过Java代码调用时，每次执行任务使用独立的配置信息，可支持多个任务并行执行（适用于在Web项目中使用java-all-call-graph的场景）

2. 通过源码启动

通过源码启动时，可以使用测试代码进行功能验证

  • 编译测试代码

在项目根目录执行以下命令

gradlew test_gen_jar
  • 解析测试代码并将结果写入数据库

执行以下类

test.runbycode.TestRBC0RunnerWriteDb
  • 生成向上的方法完整调用链

执行以下类

test.runbycode.TestRBCRunnerGenAllGraph4Callee
  • 生成向下的方法完整调用链

执行以下类

test.runbycode.TestRBCRunnerGenAllGraph4Caller

2.1. 通过Java代码对配置参数进行设置

支持通过Java代码对配置参数进行设置，可覆盖配置文件中的参数（或仅使用Java代码中设置的参数，不使用配置文件中的参数）

以下使用Java代码中指定的参数配置，与通过配置文件配置的效果一样

相关的参数定义可参考以下类

com.adrninistrator.jacg.common.enums.ConfigKeyEnum
com.adrninistrator.jacg.common.enums.ConfigDbKeyEnum
com.adrninistrator.jacg.common.enums.OtherConfigFileUseListEnum
com.adrninistrator.jacg.common.enums.OtherConfigFileUseSetEnum

以下类用于对配置参数进行设置

com.adrninistrator.jacg.conf.ConfigureWrapper

以下类的构造函数支持传入ConfigureWrapper对象，以支持每次执行任务使用独立的配置信息，以下方法可支持多个任务并行执行（适用于在Web项目中使用java-all-call-graph的场景），每次需要创建以下类新的实例

类 方法 作用
RunnerWriteDb run() 生成Java方法调用关系并写入数据库
RunnerGenAllGraph4Callee run() 生成调用指定类方法向上的完整调用链
RunnerGenAllGraph4Caller run() 生成指定方法向下完整调用链
FindCallStackTrace find(boolean order4ee) 生成包含关键字的所有方法到起始方法之间的调用链

2.2. 示例

以下可参考test.run_by_code包中的测试代码，在TestRunByCodeBase类中创建了ConfigureWrapper对象，并在该类的子类中使用ConfigureWrapper对象调用相关的方法。

可参考test.runbycode.config.TestConfigGenerator类中通过代码进行配置的方式

2.2.1. 配置文件说明

参考通过代码执行的其他示例，该文档中有每个配置文件的简单说明，以及对应的枚举信息。每个配置文件的详细说明可打开配置文件查看

通过枚举修改配置的方式与修改配置文件的效果相同

2.2.2. 设置_jacg_config/config.properties配置文件参数

configureWrapper.setConfig(ConfigKeyEnum configKeyEnum, String value);

对于app.name参数，在以上方法中会将参数值中的-替换为_

ConfigKeyEnum枚举类中定义了_jacg_config/config.properties配置文件中的参数key

通过value参数指定需要设置的参数值

示例如下：

configureWrapper.setConfig(ConfigKeyEnum.CKE_APPNAME, "test_rbc");

2.2.3. 设置_jacg_config、_jacg_extensions目录配置文件参数

configureWrapper.setOtherConfigSet(OtherConfigFileUseSetEnum otherConfigFileUseSetEnum, Set<String> configSet);

OtherConfigFileUseSetEnum枚举类中定义了_jacg_config目录中其他配置文件的文件名，以及_jacg_extensions目录中的配置文件名

通过configSet参数指定需要设置的Set类型的参数值

示例如下：

configureWrapper.setOtherConfigSet(OtherConfigFileUseSetEnum.OCFUSE_IN_ALLOWED_CLASS_PREFIX, new HashSet<>(Arrays.asList(
        "test.callgraph.methodcall",
        "test.callgraph.argument",
        "java.")));

2.2.4. 设置_jacg_find_keyword目录配置文件参数

configureWrapper.setOtherConfigList(OtherConfigFileUseListEnum otherConfigFileUseListEnum, List<String> configList);

OtherConfigFileUseListEnum枚举类中定义了_jacg_find_keyword目录中配置文件的文件名

通过configList参数指定需要设置的List类型的参数值

示例如下：

configureWrapper.setOtherConfigList(OtherConfigFileUseListEnum.OCFULE_FIND_KEYWORD_4CALLEE, Arrays.asList("!entry!", "<init>"));