@@ -19,7 +19,7 @@ Intelligent Routing (Zuul) and Client Side Load Balancing (Ribbon).
...
@@ -19,7 +19,7 @@ Intelligent Routing (Zuul) and Client Side Load Balancing (Ribbon).
* Declarative REST Client: Feign creates a dynamic implementation of an interface decorated with JAX-RS or Spring MVC annotations
* Declarative REST Client: Feign creates a dynamic implementation of an interface decorated with JAX-RS or Spring MVC annotations
* Client Side Load Balancer: Ribbon
* Client Side Load Balancer: Ribbon
* External Configuration: a bridge from the Spring Environment to Archaius (enables native configuration of Netflix components using Spring Boot conventions)
* External Configuration: a bridge from the Spring Environment to Archaius (enables native configuration of Netflix components using Spring Boot conventions)
* Router and Filter: automatic regsitration of Zuul filters, and a simple convention over configuration approach to reverse proxy creation
* Router and Filter: automatic registration of Zuul filters, and a simple convention over configuration approach to reverse proxy creation
== Building
== Building
...
@@ -27,35 +27,47 @@ Intelligent Routing (Zuul) and Client Side Load Balancing (Ribbon).
...
@@ -27,35 +27,47 @@ Intelligent Routing (Zuul) and Client Side Load Balancing (Ribbon).
=== Basic Compile and Test
=== Basic Compile and Test
To build the source you will need to install
To build the source you will need to install JDK {jdkversion}.
http://maven.apache.org/run-maven/index.html[Apache Maven] v3.0.6 or above and JDK {jdkversion}.
Spring Cloud uses Maven for most build-related activities, and you
Spring Cloud uses Maven for most build-related activities, and you
should be able to get off the ground quite quickly by cloning the
should be able to get off the ground quite quickly by cloning the
project you are interested in and typing
project you are interested in and typing
----
----
$ mvn install -s .settings.xml
$ ./mvnw install
----
----
NOTE: You may need to increase the amount of memory available to Maven by setting
NOTE: You can also install Maven (>=3.3.3) yourself and run the `mvn` command
a `MAVEN_OPTS` environment variable with the value `-Xmx512m -XX:MaxPermSize=128m`
in place of `./mvnw` in the examples below. If you do that you also
might need to add `-P spring` if your local Maven settings do not
contain repository declarations for spring pre-release artifacts.
The `.settings.xml` is only required the first time (or after updates
NOTE: Be aware that you might need to increase the amount of memory
to dependencies). It is there to provide repository declarations so
available to Maven by setting a `MAVEN_OPTS` environment variable with
that those do not need to be hard coded in the project poms.
a value like `-Xmx512m -XX:MaxPermSize=128m`. We try to cover this in
the `.mvn` configuration, so if you find you have to do it to make a
build succeed, please raise a ticket to get the settings added to
source control.
For hints on how to build the project look in `.travis.yml` if there
For hints on how to build the project look in `.travis.yml` if there
is one. There should be a "script" and maybe "install" command. Also
is one. There should be a "script" and maybe "install" command. Also
look at the "services" section to see if any services need to be
look at the "services" section to see if any services need to be
running locally (e.g. mongo or rabbit). Ignore the git-related bits
running locally (e.g. mongo or rabbit). Ignore the git-related bits
that you might find in "before_install" since they will be able git
that you might find in "before_install" since they're related to setting git
credentials and you already have those.
credentials and you already have those.
If you need mongo, rabbit or redis, see the README in the https://github.com/spring-cloud-samples/scripts[scripts
The projects that require middleware generally include a
demo repository] for
`docker-compose.yml`, so consider using
instructions. For example consider using the "fig.yml" with
http://compose.docker.io/[Docker Compose] to run the middeware servers
http://www.fig.sh/[Fig] to run them in Docker containers.
agreement]. Signing the contributor's agreement does not grant anyone
commit rights to the main repository, but it does mean that we can
accept your contributions, and you will get an author credit if we do.
Active contributors might be asked to join the core team, and given
the ability to merge pull requests.
==== Code Conventions and Housekeeping
None of these is essential for a pull request, but they will all help. They can also be
added after the original pull request but before a merge.
* Use the Spring Framework code format conventions. If you use Eclipse and you follow
the ``Importing into eclipse'' instructions below you should get project specific
formatting automatically. You can also import formatter settings using the
`eclipse-code-formatter.xml` file from the `eclipse` folder. If using IntelliJ, you can
use the http://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter Plugin]
to import the same file.
* Make sure all new `.java` files to have a simple Javadoc class comment with at least an
`@author` tag identifying you, and preferably at least a paragraph on what the class is
for.
* Add the ASF license header comment to all new `.java` files (copy from existing files
in the project)
* Add yourself as an `@author` to the .java files that you modify substantially (more
than cosmetic changes).
* Add some Javadocs and, if you change the namespace, some XSD doc elements.
* A few unit tests would help a lot as well -- someone has to do it.
* If no-one else is using your branch, please rebase it against the current master (or
other target branch in the main project).
=== Working with the code
=== Working with the code
If you don't have an IDE preference we would recommend that you use
If you don't have an IDE preference we would recommend that you use
http://www.springsource.com/developer/sts[Spring Tools Suite] or
http://www.springsource.com/developer/sts[Spring Tools Suite] or
...
@@ -120,13 +92,25 @@ We recommend the http://eclipse.org/m2e/[m2eclipe] eclipse plugin when working w
...
@@ -120,13 +92,25 @@ We recommend the http://eclipse.org/m2e/[m2eclipe] eclipse plugin when working w
eclipse. If you don't already have m2eclipse installed it is available from the "eclipse
eclipse. If you don't already have m2eclipse installed it is available from the "eclipse
marketplace".
marketplace".
Unfortunately m2e does not yet support Maven 3.3, so once the projects
are imported into Eclipse you will also need to tell m2eclipse to use
the `.settings.xml` file for the projects. If you do not do this you
may see errors many different errors related to the POMs in the
projects. Open your Eclipse preferences, expand the Maven
preferences, and select User Settings. In the User Settings field
click Browse and navigate to the Spring Cloud project you imported
selecting the `.settings.xml` file in that project. Click Apply and
then OK to save the preference changes.
NOTE: Alternatively you can copy the repository settings from https://github.com/spring-cloud/spring-cloud-build/blob/master/.settings.xml[`.settings.xml`] into your own `~/.m2/settings.xml`.
==== Importing into eclipse without m2eclipse
==== Importing into eclipse without m2eclipse
If you prefer not to use m2eclipse you can generate eclipse project metadata using the
If you prefer not to use m2eclipse you can generate eclipse project metadata using the
following command:
following command:
[indent=0]
[indent=0]
----
----
$ mvn eclipse:eclipse
$ ./mvnw eclipse:eclipse
----
----
The generated eclipse projects can be imported by selecting `import existing projects`
The generated eclipse projects can be imported by selecting `import existing projects`
...
@@ -134,9 +118,8 @@ from the `file` menu.
...
@@ -134,9 +118,8 @@ from the `file` menu.
==== Adding Project Lombok Agent
==== Adding Project Lombok Agent
Spring Cloud uses [Project
Spring Cloud uses http://projectlombok.org/features/index.html[Project Lombok]
Lombok](http://projectlombok.org/features/index.html) to generate
to generate getters and setters etc. Compiling from the command line this
getters and setters etc. Compiling from the command line this
shouldn't cause any problems, but in an IDE you need to add an agent
shouldn't cause any problems, but in an IDE you need to add an agent
to the JVM. Full instructions can be found in the Lombok website. The
to the JVM. Full instructions can be found in the Lombok website. The
sign that you need to do this is a lot of compiler errors to do with
sign that you need to do this is a lot of compiler errors to do with
...
@@ -158,9 +141,11 @@ Maven is well supported by most Java IDEs. Refer to you vendor documentation.
...
@@ -158,9 +141,11 @@ Maven is well supported by most Java IDEs. Refer to you vendor documentation.
== Contributing
== Contributing
Spring Cloud is released under the non-restrictive Apache 2.0 license. If you would like
Spring Cloud is released under the non-restrictive Apache 2.0 license,
to contribute something, or simply want to hack on the code this document should help
and follows a very standard Github development process, using Github
you get started.
tracker for issues and merging pull requests into master. If you want
to contribute even something trivial please do not hesitate, but
follow the guidelines below.
=== Sign the Contributor License Agreement
=== Sign the Contributor License Agreement
Before we accept a non-trivial patch or pull request we will need you to sign the
Before we accept a non-trivial patch or pull request we will need you to sign the
