FunctionDeclarationUtil

5 篇文章 0 订阅
本文深入探讨了Java中FunctionDeclarationUtil工具类的作用和用法,包括它如何简化函数声明和调用,以及在实际开发中的应用案例。通过实例解析,读者将了解如何有效地利用这个工具提高代码的可读性和效率。
摘要由CSDN通过智能技术生成
import com.google.common.collect.Lists;

import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.lang.reflect.Type;
import java.net.JarURLConnection;
import java.net.URL;
import java.net.URLDecoder;
import java.util.Enumeration;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;

import io.swagger.annotations.ApiOperation;

public class FunctionDeclarationUtil {

    public static void main(String[] args) {
        List<String> packageNames = Lists.newArrayList("com.pkg1", "com.pkg2");
        packageNames.forEach(packageName -> {
            Set<Class<?>> classes = null;
            try {
                classes = getClasses(packageName);
            } catch (IOException e) {
                e.printStackTrace();
            }
            assert classes != null;
            classes.forEach(FunctionDeclarationUtil::listFunctionDeclarations);
        });
    }

    public static Set<Class<?>> getClasses(String pack) throws IOException {
        // 第一个class类的集合
        Set<Class<?>> classes = new LinkedHashSet<Class<?>>();
        // 是否循环迭代
        boolean recursive = true;
        // 获取包的名字 并进行替换
        String packageName = pack;
        String packageDirName = packageName.replace('.', '/');
        // 定义一个枚举的集合 并进行循环来处理这个目录下的things
        Enumeration<URL> dirs;
        try {
            dirs = Thread.currentThread().getContextClassLoader().getResources(packageDirName);
            // 循环迭代下去
            while (dirs.hasMoreElements()) {
                // 获取下一个元素
                URL url = dirs.nextElement();
                // 得到协议的名称
                String protocol = url.getProtocol();
                // 如果是以文件的形式保存在服务器上
                if ("file".equals(protocol)) {
                    // 获取包的物理路径
                    String filePath = URLDecoder.decode(url.getFile(), "UTF-8");
                    // 以文件的方式扫描整个包下的文件 并添加到集合中
                    findAndAddClassesInPackageByFile(packageName, filePath, recursive, classes);
                } else if ("jar".equals(protocol)) {
                    // 如果是jar包文件
                    // 定义一个JarFile
                    JarFile jar;
                    try {
                        // 获取jar
                        jar = ((JarURLConnection) url.openConnection()).getJarFile();
                        // 从此jar包 得到一个枚举类
                        Enumeration<JarEntry> entries = jar.entries();
                        // 同样的进行循环迭代
                        while (entries.hasMoreElements()) {
                            // 获取jar里的一个实体 可以是目录 和一些jar包里的其他文件 如META-INF等文件
                            JarEntry entry = entries.nextElement();
                            String name = entry.getName();
                            if (name.charAt(0) == '/') {
                                name = name.substring(1);
                            }
                            // 如果前半部分和定义的包名相同
                            if (name.startsWith(packageDirName)) {
                                int idx = name.lastIndexOf('/');
                                if (idx != -1) {
                                    packageName = name.substring(0, idx).replace('/', '.');
                                }
                                if ((idx != -1) || recursive) {
                                    // 如果是一个.class文件 而且不是目录
                                    if (name.endsWith(".class") && !entry.isDirectory()) {
                                        // 去掉后面的".class" 获取真正的类名
                                        String className = name.substring(packageName.length() + 1, name.length() - 6);
                                        try {
                                            // 添加到classes
                                            classes.add(Class.forName(packageName + '.' + className));
                                        } catch (ClassNotFoundException e) {
                                            e.printStackTrace();
                                        }
                                    }
                                }
                            }
                        }
                    } catch (IOException e) {
                        // log.error("在扫描用户定义视图时从jar包获取文件出错");
                        e.printStackTrace();
                    }
                }
            }
        } catch (IOException e) {
            e.printStackTrace();
        }

        return classes;
    }

