1. 程式人生 > >java 實現簡單的自動裝配

java 實現簡單的自動裝配

在學習Spring的時候,對於自動裝配一直有一點疑惑,通過查閱了各種資料寫了如下的自動裝配的實現

一下采用兩種方式實現自動裝配

1.採用繼承的方式實現自動裝配

2.採用包掃描+註解的方式實現自動裝配

下面我們分別通過程式碼來實現簡單的自動裝配,由於Spring中實現了IOC,因而其能夠獲取到相應型別的物件來自動裝配但是此示例並沒有實現該IOC,因而採用基本型別加引數值的形式來實現簡單的自動裝配,但是原理都是差不多的。

首先採用繼承的方式實現自動裝配

原理:自動裝配的原理在於,生成物件的時候,物件標記過得屬效能夠被自動的初始化,也就是必須要有一種機制能夠在物件生成的時候自動觸發自動裝配的過程。我們知道Java在生成物件的時候,會首先呼叫父類的構造方法,也就是說會觸發父類的構造方法,因而我們可以通過這個特性來實現基於繼承的自動裝配。

首先:定義一個需要自動裝配的註解:

/**
 * Created by fangiming on 2017/10/14.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface MyAutowired {
    String paramValue() default "hello world";
}
接下來在定義一個註解的基類(如果某一個類需要自動裝配就必須繼承自該基類)
package annotation;

import java.lang.reflect.Field;

/**
 * Created by fangiming on 2017/10/14.
 */
public class BaseInject {
    
    public BaseInject(){
        inject(this);
    }
    
    private void inject(BaseInject auto){
        Field[] fields=auto.getClass().getDeclaredFields();
        for(Field field : fields ){
            MyAutowired myAutowired=null;
            if((myAutowired=field.getAnnotation(MyAutowired.class))!=null){
                field.setAccessible(true);
                try{
                    field.set(this,myAutowired.paramValue() );
                }catch(Exception e){
                    System.out.println("錯誤");
                }
            }
        }
    }
}

最後在寫一個測試類
public class InheritAutowired extends BaseInject{

    @MyAutowired
    private String paramString;

    @Test
    public void myAutowiredTest(){
        InheritAutowired inheritAutowired=new InheritAutowired();
        assertEquals("hello world",inheritAutowired.paramString);
    }
}
測試通過:以上就是簡單的通過繼承的方式實現自動裝配了。

接下來,我們通過註解的形式實現自動裝配

在通過註解的形式實現自動裝配之前,我們首先需要一個工具類來實現掃描包獲取包下面的的類的工具類,如下:

一下類是參考的如下博文:http://blog.csdn.net/sun5769675/article/details/51789375

package annotation;

import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
import java.net.JarURLConnection;
import java.net.URL;
import java.net.URLDecoder;
import java.util.Enumeration;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;

/**
 * Created by fangiming on 2017/10/14.
 */
public class ClassTools{

    /**
     * 從包package中獲取所有的Class
     *
     * @param pack
     * @return
     */
    public static Set<Class<?>> getClasses(String pack){

        // 第一個class類的集合
        Set<Class<?>> classes = new LinkedHashSet<Class<?>>();  //宣告一個class的集合
        // 是否迴圈迭代
        boolean recursive = true;                               //是否迭代迴圈的標記
        // 獲取包的名字 並進行替換
        String packageName = pack;                              //包名
        String packageDirName = packageName.replace('.', '/');  //將包名中的 / 替換成 .
        // 定義一個列舉的集合 並進行迴圈來處理這個目錄下的things
        Enumeration<URL> dirs;                                  //定義一個列舉型別的集合  類URL 代表一個統一資源定位符,它是指向網際網路“資源”的指標
        try{
            dirs = Thread.currentThread().getContextClassLoader().getResources(packageDirName);     //得到指定類載入器下面的資源
            // 迴圈迭代下去
            while (dirs.hasMoreElements()){
                // 獲取下一個元素
                URL url = dirs.nextElement();
                // 得到協議的名稱
                String protocol = url.getProtocol();
                // 如果是以檔案的形式儲存在伺服器上
                if ("file".equals(protocol)) {
                    System.err.println("file型別的掃描");
                    // 獲取包的物理路徑
                    String filePath = URLDecoder.decode(url.getFile(), "UTF-8");
                    // 以檔案的方式掃描整個包下的檔案 並新增到集合中
                    findAndAddClassesInPackageByFile(packageName, filePath, recursive, classes);
                }else if ("jar".equals(protocol)) {         //如果是jar包檔案
                    // 如果是jar包檔案
                    // 定義一個JarFile
                    System.err.println("jar型別的掃描");     //列印掃描的是jar包檔案
                    JarFile jar;                            //jar包的描述物件
                    try{
                        // 獲取jar
                        jar = ((JarURLConnection) url.openConnection()).getJarFile();       //獲取到jar檔案
                        // 從此jar包 得到一個列舉類
                        Enumeration<JarEntry> entries = jar.entries();                      //得到jar的列舉型別
                        // 同樣的進行迴圈迭代
                        while (entries.hasMoreElements()){
                            // 獲取jar裡的一個實體 可以是目錄 和一些jar包裡的其他檔案 如META-INF等檔案
                            JarEntry entry = entries.nextElement();
                            String name = entry.getName();
                            // 如果是以/開頭的
                            if (name.charAt(0) == '/') {
                                // 獲取後面的字串
                                name = name.substring(1);
                            }
                            // 如果前半部分和定義的包名相同
                            if (name.startsWith(packageDirName)) {
                                int idx = name.lastIndexOf('/');
                                // 如果以"/"結尾 是一個包
                                if (idx != -1) {
                                    // 獲取包名 把"/"替換成"."
                                    packageName = name.substring(0, idx).replace('/', '.');
                                }
                                // 如果可以迭代下去 並且是一個包
                                if ((idx != -1) || recursive) {
                                    // 如果是一個.class檔案 而且不是目錄
                                    if (name.endsWith(".class") && !entry.isDirectory()) {
                                        // 去掉後面的".class" 獲取真正的類名
                                        String className = name.substring(packageName.length() + 1, name.length() - 6);
                                        try{
                                            // 新增到classes
                                            classes.add(Class.forName(packageName + '.' + className));
                                        }catch (ClassNotFoundException e){
                                            // log
                                            // .error("新增使用者自定義檢視類錯誤 找不到此類的.class檔案");
                                            e.printStackTrace();
                                        }
                                    }
                                }
                            }
                        }
                    }catch (IOException e){
                        // log.error("在掃描使用者定義檢視時從jar包獲取檔案出錯");
                        e.printStackTrace();
                    }
                }
            }
        }catch (IOException e){
            e.printStackTrace();
        }

        return classes;
    }

