Java服務器熱部署的實現原理

jopen 9年前發布 | 28K 次閱讀 Java Java開發

在 web應用開發或者游戲服務器開發的過程中,我們時時刻刻都在使用熱部署。熱部署的目的很簡單,就是為了節省應用開發和發布的時間。比如,我們在使用 Tomcat或者Jboss等應用服務器開發應用時,我們經常會開啟熱部署功能。熱部署,簡單點來說,就是我們將打包好的應用直接替換掉原有的應用,不用 關閉或者重啟服務器,一切就是這么簡單。那么,熱部署到底是如何實現的呢?在本文中,我將寫一個實例,這個實例就是一個容器應用,允許用戶發布自己的應 用,同時支持熱部署。


在 Java中,要實現熱部署,首先,你得明白,Java中類的加載方式。每一個應用程序的類都會被ClassLoader加載,所以,要實現一個支持熱部署 的應用,我們可以對每一個用戶自定義的應用程序使用一個單獨的ClassLoader進行加載。然后,當某個用戶自定義的應用程序發生變化的時候,我們首 先銷毀原來的應用,然后使用一個新的ClassLoader來加載改變之后的應用。而所有其他的應用程序不會受到一點干擾。先看一下,該應用的設計圖:



有了總體實現思路之后,我們可以想到如下幾個需要完成的目標:

1、定義一個用戶自定義應用程序的接口,這是因為,我們需要在容器應用中去加載用戶自定義的應用程序。
2、我們還需要一個配置文件,讓用戶去配置他們的應用程序。
3、應用啟動的時候,加載所有已有的用戶自定義應用程序。
4、為了支持熱部署,我們需要一個監聽器,來監聽應用發布目錄中每個文件的變動。這樣,當某個應用重新部署之后,我們就可以得到通知,進而進行熱部署處理。

實現部分:

首先,我們定義一個接口,每一個用戶自定義的程序中都必須包含唯一一個實現了該接口的類。代碼如下:
    public interface IApplication {  

            public void init();  

            public void execute();  

            public void destory();  

    }  


在這個例子中,每一個用戶自定義的應用程序,都必須首先打包成一個jar文件,然后發布到一個指定的目錄,按照指定的格式,然后首次發布的時候,還需要將應用的配置添加到配置文件中。所以,首先,我們需要定義一個可以加載指定目錄jar文件的類:
public ClassLoader createClassLoader(ClassLoader parentClassLoader, String... folders) {  

       List<URL> jarsToLoad = new ArrayList<URL>();  
        for (String folder : folders) {  
              List<String> jarPaths = scanJarFiles(folder);  

               for (String jar : jarPaths) {  

                     try {  
                           File file = new File(jar);  
                           jarsToLoad.add(file.toURI().toURL());  

                    } catch (MalformedURLException e) {  
                           e.printStackTrace();  
                    }  
              }  
       }  

       URL[] urls = new URL[jarsToLoad.size()];  
       jarsToLoad.toArray(urls);  

        return new URLClassLoader(urls, parentClassLoader);  
}  


這 個方法很簡單,就是從多個目錄中掃描jar文件,然后返回一個新的URLClassLoader實例。至于scanJarFiles方法,你可以隨后下載 本文的源碼。然后,我們需要定義一個配置文件,用戶需要將他們自定義的應用程序信息配置在這里,這樣,該容器應用隨后就根據這個配置文件來加載所有的應用 程序:
    <apps>  
            <app>  
                   <name> TestApplication1</name >  
                   <file> com.ijavaboy.app.TestApplication1</file >  
            </app>  
            <app>  
                   <name> TestApplication2</name >  
                   <file> com.ijavaboy.app.TestApplication2</file >  
            </app>  
    </apps>  