    public static void findAndAddClassesInPackageByFile(String packageName, String packagePath, final boolean recursive,
                                                        Set<Class<?>> classes) {
        // 获取此包的目录 建立一个File
        File dir = new File(packagePath);
        // 如果不存在或者 也不是目录就直接返回
        if (!dir.exists() || !dir.isDirectory()) {
            // log.warn("用户定义包名 " + packageName + " 下没有任何文件");
            return;
        }
        // 如果存在 就获取包下的所有文件 包括目录
        File[] dirfiles = dir.listFiles(new FileFilter() {
            // 自定义过滤规则 如果可以循环(包含子目录) 或则是以.class结尾的文件(编译好的java类文件)
            public boolean accept(File file) {
                return (recursive && file.isDirectory()) || (file.getName().endsWith(".class"));
            }
        });
        // 循环所有文件
        for (File file : dirfiles) {
            // 如果是目录 则继续扫描
            if (file.isDirectory()) {
                findAndAddClassesInPackageByFile(packageName + "." + file.getName(), file.getAbsolutePath(), recursive,
                        classes);
            } else {
                // 如果是java类文件 去掉后面的.class 只留下类名
                String className = file.getName().substring(0, file.getName().length() - 6);
                try {
                    classes.add(
                            Thread.currentThread().getContextClassLoader().loadClass(packageName + '.' + className));
                } catch (ClassNotFoundException e) {
                    // log.error("添加用户自定义视图类错误 找不到此类的.class文件");
                    e.printStackTrace();
                }
            }
        }
    }

    public static void listFunctionDeclarations(Class clazz) {
        Method[] methods = clazz.getDeclaredMethods();
        for (Method method : methods) {
            Parameter[] params = method.getParameters();
            StringBuilder paramString = new StringBuilder();
            for (int i = 0; i < params.length; i++) {
                Type type = params[i].getParameterizedType();
                paramString.append(getShortName(type.getTypeName())).append(" ").append(params[i].getName());
                if (i != params.length - 1) {
                    paramString.append(", ");
                }
            }
            ApiOperation annotation = method.getAnnotation(ApiOperation.class);
            if (!method.getName().contains("lambda") && !method.getName().contains("Lambda")) {
                if (annotation != null) {
                    System.out.print(annotation.value());
                }
                System.out.print("```");
                System.out.println(getShortName(clazz.getName()) + " public " + getShortName(method.getGenericReturnType().getTypeName()) + " " + method.getName() + "(" + paramString + ")");
            }
        }
    }

    /**
     * @param
     * @return
     * @author majl
     * @description 获取短类名,支持泛型的处理
     * @date 2019/10/30 15:50
     **/
    public static String getShortName(String typeName) {
        List<String> names = Lists.newArrayList();
        while (typeName.contains("<")) {
            StringBuilder str = new StringBuilder(typeName.substring(typeName.lastIndexOf("<")));
            str = new StringBuilder(str.substring(1, str.indexOf(">")));
            String target = "<" + str + ">";
            if (str.toString().contains(",")) {
                String[] strs = str.toString().split(",");
                str = new StringBuilder();
                for (int i = 0; i < strs.length; i++) {
                    str.append(getSimpleName(strs[i]));
                    if (i != strs.length - 1) {
                        str.append(", ");
                    }
                }
            } else {
                str = new StringBuilder(getSimpleName(str.toString()));
            }
            names.add(str.toString());
            typeName = typeName.replace(target, "");
        }
        names.add(getSimpleName(typeName));
        return packShortName(names);
    }

    private static String packShortName(List<String> names) {
        if (names.size() == 0) {
            return "";
        }
        if (names.size() == 1) {
            return names.get(0);
        }
        int size = names.size();
        String prefix = names.get(size - 1);
        names.remove(size - 1);
        return prefix + "<" + packShortName(names) + ">";
    }

    private static String getSimpleName(String name) {
        if (name.contains(".")) {
            int i = name.lastIndexOf(".");
            name = name.substring(i + 1);
        }
        //内部类会有$符号,也处理一下
        if (name.contains("$")) {
            int j = name.lastIndexOf("$");
            name = name.substring(j + 1);
        }
        return name;
    }

}
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值