自己实现spring的基本功能
之前自己做过参数校验的功能,有使用过注解. 今天就来试试实现spring的类管理
首先,先理解下spring的思路,spring 将我们需要被管理的类统一的管理起来 然后给需要初始化的类初始化,在遇到web端的请求的时候,根据url来匹配对应的controller的接口方法,进行调用.
那么我们要先明白spring 是在什么时间或者什么操作节点起作用的,在没有spring-boot之前我们搭建web项目的时候是怎么搭建的呢?不知道大家在搭建项目时有没有注意到webapp文件下的WEN-INF文件夹下有一个web.xml文件.如果没有注意的同学请去关注下.spring没有出现之前呢我们搭建web项目跟这个文件打交道的机会还是挺多的.因为我们的servlet都会在这里配置.
然后Spring的做法有一点是一致的,就是我们在使用spring 的时候也需要在web.xml文件配置一个dispatcherServlet. dispatcherServlet继承了HttpServlet .中所周知HttpServlet 有两个比较明星的方法 doGet(),doPost(),由于HttpServlet间接的实现了Servlet接口,所以还用另外两个明星方法init(),destroy().这四个方法起到了关键性作用.
我们先了解下servlet生命周期,
第一阶段:
会调用servlet的init方法,进行一些我们需要为sevlet的一些行为/属性的初始化,官方注释是说:
在servlet完成init后代表可以在service发挥作用了
关于init方法呢,其实servlet中是没有空参的init()方法的,只有一个init(ServletConfig config)方法.那为什么我们的前辈们一般都在init()方法中做初始呢? 原因是GenericServlet这个类是抽象类,他有实现init(ServletConfig config),然后在(ServletConfig config)方法内调用了init()方法.而GenericServlet中的init()是一个空方法(重点:不是抽象方法) . 是不是有点费解? 这个方法的注释是这样的这是一个用来简化在override的时候需要调用super.init(config)的方法.我的理解是,如果我们需要做一些init操作直接覆盖init()就行了,如果不需要也不用做其他操作.主要是省去了调用super.init(congfig);所以我们在使用servlet需要做初始化的时候,直接override init()方法就行了. 优雅~
第二阶段:
我们会监听web发出的请求,通过doGet和doPost还完成.
第三阶段:
在servlet结束是会调用distroy,可以所以写“善后” 的事情,官方的注释说在servlet所提了整个服务时会调用该方法.
了解了servlet后,我们应该就清楚了servlet的工作机制.
回过头来说spring ,spring的四大特点：MVC,IOC,DI,AOP其中:
IOC:控制反转,就是bean的创建交给Spring来管理,那现在我要模仿一个spring也就是说bean 的创建应该由我来管理,所以我应该在程序的一开始就做这部分工作. 从上边的servlet的工作机制我就明白我要在servlet的init()其中一部分就是模仿ioc的bean管理.
DI:ioc我模仿了那肯定也得完成依赖注入的工作,现在有确定了一部分.
MVC:我们知道当spring 接收到请求后会根据url进行匹配对应的controller 的对应接口.所以这个匹配关系也应该放在init()方法中
AOP:我们都是到aop其实就是代理,不论是哪种代理我们都是动态生成一个新的类来完成功能.所以这部分也要在init中完成.
现在spring的特性都明确了需要在哪实现.接下来就是去做了.
那在实现的时候我们大致分三个阶段:
1.在数据初始化的时候spring会将我们在配置文件中的配置加载并封装
2.将所有的类初始化一边并且将实例保存在IOC容器中,我们有了所有的容器就可以完成spring的AOP和DI(依赖注入).
3.将所有的controller 的path保存起来(也就是我们常说的handlerMapping)
以上的完成后就可以等待web访问了.
废话不多说上代码首先是注解(由于注解都是模仿spring的格式来的所以我们可以根据注解名字对表spring,功能一致):
package com.shuguolili.mvcframework.annotation;
import java.lang.annotation.*;
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SGAutowired {
String value() default "";
}
下面几个注解我就不再上代码了,如果却是又朋友需要评论说下我再上,不然篇幅太长.
接着就是我们的核心DispatchDispatchServlet
package com.shuguolili.mvcframework.servlet;
import com.shuguolili.mvcframework.annotation.SGAutowired;
import com.shuguolili.mvcframework.annotation.SGController;
import com.shuguolili.mvcframework.annotation.SGRequestMapping;
import com.shuguolili.mvcframework.annotation.SGService;
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.net.URL;
import java.util.*;
/**
* @program springdemo
* @description: 自己实现的类似springDispatchServlet的类
* @author: yang
* @create: 2020/03/31 15:00
*/
public class SGDispatchServlet extends HttpServlet {
//创建一个map用来存放url和接口的映射关系,spring 实际是将url和对应的handler封装在HandlerMapping中然后在通过list存放
private Map mapping = new HashMap();
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
doPost(req, resp);
}
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
try {
doDispatch(req,resp);
} catch (Exception e) {
e.getStackTrace();
resp.getWriter().write("500 Exception " + Arrays.toString(e.getStackTrace()));
}
}
private void doDispatch(HttpServletRequest req, HttpServletResponse resp) throws Exception {
String url = req.getRequestURI();
String contextPath = req.getContextPath();
url = url.replace(contextPath, "").replaceAll("/+", "/");
if(!this.mapping.containsKey(url)){resp.getWriter().write("404 Not Found!!");return;}
Method method = (Method) this.mapping.get(url);
Map params = req.getParameterMap();
Object o = this.mapping.get(method.getDeclaringClass().getName());
method.invoke(o,new Object[]{req,resp,params.get("name")[0]});
}
@Override
public void init(ServletConfig config) throws ServletException {
InputStream is = null;
try{
Properties configContext = new Properties();
is = this.getClass().getClassLoader().getResourceAsStream(config.getInitParameter("contextConfigLocation"));
configContext.load(is);
String scanPackage = configContext.getProperty("scanPackage");
doScanner(scanPackage);
Set strings = mapping.keySet();
List names = new ArrayList();
for(String className : strings){
names.add(className);
}
for (String className : names) {
if(!className.contains(".")){continue;}
Class clazz = Class.forName(className);
if(clazz.isAnnotationPresent(SGController.class)){
mapping.put(className,clazz.newInstance());
String baseUrl = "";
if (clazz.isAnnotationPresent(SGRequestMapping.class)) {
SGRequestMapping requestMapping = clazz.getAnnotation(SGRequestMapping.class);
baseUrl = requestMapping.value();
}
Method[] methods = clazz.getMethods();
for (Method method : methods) {
if (!method.isAnnotationPresent(SGRequestMapping.class)) { continue; }
SGRequestMapping requestMapping = method.getAnnotation(SGRequestMapping.class);
String url = (baseUrl + "/" + requestMapping.value()).replaceAll("/+", "/");
mapping.put(url, method);
System.out.println("Mapped " + url + "," + method);
}
}else if(clazz.isAnnotationPresent(SGService.class)){
SGService service = clazz.getAnnotation(SGService.class);
String beanName = service.value();
if("".equals(beanName)){beanName = clazz.getName();}
Object instance = clazz.newInstance();
mapping.put(beanName,instance);
for (Class i : clazz.getInterfaces()) {
mapping.put(i.getName(),instance);
}
}else {continue;}
}
for (Object object : mapping.values()) {
if(object == null){continue;}
Class clazz = object.getClass();
if(clazz.isAnnotationPresent(SGController.class)){
Field[] fields = clazz.getDeclaredFields();
for (Field field : fields) {
if(!field.isAnnotationPresent(SGAutowired.class)){continue; }
SGAutowired autowired = field.getAnnotation(SGAutowired.class);
String beanName = autowired.value();
if("".equals(beanName)){beanName = field.getType().getName();}
field.setAccessible(true);
try {
field.set(mapping.get(clazz.getName()),mapping.get(beanName));
} catch (IllegalAccessException e) {
e.printStackTrace();
}
}
}
}
} catch (Exception e) {
System.out.println("error : "+ Arrays.toString(e.getStackTrace()));
}finally {
if(is != null){
try {is.close();} catch (IOException e) {
e.printStackTrace();
}
}
}
System.out.print("SG MVC Framework is init success");
}
/**
* @description: 扫描指定的包路径
* @param: scanPackage
* @return: void
* @author: yang
* @date:
*/
private void doScanner(String scanPackage) {
URL url = this.getClass().getClassLoader().getResource("/" + scanPackage.replaceAll("\\.","/"));
File classDir = new File(url.getFile());
for (File file : classDir.listFiles()) {
if(file.isDirectory()){ doScanner(scanPackage + "." + file.getName());}else {
if(!file.getName().endsWith(".class")){continue;}
String clazzName = (scanPackage + "." + file.getName().replace(".class",""));
mapping.put(clazzName,null);
}
}
}
}
其中的init的方法作用就是将需要交给spring管理的类在mapping中进行初始化并完成依赖注入. 其中将handletMaaping和path的映射
也存放在mapping中这样当我们自己实现的dispatchserlvet在接收到请求的时候就可以通过mapping判断请求及对应的controller 的对应接口,完成web访问.
为了检验是否功能正常,添加一个servlce和action来试试
srvice接口:
package com.shuguolili.demo.service;
/**
* @program springdemo
* @description: service层
* @author: yang
* @create: 2020/03/31 15:15
*/
public interface IDemoService {
String get(String name);
}
service
package com.shuguolili.demo.service.impl;
import com.shuguolili.demo.service.IDemoService;
import com.shuguolili.mvcframework.annotation.SGService;
/**
* @program springdemo
* @description: service 层
* @author: yang
* @create: 2020/03/31 15:16
*/
@SGService
public class DemoService implements IDemoService {
public String get(String name) {
return "resquest name is " + name + ",this words from service.";
}
}
controller:只有一个接口,调用来service的get方法
package com.shuguolili.demo.mvc.action;
import com.shuguolili.demo.service.IDemoService;
import com.shuguolili.mvcframework.annotation.SGAutowired;
import com.shuguolili.mvcframework.annotation.SGController;
import com.shuguolili.mvcframework.annotation.SGRequestMapping;
import com.shuguolili.mvcframework.annotation.SGRequestParam;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
/**
* @program springdemo
* @description: controller层
* @author: yang
* @create: 2020/03/31 15:17
*/
//虽然，用法一样，但是没有功能
@SGController
@SGRequestMapping("/demo")
public class DemoAction {
@SGAutowired
private IDemoService demoService;
@SGRequestMapping("/query")
public void query(HttpServletRequest req, HttpServletResponse resp,
@SGRequestParam("name") String name){
String result = demoService.get(name);
try {
resp.getWriter().write(result);
} catch (IOException e) {
e.printStackTrace();
}
}
}结果展示:
OK,到目前为止成功了最最简单的spring