JSP技巧使模板更容易？

最新推荐文章于 2023-10-10 23:36:43 发布

xfxf996

最新推荐文章于 2023-10-10 23:36:43 发布

阅读量234

点赞数

文章标签： java jsp inheritance templates tags

原文链接：https://oldbug.net/q/5RD1/JSP-tricks-to-make-templating-easier

版权

本文翻译自：JSP tricks to make templating easier?

At work I've been tasked with turning a bunch of HTML files into a simple JSP project. 在工作中，我的任务是将一堆HTML文件转换为一个简单的JSP项目。 It's really all static, no serverside logic to program. 它实际上是静态的，无需编程的服务器端逻辑。 I should mention I'm completely new to Java. 我应该提到我对Java完全不熟悉。 JSP files seem to make it easy to work with common includes and variables, much like PHP , but I'd like to know a simple way to get something like template inheritance ( Django style) or at least be able to have a base.jsp file containing the header and the footer, so I can insert content later. JSP文件似乎可以很容易地使用常见的包含和变量，就像PHP一样，但我想知道一种简单的方法来获得类似模板继承（ Django样式）或者至少能够拥有base.jsp包含页眉和页脚的文件，所以我可以稍后插入内容。

Ben Lings seems to offer some hope in his answer here: JSP template inheritance Can someone explain how to achieve this? Ben Lings似乎在这里给出了一些希望： JSP模板继承有人可以解释如何实现这个目标吗？

Given that I don't have much time I think dynamic routing is a little much, so I'm happy to just to have URLs map directly onto .jsp files, but I'm open to suggestion. 鉴于我没有太多时间，我认为动态路由有点多，所以我很高兴只是将URL直接映射到.jsp文件，但我愿意接受建议。

Thanks. 谢谢。

edit: I don't want to use any external libraries, because it would increase the learning curve for myself and others who work on the project, and the company I work for has been contracted to do this. 编辑：我不想使用任何外部库，因为它会增加我自己和其他从事该项目的人的学习曲线，而我所工作的公司已经签约这样做。

Another edit: I'm not sure if JSP tags will be useful because my content doesn't really have any template variables. 另一个编辑：我不确定JSP tags是否有用，因为我的内容实际上没有任何模板变量。 What I need is a way to be able to do this: 我需要的是一种能够做到这一点的方法：

base.html:

<html><body>
{ content.body }
</body></html>

somepage.html

<wrapper:base.html>
<h1>Welcome</h1>
</wrapper>

with the output being: 输出为：

<html><body>
<h1>Welcome</h1>
</body></html>

I think this would give me enough versatility to do everything I need. 我认为这会给我足够的多功能性来做我需要的一切。 It could be achieved with includes but then I would need a top and a bottom include for each wrapper, which is kind of messy. 它可以通过includes实现，但是我需要为每个包装器提供顶部和底部包含，这有点混乱。

#1楼

参考：https://stackoom.com/question/5RD1/JSP技巧使模板更容易

#2楼

Use tiles . 使用瓷砖。 It saved my life. 它救了我的命。

But if you can't, there's the include tag , making it similar to php. 但如果你不能，那就是include标签，使它类似于php。

The body tag might not actually do what you need it to, unless you have super simple content. 除非你有超级简单的内容，否则body标签可能实际上并不是你需要的。 The body tag is used to define the body of a specified element. body标签用于定义指定元素的主体。 Take a look at this example : 看看这个例子：

<jsp:element name="${content.headerName}"   
   xmlns:jsp="http://java.sun.com/JSP/Page">    
   <jsp:attribute name="lang">${content.lang}</jsp:attribute>   
   <jsp:body>${content.body}</jsp:body> 
</jsp:element>

You specify the element name, any attributes that element might have ("lang" in this case), and then the text that goes in it--the body. 您可以指定元素名称，元素可能具有的任何属性（在本例中为“lang”），然后指定其中的文本 - 正文。 So if 因此，如果

content.headerName = h1 , content.headerName = h1 ，
content.lang = fr , and content.lang = fr ，和
content.body = Heading in French

