设计 REST 风格的 MVC 框架

http://www.ibm.com/developerworks/cn/java/j-lo-restmvc/

传统的 JavaEE MVC 框架如 Struts 等都是基于 Action 设计的后缀式映射，然而，流行的 Web 趋势是 REST 风格的架构。尽管使用 Filter 或者 Apache mod_rewrite 能够通过 URL 重写实现 REST 风格的 URL，为什么不直接设计一个全新的 REST 风格的 MVC 框架呢？ 本文将讲述如何从头设计一个基于 REST 风格的 Java MVC 框架，配合 Annotation，最大限度地简化 Web 应用的开发，您甚至编写一行代码就可以实现“Hello, world”。

0 评论：

廖 雪峰, 软件工程师, HP

2010 年 1 月 04 日

  • 内容

在 IBM Bluemix 云平台上开发并部署您的下一个应用。

开始您的试用

Java 开发者对 MVC 框架一定不陌生，从 Struts 到 WebWork，Java MVC 框架层出不穷。我们已经习惯了处理 *.do 或 *.action 风格的 URL，为每一个 URL 编写一个控制器，并继承一个 Action 或者 Controller 接口。然而，流行的 Web 趋势是使用更加简单，对用户和搜索引擎更加友好的 REST 风格的 URL。例如，来自豆瓣的一本书的链接是 http://www.douban.com/subject/2129650/，而非http://www.douban.com/subject.do?id=2129650。

有经验的 Java Web 开发人员会使用 URL 重写的方式来实现类似的 URL，例如，为前端 Apache 服务器配置 mod_rewrite 模块，并依次为每个需要实现 URL 重写的地址编写负责转换的正则表达式，或者，通过一个自定义的 RewriteFilter，使用 Java Web 服务器提供的 Filter 和请求转发（Forward）功能实现 URL 重写，不过，仍需要为每个地址编写正则表达式。

既然 URL 重写如此繁琐，为何不直接设计一个原生支持 REST 风格的 MVC 框架呢？

要设计并实现这样一个 MVC 框架并不困难，下面，我们从零开始，仔细研究如何实现 REST 风格的 URL 映射，并与常见的 IoC 容器如 Spring 框架集成。这个全新的 MVC 框架暂命名为 WebWind。

术语

MVC：Model-View-Controller，是一种常见的 UI 架构模式，通过分离 Model（模型）、View（视图）和 Controller（控制器），可以更容易实现易于扩展的 UI。在 Web 应用程序中，Model 指后台返回的数据；View 指需要渲染的页面，通常是 JSP 或者其他模板页面，渲染后的结果通常是 HTML；Controller 指 Web 开发人员编写的处理不同 URL 的控制器（在 Struts 中被称之为 Action），而 MVC 框架本身还有一个前置控制器，用于接收所有的 URL 请求，并根据 URL 地址分发到 Web 开发人员编写的 Controller 中。

IoC：Invertion-of-Control，控制反转，是目前流行的管理所有组件生命周期和复杂依赖关系的容器，例如 Spring 容器。

Template：模板，通过渲染，模板中的变量将被 Model 的实际数据所替换，然后，生成的内容即是用户在浏览器中看到的 HTML。模板也能实现判断、循环等简单逻辑。本质上，JSP 页面也是一种模板。此外，还有许多第三方模板引擎，如 Velocity，FreeMarker 等。

回页首

设计目标

和传统的 Struts 等 MVC 框架完全不同，为了支持 REST 风格的 URL，我们并不把一个 URL 映射到一个 Controller 类（或者 Struts 的 Action），而是直接把一个 URL 映射到一个方法，这样，Web 开发人员就可以将多个功能类似的方法放到一个 Controller 中，并且，Controller 没有强制要求必须实现某个接口。一个 Controller 通常拥有多个方法，每个方法负责处理一个 URL。例如，一个管理 Blog 的 Controller 定义起来就像清单 1 所示。

清单 1. 管理 Blog 的 Controller 定义
public class Blog {
    @Mapping("/create/$1")
    Public void create(int userId) { ... } 

    @Mapping("/display/$1/$2")
    Public void display(int userId, int postId) { ... } 

    @Mapping("/edit/$1/$2")
    Public void edit(int userId, int postId) { ... } 

    @Mapping("/delete/$1/$2")
    Public String delete(int userId, int postId) { ... }
}

@Mapping() 注解指示了这是一个处理 URL 映射的方法，URL 中的参数 $1、$2 ……则将作为方法参数传入。对于一个“/blog/1234/5678”的 URL，对应的方法将自动获得参数 userId=1234 和 postId=5678。同时，也无需任何与 URL 映射相关的 XML 配置文件。

