Groovy脚本如何加载类并执行类方法

文
章
目
录

• 一、本地Jar包的加载操作
• 二、本地Class的加载方法
• 三、远程Jar包的加载方式

你知道Groovy脚本如何加载类并执行类方法吗？今天咱们来聊一聊Groovy脚本在加载类以及执行类里面方法的相关技巧。这在实际项目开发中，特别是在像FastRequest这类工具的前置、后置脚本编写场景里，有着非常重要的应用。

FastRequest允许在API执行前后处理一些逻辑，而这些逻辑是通过Groovy脚本来实现的。Groovy这门语言和Java极为相似，对Java开发者来说上手并不难。接下来，咱们就深入探讨如何利用Groovy来加载某个jar包或者项目里的类，并调用类中的方法来达成我们想要的功能。

一、本地Jar包的加载操作

想要在Groovy脚本里加载本地Jar包，首先得借助classLoader的addURL方法。比如说，commons.lang包里面有许多实用的工具方法，我们要是想用这些方法，就得先把包含这个包的Jar包加载进来。

// 使用classLoader的addURL方法加载本地Jar包，这里的路径需要替换为实际的Jar包路径
this.class.classLoader.addURL(new URL(\"file:/path/to/jar\"))
// 通过Class.forName获取指定类，并实例化该类，这里以org.apache.commons.lang3.StringUtils类为例
def StringUtils = Class.forName(\"org.apache.commons.lang3.StringUtils\").getDeclaredConstructor().newInstance()
// 利用实例化的类对象，调用其方法进行逻辑处理，这里只是示例，实际逻辑可按需编写
if(StringUtils.isNotBlank(\"\")){ 
    //some logic
} 

完成Jar包加载后，就能通过Class.forName实例化我们需要的类，后续便可以直接调用类中的方法了。

二、本地Class的加载方法

加载本地的Class文件，相对来说稍微复杂一点。我们需要自定义一个类加载器。下面这段Java代码就是一个自定义的本地类加载器：

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;

// 定义一个继承自ClassLoader的类，用于加载本地class文件
public class FrLocalClassLoader extends ClassLoader { 
    // 用于存储类路径
    private final String classpath; 
    // 构造函数，接收类路径作为参数
    public FrLocalClassLoader(String classpath) { 
        this.classpath = classpath; 
    } 
    // 重写findClass方法，用于查找并加载类
    @Override 
    public Class<?> findClass(String name) throws ClassNotFoundException { 
        // 根据类名和类路径构建class文件的路径
        String filePath = classpath + File.separator + name.replace(\".\", File.separator) + \".class\"; 
        File file = new File(filePath); 
        // 如果文件不存在，抛出类未找到异常
        if (!file.exists()) { 
            throw new ClassNotFoundException(\"Class not found: \" + name); 
        } 
        try (InputStream inputStream = new FileInputStream(file)) { 
            // 创建字节数组，用于读取class文件内容
            byte[] classData = new byte[(int) file.length()]; 
            // 读取class文件内容到字节数组
            inputStream.read(classData); 
            // 使用defineClass方法将字节数组转换为Class对象
            return defineClass(name, classData, 0, classData.length); 
        } catch (IOException e) { 
            // 如果读取文件时发生异常，抛出类加载失败异常
            throw new ClassNotFoundException(\"Could not load class: \" + name, e); 
        } 
    }
}

这个自定义类加载器的构造器需要传入classpath，它指的是class文件所在的目录。以SpringBoot项目为例，项目编译后会在模块目录下生成target/classes层级目录，我们就要把classes目录的绝对路径作为classPath。

加载类时，就可以像下面这样调用：

// 使用自定义类加载器加载指定类，这里路径和类名需要替换为实际的
def XxxUtil = new FrLocalClassLoader(\"path/to/classes\").loadClass(\"some.package.XxxUtil\") 

要是加载的类有构造器，操作也不复杂。获取到类之后，调用getConstructor方法，并传入对应的参数类型就可以了。

// 获取指定类的构造器，这里路径和类名以及参数类型需要替换为实际的
Constructor<?> constructor = new FrLocalClassLoader(\"path/to/classes\").loadClass(\"some.package.User\").getConstructor(String.class, int.class);
// 使用构造器创建类的实例，这里的参数值也需要替换为实际的
User instance = constructor.newInstance(\"Alice\", 30); 

三、远程Jar包的加载方式

在Groovy中加载远程Jar包，有一种简单便捷的方式，那就是使用@Grab注解。

// 使用@Grab注解加载指定的远程Jar包，这里groupId、artifactId和version需要替换为实际的
@Grab(\"org.apache.commons:commons-lang3:3.12.0\")
// 导入Jar包中的指定类
import org.apache.commons.lang3.StringUtils
// 利用导入的类对象，调用其方法进行逻辑处理，这里只是示例，实际逻辑可按需编写
if(StringUtils.isNotBlank(\"\")){ 
    //some logic
} 

通过@Grab(\"groupId:artifactId:version\")这种形式，就能轻松加载远程Jar包，然后导入对应的类，后续直接调用类中的方法即可。

掌握了Groovy脚本加载类和执行类方法的这些技巧，在开发过程中，我们就能更加灵活地利用各种类库和自定义类，实现更丰富的功能。希望本文能对大家有所帮助，要是在实际应用中遇到问题，欢迎一起交流探讨。