Then the output would be 那么输出就是

<h1 lang="fr">Heading in French</h1>

#3楼

I made quite easy, Django style JSP Template inheritance tag library. 我做了相当简单的Django样式JSP模板继承标记库。 https://github.com/kwon37xi/jsp-template-inheritance https://github.com/kwon37xi/jsp-template-inheritance

I think it make easy to manage layouts without learning curve. 我认为无需学习曲线就可以轻松管理布局。

example code : 示例代码：

base.jsp : layout base.jsp：布局

<%@page contentType="text/html; charset=UTF-8" %>
<%@ taglib uri="http://kwonnam.pe.kr/jsp/template-inheritance" prefix="layout"%>
<!DOCTYPE html>
<html lang="en">
    <head>
        <title>JSP Template Inheritance</title>
    </head>

<h1>Head</h1>
<div>
    <layout:block name="header">
        header
    </layout:block>
</div>

<h1>Contents</h1>
<div>
    <p>
    <layout:block name="contents">
        <h2>Contents will be placed under this h2</h2>
    </layout:block>
    </p>
</div>

<div class="footer">
    <hr />
    <a href="https://github.com/kwon37xi/jsp-template-inheritance">jsp template inheritance example</a>
</div>
</html>

view.jsp : contents view.jsp：内容

<%@page contentType="text/html; charset=UTF-8" %>
<%@ taglib uri="http://kwonnam.pe.kr/jsp/template-inheritance" prefix="layout"%>
<layout:extends name="base.jsp">
    <layout:put name="header" type="REPLACE">
        <h2>This is an example about layout management with JSP Template Inheritance</h2>
    </layout:put>
    <layout:put name="contents">
        Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin porta,
        augue ut ornare sagittis, diam libero facilisis augue, quis accumsan enim velit a mauris.
    </layout:put>
</layout:extends>

#4楼

Based on the same basic idea as in @Will Hartung 's answer, here is my magic one-tag extensible template engine. 基于与@Will Hartung的回答相同的基本思想，这是我的魔术单标签可扩展模板引擎。 It even includes documentation and an example :-) 它甚至包括文档和示例:-)

WEB-INF/tags/block.tag: WEB-INF /标签/ block.tag：

