自定义类加载器实现热加载

àì夳堔傛蜴生んèń 2023-06-24 14:24 43阅读 0赞

# 一、实现的需求 #

当一个java被修改后，系统无需重启，替换的类立即生效，这里以Work.java为例

# 二、实现的思路 #

## 1）难点分析 ##

> 1.  当项目在执行的时候，我们修改了Work.java,这个类的class文件是不会重新编译的，解决方法？

当Work.java内容发生改变时，调用JavaCompiler对文件进行编译，编译完成后会在Work.java文件所在目录会生成一个Work.class文件，用这个Work.class文件替换编译后目录中的Work.class文件，然后将Work.java目录中的Work.class文件删除，然后就实现了热编译。

> 1.  怎么实现文件监听？监听那些文件相关事件？

我这里是从整个项目来进行监听的，方便以后进行拓展，而不是监听单个文件。

引入common.io包，继承FileAlterationListenerAdaptor，重写方法。

> 1.  怎么实现类的热加载？

自定义类加载器，重写loadClass方法，打破双亲委派机制实现热加载。

## 2）具体实现 ##

1.  创建一个线程监听.java文件目录
    
    1.  当文件内容发生改变时，就重新编译文件
    2.  当Work.class文件创建时，就将编译目录的Work.class替换为这个，然后删除，实现热编
2.  创建另外一个线程监听.class文件目录
    
    1.  当文件内容发生改变时就重新加载类
    2.  使用自定义的类进行加载

# 三、代码实现 #

> 1.  class文件目录文件监听类

import org.apache.commons.io.FileUtils;
    import org.apache.commons.io.monitor.FileAlterationListenerAdaptor;
    import javax.tools.JavaCompiler;
    import javax.tools.ToolProvider;
    import java.io.File;
    import java.io.IOException;
    
    
    public class FileWatch extends FileAlterationListenerAdaptor { 
    
        @Override
        public void onFileCreate(File file) { 
            System.out.println(file.getName()+" created.");
            File clazz = new File("D:\\workdata\\zclassloader\\JAVA8\\target\\classes\\come");
            File[] files = clazz.listFiles();
            for (File f:files
                 ) { 
                if(f.isDirectory()){ 
                    File[] listFiles = f.listFiles();
                    for (File c:listFiles
                         ) { 
                        convertFile(file,c);
                    }
                }else{ 
                    convertFile(file,f);
                }
    
            }
    
        }
    
        private void convertFile(File file,File f){ 
            if(file.getName().equals(f.getName())){ 
                try { 
                    FileUtils.copyFile(file,f);
                    file.delete();
                    System.out.println("文件转移成功");
                } catch (IOException e) { 
                    e.printStackTrace();
                    System.out.println("文件迁移失败！");
                }
            }
        }
    
        @Override
        public void onDirectoryCreate(File directory) { 
            System.out.println("directory-create："+directory.getName());
        }
    
        @Override
        public void onDirectoryChange(File directory) { 
            System.out.println("directory-change："+directory.getName());
        }
    
        @Override
        public void onDirectoryDelete(File directory) { 
            System.out.println("directory-delete："+directory.getName());
        }
    
        @Override
        public void onFileDelete(File file) { 
            System.out.println(file.getName()+"delete.");
        }
    
        @Override
        public void onFileChange(File file) { 
            System.out.println(file.getName()+" changed.");
            JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
            int run = compiler.run(null, null, null, file.getAbsolutePath());
            System.out.println(run == 0 ? "编译成功！" : "编译失败！");
        }
    
    }

> 1.  class文件目录文件监听线程类

