eclipsejsfstructureprojects

Structure for multiple JSF projects with shared code

I have two JSF projects that share a lot of code - java classes, xhtml files, tag libraries, css and javascript files etc. My dev environment/platform consists mainly of Eclipse, Ant, Perforce and Tomcat.

Has anyone found a way to create and organize the shared code so that the common code can stay within one set of folders?

Eclipse makes it easy to add external folders for java sources, but falls short on the other file types. I'd appreciate any ideas.

Solution

  • Create a new "Java Project" in Eclipse. Add it as another project to the Deployment Assembly property of the main dynamic web project. This way it will automatically end up as a JAR in /WEB-INF/lib of the build of the web project. Since newer Eclipse versions, you can also create the project as "Web Fragment Project". This way the Deployment Assembly step will be done automatically.

    Put all those shared resource files in /META-INF/resources folder of the Java project. Just treat it like WebContent/resources of the main web project. Tagfiles can just be kept in their own /META-INF/tags folder.

    E.g.

    CommonWebProject
 |-- META-INF
 |    |-- resources
 |    |    `-- common
 |    |         |-- css
 |    |         |    `-- some.css
 |    |         |-- js
 |    |         |    `-- some.js
 |    |         |-- images
 |    |         |    `-- some.png
 |    |         |-- components
 |    |         |    `-- somecomposite.xhtml
 |    |         `-- sometemplate.xhtml
 |    |-- tags
 |    |    `-- sometag.xhtml
 |    |-- beans.xml
 |    |-- faces-config.xml
 |    |-- some.taglib.xml
 |    |-- web-fragment.xml
 |    `-- MANIFEST.MF
 :

    with

    <h:outputStylesheet library="common" name="css/some.css" />
<h:outputScript library="common" name="js/some.js" />
<h:graphicImage library="common" name="images/some.png" />
<common:somecomposite />
<common:sometag />
<ui:include src="/common/sometemplate.xhtml" />
...

    In case you're using Maven, the /META-INF folder has to be placed in src/main/resources and thus NOT src/main/java!

    If you want to trigger the Faces annotation scanner as well so that you can put @FacesValidator, @FacesConverter, @FacesComponent, @FacesRenderer and consorts in that project as well, then create a /META-INF/faces-config.xml file as well. Below is a Faces 4.0 compatible one:

    <?xml version="1.0" encoding="UTF-8"?>
<faces-config
    xmlns="https://jakarta.ee/xml/ns/jakartaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee https://jakarta.ee/xml/ns/jakartaee/web-facesconfig_4_0.xsd"
    version="4.0">
    <!-- Put shared faces-config.xml config here. -->
</faces-config>

    The /META-INF/web-fragment.xml file is mandatory for the JAR to be recognized by the servletcontainer as a "Web Fragment Project" so that it will automatically search and register any @WebServlet, @WebFilter and @WebListener classes as well. It should already be generated by your IDE, but for sake of completeness here is how it should look like for a Servlet 6.0 compatible one:

    <?xml version="1.0" encoding="utf-8"?>
<web-fragment 
    xmlns="https://jakarta.ee/xml/ns/jakartaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee https://jakarta.ee/xml/ns/jakartaee/web-fragment_6_0.xsd"
    version="6.0">
    <!-- Put shared web.xml config here. -->
</web-fragment>

    That's all.

    Real world examples can be found in OmniFaces and OptimusFaces projects.

    See also: