• Stars
    star
    2,714
  • Rank 16,797 (Top 0.4 %)
  • Language
    Java
  • License
    Apache License 2.0
  • Created almost 12 years ago
  • Updated over 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Java agent that enables class reloading in a running JVM

Welcome to Spring-Loaded

What is Spring Loaded?

Spring Loaded is a JVM agent for reloading class file changes whilst a JVM is running. It transforms classes at loadtime to make them amenable to later reloading. Unlike 'hot code replace' which only allows simple changes once a JVM is running (e.g. changes to method bodies), Spring Loaded allows you to add/modify/delete methods/fields/constructors. The annotations on types/methods/fields/constructors can also be modified and it is possible to add/remove/change values in enum types.

Spring Loaded is usable on any bytecode that may run on a JVM, and is actually the reloading system used in Grails 2,3,4 (on java 8).

Installation

1.3.0 has now been released!

1.3.0 Enables support for Grails 4.0.4+ Running on Java 8 (Java 11 is not yet supported and is in Development)

1.2.6 snapshots are in this repo area (grab the most recently built .jar): repo.spring.io

The download is the agent jar and needs no further unpacking before use.

Running with reloading

java -javaagent:<pathTo>/springloaded-{VERSION}.jar -noverify SomeJavaClass

The verifier is being turned off because some of the bytecode rewriting stretches the meaning of some of the bytecodes - in ways the JVM doesn't mind but the verifier doesn't like. Once up and running what effectively happens is that any classes loaded from jar files (dependencies) are not treated as reloadable, whilst anything loaded from .class files on disk is made reloadable. Once loaded the .class file will be watched (once a second) and should a new version appear SpringLoaded will pick it up. Any live instances of that class will immediately see the new form of the object, the instances do not need to be discarded and recreated.

No doubt that raises a lot of questions and hopefully a proper FAQ will appear here shortly! But in the meantime, here are some basic Qs and As:

Q. Does it reload anything that might change in a class file? A. No, you can't change the hierarchy of a type. Also there are certain constructor patterns of usage it can't actually handle right now.

Q. With objects changing shape, what happens with respect to reflection? A. Reflection results change over time as the objects are reloaded. For example, modifying a class with a new method and calling getDeclaredMethods() after reloading has occurred will mean you see the new method in the results. But this does mean if you have existing caches in your system that stash reflective information assuming it never changes, those will need to be cleared after a reload.

Q. How do I know when a reload has occurred so I can clear my state? A. You can write a plugin that is called when reloads occur and you can then take the appropriate action. Create an implementation of ReloadEventProcessorPlugin and then register it via SpringLoadedPreProcessor.registerGlobalPlugin(plugin). (There are other ways to register plugins, which will hopefully get some documentation!)

Q. What's the state of the codebase? A. The technology is successfully being used by Grails for reloading. It does need some performance work and a few smacks with a refactoring hammer. It needs upgrading here and there to tolerate the invokedynamic instruction and associated new constant pool entries that arrived in Java 7.

Working with the code

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

Once cloned there will be some projects suitable for import into eclipse. The main project and some test projects. One of the test projects is an AspectJ project (containing both Java and AspectJ code), and one is a Groovy project. To compile these test projects in Eclipse you will need the relevant eclipse plugins:

AJDT: update site: https://download.eclipse.org/tools/ajdt/42/dev/update Groovy-Eclipse: update site: https://dist.springsource.org/snapshot/GRECLIPSE/e4.2/

After importing them you can run the tests. There are two kinds of tests, hand crafted and generated. Running all the tests including the generated ones can take a while. To run just the hand crafted ones supply this to the JVM when launching the tests:

-Dspringloaded.tests.generatedTests=false

NOTE: When running the tests you need to pass -noverify to the JVM also.

Two launch configurations are already included if you are importing these projects into eclipse, which run with or without the generated tests.

A gradle build script is included, run './gradlew build' to rebuild the agent - it will be created as something like: springloaded/build/libs/springloaded-1.3.0.BUILD-SNAPSHOT.jar

Can I contribute?

