Spring實現(xiàn)一個簡單的SpringIOC容器

更新時間：2017年04月14日 10:55:45 作者：醉眼識朦朧

本篇文章主要介紹了Spring實現(xiàn)一個簡單的SpringIOC容器，具有一定的參考價值，感興趣的小伙伴們可以參考一下。

接觸Spring快半年了,前段時間剛用Spring4+S2H4做完了自己的畢設(shè),但是很明顯感覺對Spring尤其是IOC容器的實現(xiàn)原理理解的不到位,說白了,就是僅僅停留在會用的階段,有一顆想讀源碼的心于是買了一本計文柯的《Spring技術(shù)內(nèi)幕》,第二章沒看完,就被我扔一邊了,看的那是相當(dāng)痛苦,深深覺得自己資質(zhì)尚淺,能力還不夠,昨天在網(wǎng)上碰巧看到一個實現(xiàn)簡單的SpringIOC容器的視頻教程,于是跟著做了一遍,竟然相當(dāng)順利,至少每一行代碼都能理解,于是細(xì)心整理了一番,放在這里.

主要思想:

提到IOC,第一反應(yīng)就是控制反轉(zhuǎn),我以前以為SpringIOC就是控制反轉(zhuǎn),控制反轉(zhuǎn)就是SpringIOC,當(dāng)然這種理解是錯誤的,控制反轉(zhuǎn)是一種思想,一種模式,而Spring的IOC容器是實現(xiàn)了這種思想這種模式的一個載體.

使用過Spring的人都熟知,SpringIOC容器可以在對象生成或初始化時就直接將數(shù)據(jù)注入到對象中,如果對象A的屬性是另一個對象B,還可以將這個對象B的引用注入到注入到A的數(shù)據(jù)域中.

如果在初始化對象A的時候,對象B還沒有進(jìn)行初始化,而A又需要對象B作為自己的屬性,那么就會用一種遞歸的方式進(jìn)行注入,這樣就可以把對象的依賴關(guān)系清晰有序的建立起來.

IOC容器解決問題的核心就是把創(chuàng)建和管理對象的控制權(quán)從具體的業(yè)務(wù)對象手中搶過來.由IOC容器來管理對象之間的依賴關(guān)系,并由IOC容器完成對象的注入.這樣就把應(yīng)用從復(fù)雜的對象依賴關(guān)系的管理中解放出來,簡化了程序的開發(fā)過程.

下圖是這個簡單IOC容器的類圖(原諒我真沒學(xué)過UML,湊合看吧):

程序中所有的Bean之間的依賴關(guān)系我們是放在一個xml文件中進(jìn)行維護(hù)的,就是applicationContext.xml　　

ConfigManager類完成的功能是讀取xml,并將所有讀取到有用的信息封裝到我們創(chuàng)建的一個Map<String,Bean>集合中,用來在初始化容器時創(chuàng)建bean對象.

定義一個BeanFactory的接口,接口中有一個getBean(String name)方法,用來返回你想要創(chuàng)建的那個對象.

然后定義一個該接口的實現(xiàn)類ClassPathXmlApplicationContext.就是在這個類的構(gòu)造方法中,初始化容器,通過調(diào)用ConfigManager的方法返回的Map集合,通過反射和內(nèi)省一一創(chuàng)建bean對象.這里需要注意,對象的創(chuàng)建有兩個時間點(diǎn),這取決與bean標(biāo)簽中scope屬性的值: 　

如果scope="singleton",那么對象在容器初始化時就已創(chuàng)建好,用的時候只需要去容器中取即可.
如果scope="prototype",那么容器中不保存這個bean的實例對象,每次開發(fā)者需要使用這個對象時再進(jìn)行創(chuàng)建.

使用的主要知識點(diǎn):

dom4j解析xml文件
xpath表達(dá)式(用于解析xml中的標(biāo)簽)
java反射機(jī)制
內(nèi)省(獲取Bean屬性的set方法進(jìn)行賦值)

項目結(jié)構(gòu)圖及介紹如下:

項目需要的jar包與項目結(jié)構(gòu)已經(jīng)在上圖中介紹了,這個項目所能實現(xiàn)的功能如下:

1.　IOC容器能管理對象的創(chuàng)建以及對象之間的依賴關(guān)系.

2.　能夠?qū)崿F(xiàn)數(shù)據(jù)的自動類型轉(zhuǎn)換(借助BeanUtils).

3.　能夠?qū)崿F(xiàn)scope="singleton"和scope="prototype"的功能,即能夠控制對象是否為單例.　　

下面介紹代碼部分:

application.xml:

<?xml version="1.0" encoding="utf-8"?>
<beans>
  <bean name="student" class="com.wang.entity.Student" >
    <property name="name" value="123"></property>
  </bean>
  
  <bean name="teacher" class="com.wang.entity.Teacher">
    <property name="student" ref="student"></property>
  </bean>
  <bean name="person" class="com.wang.entity.Person" scope="prototype">
    <property name="teacher" ref="teacher"></property>
    <property name="student" ref="student"></property>
  </bean>
  
