Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/spring-petclinic/spring-framework-petclinic

A Spring Framework application based on JSP, Spring MVC, Spring Data JPA, Hibernate and JDBC
https://github.com/spring-petclinic/spring-framework-petclinic
hibernate jetty jpa jsp maven mysql sample spring spring-data-jpa spring-mvc springframework tomcat
Last synced: 6 days ago
JSON representation
A Spring Framework application based on JSP, Spring MVC, Spring Data JPA, Hibernate and JDBC
Host: GitHub
URL: https://github.com/spring-petclinic/spring-framework-petclinic
Owner: spring-petclinic
License: apache-2.0
Created: 2016-11-15T07:50:57.000Z (about 8 years ago)
Default Branch: main
Last Pushed: 2025-01-01T12:19:35.000Z (20 days ago)
Last Synced: 2025-01-08T20:04:24.354Z (13 days ago)
Topics: hibernate, jetty, jpa, jsp, maven, mysql, sample, spring, spring-data-jpa, spring-mvc, springframework, tomcat
Language: Java
Homepage:
Size: 1.66 MB
Stars: 446
Watchers: 39
Forks: 2,230
Open Issues: 3
Metadata Files:
- Readme: readme.md
- License: LICENSE.txt
Awesome Lists containing this project

README

        # Spring PetClinic Sample Application