使用 $1、$2 ……来定义 URL 中的可变参数要比正则表达式更简单，我们需要在 MVC 框架内部将其转化为正则表达式，以便匹配 URL。

此外，对于方法返回值，也未作强制要求。

回页首

集成 IoC

当接收到来自浏览器的请求，并匹配到合适的 URL 时，应该转发给某个 Controller 实例的某个标记有 @Mapping 的方法，这需要持有所有 Controller 的实例。不过，让一个 MVC 框架去管理这些组件并不是一个好的设计，这些组件可以很容易地被 IoC 容器管理，MVC 框架需要做的仅仅是向 IoC 容器请求并获取这些组件的实例。

为了解耦一种特定的 IoC 容器，我们通过 ContainerFactory 来获取所有 Controller 组件的实例，如清单 2 所示。

清单 2. 定义 ContainerFactory
public interface ContainerFactory { 

    void init(Config config); 

    List<Object> findAllBeans(); 

    void destroy();
}

其中，关键方法 findAllBeans() 返回 IoC 容器管理的所有 Bean，然后，扫描每一个 Bean 的所有 public 方法，并引用那些标记有 @Mapping 的方法实例。

我们设计目标是支持 Spring 和 Guice 这两种容器，对于 Spring 容器，可以通过 ApplicationContext 获得所有的 Bean 引用，代码见清单 3。

清单 3. 定义 SpringContainerFactory
public class SpringContainerFactory implements ContainerFactory {
    private ApplicationContext appContext; 

    public List<Object> findAllBeans() {
        String[] beanNames = appContext.getBeanDefinitionNames();
        List<Object> beans = new ArrayList<Object>(beanNames.length);
        for (int i=0; i<beanNames.length; i++) {
            beans.add(appContext.getBean(beanNames[i]));
        }
        return beans;
    }
    ...
}

对于 Guice 容器，通过 Injector 实例可以返回所有绑定对象的实例，代码见清单 4。

清单 4. 定义 GuiceContainerFactory
public class GuiceContainerFactory implements ContainerFactory {
    private Injector injector; 

    public List<Object> findAllBeans() {
        Map<Key<?>, Binding<?>> map = injector.getBindings();
        Set<Key<?>> keys = map.keySet();
        List<Object> list = new ArrayList<Object>(keys.size());
        for (Key<?> key : keys) {
            Object bean = injector.getInstance(key);
            list.add(bean);
        }
        return list;
    }
    ...
}

类似的，通过扩展 ContainerFactory，就可以支持更多的 IoC 容器，如 PicoContainer。

出于效率的考虑，我们缓存所有来自 IoC 的 Controller 实例，无论其在 IoC 中配置为 Singleton 还是 Prototype 类型。当然，也可以修改代码，每次都从 IoC 容器中重新请求实例。

回页首

设计请求转发