import org.apache.commons.io.monitor.FileAlterationMonitor;
    import org.apache.commons.io.monitor.FileAlterationObserver;
    
    import java.io.File;
    import java.util.concurrent.TimeUnit;
    
    public class ClassFileWatchThread extends Thread { 
        @Override
        public void run() { 
            System.out.println(".class文件监听线程启动...");
            File directory = new File("D:\\workdata\\zclassloader\\JAVA8\\target\\classes\\come");
            // 轮询间隔 5 秒
            long interval = TimeUnit.SECONDS.toMillis(1);
            // 创建一个文件观察器用于处理文件的格式
            FileAlterationObserver observer = new FileAlterationObserver(directory, null);
            //设置文件变化监听器
            observer.addListener(new ClassFileWatch());
            FileAlterationMonitor monitor = new FileAlterationMonitor(interval,observer);
            try { 
                monitor.start();
            } catch (Exception e) { 
                e.printStackTrace();
            }
            System.out.println(".class文件监听线程启动成功...");
        }
    }

> 1.  java文件目录文件监听类

> 1.  java文件目录文件监听线程类

import org.apache.commons.io.monitor.FileAlterationMonitor;
    import org.apache.commons.io.monitor.FileAlterationObserver;
    
    import java.io.File;
    import java.util.concurrent.TimeUnit;
    
    public class FileWatchThread extends Thread { 
        @Override
        public void run() { 
            System.out.println(".java文件监听线程启动....");
            File directory = new File("D:\\workdata\\zclassloader\\JAVA8\\src\\main\\java\\come");
            // 轮询间隔 5 秒
            long interval = TimeUnit.SECONDS.toMillis(1);
            // 创建一个文件观察器用于处理文件的格式
            FileAlterationObserver observer = new FileAlterationObserver(directory, null);
            //设置文件变化监听器
            observer.addListener(new FileWatch());
            FileAlterationMonitor monitor = new FileAlterationMonitor(interval,observer);
            try { 
                monitor.start();
            } catch (Exception e) { 
                e.printStackTrace();
            }
            System.out.println(".java文件监听线程启动成功...");
        }
    }

> 1.  自定义类加载器(这个类应该在项目最外层)

import java.io.*;
    
    public class MyClassLoader extends ClassLoader { 
        private static final String EXT = ".class";
        private String path;
    
        public MyClassLoader() { 
            path = this.getResource("").getPath();
        }
    
        public MyClassLoader(String path) { 
            this.path = path;
        }
    
    
        // 打破双亲模式，保证自己的类会被自己的classloader加载
        @Override
        protected synchronized Class<?> loadClass(String name, boolean resolve)
                throws ClassNotFoundException { 
            byte[] b = null;
            try { 
                b = loadClassFile(name);
            } catch (FileNotFoundException e) { 
                System.err.println("加载器" + this.getClass().getName()
                        + "没有找到class文件" + name + "，将委派给父类加载器！");
                // 委派给父类加载器
                return getClass().getClassLoader().loadClass(name);
            }
            catch (IOException e) { 
                System.err.println("加载器" + this.getClass().getName() + "加载class文件"
                        + name + "失败，将委派给父类加载器！");
                // 委派给父类加载器
                return getClass().getClassLoader().loadClass(name);
            }
            // 检查该类是否被当前类加载器加载过（只检查当前类加载器，不会检查父类加载器）
            Class<?> clazz = findLoadedClass(name);
            if (clazz != null) { 
                System.out.println("类" + name + "已被加载过！");
                return clazz;
            } else { 
                System.out.println("类" + name + "尚未被加载！");
            }
            return this.defineClass(name, b, 0, b.length);
        }
    
        private byte[] loadClassFile(String name) throws IOException,
                FileNotFoundException { 
            String classFile = getClassFile(name);
            System.out.println("即将加载class文件" + classFile);
            ByteArrayOutputStream out = new ByteArrayOutputStream();
            InputStream input = new FileInputStream(classFile);
            int count;
            byte[] temp = new byte[1024];
            while ((count = input.read(temp)) > -1) { 
                out.write(temp, 0, count);
            }
            out.close();
            input.close();
            return out.toByteArray();
        }
        private String getClassFile(String name) { 
            String pathName = name.replace(".", File.separator);
            if (path.endsWith("/") || path.endsWith("\\")) { 
                return path + pathName + EXT;
            }
            return path + File.separator + pathName + EXT;
        }
    }

