testable-mock/docs/zh-cn/doc/annotations.md
2021-08-08 21:53:34 +08:00

2.8 KiB
Raw Blame History

注解参数清单

基于轻量的原则,TestableMock为开发者提供了尽可能精炼、易用的注解组合,以下参数信息可供开发参考。

@EnablePrivateAccess

启用对被测类的私有成员访问编译期增强私有目标存在性的编译期校验功能。

  • 作用于:测试类
参数 类型 是否必须 默认值 作用
srcClass Class N/A 当测试类命名不符合约定时,指定实际被测类
verifyTargetOnCompile boolean true 是否启用私有目标的编译期存在性校验

@MockMethod

将当前方法标识为待匹配的Mock成员方法。

  • 作用于Mock容器类中的方法
参数 类型 是否必须 默认值 作用
targetClass Class N/A 指定Mock目标的调用者类型
targetMethod String N/A 指定Mock目标的方法名
scope MockScope MockScope.GLOBAL 指定Mock的生效范围

@MockConstructor

将当前方法标识为待匹配的Mock构造方法。

  • 作用于Mock容器类中的方法
参数 类型 是否必须 默认值 作用
scope MockScope MockScope.GLOBAL 指定Mock的生效范围

@MockWith

显式指定当前类型关联的Mock容器类。

  • 作用于:测试类、被测类
参数(N/A为默认参数) 类型 是否必须 默认值 作用
N/A Class NullType.class 指定使用的Mock容器类
treatAs ClassType ClassType.GuessByName 指定当前类是测试类或被测类

@MockDiagnose

启用或禁止Mock相关的诊断信息输出。

  • 作用于Mock容器类
参数(N/A为默认参数) 类型 是否必须 默认值 作用
N/A LogLevel N/A 指定当前Mock容器关联测试用例的诊断日志级别

@DumpTo

将指定类型被TestableMock处理过后的字节码导出到文件。

  • 作用于:任意类型
参数(N/A为默认参数) 类型 是否必须 默认值 作用
N/A String N/A 存放导出文件的目录(相对当前执行目录的相对路径),若目录不存在,将自动创建