学写一个 Java Web MVC 框架（三）

ゝ一世哀愁。 2022-08-30 00:42 140阅读 0赞

# 解析控制器 #

之所以要解析控制器，是因为 Controller 类定义了各种URL映射的规则。在初始化阶段我们要获取这套规则具体如何，以便每次请求访问过来的时候可以执行具体的控制器方法。从某个角度讲这些控制器类相当于一个个配置文件，配置规则利用 Java 注解来参与完成。很多场合下注解发挥了配置的作用。Controller 解可以定义在类身上，可以定义在方法身上，开发者先定义 Controller 类和方法，然后按照规则需求分配不同的注解到具体的类或者方法身上，从而完成 URL 与控制器之间的映射关系，这正是 MVC 的所要完成的目标：当用户访问一个 URL，最终对应的是一个 Java 方法，用户获得什么信息取决于该方法返回什么，那自然是一套规则，视乎 Controller API 能够提供什么能力给我们去设置这套规则。

如下是一个典型的 Controller。

@Path("/MyTopPath_And_SubPath")
    public class SubPathController implements IController { 
    	@GET
    	public String showHTML() { 
    		return "html::Hello World!";
    	}
    
    	@GET
    	@Path("subPath")
    	public String showHi(HttpServletRequest request, HttpServletResponse response)  { 
    		return "html::Hello " + request.getParameter("name");
    	}
    }

Controller 目标已经明确，就是映射 URL 与 Controller 的关系。为此必须使用一种数据结构来存储这种关系。到底应该如何设计合适的数据结构来描述映射关系呢？这将是我们 MVC 的重点所在。

首先观察 Action 结构。控制器与方法一起构成了一个 Action 对象，即`action = controller + methods`。我们解析一个控制器所有的信息，将其保存在 Action 身上。一个 Action 有如下属性。

*  一个控制器对应着一个 Action，如下所示 Action 类有`IController controller`属性；
 *  控制器注解`@Path`有 URL 路径，故如下所示 Action 类有`String path`属性；
 *  控制器方法有注解`@GET`、`@POST`等四种常见 HTTP 方法，故如下所示 Action 类有`Method getMethod、postMethod、putMethod、deleteMethod`属性；
 *  控制器控制器的方法还可以有注解`@Path`子路径，故如下所示Action类有`Map<String, Action> children`属性；

Action 通过`children`属性扩展下一级路径，形成一颗 Action 树。`children` 本身是一个 Map，键是 URL 路径的各个目录，键值是路径对应的 Action。如下面控制器 `FooController` 对应树状图，如插图所示。

import javax.ws.rs.DELETE;
    import javax.ws.rs.GET;
    import javax.ws.rs.POST;
    import javax.ws.rs.PUT;
    import javax.ws.rs.Path;
    
    @Path("/foo")
    public class FooController implements IController { 
    	@GET
    	public String get();
    	
    	@POST
    	public String post();
    	
    	@PUT
    	public String put();
    	
    	@DELETE
    	public String delete();
    	
    	@Path("/bar")
    	@GET
    	public String barGet();
    	
    	@Path("/bar")
    	@DELETE
    	public String barDELETE();
    	
    	@Path("/xyz")
    	@GET
    	public String xyzGET();	
    	
    	@Path("/xyz/bar/foo")
    	@POST
    	public String xyzPOST();	
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neGluMDk_size_16_color_FFFFFF_t_70]

控制器 FooController 一开始的根目录为`foo`，有下级目录`/foo/bar、/foo/xyz和/foo/xyz/bar/foo`。篇幅所限，最后的`/xyz/bar/foo`没有在图中列出。如果要列出，还有树节点`/foo/xyz/bar和/foo/xyz/bar/foo`这两个，其中`/foo/xyz/bar`节点有一 Action 实例，但是其属性`getMethod、postMethod、putMethod、deleteMethod`皆为`null`，仅承托下一级树节点之用；节点`/foo/xyz/bar/foo`有一属性 postMethod，因为它本身对应有 POST 的方法。

所有控制器路径与 Action 的关系，都定义在一个全局的静态成员`urlMappingTree`身上，它是一个 Action Map，如下插图所示。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neGluMDk_size_16_color_FFFFFF_t_70 1]