和 Struts 等常见 MVC 框架一样，我们也需要实现一个前置控制器，通常命名为 DispatcherServlet，用于接收所有的请求，并作出合适的转发。在 Servlet 规范中，有以下几种常见的 URL 匹配模式：

  • /abc：精确匹配，通常用于映射自定义的 Servlet；
  • *.do：后缀模式匹配，常见的 MVC 框架都采用这种模式；
  • /app/*：前缀模式匹配，这要求 URL 必须以固定前缀开头；
  • /：匹配默认的 Servlet，当一个 URL 没有匹配到任何 Servlet 时，就匹配默认的 Servlet。一个 Web 应用程序如果没有映射默认的 Servlet，Web 服务器会自动为 Web 应用程序添加一个默认的 Servlet。

REST 风格的 URL 一般不含后缀，我们只能将 DispatcherServlet 映射到“/”，使之变为一个默认的 Servlet，这样，就可以对任意的 URL 进行处理。

由于无法像 Struts 等传统的 MVC 框架根据后缀直接将一个 URL 映射到一个 Controller，我们必须依次匹配每个有能力处理 HTTP 请求的 @Mapping 方法。完整的 HTTP 请求处理流程如图 1 所示。

图 1. 请求处理流程

当扫描到标记有 @Mapping 注解的方法时，需要首先检查 URL 与方法参数是否匹配，UrlMatcher 用于将 @Mapping 中包含 $1、$2 ……的字符串变为正则表达式，进行预编译，并检查参数个数是否符合方法参数，代码见清单 5。

清单 5. 定义 UrlMatcher
final class UrlMatcher {
    final String url;
    int[] orders;
    Pattern pattern; 

    public UrlMatcher(String url) {
        ...
    }
}

将 @Mapping 中包含 $1、$2 ……的字符串变为正则表达式的转换规则是，依次将每个 $n 替换为 ([^\\/]*)，其余部分作精确匹配。例如，“/blog/$1/$2”变化后的正则表达式为：

 ^\\/blog\\/([^\\/]*)\\/([^\\/]*)$

请注意，Java 字符串需要两个连续的“\\”表示正则表达式中的转义字符“\”。将“/”排除在变量匹配之外可以避免很多歧义。

调用一个实例方法则由 Action 类表示，它持有类实例、方法引用和方法参数类型，代码见清单 6。

清单 6. 定义 Action
class Action {
    public final Object instance;
    public final Method method;
    public final Class<?>[] arguments; 

    public Action(Object instance, Method method) {
        this.instance = instance;
        this.method = method;
        this.arguments = method.getParameterTypes();
    }
}

负责请求转发的 Dispatcher 通过关联 UrlMatcher 与 Action，就可以匹配到合适的 URL，并转发给相应的 Action，代码见清单 7。

清单 7. 定义 Dispatcher
class Dispatcher  {
    private UrlMatcher[] urlMatchers;
    private Map<UrlMatcher, Action> urlMap = new HashMap<UrlMatcher, Action>();
    ....
}

当 Dispatcher 接收到一个 URL 请求时，遍历所有的 UrlMatcher，找到第一个匹配 URL 的 UrlMatcher，并从 URL 中提取方法参数，代码见清单 8。

清单 8. 匹配并从 URL 中提取参数
final class UrlMatcher {
    ... 

    /**
     * 根据正则表达式匹配 URL，若匹配成功，返回从 URL 中提取的参数，
     * 若匹配失败，返回 null
     */
    public String[] getMatchedParameters(String url) {
        Matcher m = pattern.matcher(url);
        if (!m.matches())
            return null;
        if (orders.length==0)
            return EMPTY_STRINGS;
        String[] params = new String[orders.length];
        for (int i=0; i<orders.length; i++) {
            params[orders[i]] = m.group(i+1);
        }
        return params;
    }
}

根据 URL 找到匹配的 Action 后，就可以构造一个 Execution 对象，并根据方法签名将 URL 中的 String 转换为合适的方法参数类型，准备好全部参数，代码见清单 9。

清单 9. 构造 Exectuion
class Execution {
    public final HttpServletRequest request;
    public final HttpServletResponse response;
    private final Action action;
    private final Object[] args;
    ... 

    public Object execute() throws Exception {
        try {
            return action.method.invoke(action.instance, args);
        }
        catch (InvocationTargetException e) {
            Throwable t = e.getCause();
            if (t!=null && t instanceof Exception)
                throw (Exception) t;
            throw e;
        }
    }
}

调用 execute() 方法就可以执行目标方法，并返回一个结果。请注意，当通过反射调用方法失败时，我们通过查找 InvocationTargetException 的根异常并将其抛出，这样，客户端就能捕获正确的原始异常。

为了最大限度地增加灵活性，我们并不强制要求 URL 的处理方法返回某一种类型。我们设计支持以下返回值：

  • String：当返回一个 String 时，自动将其作为 HTML 写入 HttpServletResponse；
  • void：当返回 void 时，不做任何操作；
  • Renderer：当返回 Renderer 对象时，将调用 Renderer 对象的 render 方法渲染 HTML 页面。

最后需要考虑的是，由于我们将 DispatcherServlet 映射为“/”，即默认的 Servlet，则所有的未匹配成功的 URL 都将由 DispatcherServlet 处理，包括所有静态文件，因此，当未匹配到任何 Controller 的 @Mapping 方法后，DispatcherServlet 将试图按 URL 查找对应的静态文件，我们用 StaticFileHandler 封装，主要代码见清单 10。