</beans>

實體類Student,Teacher,Person:

package com.wang.entity;
//Student類
public class Student {
  private String name;

  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }
}
/************************************/
package com.wang.entity;
//Teacher類
public class Teacher {

  private Student student;

  public Student getStudent() {
    return student;
  }

  public void setStudent(Student student) {
    this.student = student;
  }
   
}
/************************************/
package com.wang.entity;
//Person類
public class Person {

  private Student student;
  private Teacher teacher;
  
  public Student getStudent() {
    return student;
  }
  public void setStudent(Student student) {
    this.student = student;
  }
  public Teacher getTeacher() {
    return teacher;
  }
  public void setTeacher(Teacher teacher) {
    this.teacher = teacher;
  }
}

用于封裝Bean標(biāo)簽信息的Bean類:

package com.wang.config;

import java.util.ArrayList;
import java.util.List;

public class Bean {

  
  private String name;
  private String className;
  private String scope="singleton";
  private List<Property> properties=new ArrayList<Property>();

  
  public String getScope() {
    return scope;
  }

  public void setScope(String scope) {
    this.scope = scope;
  }

  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  public String getClassName() {
    return className;
  }

  public void setClassName(String className) {
    this.className = className;
  }

  public List<Property> getProperties() {
    return properties;
  }

  public void setProperties(List<Property> properties) {
    this.properties = properties;
  }

  
}

用與封裝Bean子標(biāo)簽property內(nèi)容的Property類:

package com.wang.config;

public class Property {

  private String name;
  private String value;
  private String ref;
  public String getName() {
    return name;
  }
  public void setName(String name) {
    this.name = name;
  }
  public String getValue() {
    return value;
  }
  public void setValue(String value) {
    this.value = value;
  }
  public String getRef() {
    return ref;
  }
  public void setRef(String ref) {
    this.ref = ref;
  }

  
}

ConfigManager類:

package com.wang.config.parse;

import java.io.InputStream;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;
import org.junit.Test;

import com.wang.config.Bean;
import com.wang.config.Property;

public class ConfigManager {
  
  private static Map<String,Bean> map=new HashMap<String,Bean>(); 

  //讀取配置文件并返回讀取結(jié)果
  //返回Map集合便于注入,key是每個Bean的name屬性,value是對應(yīng)的那個Bean對象
  public static Map<String, Bean> getConfig(String path){
    /*dom4j實現(xiàn)
     * 1.創(chuàng)建解析器
     * 2.加載配置文件,得到document對象
     * 3.定義xpath表達(dá)式,取出所有Bean元素
     * 4.對Bean元素繼續(xù)遍歷
     *   4.1將Bean元素的name/class屬性封裝到bean類屬性中
     *   4.2獲得bean下的所有property子元素
     *   4.3將屬性name/value/ref分裝到類Property類中
     * 5.將property對象封裝到bean對象中
     * 6.將bean對象封裝到Map集合中,返回map 
      */
    //1.創(chuàng)建解析器
    SAXReader reader=new SAXReader();
    //2.加載配置文件,得到document對象
    InputStream is = ConfigManager.class.getResourceAsStream(path);
    Document doc =null;
    try {
       doc = reader.read(is);
    } catch (DocumentException e) {
      e.printStackTrace();
      throw new RuntimeException("請檢查您的xml配置是否正確");
    }
    // 3.定義xpath表達(dá)式,取出所有Bean元素
    String xpath="http://bean";
    
    //4.對Bean元素繼續(xù)遍歷
    List<Element> list = doc.selectNodes(xpath);
    if(list!=null){
      //4.1將Bean元素的name/class屬性封裝到bean類屬性中
    
       // 4.3將屬性name/value/ref分裝到類Property類中
      for (Element bean : list) {
        Bean b=new Bean();
        String name=bean.attributeValue("name");
        String clazz=bean.attributeValue("class");
        String scope=bean.attributeValue("scope");
        b.setName(name);
        b.setClassName(clazz);
        if(scope!=null){
          b.setScope(scope);
        }
         // 4.2獲得bean下的所有property子元素
        List<Element> children = bean.elements("property");
        
         // 4.3將屬性name/value/ref分裝到類Property類中
        if(children!=null){
          for (Element child : children) {
            Property prop=new Property();
            String pName=child.attributeValue("name"); 
            String pValue=child.attributeValue("value");
            String pRef=child.attributeValue("ref");
            prop.setName(pName);
            prop.setRef(pRef);
            prop.setValue(pValue);
            // 5.將property對象封裝到bean對象中
            b.getProperties().add(prop);
          }
        }
        //6.將bean對象封裝到Map集合中,返回map 
        map.put(name, b);
      }
    }
    
    return map;
  }

}

BeanFactory接口:

package com.wang.main;

public interface BeanFactory {
  //核心方法getBean
  Object getBean(String name);
}

ClassPathXmlApplicationContext類:

