What’s the difference between including files with JSP include directive, JSP include action and using JSP Tag Files?

by

Overview of JSP Syntax Elements

First, to make things more clear, here is a short overview of JSP syntax elements:

  • Directives: These convey information regarding the JSP page as a
    whole.
  • Scripting elements: These are Java coding elements such as
    declarations, expressions, scriptlets, and comments.
  • Objects and scopes: JSP objects can be created either explicitly or
    implicitly and are accessible within a given scope, such as from
    anywhere in the JSP page or the session.
  • Actions: These create objects or affect the output stream in the JSP
    response (or both).

How content is included in JSP

There are several mechanisms for reusing content in a JSP file.

The following 4 mechanisms to include content in JSP can be categorized as direct reuse:
(for the first 3 mechanisms quoting from “Head First Servlets and JSP”)

1) The include directive:

<%@ include file="header.html" %>

Static: adds the content from the value of the file attribute to the current page at translation time. The directive was
originally intended for static layout templates, like HTML headers.

2) The <jsp:include> standard action:

<jsp:include page="header.jsp" />

Dynamic: adds the content from the value of the page attribute to the current page at request time. Was intended more for dynamic
content coming from JSPs.

3) The <c:import> JSTL tag:

<c:import url=”http://www.example.com/foo/bar.html” />

Dynamic: adds the content from the value of the URL attribute to the current page, at request time. It works a lot like
<jsp:include>, but it’s more powerful and flexible: unlike the
other two includes, the <c:import> URL can be from outside the
web Container!

4) Preludes and codas:

Static: preludes and codas can be applied only to the beginnings and ends of pages.
You can implicitly include preludes (also called headers) and codas
(also called footers) for a group of JSP pages by adding
<include-prelude> and <include-coda> elements respectively within
a <jsp-property-group> element in the Web application web.xml deployment descriptor.

Read more here:
• Configuring Implicit Includes at the Beginning and End of JSPs
• Defining implicit includes

Tag File is an indirect method of content reuse, the way of encapsulating reusable content.
A Tag File is a source file that contains a fragment of JSP code that is reusable as a custom tag.

The PURPOSE of includes and Tag Files is different.

Tag file (a concept introduced with JSP 2.0) is one of the options for creating custom tags. It’s a faster and easier way to build custom tags.
Custom tags, also known as tag extensions, are JSP elements that allow custom logic and output provided by other Java components to be inserted into JSP pages. The logic provided through a custom tag is implemented by a Java object known as a tag handler.

Some examples of tasks that can be performed by custom tags include operating on implicit objects, processing forms, accessing databases and other enterprise services such as email and directories, and implementing flow control.

Regarding your Edit

Maybe in your example (in your “Edit” paragraph), there is no difference between using direct include and a Tag File. But custom tags have a rich set of features. They can

  • Be customized by means of attributes passed from the calling page.

  • Pass variables back to the calling page.

  • Access all the objects available to JSP pages.

  • Communicate with each other. You can create and initialize a JavaBeans component, create a public EL variable that refers to that bean in one tag, and then use the bean in another tag.

  • Be nested within one another and communicate by means of private variables.

Also read this from “Pro JSP 2”: Understanding JSP Custom Tags.

Useful reading.

Conclusion

Use the right tools for each task.

Use Tag Files as a quick and easy way of creating custom tags that can help you encapsulate reusable content.

As for the including content in JSP (quote from here):

  • Use the include directive if the file changes rarely. It’s the fastest mechanism. If your container doesn’t automatically detect changes, you can force the changes to take effect by deleting the main page class file.
  • Use the include action only for content that changes often, and if which page to include cannot be decided until the main page is requested.

More Related Contents:

  1. Can not find the tag library descriptor of springframework
  2. How to loop through a HashMap in JSP?
  3. JSP tricks to make templating easier?
  4. How can I avoid Java code in JSP files, using JSP 2?
  5. ResultSet to Pagination
  6. Java error: Only a type can be imported. XYZ resolves to a package
  7. Struts 2 : There is no Action mapped for namespace [/]
  8. Sharing session data between contexts in Tomcat
  9. Execute JSP directly from Java
  10. How can I escape special HTML characters in JSP?
  11. JSP – What is wrong with scriptlets, and what to use instead [duplicate]
  12. What is the difference between and ? [duplicate]
  13. Retrieving servlet context, session and request in a POJO outside container
  14. Java HttpServletRequest get URL in browsers URL bar
  15. Capture generated dynamic content at server side
  16. Why did Servlet.service() for servlet jsp throw this exception?
  17. IntelliJ and JSP/JSTL cannot resolve taglib for JSTL in tomcat7 [duplicate]
  18. How to resolve : Can not find the tag library descriptor for “http://java.sun.com/jsp/jstl/core” [duplicate]
  19. UTF-8 encoding in JSP page [duplicate]
  20. How do I include a JSP file from a different project into my project
  21. Is there a way to redirect to another Action class without using on struts.xml
  22. Displaying pdf in jsp
  23. How to pass a value from one jsp to another jsp page?
  24. JSP : JSTL’s tag
  25. Resultset To List
  26. Struts 2 dynamic variables
  27. Populating one select menu based on another select menu using AJAX in Struts2
  28. Accessing Spring beans from a Tiles view (JSP)
  29. Iterate ArrayList in JSP
  30. Retrieving cookie and array values in JSTL tags

Leave a Comment