SpringMVC1-手写mvc

一: 执行流程

SpringMVC1-手写mvc_第1张图片

1、前端发起请求

2、前端控制器DispatcherServlet根据url去处理器映射器HandlerMapping中匹配,将合适的handler和Interceptor(如果有)返回

3、DispatcherServlet拿到合适的handler,去请求适配器HandlerAdapter执行

4、HandlerAdatper执行handler,执行完后接收到返回来的ModelAndView,再返给DispatcherServlet

5、前端控制器请求视图解析器ViewResolver解析,接收解析后的View对象,渲染视图,返给前端

二:springMVC九大组件

1、HandlerMapping: 存储请求url与handler的关系 (handler:mvc容器初始化时,根据controller中的RequestMapping路径(类路径+方法路径),解析出是哪个controller,哪个method,用于后面使用反射调用。 一个方法对应一个handler)

2、HandlerAdapter: 因为springMVC中的handler是任意形式,但是请求到达servlet时候,Servlet 的⽅法结构都是doService(HttpServletRequest req,HttpServletResponse resp)形式,如何让固定的servlet方法调用handler方法,就是适配器职责

3、HandlerExceptionResolver: handler异常时候设置ModelAndView

4、ViewResolver: 根据controller中返回的viewName查找view,并确定其类型(如jsp)

5、RequestToViewNameTranslator: controller没有指定view时候,通过这个组件从请求中查找

6、MultipartResolver: 封装普通请求为MultipartHttpServletRequest实现文件上传

7、FlashMapManager

 8、ThemeResolver

9、LocaleResolver

看了上面的流程,可能还有点懵。 在解读源码之前,先自己模拟实现一个mvc。

三: 手写mvc,简单了解mvc执行流程

整体结构:

SpringMVC1-手写mvc_第2张图片

步骤:

1、自定义注解

标记controller:

@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface LagouController {
    String value() default "";
}

标记service:

@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface LagouService {
    String value() default "";
}

属性注入:

@Documented
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface LagouAutowired {
    String value() default "";
}

url请求:

@Documented
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface LagouRequestMapping {
    String value() default "";
}

2、创建配置文件springmvc.properties,定义包扫描路径

scanPackage=com.lagou.demo

3、定义service,使用@LagouService注解标记

public interface IDemoService {
    String get(String name);
}




@LagouService("demoService")
public class DemoServiceImpl implements IDemoService {
    @Override
    public String get(String name) {
        System.out.println("service 实现类中的name参数:" + name) ;
        return name;
    }
}

4、定义controller,也使用自定义注解标记

@LagouController
@LagouRequestMapping("/demo")
public class DemoController {

    @LagouAutowired
    private IDemoService demoService;

    /**
     * URL: /demo/query?name=lisi
     * @param request
     * @param response
     * @param name
     * @return
     */
    @LagouRequestMapping("/query")
    public String query(HttpServletRequest request, HttpServletResponse response,String name) {
        return demoService.get(name);
    }
}

5、定义handler-用来存controller中请求url和方法的信息(方法信息指:哪个Controller,哪个方法名,参数名什么的)。

import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;
import java.util.regex.Pattern;


/**
 * 封装handler方法相关的信息
 */
public class Handler {

    private Object controller; // method.invoke(obj,)

    private Method method;

    private Pattern pattern; // spring中url是支持正则的

    private Map paramIndexMapping; // 参数顺序,是为了进行参数绑定,key是参数名,value代表是第几个参数 


    public Handler(Object controller, Method method, Pattern pattern) {
        this.controller = controller;
        this.method = method;
        this.pattern = pattern;
        this.paramIndexMapping = new HashMap<>();
    }

/**
* set  get  方法省略……
*/
}

6、定义servlet,转发url到对应的controller方法(这里就是核心逻辑了)

public class LgDispatcherServlet extends HttpServlet {

    //加载配置文件内容为key-value,用来读取扫描路径的配置
    private Properties properties = new Properties();