Sure! This is based on the original Spring Source Project work done by Andy Clement. As Spring was moving away from spring-loaded in favor of spring-dev-tools (a more basic alternative), Community efforts were made to update spring-loaded to work in more recent builds of Grails.

More Repositories

1

spring-boot

Spring Boot
Java
73,985
star
2

spring-framework

Spring Framework
Java
55,858
star
3

spring-security

Spring Security
Java
8,623
star
4

spring-petclinic

A sample Spring-based application
CSS
7,457
star
5

spring-data-examples

Spring Data Example Projects
Java
5,142
star
6

spring-authorization-server

Spring Authorization Server
Java
4,799
star
7

spring-data-jpa

Simplifies the development of creating a JPA-based data access layer.
Java
2,951
star
8

spring-data-elasticsearch

Provide support to increase developer productivity in Java when using Elasticsearch. Uses familiar Spring concepts such as a template classes for core API usage and lightweight repository style data access.
Java
2,907
star
9

spring-ai

An Application Framework for AI Engineering
Java
2,808
star
10

spring-batch

Spring Batch is a framework for writing batch applications using Java and Spring
Java
2,661
star
11

spring-integration-samples

You are looking for examples, code snippets, sample applications for Spring Integration? This is the place.
Java
2,302
star
12

spring-kafka

Provides Familiar Spring Abstractions for Apache Kafka
Java
2,180
star
13

spring-retry

Java
2,128
star
14

spring-session

Spring Session
Java
1,853
star
15

spring-data-redis

Provides support to increase developer productivity in Java when using Redis, a key-value store. Uses familiar Spring concepts such as a template classes for core API usage and lightweight repository style data access.
Java
1,733
star
16

spring-data-mongodb

Provides support to increase developer productivity in Java when using MongoDB. Uses familiar Spring concepts such as a template classes for core API usage and lightweight repository style data access.
Java
1,593
star
17

spring-statemachine

Spring Statemachine is a framework for application developers to use state machine concepts with Spring.
Java
1,553
star
18

spring-integration

Spring Integration provides an extension of the Spring programming model to support the well-known Enterprise Integration Patterns (EIP)
Java
1,519
star
19

spring-graphql

Spring Integration for GraphQL
Java
1,509
star
20

spring-security-samples

Java
1,349
star
21

spring-restdocs

Test-driven documentation for RESTful services
Java
1,154
star
22

spring-hateoas

Spring HATEOAS - Library to support implementing representations for hyper-text driven REST web services.
Java
1,029
star
23

spring-data-rest

Simplifies building hypermedia-driven REST web services on top of Spring Data repositories
Java
910
star
24

sts4

The next generation of tooling for Spring Boot, including support for Cloud Foundry manifest files, Concourse CI pipeline definitions, BOSH deployment manifests, and more... - Available for Eclipse, Visual Studio Code, and Theia
Java
862
star
25

spring-net

Spring Framework for .NET
C#
843
star
26

spring-cloud

Umbrella project for Spring Cloud
821
star
27

spring-data-neo4j

Provide support to increase developer productivity in Java when using Neo4j. Uses familiar Spring concepts such as a template classes for core API usage and lightweight repository style data access.
Java
820
star
28

spring-amqp

Spring AMQP - support for Spring programming model with AMQP, especially but not limited to RabbitMQ
Java
796
star
29

spring-data-commons

Spring Data Commons. Interfaces and code shared between the various datastore specific implementations.
Java
757
star
30

spring-data-relational

Spring Data Relational. Home of Spring Data JDBC and Spring Data R2DBC.
Java
742
star
31

spring-modulith

Modular applications with Spring Boot
Java
741
star
32

spring-shell

Spring based shell
Java
712
star
33

spring-data-r2dbc

Provide support to increase developer productivity in Java when using Reactive Relational Database Connectivity. Uses familiar Spring concepts such as a DatabaseClient for core API usage and lightweight repository style data access.
708
star
34

spring-amqp-samples

Samples for Spring AMQP
Java
588
star
35

spring-plugin

Java
438
star
36

