Google Guice带参数单例创建：如何传参并通过@Inject注入

问题原文（翻译后） #

我刚开始使用Google Guice，尝试创建单例对象。不清楚如何为getClient(...)传递所需参数，以及如何通过@Inject注解创建该对象，希望得到帮助。代码示例如下：

public class Client
{
    private final Child _child;
    public Client(Child child)
    {
        this._child = child;
    }

    static class NestedClass {
        public String propX;
        public String propY;    
    }
}

class MyHelperModule extends AbstractModule {
    private static final String propXValue = "hello";

    @Provides
    @Singleton
    private Client getClient(
        String propY) {

       Client.NestedClass nestedClass = new Client.NestedClass();
       nestedClass.propX("hello"); // 错误：字段不能用方法调用
       nestedClass.propY(propY); // 错误：字段不能用方法调用

       return new Client(nestedClass); // 错误：构造器参数是Child，传入的是NestedClass
    }
}


// helper class to create singleton object Client.  
// Need to pass param propY while creating the instance
public Client _client;

@Inject
void newClient(Client client) {
    this._client = client;
}

解决方案 #

先修复代码里的基础错误，再解决参数传递和注入问题：

1. 修复基础类型错误

• 调整Client构造器参数类型，匹配实际传入的NestedClass（如果NestedClass是Child子类，可保留Child类型，这里假设你需要直接传入NestedClass）：

public class Client
{
    private final Client.NestedClass _nested;
    public Client(Client.NestedClass nested)
    {
        this._nested = nested;
    }

    static class NestedClass {
        public String propX;
        public String propY;    
    }
}

• NestedClass字段赋值改为直接赋值，而非方法调用：

nestedClass.propX = "hello";
nestedClass.propY = propY;

2. 传递动态参数propY到@Provides方法

Guice无法直接识别未绑定的原始类型（如String），提供两种常用传递方式：

方式一：模块构造器传参（适合初始化时确定参数的场景）

通过模块构造器接收外部传入的propY，在@Provides方法中直接使用：

class MyHelperModule extends AbstractModule {
    private static final String propXValue = "hello";
    private final String propYValue;

    // 构造器接收外部传入的propY
    public MyHelperModule(String propYValue) {
        this.propYValue = propYValue;
    }

    @Provides
    @Singleton
    Client getClient() {
       Client.NestedClass nestedClass = new Client.NestedClass();
       nestedClass.propX = propXValue;
       nestedClass.propY = propYValue;

       return new Client(nestedClass);
    }
}

方式二：@Named注解绑定（适合参数需要注入的场景）

先在模块中绑定命名的propY值，再在@Provides方法中通过@Named标记参数：

class MyHelperModule extends AbstractModule {
    private static final String propXValue = "hello";

    @Override
    protected void configure() {
        // 绑定命名的propY值，可从配置文件读取或外部传入
        bind(String.class)
            .annotatedWith(Names.named("client.propY"))
            .toInstance("your-dynamic-propY");
    }

    @Provides
    @Singleton
    Client getClient(@Named("client.propY") String propY) {
       Client.NestedClass nestedClass = new Client.NestedClass();
       nestedClass.propX = propXValue;
       nestedClass.propY = propY;

       return new Client(nestedClass);
    }
}

3. 正确使用@Inject获取单例Client

在需要使用Client的类中，通过构造注入、字段注入或方法注入获取实例（推荐构造注入，更易测试）：

public class ClientHelper {
    private final Client _client;

    // 推荐：构造注入
    @Inject
    public ClientHelper(Client client) {
        this._client = client;
    }

    // 可选：字段注入或方法注入
    /*
    @Inject
    private Client _client;

    @Inject
    void setClient(Client client) {
        this._client = client;
    }
    */

    public void doSomething() {
        // 使用单例Client实例
    }
}

4. 创建Injector并初始化实例

最后创建Guice的Injector，初始化模块并获取实例：

public class Main {
    public static void main(String[] args) {
        // 方式一：使用构造传参的模块
        Injector injector = Guice.createInjector(new MyHelperModule("dynamic-propY-value"));

        // 方式二：使用@Named绑定的模块
        // Injector injector = Guice.createInjector(new MyHelperModule());

        // 获取ClientHelper实例，Guice自动注入单例Client
        ClientHelper helper = injector.getInstance(ClientHelper.class);
        // 也可以直接获取Client单例
        Client client = injector.getInstance(Client.class);
    }
}

关键注意点 #

• @Singleton注解确保Guice全局只创建一个Client实例
• 原始类型（String、int等）必须通过命名绑定或自定义注解标记，否则Guice无法识别
• 构造注入是Guice官方推荐的注入方式，比字段/方法注入更易维护和测试

内容的提问来源于stack exchange，提问作者Raj