org.mixer2.spring.webmvc.Mixer2XhtmlViewResolver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mixer2 Show documentation
Mixer2 is template engine for java.
There is a newer version: 1.4.2
package org.mixer2.spring.webmvc;

import java.util.Locale;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.mixer2.Mixer2Engine;
import org.springframework.beans.BeanUtils;
import org.springframework.core.io.Resource;
import org.springframework.core.io.ResourceLoader;
import org.springframework.util.ClassUtils;
import org.springframework.util.StringUtils;
import org.springframework.web.servlet.view.AbstractUrlBasedView;
import org.springframework.web.servlet.view.UrlBasedViewResolver;

/**
 * View Resolver for SpringMVC . your should add dependency for your
 * application:
 * 
 *  * {@code
 * 
 *     org.springframework
 *     spring-webmvc
 *     3.1.2.RELEASE (or higher)
 * 
 * }
 * 
 * 
 * Spring MVC configuration Sample
 * 
 *  * {@code
 * 
 * 
 *     
 *     
 *     
 *     
 *     
 *     
 *     
 *     
 *     
 *     
 *     
 *     
 *     
 * 
 * }
 * 
 * 
 * 
 * Using this ViewResolver, Your controller method can returns template
 * html file path and name without file extension.

 * See sample below.
 * 
 * 
 *  * 
 * {@literal @}Controller
 * public class HelloWorldController {
 * 
 *    {@literal @}Autowired
 *    protected helloMessageService helloMessageService;
 * 
 *    {@literal @}RequestMapping(value = "/hello", method = RequestMethod.GET)
 *    public String showHello(Model model) {
 *        String helloMessage = helloMessageService.getMessage();
 *        model.addAttribute("helloMessage", helloMessage);
 *        return "foo/bar/helloWorld"; 
 *    }
 * }
 * 
 * 
 * 
 * 
 * In this case, "foo/bar/helloWorld" will be attached to
 * "com.example.yourproject.web.view.foo.bar.HelloWorldView" class .
 * 
 * 
 * 
 * AbstractMixer2XhtmlView which is the base class of HelloWorldView loads the
 * file "m2mockup/m2template/foo/bar/helloWorld.html" as a html template and
 * convert it to the instance of org.mixer2.jaxb.xhtml.Html . You can change the
 * html object in HelloWorldView class.
 * 
 * 
 * 
 * The template file is "prefix" + viewName + "suffix" . See "prefix" and
 * "suffix" property of Mixer2XhtmlViewResolver bean configuration sample above.
 * 
 * 
 * 
 * If there were no "com.example.yourproject.web.view.foo.bar.HelloWorldView"
 * class in classpath,default view will be created automatically that load the
 * template file. You can not change the the html object. That means the view
 * resolver returns html on template file as is.
 * 
 * 
 * @see {@link http://mixer2.org/site/springmvcsample.html}
 * @see {@link https://github.com/nabedge/mixer2-sample/tree/master/mixer2-fruitshop-springmvc}
 * @author kazuki43zoo
 * @author nabedge
 */
public class Mixer2XhtmlViewResolver extends UrlBasedViewResolver {

    private static final String PATH_SEPARATOR = "/";

    private static final String PACKAGE_SEPARATOR = ".";

    private static final Pattern PATH_SEPARATOR_PATTERN = Pattern
            .compile(PATH_SEPARATOR);

    private static Log log = LogFactory.getLog(Mixer2XhtmlViewResolver.class);

    private Mixer2Engine mixer2Engine;

    private String basePackage = "";

    private String classNameSuffix = "View";

    private String docType;

    private boolean returnNullIfTemplateFileNotFound = true;

    public Mixer2XhtmlViewResolver() {
        setViewClass(AbstractMixer2XhtmlView.class);
    }

    public void setMixer2Engine(Mixer2Engine mixer2Engine) {
        this.mixer2Engine = mixer2Engine;
    }

    public void setBasePackage(String basePackage) {
        this.basePackage = basePackage;
    }

    public void setClassNameSuffix(String classNameSuffix) {
        this.classNameSuffix = classNameSuffix;
    }

    public void setDocType(String docType) {
        this.docType = docType;
    }

    /**
     * @since 1.2.21
     * @return
     */
    public boolean isReturnNullIfTemplateFileNotFound() {
        return returnNullIfTemplateFileNotFound;
    }

    /*
     * @since 1.2.21
     */
    public void setReturnNullIfTemplateFileNotFound(
            boolean returnNullIfTemplateFileNotFound) {
        this.returnNullIfTemplateFileNotFound = returnNullIfTemplateFileNotFound;
    }

    @Override
    protected boolean canHandle(String viewName, Locale locale) {
        String url = createUrl(viewName);
        if (log.isDebugEnabled()) {
            log.debug("template url: " + url);
        }
        Resource resource = getApplicationContext().getResource(url);
        return resource.exists();
    }

    protected AbstractUrlBasedView buildView(String viewName) throws Exception {

        // create view object.
        AbstractMixer2XhtmlView view = null;
        String fqcnOfView = (StringUtils.hasLength(basePackage) ? basePackage
                + PACKAGE_SEPARATOR : "")
                + toViewClassNamePrefix(viewName)
                + (StringUtils.hasLength(classNameSuffix) ? classNameSuffix
                        : "");
        try {
            Class viewClass = ClassUtils.forName(fqcnOfView,
                    ClassUtils.getDefaultClassLoader());
            view = BeanUtils.instantiateClass(viewClass,
                    AbstractMixer2XhtmlView.class);
            getApplicationContext().getAutowireCapableBeanFactory()
                    .autowireBean(view);
        } catch (ClassNotFoundException e) {
            view = createDefaultView();
            log.debug("Applied default view. viewName is '" + viewName
                    + "'. fqcnOfView is '" + fqcnOfView + "'.");
        }

        // inject properties of AbstractMixer2XhtmlView.
        view.setMixer2Engine(mixer2Engine);
        view.setResourceLoader(getApplicationContext());
        if (docType != null) {
            view.setDocType(docType);
        }
        // inject properties of parent class.
        view.setUrl(createUrl(viewName));
        String contentType = getContentType();
        if (contentType != null) {
            view.setContentType(contentType);
        }
        view.setRequestContextAttribute(getRequestContextAttribute());
        view.setAttributesMap(getAttributesMap());
        return view;
    }

    protected String createUrl(String viewName) {
        return getPrefix() + viewName + getSuffix();
    }

    protected String toViewClassNamePrefix(String viewName) {
        if (viewName.contains(PATH_SEPARATOR)) {
            int lastIndexOfPathSeparator = viewName.lastIndexOf(PATH_SEPARATOR);
            Matcher pathSeparatorMatcher = PATH_SEPARATOR_PATTERN
                    .matcher(viewName.substring(0, lastIndexOfPathSeparator));
            String packageName = pathSeparatorMatcher
                    .replaceAll(PACKAGE_SEPARATOR);
            String lastElement = viewName
                    .substring(lastIndexOfPathSeparator + 1);
            return packageName + PACKAGE_SEPARATOR
                    + StringUtils.capitalize(lastElement);
        } else {
            return StringUtils.capitalize(viewName);
        }
    }

    protected AbstractMixer2XhtmlView createDefaultView() {
        return AbstractMixer2XhtmlView.createDefaultView();
    }

}
org.mixer2.spring.webmvc.Mixer2XhtmlViewResolver Maven / Gradle / Ivy

your should add dependency for your * application:

Spring MVC configuration Sample
