超輕量級spring模板方案

   最近從事的工作是web方面的，主要j2ee，spring jsp這些內容，由於剛入門，很多的技術都不了解。所謂初生牛犢不怕虎，剛入門，各種不順手，比如寫jsp，總是重復很多的代碼，各種不爽，然后就去看jsp的模板技術，

看來看去也是各種不爽，於是就有了自己寫一個工具的想法。

ok，廢話一堆。先說說jsp模板，最簡單的include，成熟的解決有tiles，還有什么setmesh，當日還有更強大的什么fremaker，volocity（是這樣寫的嗎，記不清楚）等等。

include不說，實在太簡陋，tiles其實是很不錯的，不是很重，學習成本還算好，用的也比較廣吧，當然要說廣，肯定有后面那幾個了。可是這些對我來說，都太重。我要的是什么樣的？我記得rails里面的模板，大概就是layout里面寫一句yield就ok了。

沒錯，這就是我想要的。寫好layout，把什么header、menu什么的搞定，內容里面一個div套着一個yield，你就可以專注於你的子視圖了，框架自動把layout應用到你的視圖上去。

就這個簡單的功能，為什么要那么復雜的框架、插件呢？

不過jsp，看看好像還真沒有。那就自己實現吧，反正我是初入門，什么都不知道，不知者無畏嘛。

 

   屁話一堆，總算到該說些正題了。

   那么，怎么實現呢？我的思路是，layout里面寫好布局后，正文部分就用${yield}代替，

當請求子視圖的時候，自動的將子視圖插入到layout中，替換${yield}，然后生成一個新的合成視圖，存入緩存文件中，由新的視圖相應前端的請求。

  我們知道spring里面有個配置viewresolver的類，可以在有請求的時候，查找視圖，構建視圖，並返回給前端。我們就在這里做我們的事情。

  我們繼承一個InternalResourceViewResolver，該resolver會根據視圖查找相應的InternalResourceView來處理jsp視圖。InternalResourceViewResolver有一個buildView的調用，該調用根據視圖名稱構建view。

我們就重載這個方法，根據前面的思路，首先找到模板文件和子視圖，然后替換掉模板文件中的${yield}，寫入到新的jsp文件，然后重定向到該文件，就ok了。具體看代碼：

package lin.layoutsample.framework;

import lin.layoutsample.utils.FileUtils;
import lin.layoutsample.utils.StringUtils;

import org.springframework.web.servlet.view.AbstractUrlBasedView;
import org.springframework.web.servlet.view.InternalResourceViewResolver;

public class LayoutViewResolver extends InternalResourceViewResolver {

    private static String DEFUALT_YIELD_CMD = "${yield}";
    private static String DEFUALT_LAYOUT_TEMP_DIR = "/WEB-INF/layout/layout_temp";
    private static String DEFUALT_LAYOUT = "/WEB-INF/layout/layout.jsp";

    /**
     * layout文件。默認為/WEB-INF/layout/layout.jsp。
     * */
    private String layout = DEFUALT_LAYOUT;

    /**
     * 經過替換后的視圖緩存目錄，默認為/WEB-INF/layout/layout_temp。
     * */
    private String temp_path = DEFUALT_LAYOUT_TEMP_DIR;

    /**
     * 默認為${yield}。模板中該命令會被子視圖替換。類似rails的yield。
     * */
    private String yield_cmd = DEFUALT_YIELD_CMD;

    /**
     * 
     * 函數首先根據指定的view在緩存區生成對應的文件，然后將模板文件（默認為layout.jsp）中的${yield}替換成視圖的內容。
     * 再調用超類的buildview函數生成新的被視圖並返回。這樣就完成了模板的替換和重定向到新生成的視圖。
     * */
    @Override
    protected AbstractUrlBasedView buildView(String viewName) throws Exception {
        String url = getPrefix() + viewName + getSuffix();
        String target_view_real_path = super.getServletContext().getRealPath(
                getTemp_path())
                + url;
        FileUtils.createFile(target_view_real_path);
        String layout_real_path = super.getServletContext().getRealPath(
                getLayout());
        String layout_content = FileUtils.read(layout_real_path);
        String view_content = FileUtils.read(super.getServletContext()
                .getRealPath(url));
        String result_view_content = StringUtils.replace(layout_content, "\\Q"
                + getYield_cmd() + "\\E", view_content);
        FileUtils.write(target_view_real_path, result_view_content);

        AbstractUrlBasedView view = super.buildView(getTemp_path() + getPrefix()+ viewName);
        return view;
    }