控制器的分析工作在 Servlet 过滤器初始化阶段完成，最终结果就是形成这个`urlMappingTree`（有读者可能会问，Tomcat的`webapps`下面可以部署多个项目，在不同的目录。假设修改项目 A 的静态`static`成员，会影响别的项目的`static`成员吗？Tomcat 对每一个项目使用一个类加载器。JVM 中判断一个类是否相同是两个条件，全限定名相同，类加载器相同。因此这种情况是互相隔离的，不用担心）的 Map 结构。分析工作是怎么完成的呢？回到`ControllerScanner`类的`add()`方法，开始了对控制器的相关解析工作，返回一个 Action 并保存在`urlMappingTree`，如插图示。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neGluMDk_size_16_color_FFFFFF_t_70 2]

第一个重点方法是`findTreeByPath()`，这里调用的是重载后的方法，其原型方法如下插图所示。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neGluMDk_size_16_color_FFFFFF_t_70 3]

参数`path`是 URL 路径转换为队列（Queen）。队列的特性是在列表的头端进行删除操作，而在列表的后端进行插入操作。一开始路径是 String，通过字符串`split()`分拆为数组后，转换为 LinkedList 返回。LinkedList 也是一种 Queen 对象。

对于 Map 树要进行遍历查找目标 Action，输入条件是`path`。当前初始化工作是新建Action节点，也就是说找不到目标 Action 就会新建 Action。这里应用了数据结构队列的知识，当 path 队列压出一元素，马上进行`Map.get(path[0])`的匹配，若为null则表示接下来要新建 Action，否则是已经存在的 Action。然后检查这队列是否已经为空(`path.isEmpty()`），若为空表示已经查找完毕，返回`target`即可，否则仍要查找下一级目录。这时队列已经压出头端的元素，剩下未查找的目录元素，则再次调用本方法，即递归，直到找到匹配路径为止，或者找不到返回`null`。在递归之前，要检查一下`children`属性是否已有 Map 实例。

之所以要提供`boolean createIfEmpty`参数，是为了后来 MvcDispatcher 命中路径时做的准备。那时候， Action 已经初始化完毕了，每次请求过来分析路径查找 Action，不再有任何新建的操作，故只是单纯的查找操作。

生成 Action 对象之后，`add(`)接着执行的方法是创建控制器实例`createControllerInstance()`和解析控制器方法`parseMethod()`。创建实例应用到了反射和依赖注射的概念，下面相关章节会讲，这里先定懂点谈谈`parseMethod()`，如插图所示。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neGluMDk_size_16_color_FFFFFF_t_70 4]

通过反射可以获取控制器方法所有的方法（`getMethods()`），但只带有`@GET/@POST/@PUT/@DELETE`注解的方法才会被解析，表明是 HTTP 请求的方法。另外一种情形是：带`@Path`组件的和不带的，前者表示当前路径下的方法；后者为子路径的方法，由控制器总路径加上子路径组成最终的目标路径，子路径一样可以有自己的`GET/POST/PUT/DELETE`方法。

`children`是子路径保存所在Map之引用，创建好的`subAction`会保存于此。`subAction` 的 `controller` 指针会指向当前控制器实例。

`methodSend()`的作用是根据方法当前的`@GET/@POST/@PUT/@DELETE`注解分门别类地指向对应的Method方法，以便MVC有请求到达时执行对应的控制器方法。这一过程比较简单就不张贴代码了。

分析控制器的过程到这里基本完成了，整个过滤器的初始化`init()`工作到这里也结束了。总的来说， Map 结构的`urlMappingTree`保存了所有控制器路由与执行方法的映射关系，它是一棵树，如果对其进行遍历查找匹配的路径成为了一个关键算法，这里简单地应用到队列的知识，是理解 MVC 路由匹配的关键。除此之外，对于相关注解的使用运用到了 Java 反射的知识。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neGluMDk_size_16_color_FFFFFF_t_70]: /images/20220829/e35d2a954acd4339aff2bf90f79d3670.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neGluMDk_size_16_color_FFFFFF_t_70 1]: /images/20220829/3c8f676c4dd04469a10f6f38aa01e6cc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neGluMDk_size_16_color_FFFFFF_t_70 2]: /images/20220829/27dbc85941fe4f2586fb1ca059fc8931.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neGluMDk_size_16_color_FFFFFF_t_70 3]: /images/20220829/0492ca9af12948d59854ef45ce41356b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW5neGluMDk_size_16_color_FFFFFF_t_70 4]: /images/20220829/f21e5c9e16b440708d42351ca499fe3f.png