清单 10. 处理静态文件
class StaticFileHandler {
    ...
    public void handle(HttpServletRequest request, HttpServletResponse response)
    throws ServletException, IOException {
        String url = request.getRequestURI();
        String path = request.getServletPath();
        url = url.substring(path.length());
        if (url.toUpperCase().startsWith("/WEB-INF/")) {
            response.sendError(HttpServletResponse.SC_NOT_FOUND);
            return;
        }
        int n = url.indexOf(‘?‘);
        if (n!=(-1))
            url = url.substring(0, n);
        n = url.indexOf(‘#‘);
        if (n!=(-1))
            url = url.substring(0, n);
        File f = new File(servletContext.getRealPath(url));
        if (! f.isFile()) {
            response.sendError(HttpServletResponse.SC_NOT_FOUND);
            return;
        }
        long ifModifiedSince = request.getDateHeader("If-Modified-Since");
        long lastModified = f.lastModified();
        if (ifModifiedSince!=(-1) && ifModifiedSince>=lastModified) {
            response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
            return;
        }
        response.setDateHeader("Last-Modified", lastModified);
        response.setContentLength((int)f.length());
        response.setContentType(getMimeType(f));
        sendFile(f, response.getOutputStream());
    }
}

处理静态文件时要过滤 /WEB-INF/ 目录，否则将造成安全漏洞。

回页首

集成模板引擎

作为示例，返回一个“<h1>Hello, world!</h1>”作为 HTML 页面非常容易。然而，实际应用的页面通常是极其复杂的，需要一个模板引擎来渲染出 HTML。可以把 JSP 看作是一种模板，只要不在 JSP 页面中编写复杂的 Java 代码。我们的设计目标是实现对 JSP 和 Velocity 这两种模板的支持。

和集成 IoC 框架类似，我们需要解耦 MVC 与模板系统，因此，TemplateFactory 用于初始化模板引擎，并返回 Template 模板对象。TemplateFactory 定义见清单 11。

清单 11. 定义 TemplateFactory
public abstract class TemplateFactory {
    private static TemplateFactory instance;
    public static TemplateFactory getTemplateFactory() {
        return instance;
    } 

    public abstract Template loadTemplate(String path) throws Exception;
}

Template 接口则实现真正的渲染任务。定义见清单 12。

清单 12. 定义 Template
public interface Template {
    void render(HttpServletRequest request, HttpServletResponse response,
        Map<String, Object> model) throws Exception;
}

以 JSP 为例，实现 JspTemplateFactory 非常容易。代码见清单 13。

清单 13. 定义 JspTemplateFactory
public class JspTemplateFactory extends TemplateFactory {
    private Log log = LogFactory.getLog(getClass()); 

    public Template loadTemplate(String path) throws Exception {
        if (log.isDebugEnabled())
            log.debug("Load JSP template ‘" + path + "‘.");
        return new JspTemplate(path);
    } 

    public void init(Config config) {
        log.info("JspTemplateFactory init ok.");
    }
}

JspTemplate 用于渲染页面，只需要传入 JSP 的路径，将 Model 绑定到 HttpServletRequest，就可以调用 Servlet 规范的 forward 方法将请求转发给指定的 JSP 页面并渲染。代码见清单 14。

清单 14. 定义 JspTemplate
public class JspTemplate implements Template {
    private String path; 

    public JspTemplate(String path) {
        this.path = path;
    } 

    public void render(HttpServletRequest request, HttpServletResponse response,
            Map<String, Object> model) throws Exception {
        Set<String> keys = model.keySet();
        for (String key : keys) {
            request.setAttribute(key, model.get(key));
        }
        request.getRequestDispatcher(path).forward(request, response);
    }
}

另一种比 JSP 更加简单且灵活的模板引擎是 Velocity，它使用更简洁的语法来渲染页面，对页面设计人员更加友好，并且完全阻止了开发人员试图在页面中编写 Java 代码的可能性。使用 Velocity 编写的页面示例如清单 15 所示。

清单 15. Velocity 模板页面
<html>
    <head><title>${title}</title></head>
    <body><h1>Hello, ${name}!</body>
</html>

通过 VelocityTemplateFactory 和 VelocityTemplate 就可以实现对 Velocity 的集成。不过，从 Web 开发人员看来，并不需要知道具体使用的模板，客户端仅需要提供模板路径和一个由 Map<String, Object> 组成的 Model，然后返回一个 TemplateRenderer 对象。代码如清单 16 所示。

清单 16. 定义 TemplateRenderer
public class TemplateRenderer extends Renderer {
    private String path;
    private Map<String, Object> model; 

    public TemplateRenderer(String path, Map<String, Object> model) {
        this.path = path;
        this.model = model;
    } 