    public String getLayout() {
        return layout;
    }

    public void setLayout(String layout) {
        this.layout = layout;
    }

    public String getTemp_path() {
        return temp_path;
    }

    public void setTemp_path(String temp_path) {
        this.temp_path = temp_path;
    }

    public String getYield_cmd() {
        return yield_cmd;
    }

    public void setYield_cmd(String yield_cmd) {
        this.yield_cmd = yield_cmd;
    }
}

 

是不是很簡單？只需要一個方法，然后就是在web的配置里面將默認的InternalResourceViewResolver 替換成我們的就可以了。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:p="http://www.springframework.org/schema/p" xmlns:context="http://www.springframework.org/schema/context"
    xmlns:dwr="http://www.directwebremoting.org/schema/spring-dwr"
    xmlns:security="http://www.springframework.org/schema/security"
    xsi:schemaLocation="http://www.springframework.org/schema/beans 
http://www.springframework.org/schema/beans/spring-beans.xsd 
http://www.springframework.org/schema/context 
http://www.springframework.org/schema/context/spring-context.xsd 
http://www.springframework.org/schema/mvc 
http://www.springframework.org/schema/mvc/spring-mvc.xsd
http://www.directwebremoting.org/schema/spring-dwr  
http://www.directwebremoting.org/schema/spring-dwr-2.0.xsd
http://www.springframework.org/schema/security  
http://www.springframework.org/schema/security/spring-security-3.2.xsd
">

    <!-- 自動掃描controller包下的所有類，使其認為spring mvc的控制器 -->
    <context:component-scan base-package="lin.layoutsample.controller" />
    

    <!-- 通過注解，把URL映射到Controller上，該標簽默認注冊DefaultAnnotationHandlerMapping和AnnotationMethodHandlerAdapter -->
    <mvc:annotation-driven />


    <!-- 對模型視圖名稱的解析，即在模型視圖名稱添加前后綴 -->
    <bean class="lin.layoutsample.framework.LayoutViewResolver">
        <property name="prefix" value="/" />
        <property name="suffix" value=".jsp" />
        <property name="layout" value="/WEB-INF/layout/layout.jsp" />
    </bean>
</beans>

這里我們可以配置我們的模板文件（一般叫layout.jsp）的路徑，當然你也可以不用${yield}來占位，你可以自己配置成屬性就行了。

完整的layout.jsp文件如下，路徑我一般放在/WEB-INF/layout/下面。

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
    
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%>

<!DOCTYPE html>
<html>
<%
    String path = request.getContextPath();
    String basePath = request.getScheme() + "://"
            + request.getServerName() + ":" + request.getServerPort()
            + path + "/";
%>
<base href="<%=basePath%>">
<head>
<%@include file="/WEB-INF/layout/_include.jsp"%>
<title>花花世界</title>
</head>
<body>
    <%@include file="/WEB-INF/layout/_header.jsp"%>

    <div class="container-fluid">
        <div class="row">
            <%@ include file="/WEB-INF/layout/_menu.jsp"%>
            <div class="page-content">
                <div class="container-fluid" data-role="main">
                    <!-- Main component for a primary marketing message or call to action -->

                    ${yield}

                </div>
                <!-- container-fluid -->
            </div>
            <!-- page-content -->
        </div>


    </div>
    <!-- /container -->

    <%@include file="/WEB-INF/layout/_import.jsp"%>
</body>
</html>

子視圖就很簡單了只需要一行示例代碼就行了，文件say-hi.jsp如下。

<h2>hi world!!</h2>

我們的控制器完全不需要考慮模板的事情，新建一個子視圖返回就行了。

package lin.layoutsample.controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;


@Controller
@RequestMapping("/hello")
public class HelloController {
    private Logger logger = LoggerFactory.getLogger(HelloController.class);
    
    @RequestMapping("/say-hi")
    public ModelAndView sayHi(){
        logger.debug("HelloController:sayHi");
        ModelAndView mv = new ModelAndView("WEB-INF/views/say-hi");
        return mv;
    }
}

效果如下圖：

 

是不是很簡單，對開發者來說，只需要配置一下，別的都不需要關心，就可以完成模板布局的應用了。

不過我是初學，入門，哪些商業的模板工具自然有他得用武之地，我這個超輕量級的模板解決方案，寫寫小網頁還是足夠了。

有興趣的tx可以去github上下載我的代碼https://github.com/linbirg/wish。

歡迎大神批評指正。