    // 缓存扫描到的类的全限定类名
    private List classNames = new ArrayList<>(); 

    // ioc容器
    private Map ioc = new HashMap();

    // handlerMapping 存储url和Method之间的映射关系
    private List handlerMapping = new ArrayList<>();

    // init方法会在第一次请求到来时候调用
    @Override
    public void init(ServletConfig config) throws ServletException {
        // 1 加载配置文件 springmvc.properties
        String contextConfigLocation = config.getInitParameter("contextConfigLocation");
        doLoadConfig(contextConfigLocation);

        // 2 扫描相关的类,扫描注解
        doScan(properties.getProperty("scanPackage"));


        // 3 初始化bean对象(实现ioc容器,基于注解)
        doInstance();

        // 4 实现依赖注入
        doAutoWired();

        // 5 构造一个HandlerMapping处理器映射器,将配置好的url和Method建立映射关系
        initHandlerMapping();

        System.out.println("lagou mvc 初始化完成....");

        // 等待请求进入,处理请求
    }






    // 加载配置文件
    private void doLoadConfig(String contextConfigLocation) {

        InputStream resourceAsStream = this.getClass().getClassLoader().getResourceAsStream(contextConfigLocation);

        try {
            properties.load(resourceAsStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }


    // 扫描类scanPackage: com.lagou.demo  package----> 磁盘上的文件夹(File com/lagou/demo
    private void doScan(String scanPackage) {
        String scanPackagePath = Thread.currentThread().getContextClassLoader().getResource("").getPath() + scanPackage.replaceAll("\\.", "/");
        File pack = new File(scanPackagePath);

        File[] files = pack.listFiles();

        for(File file: files) {
            if(file.isDirectory()) { // 子package
                // 递归
                doScan(scanPackage + "." + file.getName());  // com.lagou.demo.controller
            }else if(file.getName().endsWith(".class")) {
                String className = scanPackage + "." + file.getName().replaceAll(".class", "");
                classNames.add(className);
            }
        }
    }


// ioc容器
    // 基于classNames缓存的类的全限定类名,以及反射技术,完成对象创建和管理
    private void doInstance()  {

        if(classNames.size() == 0) return;

        try{

            for (int i = 0; i < classNames.size(); i++) {
                String className =  classNames.get(i);  // com.lagou.demo.controller.DemoController

                // 反射
                Class aClass = Class.forName(className);
                // 区分controller,区分service'
                if(aClass.isAnnotationPresent(LagouController.class)) {
                    // controller的id此处不做过多处理,不取value了,就拿类的首字母小写作为id,保存到ioc中
                    String simpleName = aClass.getSimpleName();// DemoController
                    String lowerFirstSimpleName = lowerFirst(simpleName); // demoController
                    Object o = aClass.newInstance();
                    ioc.put(lowerFirstSimpleName,o);
                }else if(aClass.isAnnotationPresent(LagouService.class)) {
                    LagouService annotation = aClass.getAnnotation(LagouService.class);
                    //获取注解value值
                    String beanName = annotation.value();

                    // 如果指定了id,就以指定的为准
                    if(!"".equals(beanName.trim())) {
                        ioc.put(beanName,aClass.newInstance());
                    }else{
                        // 如果没有指定,就以类名首字母小写
                        beanName = lowerFirst(aClass.getSimpleName());
                        ioc.put(beanName,aClass.newInstance());
                    }


                    // service层往往是有接口的,面向接口开发,此时再以接口名为id,放入一份对象到ioc中,便于后期根据接口类型注入
                    Class[] interfaces = aClass.getInterfaces();
                    for (int j = 0; j < interfaces.length; j++) {
                        Class anInterface = interfaces[j];
                        // 以接口的全限定类名作为id放入
                        ioc.put(anInterface.getName(),aClass.newInstance());
                    }
                }else{
                    continue;
                }

            }
        }catch (Exception e) {
            e.printStackTrace();
        }
    }



//  实现依赖注入
    private void doAutoWired() {
        if(ioc.isEmpty()) {return;}

        // 有对象,再进行依赖注入处理

        // 遍历ioc中所有对象,查看对象中的字段,是否有@LagouAutowired注解,如果有需要维护依赖注入关系
        for(Map.Entry entry: ioc.entrySet()) {
            // 获取bean对象中的字段信息
            Field[] declaredFields = entry.getValue().getClass().getDeclaredFields();
            // 遍历判断处理
            for (int i = 0; i < declaredFields.length; i++) {
                Field declaredField = declaredFields[i];   //  @LagouAutowired  private IDemoService demoService;
                if(!declaredField.isAnnotationPresent(LagouAutowired.class)) {
                    continue;
                }


                // 有该注解
                LagouAutowired annotation = declaredField.getAnnotation(LagouAutowired.class);
                String beanName = annotation.value();  // 需要注入的bean的id
                if("".equals(beanName.trim())) {
                    // 没有配置具体的bean id,那就需要根据当前字段类型注入(接口注入)  IDemoService
                    beanName = declaredField.getType().getName();
                }

                // 开启赋值
                declaredField.setAccessible(true);

                try {
                    declaredField.set(entry.getValue(),ioc.get(beanName));
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
            }
        }
    }





    /*
        构造一个HandlerMapping处理器映射器
        最关键的环节
        目的:将url和method建立关联
     */
    private void initHandlerMapping() {
        if(ioc.isEmpty()) {return;}

        for(Map.Entry entry: ioc.entrySet()) {
            // 获取ioc中当前遍历的对象的class类型
            Class aClass = entry.getValue().getClass();

            if(!aClass.isAnnotationPresent(LagouController.class)) {continue;}

            String baseUrl = "";
            if(aClass.isAnnotationPresent(LagouRequestMapping.class)) {
                LagouRequestMapping annotation = aClass.getAnnotation(LagouRequestMapping.class);
                baseUrl = annotation.value(); // 等同于/demo
            }

            // 获取方法
            Method[] methods = aClass.getMethods();
            for (int i = 0; i < methods.length; i++) {
                Method method = methods[i];

                //  方法没有标识LagouRequestMapping,就不处理
                if(!method.isAnnotationPresent(LagouRequestMapping.class)) {continue;}

                // 如果标识,就处理
                LagouRequestMapping annotation = method.getAnnotation(LagouRequestMapping.class);
                String methodUrl = annotation.value();  // /query
                String url = baseUrl + methodUrl;    // 计算出来的url /demo/query

                // 把method所有信息及url封装为一个Handler
                Handler handler = new Handler(entry.getValue(),method, Pattern.compile(url));


                // 计算方法的参数位置信息  // query(HttpServletRequest request, HttpServletResponse response,String name)
                Parameter[] parameters = method.getParameters();
                for (int j = 0; j < parameters.length; j++) {
                    Parameter parameter = parameters[j];

                    if(parameter.getType() == HttpServletRequest.class || parameter.getType() == HttpServletResponse.class) {
                        // 如果是request和response对象,那么参数名称写HttpServletRequest和HttpServletResponse
                        handler.getParamIndexMapping().put(parameter.getType().getSimpleName(),j);
                    }else{
                        handler.getParamIndexMapping().put(parameter.getName(),j);  // 
                    }

                }

                // 建立url和method之间的映射关系(map缓存起来)
                handlerMapping.add(handler);
            }
        }

    }

    


    // 首字母小写方法
    public String lowerFirst(String str) {
        char[] chars = str.toCharArray();
        if('A' <= chars[0] && chars[0] <= 'Z') {
            chars[0] += 32;
        }
        return String.valueOf(chars);
    }





    @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 {
        // 根据uri获取到能够处理当前请求的hanlder(从handlermapping中(list))
        Handler handler = getHandler(req);

        if(handler == null) {
            resp.getWriter().write("404 not found");
            return;
        }

        // 参数绑定
        // 获取所有参数类型数组,这个数组的长度就是我们最后要传入的args数组的长度
        Class[] parameterTypes = handler.getMethod().getParameterTypes();


        // 根据上述数组长度创建一个新的数组(参数数组,是要传入反射调用的)
        Object[] paraValues = new Object[parameterTypes.length];

        // 以下就是为了向参数数组中塞值,而且还得保证参数的顺序和方法中形参顺序一致

        Map parameterMap = req.getParameterMap();

        // 遍历request中所有参数  (填充除了request,response之外的参数)
        for(Map.Entry param: parameterMap.entrySet()) {
            // name=1&name=2   name [1,2]
            String value = StringUtils.join(param.getValue(), ",");  // 如同 1,2

            // 如果参数和方法中的参数匹配上了,填充数据
            if(!handler.getParamIndexMapping().containsKey(param.getKey())) {continue;}

            // 方法形参确实有该参数,找到它的索引位置,对应的把参数值放入paraValues
            Integer index = handler.getParamIndexMapping().get(param.getKey());//name在第 2 个位置

            paraValues[index] = value;  // 把前台传递过来的参数值填充到对应的位置去

        }

        int requestIndex = handler.getParamIndexMapping().get(HttpServletRequest.class.getSimpleName()); // 0
        paraValues[requestIndex] = req;

        int responseIndex = handler.getParamIndexMapping().get(HttpServletResponse.class.getSimpleName()); // 1
        paraValues[responseIndex] = resp;

        // 最终调用handler的method属性
        try {
            handler.getMethod().invoke(handler.getController(),paraValues);
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        } catch (InvocationTargetException e) {
            e.printStackTrace();
        }

    }

    private Handler getHandler(HttpServletRequest req) {
        if(handlerMapping.isEmpty()){return null;}

        String url = req.getRequestURI();

        for(Handler handler: handlerMapping) {
            Matcher matcher = handler.getPattern().matcher(url);
            if(!matcher.matches()){continue;}
            return handler;
        }

        return null;

    }

}

6、定义web.xml

有了servlet后,肯定需要在web.xml中配置监听,项目启动时才会加载




  Archetype Created Web Application


  
    lgoumvc
    com.lagou.edu.mvcframework.servlet.LgDispatcherServlet
    
      contextConfigLocation   //servlet中根据该名字,知道扫描的文件是springmvc.properties
      springmvc.properties
    
  
  
  
    lgoumvc
    /*
  

当请求url到来时,找到对应的Handler使用反射技术,调用到controller的方法中。 

四:其他知识点

1、@ControllerAdvice全局异常捕获(controller抛出的异常),返回值和controller一样

@ControllerAdvice
@Slf4j
public class GlobalExceptionConfig {
   /**
    * 处理自定义异常
    */
   @ExceptionHandler(BusinessSilentException.class)
   @ResponseBody
   public JsonResult handleException(BusinessSilentException e) {
        log.error("业务异常:{}", e);
        return JsonResult.of(e);
   }
   
    /** 
     * 处理系统异常 
     */
   @ExceptionHandler(Exception.class)
   @ResponseBody
   public JsonResult handleException(Exception e) {
      log.error("系统内部错误:{}", e);
      return new JsonResult<>(500, "系统内部错误");
   }
}

2、监听器、过滤器、拦截器对比

listener:

  • 随web启动,监听整改web事件,如有变量创建、修改;  是否有请求发起等;

filter:

  • 在请求到达servlet前作用,可对所有资源过滤(servlet, js/css等静态资源);

interceptor:

  • springmvc中使用的拦截器是springmvc框架自己的,只作用在controller方法前后,这时候请求已经过了servlet。   
  • 拦截器是运用java反射方法,aop的运用也是使用拦截器。
  • 除了springmvc中,在spring其他地方也可使用java拦截器对方法前后做一些逻辑处理,拦截器可以获取ioc容器中的bean。

简单来说: filter专门用来处理Request和Response; interceptor用来处理业务方法。

你可能感兴趣的:(springmvc,手写mvc)