本教程主要详细讲解Guice的一些基本注入方式,通过该简单教程让我们可以快速使用Guice进行简单系统化开发,后续我们会更深入讲解更多模块,如果还不了解Guice大家可以先去网上自行了解一下.
基础环境
| 技术 | 版本 |
| Java | 1.8+ |
| Guice | 4.2.3 |
初始化项目
- 初始化项目
mvn archetype:generate -DgroupId=io.edurt.lc.guice -DartifactId=guice-binder-basic -DarchetypeArtifactId=maven-archetype-quickstart -Dversion=1.0.0 -DinteractiveMode=false 复制代码
- 修改pom.xml增加Guice依赖
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <parent> <artifactId>lc-guice</artifactId> <groupId>io.edurt.lc.guice</groupId> <version>1.0.0</version> </parent> <modelVersion>4.0.0</modelVersion> <artifactId>guice-binder-basic</artifactId> <name>Learning Center for Guice Binder(Basic)</name> <properties> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties> <dependencies> <dependency> <groupId>com.google.inject</groupId> <artifactId>guice</artifactId> <version>4.2.3</version> </dependency> </dependencies> </project> 复制代码
guice: guice就是我们核心要使用的依赖
Guice的绑定模型
- 修改
pom.xml配置文件,在dependencies节点中添加以下内容
<dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.12</version> <scope>test</scope> </dependency> 复制代码
- 在
src/main/java目录下新建io.edurt.lc.guice目录并在该目录下新建GuiceBasicModule类文件,在文件输入以下内容
package io.edurt.lc.guice; import com.google.inject.AbstractModule; public class GuiceBasicModule extends AbstractModule { @Override protected void configure() { System.out.println("Hello, GuiceBasicModule"); } } 复制代码
Guice中的绑定模型和Spring中的一样简单,我们通过绑定可以提供给程序任意注入类.
绑定我们需要的Module只需要继承Guice中的com.google.inject.AbstractModule即可,在configure方法中实现我们需要的绑定信息.
- 在
src/test/java源代码目录下构建io.edurt.lc.guice.TestGuiceBasicModule单元测试类文件用于我们测试代码,在文件输入以下内容
package io.edurt.lc.guice; import com.google.inject.AbstractModule; public class GuiceBasicModule extends AbstractModule { @Override protected void configure() { System.out.println("Hello, GuiceBasicModule"); } } 复制代码
运行单元测试后,控制台会输出以下信息:
Hello, GuiceBasicModule 复制代码
或者使用maven命令mvn clean package,它将输出类似以下内容
...... ------------------------------------------------------- T E S T S ------------------------------------------------------- Running io.edurt.lc.guice.TestGuiceBasicModule Hello, GuiceBasicModule Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.094 sec Results : Tests run: 1, Failures: 0, Errors: 0, Skipped: 0 ...... 复制代码
自定义Class
- 在
src/main/java目录下新建io.edurt.lc.guice.GuiceBasicService类文件内容如下
package io.edurt.lc.guice; public interface GuiceBasicService { void print(String input); } 复制代码
我们定义了一个接口文件,它构建了一个print方法用于信息输出.
- 在
src/main/java目录下新建io.edurt.lc.guice.GuiceBasicServiceImpl类文件内容如下
package io.edurt.lc.guice; public class GuiceBasicServiceImpl implements GuiceBasicService { @Override public void print(String input) { System.out.println(String.format("print %s", input)); } } 复制代码
它实现了io.edurt.lc.guice.GuiceBasicService类中的打印数据功能
- 修改
src/main/java目录下io.edurt.lc.guice.GuiceBasicModule文件在configure()方法中添加以下代码
bind(GuiceBasicService.class).to(GuiceBasicServiceImpl.class); 复制代码
这样我们就很快的绑定了一个服务,类似于Spring中的@Bean方式
bind标志我们需要绑定的类,to标志我们绑定的实现类
- 接下来修改
src/test/java目录下的io.edurt.lc.guice.TestGuiceBasicModule类文件进行定义的服务进行测试,添加以下代码
@Test public void test_service() { Injector injector = Guice.createInjector(new GuiceBasicModule()); GuiceBasicService service = injector.getInstance(GuiceBasicService.class); service.print("Hello Guice"); } 复制代码
运行单元测试后,控制台会输出以下信息:
Hello, GuiceBasicModule print Hello Guice 复制代码
使用@ImplementedBy注解
使用@ImplementedBy很简单,我们只需要在interface的接口类上添加@ImplementedBy(GuiceBasicServiceImpl.class)注解即可,修改后的代码如下
@ImplementedBy告知程序我们的接口具体实现类,Guice会帮我们做自动实例化
GuiceBasicService
package io.edurt.lc.guice; @ImplementedBy(GuiceBasicServiceImpl.class) public interface GuiceBasicService { void print(String input); } 复制代码
GuiceBasicServiceImpl类中的内容不变
- 删除
src/test/java目录下的io.edurt.lc.guice.TestGuiceBasicModule类文件中的GuiceBasicService service = injector.getInstance(GuiceBasicService.class);代码段即可.
运行单元测试后,控制台会输出以下信息:
Hello, GuiceBasicModule print Hello Guice 复制代码