1.  演示类

public class Worker { 
        public void run(){ 
            System.out.println("hello world 1288");
        }
    }

1.  应用启动类

import come.classloader.ClassFileWatchThread;
    import come.file.FileWatchThread;
    
    public class App { 
        public static void main(String[] args) throws Exception { 
            //启动监听线程
            FileWatchThread watchThread = new FileWatchThread();
            watchThread.start();
            ClassFileWatchThread classFileWatchThread = new ClassFileWatchThread();
            classFileWatchThread.start();
        }
    }

# 四、结果演示 #

.java文件监听线程启动....
    .class文件监听线程启动...
    .class文件监听线程启动成功...
    .java文件监听线程启动成功...
    Worker.java changed.
    编译成功！
    Worker.class created.
    文件转移成功
    Worker.class change.
    D:\workdata\zclassloader\JAVA8\target\classes\come\Worker.class: Worker
    即将加载class文件/D:/workdata/zclassloader/JAVA8/target/classes/come\Worker.class
    类come.Worker尚未被加载！
    即将加载class文件/D:/workdata/zclassloader/JAVA8/target/classes/java\lang\Object.class
    即将加载class文件/D:/workdata/zclassloader/JAVA8/target/classes/java\lang\System.class
    即将加载class文件/D:/workdata/zclassloader/JAVA8/target/classes/java\io\PrintStream.class
    hello world
    加载器come.MyClassLoader没有找到class文件java.lang.Object，将委派给父类加载器！
    加载器come.MyClassLoader没有找到class文件java.lang.System，将委派给父类加载器！
    加载器come.MyClassLoader没有找到class文件java.io.PrintStream，将委派给父类加载器！
    Worker.classdelete.
    Worker.java changed.
    编译成功！
    Worker.class created.
    文件转移成功
    加载器come.MyClassLoader没有找到class文件java.lang.Object，将委派给父类加载器！
    加载器come.MyClassLoader没有找到class文件java.lang.System，将委派给父类加载器！
    加载器come.MyClassLoader没有找到class文件java.io.PrintStream，将委派给父类加载器！
    Worker.class change.
    D:\workdata\zclassloader\JAVA8\target\classes\come\Worker.class: Worker
    即将加载class文件/D:/workdata/zclassloader/JAVA8/target/classes/come\Worker.class
    类come.Worker尚未被加载！
    即将加载class文件/D:/workdata/zclassloader/JAVA8/target/classes/java\lang\Object.class
    即将加载class文件/D:/workdata/zclassloader/JAVA8/target/classes/java\lang\System.class
    即将加载class文件/D:/workdata/zclassloader/JAVA8/target/classes/java\io\PrintStream.class
    我的第一个热加载程序实现了！
    Worker.classdelete.
    Worker.java changed.
    编译成功！
    Worker.class created.
    文件转移成功
    加载器come.MyClassLoader没有找到class文件java.lang.Object，将委派给父类加载器！
    Worker.class change.
    加载器come.MyClassLoader没有找到class文件java.lang.System，将委派给父类加载器！
    D:\workdata\zclassloader\JAVA8\target\classes\come\Worker.class: Worker
    加载器come.MyClassLoader没有找到class文件java.io.PrintStream，将委派给父类加载器！
    即将加载class文件/D:/workdata/zclassloader/JAVA8/target/classes/come\Worker.class
    类come.Worker尚未被加载！
    即将加载class文件/D:/workdata/zclassloader/JAVA8/target/classes/java\lang\Object.class
    即将加载class文件/D:/workdata/zclassloader/JAVA8/target/classes/java\lang\System.class
    即将加载class文件/D:/workdata/zclassloader/JAVA8/target/classes/java\io\PrintStream.class
    hello world 666666
    Worker.classdelete.

从结果来看，项目没有重启，修改了Work.java类，其方法执行的输出值也发生了改变。