net.ymate.platform.mvc.web.support.DispatchHelper.java Source code

Java tutorial

Introduction

Here is the source code for net.ymate.platform.mvc.web.support.DispatchHelper.java

Source

/*
 * Copyright 2007-2107 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.ymate.platform.mvc.web.support;

import net.ymate.platform.base.YMP;
import net.ymate.platform.commons.i18n.I18N;
import net.ymate.platform.commons.util.RuntimeUtils;
import net.ymate.platform.mvc.support.RequestExecutor;
import net.ymate.platform.mvc.view.IView;
import net.ymate.platform.mvc.web.IWebErrorHandler;
import net.ymate.platform.mvc.web.WebMVC;
import net.ymate.platform.mvc.web.context.IWebRequestContext;
import net.ymate.platform.mvc.web.context.WebContext;
import net.ymate.platform.mvc.web.context.impl.WebRequestContext;
import net.ymate.platform.mvc.web.view.impl.FreeMarkerView;
import net.ymate.platform.mvc.web.view.impl.JspView;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import javax.servlet.FilterConfig;
import javax.servlet.ServletConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;

/**
 * <p>
 * DispatchHelper
 * </p>
 * <p>
 * ?
 * </p>
 *
 * @author (suninformation@163.com)
 * @version 0.0.0
 *          <table style="border:1px solid gray;">
 *          <tr>
 *          <th width="100px">?</th><th width="100px"></th><th
 *          width="100px"></th><th width="100px"></th>
 *          </tr>
 *          <!--  Table ?? -->
 *          <tr>
 *          <td>0.0.0</td>
 *          <td></td>
 *          <td></td>
 *          <td>2013818?7:11:29</td>
 *          </tr>
 *          </table>
 */
public class DispatchHelper {

    private static final Log _LOG = LogFactory.getLog(DispatchHelper.class);

    public static final String DEFAULT_METHOD_PARAM = "_method";

    private String methodParam;

    /**
     * ?
     */
    private String prefix;

    private String baseViewFilePath;

    /**
     * 
     *
     * @param config
     */
    public DispatchHelper(FilterConfig config) {
        prefix = StringUtils.defaultIfEmpty(config.getInitParameter("prefix"), "");
        methodParam = StringUtils.defaultIfEmpty(config.getInitParameter("methodParam"), DEFAULT_METHOD_PARAM);
        baseViewFilePath = RuntimeUtils.getRootPath()
                + StringUtils.substringAfter(TemplateHelper.getRootViewPath(), "/WEB-INF/");
    }

    /**
     * 
     *
     * @param config
     */
    public DispatchHelper(ServletConfig config) {
        prefix = StringUtils.defaultIfEmpty(config.getInitParameter("prefix"), "");
        methodParam = StringUtils.defaultIfEmpty(config.getInitParameter("methodParam"), DEFAULT_METHOD_PARAM);
        baseViewFilePath = RuntimeUtils.getRootPath()
                + StringUtils.substringAfter(TemplateHelper.getRootViewPath(), "/WEB-INF/");
    }

    public IWebRequestContext bindRequestContext(HttpServletRequest request) {
        return new WebRequestContext(request, getPrefix());
    }

    public void doRequestProcess(IWebRequestContext context, ServletContext servletContext,
            HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException {
        try {
            request = wrapperRequestForREST(request);
            WebContext.setContext(new WebContext(
                    WebContext.createWebContextMap(servletContext, request, response, null), context));
            // ??
            if (WebMVC.getConfig().getEventHandlerClassImpl() != null) {
                IView _view = WebMVC.getConfig().getEventHandlerClassImpl().onRequestReceived(context);
                if (_view != null) {
                    _view.render();
                    return;
                }
            }
            //
            RequestExecutor _executor = WebMVC.processRequestMapping(context);
            if (_executor != null) {
                IView _view = _executor.execute();
                if (_view != null) {
                    _view.render();
                    return;
                }
            } else if (WebMVC.getConfig().isConventionModel()
                    && StringUtils.trimToEmpty(WebMVC.getConfig().getUrlSuffix())
                            .endsWith(WebContext.getWebRequestContext().getSuffix())) {

                String _requestMapping = context.getRequestMapping();
                List<String> _urlParams = new ArrayList<String>();
                if (WebMVC.getConfig().isConventionUrlrewrite()) {
                    String[] _parts = StringUtils.split(_requestMapping, "-");
                    if (_parts.length > 1) {
                        _requestMapping = _parts[0];
                        for (int _idx = 1; _idx < _parts.length; _idx++) {
                            _urlParams.add(_parts[_idx]);
                        }
                        WebContext.getRequest().setAttribute("_UrlParams", _urlParams);
                    }
                }
                // ??URL?
                if (WebMVC.getConfig().getErrorHandlerClassImpl() != null) {
                    IView _view = WebMVC.getConfig().getErrorHandlerClassImpl().onConvention(_requestMapping);
                    if (_view != null) {
                        _view.render();
                        return;
                    }
                }
                // ???URL
                String[] _fileTypes = { ".jsp", ".ftl" };
                File _targetFile = null;
                for (String _fileType : _fileTypes) {
                    _targetFile = new File(getBaseViewFilePath(), _requestMapping + _fileType);
                    if (_targetFile != null && _targetFile.exists()) {
                        _LOG.info(I18N.formatMessage(YMP.__LSTRING_FILE, null, null,
                                "ymp.mvc.convention_request_execute", _requestMapping));
                        if (".jsp".equals(_fileType)) {
                            new JspView(_requestMapping.substring(1)).render();
                            return;
                        } else if (".ftl".equals(_fileType)) {
                            new FreeMarkerView(_requestMapping.substring(1)).render();
                            return;
                        }
                    }
                }
            }
            // ?404
            response.sendError(HttpServletResponse.SC_NOT_FOUND);
        } catch (Exception e) {
            IWebErrorHandler _errorHandler = WebMVC.getConfig().getErrorHandlerClassImpl();
            if (_errorHandler != null) {
                _errorHandler.onError(e);
            } else {
                throw new ServletException(e);
            }
        } finally {
            // ???
            if (WebMVC.getConfig().getEventHandlerClassImpl() != null) {
                WebMVC.getConfig().getEventHandlerClassImpl().onRequestCompleted(context);
            }
            //
            WebContext.setContext(null);
        }
    }

    /**
     * @param request
     * @return ??RESTFulMethod
     */
    protected HttpServletRequest wrapperRequestForREST(HttpServletRequest request) {
        if (WebMVC.isInited() && WebMVC.getConfig().isRestfulModel()) {
            String paramValue = request.getParameter(getMethodParam());
            if ("POST".equals(request.getMethod()) && StringUtils.isNotBlank(paramValue)) {
                String method = paramValue.toUpperCase(Locale.ENGLISH);
                return new HttpMethodRequestWrapper(request, method);
            }
        }
        return request;
    }

    public String getMethodParam() {
        return methodParam;
    }

    public String getPrefix() {
        return prefix;
    }

    public String getBaseViewFilePath() {
        return baseViewFilePath;
    }

}