Java Vert.x 集成Guice
Guice介绍
Guice是谷歌推出的一个轻量级依赖注入框架,帮助我们解决Java项目中的依赖注入问题。如果使用过Spring的话,会了解到依赖注入是个非常方便的功能。不过假如只想在项目中使用依赖注入,那么引入Spring未免大材小用了。这时候我们可以考虑使用Guice。本文参考了Guice官方文档,详细信息可以直接查看Guice文档。
更多阅读
Vert.x
Vert.x是用于开发高度可扩展的非阻塞应用程序的reactive工具集。本文主要介绍vertx与guice的集成,github
Vert.x Guice
Vert.x还没有内置的依赖注入。由于您无法希望在没有它的情况下开发可维护和可测试的应用程序,所以我们需要一个解决方案,因为我们使用Java,所以该解决方案是Guice。Guice是由Google开发的大型依赖注入库。Guice的Vert.x插件已经由ef-labs构建,在这里找到。对于Guice整合的令人敬畏的工作的所有信用都归功于他们。这篇文章将简单地演示如何将它合并到您的应用程序中。将此依赖项添加到您的项目中:
build.gradle:
compile 'com.englishtown.vertx:vertx-guice:2.3.1'
Service Binder
我们需要做的第一件事是创建一个可以配置Guice来提供我们所有类的绑定器。为此,我们需要创建一个扩展的类AbstractModule。绑定器的工作是告诉Guice如何构建我们需要的所有类,并绑定我们想要用于我们在构造函数中指定的特定接口的实现。看起来像这样:
ServiceBinder.java:
public class ServiceBinder extends AbstractModule {
@Provides @Singleton
public HelloController provideController(Vertx vertx,
HelloWorld service)
{
return new HelloController(vertx,service);
}
@Provides @Singleton
public HelloWorld provideService(){
return new HelloWorld();
}
@Provides @Singleton
public AppConfig provideAppConfig(){
return new AppConfig(30,30);
}
@Override
protected void configure(){
}
}
该@Provides注解标记的方法作为提供者,@Singleton 表示注入的实例为单例,
我们要做的第二件事是覆盖该configure方法。当模块被实例化时,该方法被调用,并且它可以包括任何其他配置。我们实际上可以把我们做的方法的所有配置放在configure方法中,但是我发现它更可读和更方便地实现这些方法,所以我们configure是空的。
Main Class
在我们使用
ServiceLauncher
类来部署我们的verticle之前。这依赖于我们构建Vert.x Launcher类的构建,并将其指向我们ServiceLauncher
。这很好,但是如果我们要手动部署我们的verticle,我们需要一个主类。此类将创建一个Vert.x实例,并使用帮助方法使用Guice部署我们的verticle。这是我们的Main:
Main.java:
public class Main {
public static void main(String[] args){
Vertx vertx = Vertx.vertx();
deploy(vertx, ServiceLauncher.class,
new DeploymentOptions());
}
private static Future<Void> deploy(Vertx vertx, Class verticle,
DeploymentOptions opts)
{
Future<Void> done = Future.future();
String deploymentName = "java-guice:" + verticle.getName();
JsonObject config = new JsonObject()
.put("guice_binder", ServiceBinder.class.getName());
opts.setConfig(config);
vertx.deployVerticle(deploymentName, opts, r -> {
// handle success/failure
});
return done;
}
private static class ServiceLauncher extends AbstractVerticle{
private AppConfig appConfig;
@Inject
public ServiceLauncher(AppConfig appConfig) {
this.appConfig = appConfig;
}
/**
* Start method uses CompositeFuture to deploy all required
* verticles
*
* @param done
*/
@Override
public void start(Future<Void> done) {
// start your verticle here
}
}
}
- 方法简单地创建一个Vert.x实例,并使用一个辅助方法来部署我们的静态verticle启动器类。
Vertx.vertx()
也可以选择指定不同的参数,例如实例数。 - 接下来是我们的帮助方法,这是集成Guice库的重要部分。我们在这里做的第一件事是通过预先等待修改verticle的名称java-guice。Vert.x允许我们在部署之前创建和注册负责实例化verticle工厂。这个库提供了一个将Guice和名字开头为java-guice的Verticle集成起来的工厂方法。其次,我们在部署选项中指定我们的
ServiceBinder
,从而让Guice知道在哪里找到它。 - 最后是我们的
ServiceLauncher
。它与它是一样的,除了构造函数。我们用@InjectGuice注解添加了构造函数。这使得verticle工厂可以实例化此verticle,并让Guice知道注入我们需要的依赖关系。在这种情况下,它只是一个虚拟AppConfig依赖。重要的是要注意,ServiceLauncher
还需要使用我们的帮助方法来部署我们的verticle。这是因为您需要指定ServiceBinder并修改您要使用Guice的每个verticle的名称。
现在我们的verticles在任何地方都可以使用Guice依赖注入。我们修改了所有代码以反映这一点,将依赖关系注入到verticles,控制器和我们的服务类中。例如,HelloController构造函数如下所示:
@Inject
public HelloController(Vertx vertx,HelloWorld service){
this.vertx = vertx;
this.service = service;
}
注意:我们不需要在其中创建Vertx提供者,ServiceBinder因为Vert.x Guice库已经具有Vert.x提供者,它提供了用于部署Verticle的Vert.x实例。
总结
本系列探讨了使用Vert.x的应用程序架构。我们讨论了高吞吐量单verticle结构,独立可扩展性的多verticle结构,以及依赖注入的Guice集成。