danjee / hedgehog

Sting your regular non container-managed java classes with Spring, Guice and Weld CDI beans

Hedgehog

Hedgehog is a Spring, Guice and Weld CDI bean injector in non-managed business java classes.

Inspired from Wicket injectors

Project site: https://danjee.github.io/hedgehog/

Use it if you want to inject some managed components in legacy classes or classes that you simple do not want to have it managed like Swing or JavaFX panels.

Usage sample:

Spring

Use the maven dependency:

<dependency>
	<groupId>ro.fortsoft</groupId>
	<artifactId>hedgehog-spring</artifactId>
	<version>0.0.3</version>
</dependency>

The configuration class, with a sample bean that gets initialized here:

@Configuration
@ComponentScan(basePackages = "ro.fortsoft.beans")
public class AppConfig {

	@Bean
	public Child getChild(){
		return new Child();
	}

}

The bean definition:

@Component
public class Child {
	@Override
	public String toString() {
		return "I'm a child";
	}
}

A business panel (non managed bean), this can be any of your legacy classes that you do not want to add them to Spring management:

public class Panel {

	@Sting
	private Child child;
	
	public Panel(){
		Stinger.get().sting(this);
	}
	
	public void test() {
		System.out.println(child);
	}
}

Main class could look like this:

public class App implements StingAwareApplication {

	private MetaDataEntry<Stinger>[] metaData;

	public static void main(String[] args) {
		AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);
		SpringComponentStinger stinger = new SpringComponentStinger(context);
		App app = new App();
		stinger.bind(app);
		Panel panel = new Panel();
		panel.test();
	}

	public Stinger getMetaData(MetaDataKey<Stinger> key) {
        return key.get(metaData);
    }

    public void setMetaData(final MetaDataKey<Stinger> key, final Stinger object) {
        metaData = key.set(metaData, object);
    }
}

Guice

Use the maven dependency:

<dependency>
	<groupId>ro.fortsoft</groupId>
	<artifactId>hedgehog-guice</artifactId>
	<version>0.0.3</version>
</dependency>

The Guice module class:

public class GuiceModule extends AbstractModule {

	@Override
	protected void configure() {
		bind(ContactService.class).to(InMemoryContactService.class).asEagerSingleton();
	}
}

The beans (interface and implementation):

public interface ContactService {
	
	String add(String word);
	
	void modify(String word);
	
	void delete(String word);
}

public class InMemoryContactService implements ContactService {

	public String add(String word) {
		// TODO Auto-generated method stub
		return null;
	}

	public void modify(String word) {
		// TODO Auto-generated method stub
		
	}

	public void delete(String word) {
		// TODO Auto-generated method stub
		
	}
}

A business panel (non managed bean). This could be any of your java classes that you do not want Guice to be aware of them

public class Panel {

	@Sting
	private ContactService contactService;
	
	public Panel(){
		Stinger.get().sting(this);
	}
	
	public void test(){
		System.out.println(contactService);
	}
}

Main class

public class App implements StingAwareApplication {
	
	private MetaDataEntry<Stinger>[] metaData;
	
	public static void main(String[] args) {
		 Injector injector = Guice.createInjector(new GuiceModule());
		 GuiceComponentsStinger stinger = new GuiceComponentsStinger(injector);
		 App app = new App();
		 stinger.bind(app);
		 Panel panel = new Panel();
		 panel.test();
	}

	public Stinger getMetaData(MetaDataKey<Stinger> key) {
        return key.get(metaData);
    }

    public void setMetaData(final MetaDataKey<Stinger> key, final Stinger object) {
        metaData = key.set(metaData, object);
    }
}

Weld

Use the maven dependency:

<dependency>
	<groupId>ro.fortsoft</groupId>
	<artifactId>hedgehog-weld</artifactId>
	<version>0.0.3</version>
</dependency>

The service class to be injected

public class Child {
	@Override
	public String toString() {
		return "I'm a child";
	}
}

A business panel (non managed bean)

public class Panel {

	@Sting
	private Child child;
	
	public Panel(){
		Stinger.get().sting(this);
	}
	
	public void test() {
		System.out.println(child);
	}
}

Main class, this should print the I'm a child because the injection succeeded:

public class Main implements StingAwareApplication {

	private MetaDataEntry<Stinger>[] metaData;

	public static void main(String[] args) {
		Weld weld = new Weld();
		WeldContainer container = weld.initialize();

		WeldComponentStinger stinger = new WeldComponentStinger(container);
		Main mainApp = new Main();
		stinger.bind(mainApp);
		Panel panel = new Panel();
		panel.test();
	}

	public Stinger getMetaData(MetaDataKey<Stinger> key) {
        return key.get(metaData);
    }

    public void setMetaData(final MetaDataKey<Stinger> key, final Stinger object) {
        metaData = key.set(metaData, object);
    }
}

Versioning

Hedgehog will be maintained under the Semantic Versioning guidelines as much as possible.

Releases will be numbered with the follow format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

• Breaking backward compatibility bumps the major
• New additions without breaking backward compatibility bumps the minor
• Bug fixes and misc changes bump the patch

For more information on SemVer, please visit http://semver.org.

Issues

Any issue or improvement idea is welcome, also pull-requests are happily accepted.

hedgehog's Issues

Cache the results

Cache the results

Proxy features

return the proxies