如何在JVM启动时执行Java类库的初始化方法？

这是类库开发里很常见的需求——想让你的工具类库在用户的JVM启动时自动完成初始化，不用用户手动写调用代码。下面给你几个实用的方案，你可以根据场景灵活选择：

方案1：静态代码块（最简单的入门方案） #

Java的静态代码块会在类被JVM加载时自动执行，这是最直接的实现方式。你只需要创建一个专门的初始化类，把逻辑放在static块里，再确保这个类会被加载就行。

示例代码：

package com.your.library;

public class LibraryBootstrap {
    // 静态代码块，类加载时自动执行
    static {
        // 在这里写你的初始化逻辑，比如加载配置、初始化全局资源等
        System.out.println("你的类库正在初始化...");
    }

    // 私有构造方法，防止被外部实例化
    private LibraryBootstrap() {}

    // 可选：提供一个空方法，方便用户主动触发初始化（如果需要）
    public static void init() {
        // 无需额外逻辑，static块已经在类加载时执行了
    }
}

怎么确保这个类被加载？

• 让类库中的核心业务类间接依赖它，比如在某个工具类里加一行：private static final LibraryBootstrap TRIGGER = new LibraryBootstrap();
• 或者告诉用户：只要用到你类库的任何类，这个初始化逻辑就会自动运行；如果需要提前执行，也可以手动调用LibraryBootstrap.init()

优缺点

• ✅ 实现简单，零额外依赖，上手成本极低
• ❌ 触发时机依赖类加载，如果用户完全没用到你类库的任何类，逻辑不会执行；多个静态块的执行顺序难以精准控制

方案2：Java SPI（解耦的可控方案） #

SPI是Java原生的服务发现机制，能让你的类库和用户代码解耦，用户可以选择是否启用你的初始化逻辑，甚至替换自定义实现。

步骤1：定义初始化接口 #

package com.your.library;

public interface LibraryInitializer {
    void onJvmStartup();
}

步骤2：实现这个接口 #

package com.your.library.impl;

public class DefaultLibraryInitializer implements LibraryInitializer {
    @Override
    public void onJvmStartup() {
        // 初始化逻辑
        System.out.println("通过SPI执行类库初始化...");
    }
}

步骤3：注册SPI实现 #

在你的类库的src/main/resources/META-INF/services目录下，创建一个以接口全名为文件名的文件：com.your.library.LibraryInitializer，文件内容是实现类的全名：

com.your.library.impl.DefaultLibraryInitializer

步骤4：引导用户调用 #

用户需要在他们的项目启动入口（比如Web项目的ServletContextListener，或者控制台项目的main方法）里添加这段代码：

import java.util.ServiceLoader;
import com.your.library.LibraryInitializer;

public class AppStartupListener implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        // 加载并执行所有LibraryInitializer实现
        ServiceLoader<LibraryInitializer> loaders = ServiceLoader.load(LibraryInitializer.class);
        for (LibraryInitializer initializer : loaders) {
            initializer.onJvmStartup();
        }
    }
}

优缺点

• ✅ 解耦性强，用户可以自定义初始化逻辑，或者禁用默认实现
• ❌ 需要用户主动调用ServiceLoader的加载逻辑，做不到完全“无侵入自动执行”

方案3：Java Agent（完全自动的高级方案） #

如果必须做到用户不用写任何代码，JVM一启动就执行初始化，那Java Agent是最佳选择。它能在JVM启动初期、所有应用类加载前执行逻辑。

步骤1：编写Agent类 #

package com.your.library.agent;

import java.lang.instrument.Instrumentation;

public class LibraryStartupAgent {
    // premain方法会在JVM启动时被自动调用
    public static void premain(String agentArgs, Instrumentation inst) {
        // 你的初始化逻辑
        System.out.println("通过Java Agent执行类库初始化...");
    }
}

步骤2：打包Agent Jar #

在你的Maven项目中，配置maven-jar-plugin生成包含Agent信息的Jar：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <version>3.3.0</version>
    <configuration>
        <archive>
            <manifest>
                <addClasspath>true</addClasspath>
                <!-- 指定premain类 -->
                <manifestEntries>
                    <Premain-Class>com.your.library.agent.LibraryStartupAgent</Premain-Class>
                    <Can-Redefine-Classes>true</Can-Redefine-Classes>
                </manifestEntries>
            </manifest>
        </archive>
    </configuration>
</plugin>

步骤3：用户使用方式 #

用户需要在启动JVM时添加参数：

-javaagent:/path/to/your-library-agent.jar

如果是Tomcat这类容器，可以在catalina.sh（或catalina.bat）里添加JAVA_OPTS="$JAVA_OPTS -javaagent:/path/to/your-library-agent.jar"

优缺点

• ✅ 完全自动，JVM启动即执行，不依赖用户代码
• ❌ 用户需要配置JVM参数，门槛略高；Agent逻辑出错可能影响整个JVM启动

方案选择建议 #

• 🌟 如果你只需要简单的初始化，且类库一定会被用户使用：选静态代码块
• 🌟 如果你希望用户能灵活控制初始化逻辑：选Java SPI
• 🌟 如果你必须做到完全自动，不需要用户干预：选Java Agent

内容的提问来源于stack exchange，提问作者Dimitrios Efthymiou