關於spring 掃描不到jar中class文件的原因分析及解決

Posted on by

spring 掃描不到jar中class文件的原因及解決

背景

公司一web項目使用的是spring mvc開發的，老員工們寫瞭一個緩存service，即EhcacheService , 該緩存service在web中使用瞭spring 的@Scheduled 啟動加載緩存，代碼如下：

applicationContext.xml

<context:component-scan base-package="cn.com.service" />

EhcacheService .java

// 啟動加載緩存, 以上一次執行完為準
@Scheduled(fixedDelay = 365 * 24 * 60 * 60 * 1000)   
public void initEhcache() {
    logger.debug("++++++++++++++++++++緩存加載開始++++++++++++++++++++");
    long start = System.currentTimeMillis();
    try {
        this.ehcacheService.loadCache();
    } catch (Exception e) {
        logger.error(e.getMessage(), e);
    }
    long end = System.currentTimeMillis();
    logger.debug("++++++++++++++++++++緩存加載結束,耗時：" + (end - start) + "++++++++++++++++++++");
}

然而最近同步數據，需要用到EhcacheService , 本人也懶得重寫裡面的方法，便想著使用ClassPathXmlApplicationContext 或者FileSystemXmlApplicationContext 或者GenericXmlApplicationContext來加載spring配置，然後打包成jar包，丟到linux上，使用java -jar my.jar。代碼如下：

test.java

// 程序入口
public static void main(String[] args) throws Exception {
    // 加載spring配置
    GenericXmlApplicationContext context = new GenericXmlApplicationContext();
    context.setValidating(false);
    context.load("classpath*:spring-*.xml");
    context.refresh();
    // ApplicationContext ctx = new FileSystemXmlApplicationContext("spring-*.xml");
    // ApplicationContext context = new ClassPathXmlApplicationContext("spring-*.xml");
    System.out.println("bean的數據量" + context.getBeanDefinitionNames().length);
    EhcacheService ehcacheService = (EhcacheService) context.getBean("ehcacheService");
}

我們先看一下在Eclipse中運行情況

這裡寫圖片描述

我們再看看打包成Runable jar File後，使用 java -jar my.jar的運行情況

這裡寫圖片描述

根據圖片中的錯誤，我們可以看到，spring-*.xml是成功被加載瞭，然而找不到bean, 很明顯，它存在一種可能，那就是bean的class文件沒有被spring掃描到。

那麼為什麼會出現這種情況呢？經過我多方面的查證，spring 掃描bean文件是通過Thread.currentThread().getContextClassLoader().getResource(packageName)加載的。那麼我們分析一下ContextClassLoader資源加載機制。

舉例說明：我們有這樣的一個: cn.com.Test, 類加載器首先會把這個包名轉化成文件夾的形式 cn/com, 然後到這個文件夾裡去加載Test.class。

然後，當你打包成Runable jar File時，jar的包和文件系統中的包便不是一個概念瞭，它不能將cn.com轉換成cn/com文件夾方式去解讀， 類加載轉換成cn/com去加載類的時候，便會報出classNotFoundException異常

下面我們使用如下代碼驗證一下這個過程：

// 項目中jar包所在物理路徑  
String jarName = "C:\\Users\\Administrator\\Desktop\\my.jar";  
// 項目中war包所在物理路徑
//String jarName = "C:\\Users\\Administrator\\Desktop\\my.war";  
 JarFile jarFile = new JarFile(jarName);  
 Enumeration<JarEntry> entrys = jarFile.entries();  
 while (entrys.hasMoreElements()) {  
     JarEntry jarEntry = entrys.nextElement();  
     System.out.println(jarEntry.getName());  
 }

打印結果如下：

META-INF/MANIFEST.MF cn/com/server/action/JobAction.class cn/com/server/annotation/DataDigestAnnotation.class cn/com/server/dao/EhcacheDao.class

然後我們打包成war包再看看他的war包物理路徑，我們可以看到打印結果如下：

META-INF/MANIFEST.MF META-INF/ WEB-INF/classes/ WEB-INF/classes/cn/ WEB-INF/classes/cn/com/ WEB-INF/classes/cn/com/ WEB-INF/classes/cn/com/server/ WEB-INF/classes/cn/com/server/action/ WEB-INF/classes/cn/com/server/action/JobAction.class WEB-INF/classes/cn/com/server/addrsrv/ WEB-INF/classes/cn/com/server/addrsrv/GeoAddrSrv.class …..

我們可以看到war類的文件目錄和jar的文件目錄明顯不同，這樣就能解釋上面我所描述的問題。

Q: 那麼我們怎麼解決spring 掃描不到jar中class這個問題呢？

A: 有一種做法，就是打jar包的時候，打成JAR file, 然後選擇 add directory entries， 如圖：

這裡寫圖片描述

然後這種打包方式，雖然能解決spring 掃描不到jar中class文件問題，但是打並不是我們想要的，我們想要的是一個可以執行jar，也就是Runable JAR FILE。

Q: 那麼我們怎麼打包成Runable JAR FILE，並且解決spring 掃描不到jar中class的問題？

A:

1、首先使用Eclipse打包，打包成JAR file。

2、上傳到Linux， 解壓my.jar

unzip my.jar -d myapp

3、進入 myapp文件夾， 使用以下命令：

java -Djava.ext.dirs=WebContent/WEB-INF/lib cn.com.test

大功告成

其他技巧：除瞭上訴使用代碼方式查看jar包物理路徑，我們還可以是 jar tr my.jar來查看。如圖：

這裡寫圖片描述

@ComponentScan註解進行掃描的幾種方式

方式一：掃描包

返回是String的數組，所以可是多個包路徑!也可是一個包路徑！完整寫法是

  • 單個：@ComponentScan(basePackages = “xxx”)
  • 多個：@ComponentScan(basePackages = {“xxx”，“aaa”，“…”})

註意：可以省略“basePackages =”

方式二：掃描類

同樣返回是String的數組，所以可以是有多個類名! 也可是一個類名！

  • 單個：@ComponentScan(basePackageClasses = “”)
  • 多個：@ComponentScan(basePackageClasses = {“xxx”，“aaa”，“…”})

註意：不可以省略“basePackageClasses =”

測試：

方式三：掃描包（通配式：開發常用）

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：