3.9 KiB
GourmetJ application Architecture.
This is a Spring Boot self-hosted website built on standard JEE components like JavaServer Faces (JSF) and the Java Persistence Architecture (JPA). It is built and can be tested using Maven.
The Maven pom.xml file determines the build and what dependencies
it has. The core dependencies and their versions are determined
in the dependencyManagement section of the POM. Actual inclusion
of dependencies is done in the dependencies section.
Of the 3 dependencyManagement dependencies, the JoinFaces BOM is
the most important. It ensures that the proper version of Spring
Boot and its dependencies is brought into the dependencies as
well as allowing the option to select which JSF extension libraries
are to be used. For this project, PrimeFaces is the primary JSF
framework.
Source Code components
Source code files come in 4 major types:
- Spring/Spring Boot support
- JSF Backing Beans
- Data Persistence
- General Utilities (for example data format converters and parsers)
Spring and Spring Boot Support
The application code root package is com.mousetech.gourmetj. The
Spring configuration classes are located in this package. There
are two of them: SpringPrimeFacesApplication'java, which is the
main class for the app, and SpringSecurityConfig.java, which
defines security. Security credentials (userid/password) are taken
from an external password file whose location is defined by the
application.yml properties file. There are no security roles, and
all site pages are accessible without logging in except for the
ones that can modify the database (create/edit recipe).
Secondary Spring characteristics come from the WelcomePageRedirect.java
file which defines the site's welcome page (index.html).
A small bit of Spring Web in the springweb.PicureController class.
This Controller resolves the image URLs for recipe images and
thumbnails.
JSF BackingBeans
The heart of the webapp is in JavaServer Faces Backing Beans which provide the Models for their corresponding View Template (.xhtml) files. The most important beans are the adminMain bean, which generates the recipe list page and the recipeDetail bean, which back the display and editing of a recipe. The CookieBean is a utility class that allows keeping search information in user-side cookies between user sessions and JSFUtils allows access to HTTP/Servlet soecific resources in a way that isolates them from the general application code. That allows platform independence and easier unit testing.
Persistence
Persistence is done via JPA and has 3 layers:
-
Service layer. This layer fetches and updates "working sets" of related database entity objects. All service methods are Transactions. Working sets passed in or out of the service layer to the higher (business) layer of the app are detached objects, so the Service layer also ensures detaching and re-attaching (merging) as needed for the lower layer functions.
-
DAO layer. This layer does find/CRUD functions for a single Entity type or sometimes a parent/child Entity set. I've coded this using explicit logic in times past, but in this app, I've leveraged Spring's Repository feature to let it write the grunt code.
-
Model layer. This layer contains the actual Entity classes, which are all POJOs and have no executable logic except get/set.
Utilities
Most utility services are in the utils package, except for
JSFUtils, which serves as a liason between JSF server-independent
code and server platform-specific services.
Future considerations
There's probably still some lint in the POM and perhaps some dead code from deadend solutions that weren't viable. That's how apps are in the Real World.
Adding an I18N Bundle would probably be nice.
A Schema file was recently added to the project and it needs to
be checked for functionality. A similar data.sql is probably
needed to be able to fully set up a database from scratch. My
current copy was simply cloned from an existing database.