    /**
     * 以檔案的形式來獲取包下的所有Class
     *
     * @param packageName
     * @param packagePath
     * @param recursive
     * @param classes
     */
    public static void findAndAddClassesInPackageByFile(String packageName, String packagePath, final boolean recursive, Set<Class<?>> classes){
        // 獲取此包的目錄 建立一個File
        File dir = new File(packagePath);
        // 如果不存在或者 也不是目錄就直接返回
        if (!dir.exists() || !dir.isDirectory()) {
            // log.warn("使用者定義包名 " + packageName + " 下沒有任何檔案");
            return;
        }
        // 如果存在 就獲取包下的所有檔案 包括目錄
        File[] dirfiles = dir.listFiles(new FileFilter(){

            // 自定義過濾規則 如果可以迴圈(包含子目錄) 或則是以.class結尾的檔案(編譯好的java類檔案)
            public boolean accept(File file){
                return (recursive && file.isDirectory()) || (file.getName().endsWith(".class"));
            }
        });
        // 迴圈所有檔案
        for (File file : dirfiles){
            // 如果是目錄 則繼續掃描
            if (file.isDirectory()) {
                findAndAddClassesInPackageByFile(packageName + "." + file.getName(), file.getAbsolutePath(), recursive, classes);
            }else{
                // 如果是java類檔案 去掉後面的.class 只留下類名
                String className = file.getName().substring(0, file.getName().length() - 6);
                try{
                    // 新增到集合中去
                    // classes.add(Class.forName(packageName + '.' +
                    // className));
                    // 經過回覆同學的提醒,這裡用forName有一些不好,會觸發static方法,沒有使用classLoader的load乾淨
                    classes.add(Thread.currentThread().getContextClassLoader().loadClass(packageName + '.' + className));
                }catch (ClassNotFoundException e){
                    // log.error("新增使用者自定義檢視類錯誤 找不到此類的.class檔案");
                    e.printStackTrace();
                }
            }
        }
    }
}

接下來我們需要給獲取到的類做一些標記:也就是哪些類需要自動裝配,哪些類不需要自動裝配,這裡採用註解的方式來標記,定義如下:
package annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Created by fangiming on 2017/10/14.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface MyComponent {
}
接下來我們再來定義一個需要被自動裝配的類如下:
package annotation;

/**
 * Created by fangiming on 2017/10/14.
 */
@MyComponent
public class AnnotationAutowired {

    @MyAutowired
    private String paramString;

}

現在模仿Spring的包掃描,自動裝配該物件並放入到一個Map中
package annotation;

import org.junit.Test;

import java.lang.reflect.Field;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;

import static org.junit.Assert.assertEquals;

/**
 * Created by fangiming on 2017/10/14.
 */
public class AnnotationAutowiredTest {

    @Test
    public void AnnAutowiredTest()throws Exception{
        Map<String,Object> map=new HashMap<String,Object>();
        Set<Class<?>> set=ClassTools.getClasses("annotation");
        for(Class<?> klass : set){
            MyComponent ann=null;
            if((ann=klass.getAnnotation(MyComponent.class))!=null){
                Object o=klass.newInstance();
                Field[] fields=klass.getDeclaredFields();
                for(Field field : fields){
                    MyAutowired param=null;
                    if((param=field.getAnnotation(MyAutowired.class))!=null){
                        field.setAccessible(true);
                        field.set(o,param.paramValue());
                    }
                }
                map.put(o.getClass().getName(),o);
            }
        }
        assertEquals("hello world",((AnnotationAutowired)map.get(AnnotationAutowired.class.getName())).paramString);
    }
}
以上測試通過。