[![Java CI with Maven](https://github.com/spring-petclinic/spring-framework-petclinic/actions/workflows/maven-build.yml/badge.svg)](https://github.com/spring-petclinic/spring-framework-petclinic/actions/workflows/maven-build.yml)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=spring-petclinic_spring-framework-petclinic&metric=alert_status)](https://sonarcloud.io/dashboard?id=spring-petclinic_spring-framework-petclinic)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=spring-petclinic_spring-framework-petclinic&metric=coverage)](https://sonarcloud.io/dashboard?id=spring-petclinic_spring-framework-petclinic)

Approved by the Spring team, this repo is a fork of the [spring-projects/spring-petclinic](https://github.com/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]([https://github.com/spring-projects/spring-petclinic/pull/200). 

## Understanding the Spring Petclinic application with a few diagrams

[See the presentation here](http://fr.slideshare.net/AntoineRey/spring-framework-petclinic-sample-application) (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/](http://localhost:8080/)



## 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.

```

    MYSQL

    com.mysql.cj.jdbc.Driver

    jdbc:mysql://localhost:3306/petclinic?useUnicode=true

    petclinic

    petclinic

```      

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.

```

    POSTGRESQL

    org.postgresql.Driver

    jdbc:postgresql://localhost:5432/petclinic

    postgres

    petclinic

```

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 have 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

```

## Compiling the CSS

There is a `petclinic.css` in `src/main/webapp/resources/resources/css`. 

It was generated from the `petclinic.scss` source, combined with the [Bootstrap](https://getbootstrap.com/) library.

If you make changes to the `scss`, or upgrade Bootstrap, you will need to re-compile the CSS resources

using the Maven profile "css", i.e. `./mvnw generate-resources -P css`.

## Working with Petclinic in your IDE

### Prerequisites

The following items should be installed in your system:

* Java 17 or newer (full JDK not a JRE)

* Maven 3.5+ (https://maven.apache.org/install.html)

* git command line tool (https://help.github.com/articles/set-up-git)

* Jetty 11.0+ or Tomcat 10+

* Your prefered IDE 

  * Eclipse with the m2e plugin. Note: when m2e is available, there is an m2 icon in Help -> About dialog. If m2e is not there, just follow the install process here: http://www.eclipse.org/m2e/

  * [Spring Tools Suite](https://spring.io/tools) (STS)

  * IntelliJ IDEA

### Steps:

1) On the command line

```

git clone https://github.com/spring-petclinic/spring-framework-petclinic.git

```

2) 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.

3) Inside IntelliJ IDEA

In the main menu, select `File > Open` and select the Petclinic [pom.xml](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.

4) Navigate to Petclinic

Visit [http://localhost:8080](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](https://github.com/spring-petclinic/spring-framework-petclinic/tree/javaconfig) |

| Inside the 'Web' layer | Files |

|------------------------|-------|

| Spring MVC - XML integration | [mvc-view-config.xml](src/main/resources/spring/mvc-view-config.xml)  |

| Spring MVC - ContentNegotiatingViewResolver| [mvc-view-config.xml](src/main/resources/spring/mvc-view-config.xml) |

| JSP custom tags | [WEB-INF/tags](src/main/webapp/WEB-INF/tags), [createOrUpdateOwnerForm.jsp](src/main/webapp/WEB-INF/jsp/owners/createOrUpdateOwnerForm.jsp)|

| JavaScript dependencies | [JavaScript libraries are declared as webjars in the pom.xml](pom.xml) |

| Static resources config | [Resource mapping in Spring configuration](/src/main/resources/spring/mvc-core-config.xml#L30) |

| Static resources usage | [htmlHeader.tag](src/main/webapp/WEB-INF/tags/htmlHeader.tag), [footer.tag](src/main/webapp/WEB-INF/tags/footer.tag) |

| Thymeleaf | In the late 2016, the original [Spring Petclinic](https://github.com/spring-projects/spring-petclinic) has moved from JSP to Thymeleaf. |

| 'Service' and 'Repository' layers | Files |

|-----------------------------------|-------|

| Transactions | [business-config.xml](src/main/resources/spring/business-config.xml), [ClinicServiceImpl.java](src/main/java/org/springframework/samples/petclinic/service/ClinicServiceImpl.java) |

| Cache | [tools-config.xml](src/main/resources/spring/tools-config.xml), [ClinicServiceImpl.java](src/main/java/org/springframework/samples/petclinic/service/ClinicServiceImpl.java) |

| Bean Profiles | [business-config.xml](src/main/resources/spring/business-config.xml), [ClinicServiceJdbcTests.java](src/test/java/org/springframework/samples/petclinic/service/ClinicServiceJdbcTests.java), [PetclinicInitializer.java](src/main/java/org/springframework/samples/petclinic/PetclinicInitializer.java) |

| JDBC | [business-config.xml](src/main/resources/spring/business-config.xml), [jdbc folder](src/main/java/org/springframework/samples/petclinic/repository/jdbc) |

| JPA | [business-config.xml](src/main/resources/spring/business-config.xml), [jpa folder](src/main/java/org/springframework/samples/petclinic/repository/jpa) |

| Spring Data JPA | [business-config.xml](src/main/resources/spring/business-config.xml), [springdatajpa folder](src/main/java/org/springframework/samples/petclinic/repository/springdatajpa) |

## Publishing a Docker image

This application uses [Google Jib]([https://github.com/GoogleContainerTools/jib) to build an optimized Docker image

into the [Docker Hub](https://cloud.docker.com/u/springcommunity/repository/docker/springcommunity/spring-framework-petclinic/)

repository.

The [pom.xml](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](https://github.com/GoogleContainerTools/distroless/tree/master/java/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](https://github.com/spring-projects/spring-petclinic)

GitHub org is the "canonical" implementation, currently based on Spring Boot and Thymeleaf.

This [spring-framework-petclinic](https://github.com/spring-petclinic/spring-framework-petclinic) project is one of the [several forks](https://spring-petclinic.github.io/docs/forks.html) 

hosted in a special GitHub org: [spring-petclinic](https://github.com/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](https://github.com/spring-projects/spring-framework/issues/14889) and [SPR-10257](https://github.com/spring-projects/spring-framework/issues/14890) |

| Bean Validation / Hibernate Validator: simplify Maven dependencies and backward compatibility |[HV-790](https://hibernate.atlassian.net/browse/HV-790) and [HV-792](https://hibernate.atlassian.net/browse/HV-792) |

| Spring Data: provide more flexibility when working with JPQL queries | [DATAJPA-292](https://github.com/spring-projects/spring-data-jpa/issues/704) |

| Dandelion: improves the DandelionFilter for Jetty support | [113](https://github.com/dandelion/dandelion/issues/113) |

# Contributing

The [issue tracker](/issues) is the preferred channel for bug reports, features requests and submitting pull requests.

For pull requests, editor preferences are available in the [editor config](.editorconfig) for easy use in common text editors. Read more and download plugins at .