    @Override
    public void render(ServletContext context, HttpServletRequest request,
            HttpServletResponse response) throws Exception {
        TemplateFactory.getTemplateFactory()
                .loadTemplate(path)
                .render(request, response, model);
    }
}

TemplateRenderer 通过简单地调用 render 方法就实现了页面渲染。为了指定 Jsp 或 Velocity，需要在 web.xml 中配置 DispatcherServlet 的初始参数。配置示例请参考清单 17。

清单 17. 配置 Velocity 作为模板引擎
<servlet>
    <servlet-name>dispatcher</servlet-name>
    <servlet-class>org.expressme.webwind.DispatcherServlet</servlet-class>
    <init-param>
        <param-name>template</param-name>
        <param-value>Velocity</param-value>
    </init-param>
</servlet>

如果没有该缺省参数，那就使用默认的 Jsp。

类似的，通过扩展 TemplateFactory 和 Template，就可以添加更多的模板支持，例如 FreeMarker。

回页首

设计拦截器

拦截器和 Servlet 规范中的 Filter 非常类似，不过 Filter 的作用范围是整个 HttpServletRequest 的处理过程，而拦截器仅作用于 Controller，不涉及到 View 的渲染，在大多数情况下，使用拦截器比 Filter 速度要快，尤其是绑定数据库事务时，拦截器能缩短数据库事务开启的时间。

拦截器接口 Interceptor 定义如清单 18 所示。

清单 18. 定义 Interceptor
public interface Interceptor {
    void intercept(Execution execution, InterceptorChain chain) throws Exception;
}

和 Filter 类似，InterceptorChain 代表拦截器链。InterceptorChain 定义如清单 19 所示。

清单 19. 定义 InterceptorChain
public interface InterceptorChain {
    void doInterceptor(Execution execution) throws Exception;
}

实现 InterceptorChain 要比实现 FilterChain 简单，因为 Filter 需要处理 Request、Forward、Include 和 Error 这 4 种请求转发的情况，而 Interceptor 仅拦截 Request。当 MVC 框架处理一个请求时，先初始化一个拦截器链，然后，依次调用链上的每个拦截器。请参考清单 20 所示的代码。

清单 20. 实现 InterceptorChain 接口
class InterceptorChainImpl implements InterceptorChain {
    private final Interceptor[] interceptors;
    private int index = 0;
    private Object result = null; 

    InterceptorChainImpl(Interceptor[] interceptors) {
        this.interceptors = interceptors;
    } 

    Object getResult() {
        return result;
    } 

    public void doInterceptor(Execution execution) throws Exception {
        if(index==interceptors.length)
            result = execution.execute();
        else {
            // must update index first, otherwise will cause stack overflow:
            index++;
            interceptors[index-1].intercept(execution, this);
        }
    }
}

成员变量 index 表示当前链上的第 N 个拦截器，当最后一个拦截器被调用后，InterceptorChain 才真正调用 Execution 对象的 execute() 方法，并保存其返回结果，整个请求处理过程结束，进入渲染阶段。清单 21 演示了如何调用拦截器链的代码。

清单 21. 调用拦截器链
class Dispatcher  {
    ...
    private Interceptor[] interceptors;
    void handleExecution(Execution execution, HttpServletRequest request,
        HttpServletResponse response) throws ServletException, IOException {
        InterceptorChainImpl chains = new InterceptorChainImpl(interceptors);
        chains.doInterceptor(execution);
        handleResult(request, response, chains.getResult());
    }
}

当 Controller 方法被调用完毕后，handleResult() 方法用于处理执行结果。

回页首

渲染

由于我们没有强制 HTTP 处理方法的返回类型，因此，handleResult() 方法针对不同的返回值将做不同的处理。代码如清单 22 所示。

清单 22. 处理返回值
class Dispatcher  {
    ...
    void handleResult(HttpServletRequest request, HttpServletResponse response,
            Object result) throws Exception {
        if (result==null)
            return;
        if (result instanceof Renderer) {
            Renderer r = (Renderer) result;
            r.render(this.servletContext, request, response);
            return;
        }
        if (result instanceof String) {
            String s = (String) result;
            if (s.startsWith("redirect:")) {
                response.sendRedirect(s.substring(9));
                return;
            }
            new TextRenderer(s).render(servletContext, request, response);
            return;
        }
        throw new ServletException("Cannot handle result with type ‘"
                + result.getClass().getName() + "‘.");
    }
}

如果返回 null，则认为 HTTP 请求已处理完成，不做任何处理；如果返回 Renderer，则调用 Renderer 对象的 render() 方法渲染视图；如果返回 String，则根据前缀是否有“redirect:”判断是重定向还是作为 HTML 返回给浏览器。这样，客户端可以不必访问 HttpServletResponse 对象就可以非常方便地实现重定向。代码如清单 23 所示。

清单 23. 重定向
@Mapping("/register")
String register() {
    ...
    if (success)
        return "redirect:/reg/success";
    return "redirect:/reg/failed";
}

扩展 Renderer 还可以处理更多的格式，例如，向浏览器返回 JavaScript 代码等。

回页首

扩展

使用 Filter 转发

对于请求转发，除了使用 DispatcherServlet 外，还可以使用 Filter 来拦截所有请求，并直接在 Filter 内实现请求转发和处理。使用 Filter 的一个好处是如果 URL 没有被任何 Controller 的映射方法匹配到，则可以简单地调用 FilterChain.doFilter() 将 HTTP 请求传递给下一个 Filter，这样，我们就不必自己处理静态文件，而由 Web 服务器提供的默认 Servlet 处理，效率更高。和 DispatcherServlet 类似，我们编写一个 DispatcherFilter 作为前置处理器，负责转发请求，代码见清单 24。

清单 24. 定义 DispatcherFilter
public class DispatcherFilter implements Filter {
    ...
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain)
    throws IOException, ServletException {
        HttpServletRequest httpReq = (HttpServletRequest) req;
        HttpServletResponse httpResp = (HttpServletResponse) resp;
        String method = httpReq.getMethod();
        if ("GET".equals(method) || "POST".equals(method)) {
            if (!dispatcher.service(httpReq, httpResp))
                chain.doFilter(req, resp);
            return;
        }
        httpResp.sendError(HttpServletResponse.SC_METHOD_NOT_ALLOWED);
    }
}