<%--
    The block tag implements a basic but useful extensible template system.

    A base template consists of a block tag without a 'template' attribute.
    The template body is specified in a standard jsp:body tag, which can
    contain EL, JSTL tags, nested block tags and other custom tags, but
    cannot contain scriptlets (scriptlets are allowed in the template file,
    but only outside of the body and attribute tags). Templates can be
    full-page templates, or smaller blocks of markup included within a page.

    The template is customizable by referencing named attributes within
    the body (via EL). Attribute values can then be set either as attributes
    of the block tag element itself (convenient for short values), or by
    using nested jsp:attribute elements (better for entire blocks of markup).

    Rendering a template block or extending it in a child template is then
    just a matter of invoking the block tag with the 'template' attribute set
    to the desired template name, and overriding template-specific attributes
    as necessary to customize it.

    Attribute values set when rendering a tag override those set in the template
    definition, which override those set in its parent template definition, etc.
    The attributes that are set in the base template are thus effectively used
    as defaults. Attributes that are not set anywhere are treated as empty.

    Internally, attributes are passed from child to parent via request-scope
    attributes, which are removed when rendering is complete.

    Here's a contrived example:

    ====== WEB-INF/tags/block.tag (the template engine tag)

    <the file you're looking at right now>

    ====== WEB-INF/templates/base.jsp (base template)

    <%@ page trimDirectiveWhitespaces="true" %>
    <%@ taglib prefix="t" tagdir="/WEB-INF/tags" %>
    <t:block>
        <jsp:attribute name="title">Template Page</jsp:attribute>
        <jsp:attribute name="style">
            .footer { font-size: smaller; color: #aaa; }
            .content { margin: 2em; color: #009; }
            ${moreStyle}
        </jsp:attribute>
        <jsp:attribute name="footer">
            <div class="footer">
                Powered by the block tag
            </div>
        </jsp:attribute>
        <jsp:body>
            <html>
                <head>
                    <title>${title}</title>
                    <style>
                        ${style}
                    </style>
                </head>
                <body>
                    <h1>${title}</h1>
                    <div class="content">
                        ${content}
                    </div>
                    ${footer}
                </body>
            </html>
        </jsp:body>
    </t:block>

    ====== WEB-INF/templates/history.jsp (child template)

    <%@ page trimDirectiveWhitespaces="true" %>
    <%@ taglib prefix="t" tagdir="/WEB-INF/tags" %>
    <t:block template="base" title="History Lesson">
        <jsp:attribute name="content" trim="false">
            <p>${shooter} shot first!</p>
        </jsp:attribute>
    </t:block>

    ====== history-1977.jsp (a page using child template)

    <%@ page trimDirectiveWhitespaces="true" %>
    <%@ taglib prefix="t" tagdir="/WEB-INF/tags" %>
    <t:block template="history" shooter="Han" />

    ====== history-1997.jsp (a page using child template)

    <%@ page trimDirectiveWhitespaces="true" %>
    <%@ taglib prefix="t" tagdir="/WEB-INF/tags" %>
    <t:block template="history" title="Revised History Lesson">
        <jsp:attribute name="moreStyle">.revised { font-style: italic; }</jsp:attribute>
        <jsp:attribute name="shooter"><span class="revised">Greedo</span></jsp:attribute>
    </t:block>

--%>

<%@ tag trimDirectiveWhitespaces="true" %>
<%@ tag import="java.util.HashSet, java.util.Map, java.util.Map.Entry" %>
<%@ tag dynamic-attributes="dynattributes" %>
<%@ attribute name="template" %>
<%
    // get template name (adding default .jsp extension if it does not contain
    // any '.', and /WEB-INF/templates/ prefix if it does not start with a '/')
    String template = (String)jspContext.getAttribute("template");
    if (template != null) {
        if (!template.contains("."))
            template += ".jsp";
        if (!template.startsWith("/"))
            template = "/WEB-INF/templates/" + template;
    }
    // copy dynamic attributes into request scope so they can be accessed from included template page
    // (child is processed before parent template, so only set previously undefined attributes)
    Map<String, String> dynattributes = (Map<String, String>)jspContext.getAttribute("dynattributes");
    HashSet<String> addedAttributes = new HashSet<String>();
    for (Map.Entry<String, String> e : dynattributes.entrySet()) {
        if (jspContext.getAttribute(e.getKey(), PageContext.REQUEST_SCOPE) == null) {
            jspContext.setAttribute(e.getKey(), e.getValue(), PageContext.REQUEST_SCOPE);
            addedAttributes.add(e.getKey());
        }
    }
%>

<% if (template == null) { // this is the base template itself, so render it %>
    <jsp:doBody/>
<% } else { // this is a page using the template, so include the template instead %>
    <jsp:include page="<%= template %>" />
<% } %>

<%
    // clean up the added attributes to prevent side effect outside the current tag
    for (String key : addedAttributes) {
        jspContext.removeAttribute(key, PageContext.REQUEST_SCOPE);
    }
%>

#5楼

As skaffman suggested , JSP 2.0 Tag Files are the bee's knees. 正如Skaffman所说， JSP 2.0标记文件是蜜蜂的膝盖。

Let's take your simple example. 让我们举一个简单的例子。

Put the following in WEB-INF/tags/wrapper.tag 将以下内容放在WEB-INF/tags/wrapper.tag

<%@tag description="Simple Wrapper Tag" pageEncoding="UTF-8"%>
<html><body>
  <jsp:doBody/>
</body></html>

Now in your example.jsp page: 现在在你的example.jsp页面中：

<%@page contentType="text/html" pageEncoding="UTF-8"%>
<%@taglib prefix="t" tagdir="/WEB-INF/tags" %>

<t:wrapper>
    <h1>Welcome</h1>
</t:wrapper>

That does exactly what you think it does. 这完全符合你的想法。

So, lets expand upon that to something a bit more general. 所以，让我们把它扩展到更一般的东西。 WEB-INF/tags/genericpage.tag

<%@tag description="Overall Page template" pageEncoding="UTF-8"%>
<%@attribute name="header" fragment="true" %>
<%@attribute name="footer" fragment="true" %>
<html>
  <body>
    <div id="pageheader">
      <jsp:invoke fragment="header"/>
    </div>
    <div id="body">
      <jsp:doBody/>
    </div>
    <div id="pagefooter">
      <jsp:invoke fragment="footer"/>
    </div>
  </body>
</html>

To use this: 要使用它：

<%@page contentType="text/html" pageEncoding="UTF-8"%>
<%@taglib prefix="t" tagdir="/WEB-INF/tags" %>

<t:genericpage>
    <jsp:attribute name="header">
      <h1>Welcome</h1>
    </jsp:attribute>
    <jsp:attribute name="footer">
      <p id="copyright">Copyright 1927, Future Bits When There Be Bits Inc.</p>
    </jsp:attribute>
    <jsp:body>
        <p>Hi I'm the heart of the message</p>
    </jsp:body>
</t:genericpage>

What does that buy you? 这会给你带来什么？ A lot really, but it gets even better... 很多，但它变得更好......

WEB-INF/tags/userpage.tag

<%@tag description="User Page template" pageEncoding="UTF-8"%>
<%@taglib prefix="t" tagdir="/WEB-INF/tags" %>
<%@attribute name="userName" required="true"%>

<t:genericpage>
    <jsp:attribute name="header">
      <h1>Welcome ${userName}</h1>
    </jsp:attribute>
    <jsp:attribute name="footer">
      <p id="copyright">Copyright 1927, Future Bits When There Be Bits Inc.</p>
    </jsp:attribute>
    <jsp:body>
        <jsp:doBody/>
    </jsp:body>
</t:genericpage>

To use this: (assume we have a user variable in the request) 要使用它:(假设我们在请求中有一个用户变量）

<%@page contentType="text/html" pageEncoding="UTF-8"%>
<%@taglib prefix="t" tagdir="/WEB-INF/tags" %>

<t:userpage userName="${user.fullName}">
  <p>
    First Name: ${user.firstName} <br/>
    Last Name: ${user.lastName} <br/>
    Phone: ${user.phone}<br/>
  </p>
</t:userpage>

But it turns you like to use that user detail block in other places. 但它让你想在其他地方使用那个用户细节块。 So, we'll refactor it. 所以，我们将重构它。 WEB-INF/tags/userdetail.tag

<%@tag description="User Page template" pageEncoding="UTF-8"%>
<%@tag import="com.example.User" %>
<%@attribute name="user" required="true" type="com.example.User"%>

First Name: ${user.firstName} <br/>
Last Name: ${user.lastName} <br/>
Phone: ${user.phone}<br/>

Now the previous example becomes: 现在前面的例子变成了：

<%@page contentType="text/html" pageEncoding="UTF-8"%>
<%@taglib prefix="t" tagdir="/WEB-INF/tags" %>

<t:userpage userName="${user.fullName}">
  <p>
    <t:userdetail user="${user}"/>
  </p>
</t:userpage>

The beauty of JSP Tag files is that it lets you basically tag generic markup and then refactor it to your heart's content. JSP标记文件的优点在于它允许您基本标记通用标记，然后将其重构为您的内容。

JSP Tag Files have pretty much usurped things like Tiles etc., at least for me. JSP Tag Files有很多篡改像Tiles等的东西，至少对我而言。 I find them much easier to use as the only structure is what you give it, nothing preconceived. 我发现它们更容易使用，因为唯一的结构是你给它的，没有任何先入为主。 Plus you can use JSP tag files for other things (like the user detail fragment above). 另外，您可以将JSP标记文件用于其他内容（例如上面的用户详细信息片段）。

Here's an example that is similar to DisplayTag that I've done, but this is all done with Tag Files (and the Stripes framework, that's the s: tags..). 这是一个类似于我已经完成的DisplayTag的示例，但这都是使用Tag Files（以及Stripes框架，即s：tags ...）完成的。 This results in a table of rows, alternating colors, page navigation, etc: 这会产生一个行表，交替颜色，页面导航等：

<t:table items="${actionBean.customerList}" var="obj" css_class="display">
  <t:col css_class="checkboxcol">
    <s:checkbox name="customerIds" value="${obj.customerId}"
                onclick="handleCheckboxRangeSelection(this, event);"/>
  </t:col>
  <t:col name="customerId" title="ID"/>
  <t:col name="firstName" title="First Name"/>
  <t:col name="lastName" title="Last Name"/>
  <t:col>
    <s:link href="/Customer.action" event="preEdit">
      Edit
      <s:param name="customer.customerId" value="${obj.customerId}"/>
      <s:param name="page" value="${actionBean.page}"/>
    </s:link>
  </t:col>
</t:table>

Of course the tags work with the JSTL tags (like c:if , etc.). 当然，标签使用JSTL tags （如c:if等）。 The only thing you can't do within the body of a tag file tag is add Java scriptlet code, but this isn't as much of a limitation as you might think. 在标记文件标记的主体中唯一不能做的就是添加Java scriptlet代码，但这并不像你想象的那么多。 If I need scriptlet stuff, I just put the logic in to a tag and drop the tag in. Easy. 如果我需要scriptlet的东西，我只需将逻辑放入标签并将标签放入。容易。

So, tag files can be pretty much whatever you want them to be. 因此，标记文件可以是您想要的任何内容。 At the most basic level, it's simple cut and paste refactoring. 在最基本的层面上，它是简单的剪切和粘贴重构。 Grab a chunk of layout, cut it out, do some simple parameterization, and replace it with a tag invocation. 抓取一大块布局，将其剪切掉，进行一些简单的参数化，然后用标签调用替换它。

At a higher level, you can do sophisticated things like this table tag I have here. 在更高的层次上，你可以做一些复杂的事情，比如我在这里的这个表格标签。

#6楼

I know this answer is coming years after the fact and there is already a great JSP answer by Will Hartung, but there is Facelets, they are even mentioned in the answers from the linked question in the original question. 我知道这个答案是在事实发生多年之后，Will Hartung已经有了很好的JSP答案，但是有Facelets，它们甚至在原始问题中的链接问题的答案中被提及。

Facelets SO tag description Facelets SO标签描述

Facelets is an XML-based view technology for the JavaServer Faces framework. Facelets是JavaServer Faces框架的基于XML的视图技术。 Designed specifically for JSF, Facelets is intended to be a simpler and more powerful alternative to JSP-based views. Facelets专为JSF设计，旨在成为基于JSP的视图的更简单，更强大的替代方案。 Initially a separate project, the technology was standardized as part of JSF 2.0 and Java-EE 6 and has deprecated JSP. 最初是一个单独的项目，该技术被标准化为JSF 2.0和Java-EE 6的一部分，并且已经弃用了JSP。 Almost all JSF 2.0 targeted component libraries do not support JSP anymore, but only Facelets. 几乎所有JSF 2.0目标组件库都不再支持JSP，而只支持Facelets。

Sadly the best plain tutorial description I found was on Wikipedia and not a tutorial site. 遗憾的是，我发现最好的简单教程描述是在维基百科上，而不是教程网站。 In fact the section describing templates even does along the lines of what the original question was asking for. 事实上，描述模板的部分甚至与原始问题所要求的一致。

Due to the fact that Java-EE 6 has deprecated JSP I would recommend going with Facelets despite the fact that it looks like there might be more required for little to no gain over JSP. 由于Java-EE 6已弃用JSP，我建议使用Facelets，尽管事实上看起来可能需要更多，而不是通过JSP获得。

xfxf996

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
JSP技巧使模板更容易？

At work I've been tasked with turning a bunch of HTML files into a simple JSP project. 在工作中，我的任务是将一
复制链接

扫一扫