package com.wang.main;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;

import org.apache.commons.beanutils.BeanUtils;
import org.junit.Test;

import com.wang.config.Bean;
import com.wang.config.Property;
import com.wang.config.parse.ConfigManager;
import com.wang.entity.Student;
//import com.wang.utils.BeanUtils;
import com.wang.utils.BeanUtil;

public class ClassPathXmlApplicationContext implements BeanFactory {

  // 獲得讀取的配置文件中的Map信息
  private Map<String, Bean> map;
  // 作為IOC容器使用,放置sring放置的對象
  private Map<String, Object> context = new HashMap<String, Object>();

  public ClassPathXmlApplicationContext(String path) {
    // 1.讀取配置文件得到需要初始化的Bean信息
    map = ConfigManager.getConfig(path);
    // 2.遍歷配置,初始化Bean
    for (Entry<String, Bean> en : map.entrySet()) {
      String beanName = en.getKey();
      Bean bean = en.getValue();

      Object existBean = context.get(beanName);
      // 當(dāng)容器中為空并且bean的scope屬性為singleton時
      if (existBean == null && bean.getScope().equals("singleton")) {
        // 根據(jù)字符串創(chuàng)建Bean對象
        Object beanObj = createBean(bean);

        // 把創(chuàng)建好的bean對象放置到map中去
        context.put(beanName, beanObj);
      }
    }

  }

  // 通過反射創(chuàng)建對象
  private Object createBean(Bean bean) {
    // 創(chuàng)建該類對象
    Class clazz = null;
    try {
      clazz = Class.forName(bean.getClassName());
    } catch (ClassNotFoundException e) {
      e.printStackTrace();
      throw new RuntimeException("沒有找到該類" + bean.getClassName());
    }
    Object beanObj = null;
    try {
      beanObj = clazz.newInstance();
    } catch (Exception e) {
      e.printStackTrace();
      throw new RuntimeException("沒有提供無參構(gòu)造器");
    }
    // 獲得bean的屬性,將其注入
    if (bean.getProperties() != null) {
      for (Property prop : bean.getProperties()) {
        // 注入分兩種情況
        // 獲得要注入的屬性名稱
        String name = prop.getName();
        String value = prop.getValue();
        String ref = prop.getRef();
        // 使用BeanUtils工具類完成屬性注入,可以自動完成類型轉(zhuǎn)換
        // 如果value不為null,說明有
        if (value != null) {
          Map<String, String[]> parmMap = new HashMap<String, String[]>();
          parmMap.put(name, new String[] { value });
          try {
            BeanUtils.populate(beanObj, parmMap);
          } catch (Exception e) {
            e.printStackTrace();
            throw new RuntimeException("請檢查你的" + name + "屬性");
          }
        }

        if (ref != null) {
          // 根據(jù)屬性名獲得一個注入屬性對應(yīng)的set方法
          // Method setMethod = BeanUtil.getWriteMethod(beanObj,
          // name);

          // 看一看當(dāng)前IOC容器中是否已存在該bean,有的話直接設(shè)置沒有的話使用遞歸,創(chuàng)建該bean對象
          Object existBean = context.get(prop.getRef());
          if (existBean == null) {
            // 遞歸的創(chuàng)建一個bean
            existBean = createBean(map.get(prop.getRef()));
            // 放置到context容器中
            // 只有當(dāng)scope="singleton"時才往容器中放
            if (map.get(prop.getRef()).getScope()
                .equals("singleton")) {
              context.put(prop.getRef(), existBean);
            }
          }
          try {
            // setMethod.invoke(beanObj, existBean);
　　　　　　　　　　　　　　//通過BeanUtils為beanObj設(shè)置屬性
            BeanUtils.setProperty(beanObj, name, existBean);
          } catch (Exception e) {
            e.printStackTrace();
            throw new RuntimeException("您的bean的屬性" + name
                + "沒有對應(yīng)的set方法");
          }

        }

      }
    }

    return beanObj;
  }

  @Override
  public Object getBean(String name) {
    Object bean = context.get(name);
    // 如果為空說明scope不是singleton,那么容器中是沒有的,這里現(xiàn)場創(chuàng)建
    if (bean == null) {
      bean = createBean(map.get(name));
    }

    return bean;
  }

}

最后就是一個測試類TestBean:

 package com.wang.main;

import org.junit.Test;

import com.wang.entity.Person;
import com.wang.entity.Student;
import com.wang.entity.Teacher;


public class TestBean {

  @Test
  public void func1(){
    
    BeanFactory bf=new ClassPathXmlApplicationContext("/applicationContext.xml");
    Person s=(Person)bf.getBean("person");
    Person s1=(Person)bf.getBean("person");
    System.out.println(s==s1);
    System.out.println(s1);
    Student stu1=(Student) bf.getBean("student");
    Student stu2=(Student) bf.getBean("student");
    String name=stu1.getName();
    System.out.println(name);
    System.out.println(stu1==stu2);
  }
}

以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: