使用Spring框架的人一定都聽過Spring的IoC(控制反轉(zhuǎn)) 、DI(依賴注入)這兩個概念,對于初學(xué)Spring的人來說,總覺得IoC 、DI這兩個概念是模糊不清的;對于耳熟能詳?shù)?a href="/tags/spring" target="_blank">spring容器又感到模糊抽象,理解不深。本文筆者就用數(shù)百行代碼模擬一個簡易的spring容器和spring mvc框架,揭秘spring底層運作的核心邏輯。
spring web項目啟動的時候,會在實現(xiàn)tomcat的listener、filter、servlet的類中完成spring容器相關(guān)的初始化工作。
于是我們也一樣,先創(chuàng)建一個web項目。項目目錄結(jié)構(gòu)如圖1所示:
圖1 項目目錄結(jié)構(gòu)圖
開發(fā)spring web項目時,我們需要在web.xml中寫一堆配置,為了與spring web項目一直,我們維持一樣的寫法,下面是項目的web.xml源碼。
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
myspringmvc
com.nanshan.myspringmvc.MyDispatcherServlet
contextConfigLocation
application.properties
1
myspringmvc
/*
??
只要做過spring web項目開發(fā)的伙伴,相信對web.xml各部分再熟悉不過了。為了開發(fā)簡單,在application.properties配置文件中定義了一個配置項:scanPackages=com.nanshan.myspringmvc,表示項目從這個目錄掃描bean,然后注入到容器中。接下來,我們就要開始寫代碼了。首先我們定義幾個spring最常用的注解。
- @MyService對應(yīng)spring的@Service;
- @MyAutowired對應(yīng)spring的@Autowired;
- @MyController對應(yīng)spring的@Controller;
- @MyRequestMapping對應(yīng)spring的@RequestMapping;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface MyService {
String value()default "";
}
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface MyAutowired {
String value()default "";
}
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface MyController {
String value() default "";
}
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface MyRequestMapping {
String value() default "";
}
下面就是最核心的,spring項目的啟動初始化了,我們這里主要是在servlet啟動的時候初始化的。定義一個MyDispatcherServlet繼承自HttpServlet,模擬spring中的DispatcherServlet,接著在MyDispatcherServlet的init方法中初始化所有的工作。
init初始化方法中,主要做了這幾件事:
- 加載配置文件;
- 掃描包下的類;
- 初始化IOC容器,把相關(guān)的類注入相關(guān)的實例;
- 自動注入bean;
- 初始化spring mvc的handingmapping;
@Override
public void init(ServletConfig config) throws ServletException {
super.init(config);
// 1 加載配置文件
loadConfig(config.getInitParameter("contextConfigLocation"));
// 2 掃描相關(guān)的類
scanPackages((String)contextConfig.getProperty("scanPackages"));
// 3 初始化IOC容器,把相關(guān)的類注入相關(guān)的實例
createInstances();
// 4 自動注入
autowiredInstance();
// 5 初始化handingMapping()
initHandleMapping();
System.out.println("myspringmvc init");
第一步加載配置,主要是讀取application.properties中的配置,contextConfig是一個Properties對象。private void loadConfig(String contextConfigLocation) {
????InputStream?is?=?this.getClass().getClassLoader().getResourceAsStream(contextConfigLocation);
try {
????????contextConfig.load(is);
????}?catch?(Exception?e)?{
????????e.printStackTrace();
????}?finally?{
????????try?{
???????????if?(is?!=?null)?{
????????????????is.close();
????????????}
????????}?catch?(IOException?e)?{
????????????e.printStackTrace();
???????}
????}
}
第二步,掃描scanPackages配置路徑下的類,找到添加了@MyService,@MyController注解的類。private void scanPackages(String scanPackages) {
URL url = this.getClass().getClassLoader().getResource("/" scanPackages.replaceAll("\\.", "/"));
File classPath = new File(url.getFile());
for (File file : classPath.listFiles()) {
if (file.isDirectory()) {
scanPackages(scanPackages "." file.getName());
} else {
if (!file.getName().endsWith(".class")) {
continue;
}
String className = scanPackages "." file.getName().replaceAll(".class", "");
classNames.add(className);
}
}
}
第三步,初始化IOC容器,把相關(guān)的類注入相關(guān)的實例,也就是把第二步掃描出來的類實例化,放到容器中。其實所謂的容器就是一個map,key為bean名字value為實例的map。
private void createInstances() {
if (classNames.isEmpty()) {
return;
}
try {
for (String className : classNames) {
Class> clazz = Class.forName(className);
if (clazz.isAnnotationPresent(MyController.class)) {
String beanName = toLowerFirstCase(clazz.getSimpleName());
Object instance = clazz.newInstance();
ioc.put(beanName, instance);
} else if (clazz.isAnnotationPresent(MyService.class)) {
String beanName = toLowerFirstCase(clazz.getSimpleName());
MyService service = clazz.getAnnotation(MyService.class);
if (!"".equals(service.value().trim())) {
beanName = service.value();
}
Object instance = clazz.newInstance();
????????????????ioc.put(beanName,?instance);
} else {
continue;
}
}
} catch (Exception e) {
e.printStackTrace();
}
}
第四步,把實例化完的實例,注入到bean中。其實也很簡單,就是根據(jù)bean的名字,到IOC容器(map)中找到對應(yīng)的實例,set到bean中就可以了。private void autowiredInstance() {
if (ioc.isEmpty()) {
return;
}
for (Map.Entry entry : ioc.entrySet()) {
Field[] fields = entry.getValue().getClass().getDeclaredFields();
for (Field field : fields) {
if (!field.isAnnotationPresent(MyAutowired.class)) {
continue;
}
MyAutowired autowired = field.getAnnotation(MyAutowired.class);
String beanNmae = autowired.value();
if ("".equals(beanNmae)) {
beanNmae = field.getName();
}
field.setAccessible(true);
try {
field.set(entry.getValue(), ioc.get(beanNmae));
} catch (Exception e) {
e.printStackTrace();
}
}
}
}
第五步,完成spring mvc容器相關(guān)的工作。我們這里主要是給@MyController注解的類中的@MyRequestMapping找到對應(yīng)的url對應(yīng)的處理method。private void initHandleMapping() {
if (ioc.isEmpty()) {
return;
}
for (Map.Entry entry : ioc.entrySet()) {
Class> clazz = entry.getValue().getClass();
if (!clazz.isAnnotationPresent(MyController.class)) {
continue;
}
String bastUrl = "";
if (clazz.isAnnotationPresent(MyRequestMapping.class)) {
MyRequestMapping requestMapping = clazz.getAnnotation(MyRequestMapping.class);
bastUrl = requestMapping.value();
}
Method[] methods = clazz.getMethods();
for (Method method : methods) {
if (!method.isAnnotationPresent(MyRequestMapping.class)) {
continue;
}
MyRequestMapping myRequestMapping = method.getAnnotation(MyRequestMapping.class);
String url = ("/" bastUrl "/" myRequestMapping.value()).replaceAll("/ ", "/");
handingMapping.put(url, method);
System.out.println("mapped: " url ", " method);
}
}
}
完成了IOC和spring mvc的初始化工作后,spring最核心的工作就做完了。接下來,我們就可以寫一個service和controller測試下。@MyRequestMapping("/test")
@MyController
public class QueryController {
@MyAutowired
private Car car;
@MyRequestMapping("/query")
public void query(HttpServletRequest request, HttpServletResponse respones, String name) {
car.print();
}
}
@MyService
public class Car {
public void print() {
System.out.println("this is a car");
}
}
最后,在tomcat中啟動程序,請求controller中的地址,測試下程序是否正常運行。啟動tomcat的過程中,有如下打印日志,說明完成了初始化。
我們在瀏覽器中請求:http://localhost:8080/myspringmvc_war/test/query?name=1234
看到有如下輸出,說明我們的建議spring IOC容器和spring mvc框架生效了。
總結(jié):
本文只是用一個簡單的demo講解spring IOC和spring mvc的核心原理,能讓它跑起來,許多細節(jié)沒有處理,不過也不是本文重點。spring框架遠比這個demo復(fù)雜很多很多,想要更深入的了解spring框架的更多細節(jié),還需要精讀它的源碼。