%20(2)%20(2).png)
ColdSpring was the first dependency injection framework for ColdFusion in the good 'ol days. It was inspired by Java Spring and it rocked during its tenure. As a matter of fact, there is still quite a large number of applications leveraging it, even though the framework itself is completely legacy, unsupported and might not even work on some versions of Adobe 2018+ as well. If you are in this technical debt boat and want a quick win and recover some ground in the technical debt war, then this tutorial is for you.
WireBox
WireBox is an enterprise ColdFusion Dependency Injection and Aspect Oriented Programing (AOP) framework. WireBox's inspiration has been based on the idea of rapid workflows when building object oriented ColdFusion applications, programmatic configurations and simplicity. With that motivation we introduced dependency injection by annotations and conventions, which has been the core foundation of WireBox.
WireBox is standalone framework for ColdFusion (CFML) applications and it is also bundled with the ColdBox Platform.
What's even more important its that WireBox is:
- Modern
- Professionally Supported
- Actively Maintained
- Widely Used
Installing WireBox into your legacy application is super easy using our CLI tool called CommandBox:
1 |
box install wirebox |
This command will download the latest version of WireBox and create a folder called wirebox for you. You can then maintain that dependeny or more using CommandBox.
1 2 |
// Creates wirebox and places it in application scope: application.wireboxnew wirebox.system.ioc.Injector(); |
Let's Convert!
If you have an application that leveraged ColdSpring for your dependency injection, you can easily port it to WireBox. The first step is converting the ColdSpring XML file to a WireBox Binder. This will translate 1-1 the bean configurations to WireBox configurations. After that, it's a matter of testing your objects and switching the references to the ColdSpring bean factory to application.wirebox.getInstance( "BeanName" ).
After that, you can decide if you want to keep the object configurations as is, or you can start refactoring them by using our conventions instead of configuration approach. Especially if you love annotations in your code.
ColdSpring XML to WireBox DSL
Make sure you have CommandBox CLI installed as we will be using it to convert our XML file to WireBox DSL. Now it's time to install our module that converts ColdSpring XML to WireBox DSL:
1 |
box install commandbox-coldspring-to-wirebox |
This will install the coldspring-to-wirebox command into your CLI. You can get help by issuing a coldspring-to-wirebox --help command. However, it's very easy to use:
1 2 3 4 5 |
# Produces a WireBox.cfc where you run the commandcoldspring-to-wirebox tests/coldspring.xml.cfm# Stores the WireBox.cfc in the same location as the file abovecoldspring-to-wirebox tests/coldspring.xml.cfm tests/WireBox.cfc |
That's it! This will convert all your definitions and you are ready to roll!
Test Your Binder
We can now instantiate a new instance of WireBox with this Binder and use it!
1 2 3 4 |
new wirebox.system.ioc.Injector( "tests/WireBox" );// Get an instance!application.wirebox.getInstance( "MyOldBean" ); |
Right now would be a great time to create some canary integration tests using TestBox which can verify that your objects can be created and wired up correctly. This will be a huge help to get you started on the road to better test coverage and migrating your legacy elephant to modern times:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
component extends="testbox.system.BaseSpec"{ // executes before all suites function beforeAll(){ wirebox = new wirebox.system.ioc.Injector( "path.to.Binder" ); } // executes after all suites function afterAll(){ structDelete( application, "wirebox" ); } // All suites go in here function run( testResults, testBox ){ describe( "UserService", () => { it( "can be created and wired", () => { var target = wirebox.getInstance( "UserService" ); expect( target ).toBeComponent(); expect( target.getUserDAO() ).toBeComponent(); } ); } ); }} |
Add Your Comment