關於@MapperScan包掃描的坑及解決

Posted on by

@MapperScan包掃描的坑

在使用通用mapper執行查詢時，由於不太註意順手就導瞭spring的包：

import org.mybatis.spring.annotation.MapperScan;

結果就異常：

tk.mybatis.mapper.provider.base.BaseSelectProvider:xxxx

找瞭半天才發現是包的問題，應該導mybatis的MapperScan而不是spring中的包，正確的包名：

import tk.mybatis.spring.annotation.MapperScan;

手寫一個@MapperScan掃描器

@MapperScan

1.@MapperScan這個註解是由MyBatis提供的；

2.隻能使用在類上；

3.主要功能是掃描到指定包下接口的生成Class對象

註解使用在類上，指定value的值可以指定掃描的包，把掃描到的包中的接口，生成動態代理註入到Spring的ioc容器中；

自己手寫該註解的思路

1.需要使用一個類，把使用這個註解的類加載加載(把Class對象註冊進來)；

2.解析這個類上是否有@MapperScan註解；

3.然後解析@MapperScan註解上的value值得到接口的路徑；

4.根據路徑掃描有哪些接口；

5.根據接口名和classpath路徑，把接口加載進來；

6.把接口的class對象保存在List中；

#7.接下來就是Mybatis框架生成動態代理；

註解：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface BeanScan {
    String value();
}
//生成MapperScan這個類的處理邏輯
public class MapperScan {
    //通過解析BeanScan來得到文件目錄
    Class<BeanScan> beanScanClass;
    /**
     *Class這個參數是使用@MapperScan這個類的class對象
    */
    public ArrayList<Class>  scan(Class aClass) throws ClassNotFoundException {
 
        //創建一個ArrayList存放生成的接口的class對象
        ArrayList<Class> mapperName = new ArrayList<>();
        
        //解析傳入的aclass對象得到@MapperSCan這個註解
        //BeanScan這個我們定義的@mapperScan註解
        BeanScan BeanScan = (com.scan.BeanScan) aClass.getDeclaredAnnotation(BeanScan.class);
 
        //通過BeanScan對象的到接口的路徑
        String path = BeanScan.value();
 
        //獲得當前的類加載器（可以用類加載器得到classpath，然後使用File對象操作文件）
        ClassLoader classLoader = aClass.getClassLoader();
        
        //接口的路徑是"."轉換成"\"
        String replacePath = path.replace(".", "\\");
 
        //通過類加載器獲取當前文件的絕對路徑
        URL resource = classLoader.getResource(replacePath);
 
        //通過文件的絕對路徑把文件編程File對象
        String file = resource.getFile();
        File file1 = new File(file);      
      
 
        //判斷File對象是否是目錄
        if(file1.isDirectory()){
            //把File對象下的文件名稱取出來
            File[] files = file1.listFiles();
            for (File f :files) {                
 
                //字符串拼接操作(把字符串拼接成系統類加載器可以加載的格式)
                String name1 = file1.getName();
                String name = f.getName();
                String pathName = name1+"."+name;
                String substring = pathName.substring(0, pathName.indexOf(".class"));
                
                //把接口的全限定名稱傳入生成class對象，放入到list集合中
                Class<?> aClass1 = ClassLoader.loadClass(substring);
                mapperName.add(aClass1);
                System.out.println(aClass1); 
            } 
        }
        return mapperName; 
    }
}

#有瞭這個註解後，我們就不用手動去傳入接口的class對象來生成動態代理

隻需要在指定的文件下在創建Mapper接口，系統會自動的去掃描； 

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

推薦閱讀：