這個配置是XML格式的,每一個app標簽就表示一個應用程序,每一個應用程序,需要配置名稱和那個實現了IApplication接口的類的完整路徑和名稱。
有 了這個配置文件,我們需要對其進行解析,在這個例子中,我使用的是xstream,很簡單,你可以下載源碼,然后看看就知道了。這里略過。這里需要提一 下:每個應用的名稱(name),是至關重要的,因為該例子中,我們的發布目錄是整個項目發布目錄下的applications目錄,這是所有用戶自定義 應用程序發布的目錄。而用戶發布一個應用程序,需要首先在該目錄下新建一個和這里配置的name一樣名稱的文件夾,然后將打包好的應用發布到該文件夾中。 (你必須這樣做,否則在這個例子中,你會發布失敗)。
好了,現在加載jar的方法和配置都有了,下面將是整個例子的核心部分,對,就是應用程序管理類,這個類就是要完成對每一個用戶自定義應用程序的管理和維護。首先要做的,就是如何加載一個應用程序:
    public void createApplication(String basePath, AppConfig config){  
          String folderName = basePath + GlobalSetting. JAR_FOLDER + config.getName();  
          ClassLoader loader = this.jarLoader .createClassLoader(ApplicationManager. class.getClassLoader(), folderName);  

           try {  
                 Class<?> appClass = loader. loadClass(config.getFile());  

                 IApplication app = (IApplication)appClass.newInstance();  

                 app.init();  

                  this.apps .put(config.getName(), app);  

          } catch (ClassNotFoundException e) {  
                 e.printStackTrace();  
          } catch (InstantiationException e) {  
                 e.printStackTrace();  
          } catch (IllegalAccessException e) {  
                 e.printStackTrace();  
          }  


可 以看到,這個方法接收兩個參數,一個是基本路徑,一個是應用程序配置。基本路徑其實就是項目發布目錄的地址,而AppConfig其實就是配置文件中 app標簽的一個實體映射,這個方法從指定的配置目錄中加載指定的類,然后調用該應用的init方法,完成用戶自定義應用程序的初始化。最后將,該加載的 應用放入內存中。
現在,所有的準備工作,都已經完成了。接下來,在整個應用程序啟動的時候,我們需要加載所有的用戶自定義應用程序,所以,我們在ApplicationManager中添加一個方法:

     public void loadAllApplications(String basePath){  

            for(AppConfig config : this.configManager.getConfigs()){  
                   this.createApplication(basePath, config);  
           }  
    }  

這 個方法,就是將用戶配置的所有應用程序加載到該容器應用中來。好了,現在我們是不是需要寫兩個獨立的應用程序試試效果了,要寫這個應用程序,首先我們新建 一個java應用程序,然后引用這個例子項目,或者將該例子項目打包成一個jar文件,然后引用到這個獨立的應用中來,因為這個獨立的應用程序中,必須要 包含一個實現了IApplication接口的類。我們來看看這個例子包含的一個獨立應用的樣子:
    public class TestApplication1 implements IApplication{  

            @Override  
            public void init() {  
                  System. out.println("TestApplication1-->init" );  
           }  

            @Override  
            public void execute() {  
                  System. out.println("TestApplication1-->do something" );  
           }  

            @Override  
            public void destory() {  
                  System. out.println("TestApplication1-->destoryed" );  
           }  

    }  


是不是很簡單?對,就是這么簡單。你可以照這個樣子,再寫一個獨立應用。接下來,你還需要在applications.xml中進行配置,很簡單,就是在apps標簽中增加如下代碼:
    <app>  
           <name> TestApplication1</name >  
           <file> com.ijavaboy.app.TestApplication1</file >  
    </app>  

接 下來,進入到本文的核心部分了,接下來我們的任務,就全部集中在熱部署上了,其實,也許現在你還覺得熱部署很神秘,但是,我相信一分鐘之后,你就不會這么 想了。要實現熱部署,我們之前說過,需要一個監聽器,來監聽發布目錄applications,這樣當某個應用程序的jar文件改變時,我們可以進行熱部 署處理。其實,要實現目錄文件改變的監聽,有很多種方法,這個例子中我使用的是apache的一個開源虛擬文件系統——common-vfs。如果你對其 感興趣,你可以訪問http://commons.apache.org/proper/commons-vfs/。這里,我們繼承其FileListener接口,實現fileChanged 即可:
public void fileChanged (FileChangeEvent event) throws Exception {  

      String ext = event.getFile().getName().getExtension();  
       if(!"jar" .equalsIgnoreCase(ext)){  
              return;  
      }  

      String name = event.getFile().getName().getParent().getBaseName();  

      ApplicationManager. getInstance().reloadApplication(name);      


當某個文件改變的時候,該方法會被回調。所以,我們在這個方法中調用了ApplicationManager的reloadApplication方法,重現加載該應用程序。
    public void reloadApplication (String name){  
          IApplication oldApp = this.apps .remove(name);  

           if(oldApp == null){  
                  return;  
          }  

          oldApp.destory();     //call the destroy method in the user's application  

          AppConfig config = this.configManager .getConfig(name);  
           if(config == null){  
                  return;  
          }  

          createApplication(getBasePath(), config);  


重現加載應用程序時,我們首先從內存中刪除該應用程序,然后調用原來應用程序的destory方法,最后按照配置重新創建該應用程序實例。
到這里,你還覺得熱部署很玄妙很高深嗎?一切就是如此簡單。好了,言歸正傳,為了讓我們自定義的監聽接口可以有效工作起來,我們還需要指定它要監聽的目錄:
     public void initMonitorForChange(String basePath){  
            try {  
                   this.fileManager = VFS.getManager();  

                  File file = new File(basePath + GlobalSetting.JAR_FOLDER);  
                  FileObject monitoredDir = this.fileManager .resolveFile(file.getAbsolutePath());  
                  FileListener fileMonitorListener = new JarFileChangeListener();  
                   this.fileMonitor = new DefaultFileMonitor(fileMonitorListener);  
                   this.fileMonitor .setRecursive(true);  
                   this.fileMonitor .addFile(monitoredDir);  
                   this.fileMonitor .start();  
                  System. out.println("Now to listen " + monitoredDir.getName().getPath());  

           } catch (FileSystemException e) {  
                  e.printStackTrace();  
           }  
    }  



這里,就是初始化監聽器的地方,我們使用VFS的DefaultFileMonitor完成監聽。而監聽的目錄,就是應用發布目錄applications。接下來,為了讓整個應用程序可以持續的運行而不會結束,我們修改下啟動方法:
public static void main(String[] args){  

       Thread t = new Thread(new Runnable() {  

               @Override  
               public void run() {  
                    ApplicationManager manager = ApplicationManager.getInstance();  
                    manager.init();  
              }  
       });  

       t.start();  

        while(true ){  
               try {  
                    Thread. sleep(300);  
              } catch (InterruptedException e) {  
                    e.printStackTrace();  
              }  
       }  
}  


好了,到這里,一切都要結束了。現在,你已經很明白熱部署是怎么一回事了,對嗎?不明白?OK,還有最后一招,去看看源碼吧!

源碼我已經放到了GitHub上面了,地址:https://github.com/chenjie19891104/ijavaboy/tree/master/AppLoader,歡迎下載使用,你擁有一切的權利對其進行修改。

來自:http://blog.csdn.net/chenjie19891104/article/details/42807959
 本文由用戶 jopen 自行上傳分享,僅供網友學習交流。所有權歸原作者,若您的權利被侵害,請聯系管理員。
 轉載本站原創文章,請注明出處,并保留原始鏈接、圖片水印。
 本站是一個以用戶分享為主的開源技術平臺,歡迎各類分享!