如果用 DispatcherFilter 代替 DispatcherServlet，则我们需要过滤“/*”，在 web.xml 中添加声明如清单 25 所示。

清单 25. 声明 DispatcherFilter
<filter>
    <filter-name>dispatcher</servlet-name>
    <filter-class>org.expressme.webwind.DispatcherFilter</servlet-class>
</filter>
<filter-mapping>
    <filter-name>dispatcher</servlet-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

访问 Request 和 Response 对象

如何在 @Mapping 方法中访问 Servlet 对象？如 HttpServletRequest，HttpServletResponse，HttpSession 和 ServletContext。ThreadLocal 是一个最简单有效的解决方案。我们编写一个 ActionContext，通过 ThreadLocal 来封装对 Request 等对象的访问。代码见清单 26。

清单 26. 定义 ActionContext
public final class ActionContext {
    private static final ThreadLocal<ActionContext> actionContextThreadLocal
            = new ThreadLocal<ActionContext>(); 

    private ServletContext context;
    private HttpServletRequest request;
    private HttpServletResponse response; 

    public ServletContext getServletContext() {
        return context;
    } 

    public HttpServletRequest getHttpServletRequest() {
        return request;
    } 

    public HttpServletResponse getHttpServletResponse() {
        return response;
    } 

    public HttpSession getHttpSession() {
        return request.getSession();
    } 

    public static ActionContext getActionContext() {
        return actionContextThreadLocal.get();
    } 

    static void setActionContext(ServletContext context,
            HttpServletRequest request, HttpServletResponse response) {
        ActionContext ctx = new ActionContext();
        ctx.context = context;
        ctx.request = request;
        ctx.response = response;
        actionContextThreadLocal.set(ctx);
    } 

    static void removeActionContext() {
        actionContextThreadLocal.remove();
    }
}

在 Dispatcher 的 handleExecution() 方法中，初始化 ActionContext，并在 finally 中移除所有已绑定变量，代码见清单 27。

清单 27. 初始化 ActionContext
class Dispatcher {
    ...
    void handleExecution(Execution execution, HttpServletRequest request,
    HttpServletResponse response) throws ServletException, IOException {
        ActionContext.setActionContext(servletContext, request, response);
        try {
            InterceptorChainImpl chains = new InterceptorChainImpl(interceptors);
            chains.doInterceptor(execution);
            handleResult(request, response, chains.getResult());
        }
        catch (Exception e) {
            handleException(request, response, e);
        }
        finally {
            ActionContext.removeActionContext();
        }
    }
}

这样，在 @Mapping 方法内部，可以随时获得需要的 Request、Response、 Session 和 ServletContext 对象。

处理文件上传

Servlet API 本身并没有提供对文件上传的支持，要处理文件上传，我们需要使用 Commons FileUpload 之类的第三方扩展包。考虑到 Commons FileUpload 是使用最广泛的文件上传包，我们希望能集成 Commons FileUpload，但是，不要暴露 Commons FileUpload 的任何 API 给 MVC 的客户端，客户端应该可以直接从一个普通的 HttpServletRequest 对象中获取上传文件。

要让 MVC 客户端直接使用 HttpServletRequest，我们可以用自定义的 MultipartHttpServletRequest 替换原始的 HttpServletRequest，这样，客户端代码可以通过 instanceof 判断是否是一个 Multipart 格式的 Request，如果是，就强制转型为 MultipartHttpServletRequest，然后，获取上传的文件流。

核心思想是从 HttpServletRequestWrapper 派生 MultipartHttpServletRequest，这样，MultipartHttpServletRequest 具有 HttpServletRequest 接口。MultipartHttpServletRequest 的定义如清单 28 所示。

清单 28. 定义 MultipartHttpServletRequest
public class MultipartHttpServletRequest extends HttpServletRequestWrapper {
    final HttpServletRequest target;
    final Map<String, List<FileItemStream>> fileItems;
    final Map<String, List<String>> formItems; 

    public MultipartHttpServletRequest(HttpServletRequest request, long maxFileSize)
    throws IOException {
        super(request);
        this.target = request;
        this.fileItems = new HashMap<String, List<FileItemStream>>();
        this.formItems = new HashMap<String, List<String>>();
        ServletFileUpload upload = new ServletFileUpload();
        upload.setFileSizeMax(maxFileSize);
        try {

...解析Multipart ...

        }
        catch (FileUploadException e) {
            throw new IOException(e);
        }
    } 

    public InputStream getFileInputStream(String fieldName) throws IOException {
        List<FileItemStream> list = fileItems.get(fieldName);
        if (list==null)
            throw new IOException("No file item with name ‘" + fieldName + "‘.");
        return list.get(0).openStream();
    };
}

对于正常的 Field 参数，保存在成员变量 Map<String, List<String>> formItems 中，通过覆写 getParameter()、getParameters() 等方法，就可以让客户端把 MultipartHttpServletRequest 也当作一个普通的 Request 来操作，代码见清单 29。

清单 29. 覆写 getParameter
public class MultipartHttpServletRequest extends HttpServletRequestWrapper {
    ...
    @Override
    public String getParameter(String name) {
        List<String> list = formItems.get(name);
        if (list==null)
            return null;
        return list.get(0);
    } 

    @Override
    @SuppressWarnings("unchecked")
    public Map getParameterMap() {
        Map<String, String[]> map = new HashMap<String, String[]>();
        Set<String> keys = formItems.keySet();
        for (String key : keys) {
            List<String> list = formItems.get(key);
            map.put(key, list.toArray(new String[list.size()]));
        }
        return Collections.unmodifiableMap(map);
    } 

    @Override
    @SuppressWarnings("unchecked")
    public Enumeration getParameterNames() {
        return Collections.enumeration(formItems.keySet());
    } 

    @Override
    public String[] getParameterValues(String name) {
        List<String> list = formItems.get(name);
        if (list==null)
            return null;
        return list.toArray(new String[list.size()]);
    }
}

为了简化配置，在 Web 应用程序启动的时候，自动检测当前 ClassPath 下是否有 Commons FileUpload，如果存在，文件上传功能就自动开启，如果不存在，文件上传功能就不可用，这样，客户端只需要简单地把 Commons FileUpload 的 jar 包放入 /WEB-INF/lib/，不需任何配置就可以直接使用。核心代码见清单 30。

清单 30. 检测 Commons FileUpload
class Dispatcher {
    private boolean multipartSupport = false;
    ...
    void initAll(Config config) throws Exception {
        try {
            Class.forName("org.apache.commons.fileupload.servlet.ServletFileUpload");
            this.multipartSupport = true;
        }
        catch (ClassNotFoundException e) {
            log.info("CommonsFileUpload not found.");
        }
        ...
    } 

    void handleExecution(Execution execution, HttpServletRequest request,
            HttpServletResponse response) throws ServletException, IOException {
        if (this.multipartSupport) {
            if (MultipartHttpServletRequest.isMultipartRequest(request)) {
                request = new MultipartHttpServletRequest(request, maxFileSize);
            }
        }
        ...
    }
    ...
}

回页首

小结

要从头设计并实现一个 MVC 框架其实并不困难，设计 WebWind 的目标是改善 Web 应用程序的 URL 结构，并通过自动提取和映射 URL 中的参数，简化控制器的编写。WebWind 适合那些从头构造的新的互联网应用，以便天生支持 REST 风格的 URL。但是，它不适合改造已有的企业应用程序，企业应用的页面不需要搜索引擎的索引，其用户对 URL 地址的友好程度通常也并不关心。

参考资料

学习

获得产品和技术

讨论

时间： 2024-10-10 16:57:43

设计 REST 风格的 MVC 框架的相关文章

搭建基于spring MVC框架 + RESTful架构风格技术总结

实战篇: 在SpringMVC框架中搭建RESTful架构风格来完成客户端与服务器端的低耦合度.可扩展性.高并发与大数据流量的访问. 用RESTful架构的创建步骤: 1.创建一个全新的Web工程 2.导包,导入所需要的所有第三方jar包.(springMVC+Hibernate的基本包是必须的) 3.作配置,针对不同的项目需求和不同的搭建设计,开发人员可以按照自己的编码风格来设计符合项目开发具体 应该用多少篇配置文件.但是这几篇配置文件是必不可少的: 3-1.web.xml配置文件:最基本的配

主流MVC框架的设计模式及遵守的软件设计原则

原文地址,会不断更新  http://it.zuocheng.net/mvc-design-pattern-design-principle-summary   作程的技术博客 本文以主流的MVC框架为例,比如Java 的SSH.PHP的Symfony和Zend Framework ,在简单地剖析他们的设计原理之后,找到其中使用的设计模式:鉴赏他们的代码实现,查看设计者们都遵守了哪些软件设计原则.作此文,一为学习,二为总结.其中下面所写内容可能并不全面,也可能不准确,但会不断修改完善. 框架模式

从MVC框架看MVC架构的设计

转自:http://blog.csdn.net/bluishglc/article/details/6690693 从MVC框架看MVC架构的设计 尽管MVC早已不是什么新鲜话题了,但是从近些年一些优秀MVC框架的设计上,我们还是会发现MVC在架构设计上的一些新亮点.本文将对传统MVC架构中的一些弊病进行解读,了解一些优秀MVC框架是如何化解这些问题的,揭示其中所折射出的设计思想与设计理念. MVC回顾   作为一种经典到不能再经典的架构模式,MVC的成功有其必然的道理,这个道理不同的人会有不同

如何设计一个易用的MVC框架

导言 把一件简单的事情做复杂很容易,把一件复杂的事情做简单却不易.在计算机的世界里, 冯.诺依曼把复杂的电脑简化为:存储器,控制器,运算器和I/O设备; 丹尼斯·里奇把晦涩的汇编语言简化为258页的<C程序设计语言>; 詹姆斯高斯林把繁琐的跨平台编码简化为256条字节码指令: 对我们大部分人而言,把简单的事情做简单就足够了. 关于框架 框架是对某一类共通业务的封装,框架设计应该遵循几个基本的原则:1 易用性 2 稳定性3 扩展性,框架从来都是给别人用 的,框架的学习成本与他的复杂度成正比,如果

从MVC框架看MVC架构的设计(转)

尽管MVC早已不是什么新鲜话题了,但是从近些年一些优秀MVC框架的设计上,我们还是会发现MVC在架构设计上的一些新亮点.本文将对传统MVC架构中的一些弊病进行解读,了解一些优秀MVC框架是如何化解这些问题的,揭示其中所折射出的设计思想与设计理念. MVC回顾 作为一种经典到不能再经典的架构模式,MVC的成功有其必然的道理,这个道理不同的人会有不同的解读,笔者最认同的一种观点是:通过把职责.性质相近的成分归结在一起,不相近的进行隔离,MVC将系统分解为模型.视图.控制器三部分,每一部分都相对独立,

【从MVC框架看MVC架构的设计】

尽管MVC早已不是什么新鲜话题了,但是从近些年一些优秀MVC框架的设计上,我们还是会发现MVC在架构设计上的一些新亮点.本文将对传统MVC架构中的一些弊病进行解读,了解一些优秀MVC框架是如何化解这些问题的,揭示其中所折射出的设计思想与设计理念. MVC回顾 作为一种经典到不能再经典的架构模式,MVC的成功有其必然的道理,这个道理不同的人会有不同的解读,笔者最认同的一种观点是:通过把职责.性质相近的成分归结在一起,不相近的进行隔离,MVC将系统分解为模型.视图.控制器三部分,每一部分都相对独立,

通过极简模拟框架让你了解ASP.NET Core MVC框架的设计与实现[上篇]

<200行代码,7个对象--让你了解ASP.NET Core框架的本质>让很多读者对ASP.NET Core管道有了真实的了解.在过去很长一段时间中,有很多人私信给我:能否按照相同的方式分析一下MVC框架的设计与实现原理,希望这篇文章能够满足你们的需求.在对本章内容展开介绍之前,顺便作一下广告:<ASP.NET Core 3框架揭秘>已经开始销售,现时5折优惠还有最后4天,有兴趣的从这里入群购买. 目录一.Action元数据的解析     ActionDescriptor    

readbook:自己设计mvc框架,java类似struts2的实现

如果你不能简单说清楚,就是你还没有完全明白.——爱因斯坦 need things: 1.操作xml文档 dom4j 等开源类库 2. dtd的验证 等知识储备 * n到n次     ? 0到1次        + 1到n次 3. java 反射的相关知识反射过程:导入 java.lang.reflect.*1.获得需要操作的类的 Java.lang.Class对象2.调用Class的方法获取Field, Method等对象使用 反射api 进行操作 反射的常用类Class 类 : 反射的核心类,

Spring官方文档翻译——15.1 介绍Spring Web MVC框架

Part V. The Web 文档的这一部分介绍了Spring框架对展现层的支持(尤其是基于web的展现层) Spring拥有自己的web框架--Spring Web MVC,在前两章中会有介绍.剩下的章节则用来介绍Spring和其他web技术的集成,比如Struts和JSF(这里只提两个). 本节以对Spring MVC portlet框架的介绍结尾. 第十五章--Web MVC框架(Web MVC framework) 第十六章--视图技术(View technologie) 第十七章--