RESTEasy Guice has some simple integration with Guice 7.0.
RESTEasy Guice will scan the binding types for a Guice Module for @Path and @Provider annotations.
It will register these bindings with RESTEasy.
@Path("hello")
public class HelloResource {
@GET
@Path("{name}")
public String hello(@PathParam("name") final String name) {
return "Hello " + name;
}
}First you start off by specifying a Jakarta REST resource class.
The HelloResource is just that.
Next you create a Guice Module class that defines all your bindings:
import com.google.inject.Module;
import com.google.inject.Binder;
public class HelloModule implements Module {
public void configure(final Binder binder) {
binder.bind(HelloResource.class);
}
}You put all these classes somewhere within your WAR WEB-INF/classes or in a JAR within WEB-INF/lib.
Then you need to create your web.xml file.
You need to use the GuiceResteasyBootstrapServletContextListener as follows
<web-app>
<display-name>Guice Hello</display-name>
<context-param>
<param-name>resteasy.guice.modules</param-name>
<param-value>dev.resteasy.examples.guice.hello.HelloModule</param-value>
</context-param>
<listener>
<listener-class>
dev.resteasy.guice.GuiceResteasyBootstrapServletContextListener
</listener-class>
</listener>
<servlet>
<servlet-name>Resteasy</servlet-name>
<servlet-class>
org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher
</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>Resteasy</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-app>GuiceResteasyBootstrapServletContextListener is a subclass of ResteasyBootstrap, so you can use any other RESTEasy configuration option within your web.xml file.
Also notice that there is a resteasy.guice.modules context-param.
This can take a comma delimited list of class names that are Guice Modules.
Add the RequestScopeModule to your modules to allow objects to be scoped to the HTTP request by adding the @RequestScoped annotation to your fields in resource classes.
All the objects injectable via the @Context annotation are also injectable, except ServletConfig and ServletContext.
Note that RequestScopeModule will already be added if any of your modules extends com.google.inject.servlet.ServletModule.
In such cases you should not add it again to avoid injector creation errors.
import javax.inject.Inject;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.core.Context;
import dev.resteasy.guice.RequestScoped;
public class MyClass {
@Inject @RequestScoped @Context
private HttpRequest request;
}Add the JaxrsModule to bind jakarta.ws.rs.ext.RuntimeDelegate, jakarta.ws.rs.core.Response.ResponseBuilder, jakarta.ws.rs.core.UriBuilder, jakarta.ws.rs.core.Variant.VariantListBuilder and org.jboss.resteasy.client.jaxrs.ClientHttpEngine.
You can configure the stage Guice uses to deploy your modules by specific a context param, resteasy.guice.stage.
If this value is not specified, RESTEasy uses whatever Guice’s default is.
<web-app>
<display-name>Guice Hello</display-name>
<context-param>
<param-name>resteasy.guice.modules</param-name>
<param-value>dev.resteasy.examples.guice.hello.HelloModule</param-value>
</context-param>
<context-param>
<param-name>resteasy.guice.stage</param-name>
<param-value>PRODUCTION</param-value>
</context-param>
<listener>
<listener-class>
dev.resteasy.guice.GuiceResteasyBootstrapServletContextListener
</listener-class>
</listener>
<servlet>
<servlet-name>Resteasy</servlet-name>
<servlet-class>
org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher
</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>Resteasy</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-app>GuiceResteasyBootstrapServletContextListener can be extended to allow more flexibility in the way the Injector and Modules are created.
Three methods can be overridden: getModules(), withInjector() and getStage(). Register your subclass as the listener in the web.xml.
Override getModules() when you need to pass arguments to your modules' constructor or perform more complex operations.
Override withInjector(Injector) when you need to interact with the Injector after it has been created.
Override getStage(ServletContext) to set the Stage yourself.
<web-app>
<!-- other tags omitted -->
<listener>
<listener-class>
dev.resteasy.guice.GuiceResteasyBootstrapServletContextListener
</listener-class>
</listener>
</web-app>public class MyServletContextListener extends GuiceResteasyBootstrapServletContextListener {
@Override
protected List<? extends Module> getModules(ServletContext context) {
return List.of(new JpaPersistModule("consulting_hours"), new MyModule());
}
@Override
public void withInjector(Injector injector) {
injector.getInstance(PersistService.class).start();
}
}The group name and package name have both changed. If you are migrating from prior editions of RESTEasy Guice, you will need to update your dependencies and imports.
The new group name is 'dev.resteasy.guice' and the new package name is 'dev.resteasy.guice'.
For example code for the dependencies see: https://central.sonatype.com/artifact/dev.resteasy.guice/resteasy-guice
-
Previous package name: org.jboss.resteasy.plugins.guice.
-
Current package name: dev.resteasy.guice
This update may be as simple as searching for org.jboss.resteasy.plugins.guice and replacing it with dev.resteasy.guice.
For most projects, that will be either changing the entry in web.xml to:
<listener>
<listener-class>
dev.resteasy.guice.GuiceResteasyBootstrapServletContextListener
</listener-class>
</listener>Or changing the import statement in a custom listener to:
import dev.resteasy.guice.GuiceResteasyBootstrapServletContextListener;