Spring PetClinic Sample Application

Understanding the Spring Petclinic application with a few diagrams

See the presentation here

Running petclinic locally

	git clone https://github.com/spring-projects/spring-petclinic.git
	cd spring-petclinic
	./mvnw tomcat7:run

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

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

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

Database configuration

In its default configuration, Petclinic uses an in-memory database (HSQLDB) which gets populated at startup with data. A similar setup is provided for MySql in case a persistent database configuration is needed. To run petclinic locally using MySQL database, it is needed to run with 'MYSQL' profile defined in main pom.xml file.

    ./mvnw tomcat7:run -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.jdbc.Driver</jdbc.driverClassName>
        <jdbc.url>jdbc:mysql://localhost:3306/petclinic?useUnicode=true</jdbc.url>
        <jdbc.username>root</jdbc.username>
        <jdbc.password>petclinic</jdbc.password>
    </properties>

You may start a MySql database with docker:

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

Working with Petclinic in Eclipse/STS

prerequisites

The following items should be installed in your system:

• Maven 3 (http://www.sonatype.com/books/mvnref-book/reference/installation.html)
• git command line tool (https://help.github.com/articles/set-up-git)
• Eclipse with the m2e plugin (m2e is installed by default when using the STS (http://www.springsource.org/sts) distribution of Eclipse)

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://eclipse.org/m2e/download/

Steps:

1. In the command line

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

2. Inside Eclipse

File -> Import -> Maven -> Existing Maven project

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. Thanks to Antoine Rey for his contribution.
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
Bower	bower-install maven profile declaration inside pom.xml JavaScript libraries are defined by the manifest file bower.json Bower configuration using JSON Resource mapping in Spring configuration sample usage in JSP
Thymeleaf branch	See here
Branch using GemFire and Spring Data GemFire instead of ehcache (thanks Bijoy Choudhury)	See here

'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
JdbcTemplate	business-config.xml jdbc folder
JPA	business-config.xml jpa folder
Spring Data JPA	business-config.xml springdatajpa folder

Others	Files
Spring Boot branch (with JSP)	See here
Angular JS and Spring Boot branch	See here
ReactJS and Spring Boot branch	See here
Gradle branch	See here

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
Eclipse: validation bug when working with .tag/.tagx files (has only been fixed for Eclipse 4.3 (Kepler)). See here for more details.	STS-3294

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.