Awesome Open Source
Awesome Open Source

Spring PetClinic Sample Application

Build Status Quality Gate Status Coverage

Approved by the Spring team, this repo is a fork of the spring-projects/spring-petclinic. It allows the Spring community to maintain a Petclinic version with a plain old Spring Framework configuration and with a 3-layer architecture (i.e. presentation --> service --> repository). The "canonical" implementation is now based on Spring Boot, Thymeleaf and aggregate-oriented domain.

Understanding the Spring Petclinic application with a few diagrams

See the presentation here (2017 update)

Running petclinic locally

With Maven command line

git clone https://github.com/spring-petclinic/spring-framework-petclinic.git
cd spring-framework-petclinic
./mvnw jetty:run-war
# For Windows : ./mvnw.cmd jetty:run-war

With Docker

docker run -p 8080:8080 springcommunity/spring-framework-petclinic

You can then access petclinic here: http://localhost:8080/

petclinic-screenshot

In case you find a bug/suggested improvement for Spring Petclinic

Our issue tracker is available here: https://github.com/spring-petclinic/spring-framework-petclinic/issues

Database configuration

In its default configuration, Petclinic uses an in-memory database (H2) which gets populated at startup with data.

A similar setups is provided for MySQL and PostgreSQL in case a persistent database configuration is needed. To run petclinic locally using persistent database, it is needed to run with profile defined in main pom.xml file.

For MySQL database, it is needed to run with 'MySQL' profile defined in main pom.xml file.

./mvnw jetty:run-war -P MySQL

Before do this, would be good to check properties defined in MySQL profile inside pom.xml file.

<properties>
    <jpa.database>MYSQL</jpa.database>
    <jdbc.driverClassName>com.mysql.cj.jdbc.Driver</jdbc.driverClassName>
    <jdbc.url>jdbc:mysql://localhost:3306/petclinic?useUnicode=true</jdbc.url>
    <jdbc.username>petclinic</jdbc.username>
    <jdbc.password>petclinic</jdbc.password>
</properties>

You could start MySQL locally with whatever installer works for your OS, or with docker:

docker run -e MYSQL_USER=petclinic -e MYSQL_PASSWORD=petclinic -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=petclinic -p 3306:3306 mysql:5.7.8

For PostgreSQL database, it is needed to run with 'PostgreSQL' profile defined in main pom.xml file.

./mvnw jetty:run-war -P PostgreSQL

Before do this, would be good to check properties defined in PostgreSQL profile inside pom.xml file.

<properties>
    <jpa.database>POSTGRESQL</jpa.database>
    <jdbc.driverClassName>org.postgresql.Driver</jdbc.driverClassName>
    <jdbc.url>jdbc:postgresql://localhost:5432/petclinic</jdbc.url>
    <jdbc.username>postgres</jdbc.username>
    <jdbc.password>petclinic</jdbc.password>
</properties>

You could also start PostgreSQL locally with whatever installer works for your OS, or with docker:

docker run --name postgres-petclinic -e POSTGRES_PASSWORD=petclinic -e POSTGRES_DB=petclinic -p 5432:5432 -d postgres:9.6.0

Persistence layer choice

The persistence layer habve 3 available implementations: JPA (default), JDBC and Spring Data JPA. The default JPA implementation could be changed by using a Spring profile: jdbc, spring-data-jpa and jpa.
As an example, you may use the -Dspring.profiles.active=jdbc VM options to start the application with the JDBC implementation.

./mvnw jetty:run-war -Dspring.profiles.active=jdbc

Working with Petclinic in your IDE

Prerequisites

The following items should be installed in your system:

Steps:

  1. On the command line
git clone https://github.com/spring-petclinic/spring-framework-petclinic.git
  1. Inside Eclipse or STS
File -> Import -> Maven -> Existing Maven project

Then either build on the command line ./mvnw generate-resources or using the Eclipse launcher (right click on project and Run As -> Maven install) to generate the CSS. Configure a Jetty or a Tomcat web container then deploy the spring-petclinic.war file.

  1. Inside IntelliJ IDEA

In the main menu, select File > Open and select the Petclinic pom.xml. Click on the Open button.

CSS files are generated from the Maven build. You can either build them on the command line ./mvnw generate-resources or right click on the spring-petclinic project then Maven -> Generates sources and Update Folders.

Go to the Run -> Edit Configuration then configure a Tomcat or a Jetty web container. Deploy the spring-petclinic.war file. Run the application by clicking on the Run icon.

  1. Navigate to Petclinic

Visit http://localhost:8080 in your browser.

Working with Petclinic in IntelliJ IDEA

prerequisites

The following items should be installed in your system:

Looking for something in particular?

Java Config
Java config branch Petclinic uses XML configuration by default. In case you'd like to use Java Config instead, there is a Java Config branch available here
Inside the 'Web' layer Files
Spring MVC - XML integration mvc-view-config.xml
Spring MVC - ContentNegotiatingViewResolver mvc-view-config.xml
JSP custom tags WEB-INF/tags, createOrUpdateOwnerForm.jsp
JavaScript dependencies JavaScript libraries are declared as webjars in the pom.xml
Static resources config Resource mapping in Spring configuration
Static resources usage htmlHeader.tag, footer.tag
Thymeleaf In the late 2016, the original Spring Petclinic has moved from JSP to Thymeleaf.
'Service' and 'Repository' layers Files
Transactions business-config.xml, ClinicServiceImpl.java
Cache tools-config.xml, ClinicServiceImpl.java
Bean Profiles business-config.xml, ClinicServiceJdbcTests.java, PetclinicInitializer.java
JDBC business-config.xml, jdbc folder
JPA business-config.xml, jpa folder
Spring Data JPA business-config.xml, springdatajpa folder

Publishing a Docker image

This application uses Google Jib to build an optimized Docker image into the Docker Hub repository. The pom.xml has been configured to publish the image with a the springcommunity/spring-framework-petclinic image name.

Jib containerizes this WAR project by using the distroless Jetty as a base image.

Build and push the container image of Petclinic to the Docker Hub registry:

mvn jib:build

Interesting Spring Petclinic forks

The Spring Petclinic master branch in the main spring-projects GitHub org is the "canonical" implementation, currently based on Spring Boot and Thymeleaf.

This spring-framework-petclinic project is one of the several forks hosted in a special GitHub org: spring-petclinic. If you have a special interest in a different technology stack that could be used to implement the Pet Clinic then please join the community there.

Interaction with other open source projects

One of the best parts about working on the Spring Petclinic application is that we have the opportunity to work in direct contact with many Open Source projects. We found some bugs/suggested improvements on various topics such as Spring, Spring Data, Bean Validation and even Eclipse! In many cases, they've been fixed/implemented in just a few days. Here is a list of them:

Name Issue
Spring JDBC: simplify usage of NamedParameterJdbcTemplate SPR-10256 and SPR-10257
Bean Validation / Hibernate Validator: simplify Maven dependencies and backward compatibility HV-790 and HV-792
Spring Data: provide more flexibility when working with JPQL queries DATAJPA-292
Dandelion: improves the DandelionFilter for Jetty support 113

Contributing

The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests.

For pull requests, editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at http://editorconfig.org.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
java (30,349
mysql (976
spring (494
maven (167
spring-mvc (118
sample (106
hibernate (83
jpa (82
tomcat (62
spring-data-jpa (55
springframework (23
jetty (16

Find Open Source By Browsing 7,000 Topics Across 59 Categories