java根据接口路径找到对应的类

场景说明

开发人员如果要查看接口的代码就要根据接口的请求路径找到相应的代码文件，虽然可以根据接口路径按包名和文件名去查找，但有些麻烦而且有时候路径跟包名和文件名是对不上的，以下提供了便捷的方法可以迅速找到接口路径对应的文件

如果有源码则可以通过idea的自带工具找到接口路径对应的类（如下图），但如果接口只存放在jar包里或class文件里就不行了

可以通过根据注解查找指定类和方法的原理查找接口路径对应的类

原理

根据类和方法上的注解，获取到指定的类，比如暴露接口的类和方法都有映射接口路径的@Path注解，这样就可以根据注解上的值来找到类了，对于其它映射接口路径注解也是一样的，比如@RequestMapping

步骤

使用 reflections 框架根据注解查找类

1.添加 reflections 框架依赖

<dependency>
    <groupId>org.reflections</groupId>
    <artifactId>reflections</artifactId>
    <version>0.9.11</version>
</dependency>
<dependency> 
    <groupId>com.google.guava</groupId>
    <artifactId>guava</artifactId>
    <version>21.0</version>
</dependency>

2.根据 /api/workflow/reqform/detailData 接口路径查找对应的类的示例

类的Path注解一般是接口路径的前面几层，比如/workflow/reqform，所以类按这个查找

方法的Path注解就是接口路径的最后一层，按/detailData进行查找

@Test
public void Test() throws Exception {
    // 可以在构造方法加上包路径，这样就会扫描指定包下的类，如 com.api ,如不指定包名则会扫描所有类，这样会比较慢
    Reflections f = new Reflections("");
    // 找到所有使用Path注解的类
    Set<Class<?>> set = f.getTypesAnnotatedWith(Path.class);
    for (Class<?> c : set){
        Path path = c.getAnnotation(Path.class);
        // 该类的Path注解是否包含指定路径
        if (path.value().equals("/workflow/reqform")){
            // 获取该类的所有方法
            Method[] methods = c.getMethods();
            for (Method m:methods){
                // 该方法是否使用Path注解，并且该注解是否包含指定接口路径
                if (m.isAnnotationPresent(Path.class)){
                    Path methodPath = m.getAnnotation(Path.class);
                    if (methodPath.value().contains("detailData")){
                        // 输出类路径
                        System.out.println("已找到："+c);
                        break;
                    }
                }
            }
        }
    }
}

输出结果：