This is an ad-hoc and tiny macro project for Play Framework with MacWire.
This macro automatically wire
s all controllers for given generated routes classes.
If you use MacWire, you have to write as below:
// define controller
class GreeterController(greetingService: GreetingService,
langs: Langs,
cc: ControllerComponents) extends AbstractController(cc)
// define an application loader and a component
class GreetingApplicationLoader extends ApplicationLoader {
def load(context: Context): Application = new GreetingComponents(context).application
}
class GreetingComponents(context: Context) extends BuiltInComponentsFromContext(context)
with ServicesModule
with AssetsComponents
with I18nComponents
with play.filters.HttpFiltersComponents {
// wire *all* controllers
lazy val greeterController = wire[GreeterController]
// wire a router
lazy val router: Router = new Routes(httpErrorHandler, greeterController, assets)
}
If you use Guice, what you have to do is only to insert @Inject()
as below:
// โ Only this!
@Inject() class GreeterController(greetingService: GreetingService,
langs: Langs,
cc: ControllerComponents) extends AbstractController(cc)
It is unreasonable! Can you think the case your project has hundreds of controllers?
This macro helps to wire all controllers.
Add following code to your build.sbt:
libraryDependencies += "com.github.hiroshi-cl" %% "play-routes-wire" % "2.8.1-0.1.0"
- Make sure that all controllers are subclass of
ControllerHelpers
. - Make sure that all depending services are found in the scope.
Write as below:
class GreetingComponents(context: Context) extends BuiltInComponentsFromContext(context)
with ServicesModule
with AssetsComponents
with I18nComponents
with play.filters.HttpFiltersComponents {
lazy val router: Router = Macro.wireRoutes[Routes](httpErrorHandler, "/")
}
- Supporting Play versions: 2.6.x, 2.7.x, 2.8.x
- Supporting MacWire versions: 2.3.x