spring-webflow-samples

CSS
411
star
37

spring-hateoas-examples

Collection of examples on how (and why) to build hypermedia-driven apps with Spring HATEOAS
Java
375
star
38

spring-data-cassandra

Provides support to increase developer productivity in Java when using Apache Cassandra. Uses familiar Spring concepts such as a template classes for core API usage and lightweight repository style data access.
Java
374
star
39

spring-ldap

Spring LDAP
Java
341
star
40

spring-webflow

Spring Web Flow
Java
324
star
41

spring-ws

Spring Web Services
Java
316
star
42

spring-flo

JavaScript angular based embeddable graphical component for pipeline/graph building and editing
TypeScript
301
star
43

spring-vault

Provides familiar Spring abstractions for HashiCorp Vault
Java
280
star
44

spring-integration-extensions

The Spring Integration Extensions project provides extension components for Spring Integration
Java
279
star
45

spring-data-couchbase

Provides support to increase developer productivity in Java when using Couchbase. Uses familiar Spring concepts such as a template classes for core API usage and lightweight repository style data access.
Java
273
star
46

spring-data-envers

Envers extension of the Spring Data JPA module
262
star
47

spring-batch-extensions

Spring Batch Extensions
Java
241
star
48

spring-integration-aws

Java
209
star
49

spring-pulsar

Spring Friendly Abstractions for Apache Pulsar
Java
183
star
50

spring-security-kerberos

Spring Security Kerberos
Java
179
star
51

spring-guice

Tools for using Spring in Guice and Guice in Spring
Java
172
star
52

spring-ws-samples

Java
147
star
53

gradle-plugins

Gradle plugins for use in building and publishing open-source Spring projects, e.g. Spring Framework, Spring Integration
Groovy
139
star
54

spring-data-keyvalue

Project to provide infrastructure to implement Spring Data repositories on top of key-value-based, in-memory data stores.
Java
133
star
55

spring-data-build

Modules to centralize common resources and configuration for Spring Data Maven builds.
Shell
100
star
56

spring-data-gemfire

Spring Data integration for Pivotal GemFire
Java
99
star
57

spring-cli

A CLI focused on developer productivity
Java
94
star
58

spring-data

Spring Data
87
star
59

spring-data-ldap

Repository abstraction for Spring LDAP
Java
66
star
60

spring-aot-smoke-tests

Smoke tests for Spring's AOT and native support
Java
51
star
61

spring-data-geode

Spring Data support for Apache Geode
Java
50
star
62

spring-session-data-mongodb

Spring Session for MongoDB
Java
47
star
63

spring-boot-data-geode

Spring Boot support for Apache Geode and VMware GemFire
Java
44
star
64

spring-data-dev-tools

A collection of tools to support Spring Data development.
Java
41
star
65

spring-restdocs-samples

JavaScript
32
star
66

spring-session-bom

Spring Session Bill of Materials
Java
32
star
67

spring-credhub

Spring abstractions for Cloud Foundry CredHub
Java
26
star
68

spring-lifecycle-smoke-tests

Java
26
star
69

spring-integration-splunk

Java
22
star
70

spring-test-data-geode

A Spring-based Test Framework supporting Unit and Integration testing for Spring Boot applications using Spring Data with either Apache Geode or VMware Tanzu GemFire
Java
21
star
71

spring-session-data-geode

Spring Session support for Apache Geode and VMware Tanzu GemFire
Java
20
star
72

spring-data-bom

Spring Data Bill of Materials
18
star
73

security-advisories

Report a Spring CVE
17
star
74

spring-session-data-mongodb-examples

Java
16
star
75

eclipse-integration-tcserver

Eclipse Integration for vFabric tc Server
Java
15
star
76

spring-graphql-examples

Spring for GraphQL Examples
Java
11
star
77

spring-integration-flow

Java
10
star
78

gh-pages

Shared gh-pages content for Spring projects
JavaScript
8
star
79

spring-data-release

Command-line application to ship Spring Data releases
Java
7
star
80

.github

7
star
81

spring-rewrite-commons

Java
6
star