如何在运行时获取命令框架API中类的实例？

针对你开发的命令框架遇到的问题——既要支持开发者自行初始化命令类实例，又要在未初始化时自动创建实例，以下是几种可行的方案：

方案1：提供实例注册API（推荐） #

这是最可靠且侵入性最低的方式，让开发者主动将自己创建的命令实例注册到框架中。

• 框架维护一个Map<Class<?>, Object>来存储已注册的实例，键是命令类的Class对象，值是对应的实例。
• 提供注册方法，比如：

  public class CommandFramework {
      private static final Map<Class<?>, Object> registeredInstances = new ConcurrentHashMap<>();
  
      public static void registerCommandInstance(Object commandInstance) {
          registeredInstances.put(commandInstance.getClass(), commandInstance);
      }
  }
  

• 调用命令方法时，先从Map中查找实例：

  Class<?> declaringClass = mapping.getMethod().getDeclaringClass();
  Object instance = registeredInstances.getOrDefault(declaringClass, declaringClass.newInstance());
  mapping.getMethod().invoke(instance, paramValues);
  

• 优点：逻辑简单可控，完全尊重开发者的实例管理需求，避免反射带来的潜在问题。
• 缺点：需要开发者额外调用注册方法，增加了一点使用成本。

方案2：反射遍历堆中已存在的实例（非常规手段） #

如果不想让开发者手动注册，可以通过反射或底层API遍历JVM堆中的对象，找到对应类的实例。

• 借助Instrumentation API：需要通过Java Agent启动应用，使用Instrumentation.getAllLoadedClasses()获取所有加载的类，再结合堆遍历逻辑找到对应实例。
• 使用Unsafe类：通过Unsafe的底层方法直接操作内存查找实例，但这种方法依赖JVM实现，兼容性差，且存在安全风险。
• 简化思路示例：

  public Object getExistingInstance(Class<?> clazz, Instrumentation inst) {
      for (Class<?> loadedClass : inst.getAllLoadedClasses()) {
          if (loadedClass.equals(clazz)) {
              List<Object> instances = HeapTraversal.findInstancesOf(clazz, inst);
              if (!instances.isEmpty()) {
                  return instances.get(0); // 返回第一个找到的实例，多实例场景需额外约定规则
              }
          }
      }
      return null;
  }
  

• 优点：无需开发者手动操作，自动发现实例。
• 缺点：实现复杂，性能开销大，依赖JVM特性，无法完美处理多实例场景。

方案3：约定实例获取规则 #

和开发者约定命令类的实例获取方式，比如要求单例类提供getInstance()静态方法：

• 调用时先尝试反射调用静态方法获取实例，失败再创建新实例：

  Class<?> declaringClass = mapping.getMethod().getDeclaringClass();
  Object instance;
  try {
      Method getInstance = declaringClass.getMethod("getInstance");
      instance = getInstance.invoke(null);
  } catch (NoSuchMethodException e) {
      instance = declaringClass.newInstance();
  }
  mapping.getMethod().invoke(instance, paramValues);
  

• 优点：实现简单，无需额外API。
• 缺点：强制开发者遵守约定，灵活性差，无法处理非单例的自定义实例。

方案4：字节码增强跟踪实例创建 #

通过ASM等字节码操作库，修改命令类的构造函数，每次实例化时自动将实例上报给框架：

• 框架在类加载时，拦截命令类的构造方法，插入代码将实例保存到框架的弱引用集合中：

  // ASM示例：修改构造函数
  @Override
  public MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions) {
      MethodVisitor mv = super.visitMethod(access, name, desc, signature, exceptions);
      if ("<init>".equals(name)) { // 匹配构造方法
          return new ConstructorVisitor(mv, owner);
      }
      return mv;
  }
  
  private static class ConstructorVisitor extends AdviceAdapter {
      private final String owner;
  
      public ConstructorVisitor(MethodVisitor mv, String owner) {
          super(ASM9, mv, ACC_PUBLIC, "<init>", "()V");
          this.owner = owner;
      }
  
      @Override
      protected void onMethodExit(int opcode) {
          // 将当前实例（this）注册到框架
          mv.visitVarInsn(ALOAD, 0);
          mv.visitMethodInsn(INVOKESTATIC, "com/yourframework/CommandFramework", "trackInstance", "(Ljava/lang/Object;)V", false);
          super.onMethodExit(opcode);
      }
  }
  

• 框架维护一个WeakHashMap<Class<?>, Object>来跟踪实例，避免内存泄漏。
• 优点：自动跟踪实例，无需开发者干预。
• 缺点：需要引入字节码依赖，增加框架复杂度，可能和其他字节码工具冲突。

内容的提问来源于stack exchange，提问作者Stephen Kross