Javaのjava.net.spiを徹底解説！ネットワーク動作をカスタマイズする仕組み

注意: このSPIはJava 9で導入され、それ以前の非公開SPIであったsun.net.spi.nameservice.NameServiceを置き換えるものです。Java 18でさらに改良されました。

InetAddress.getByName("example.com")のようなホスト名からIPアドレスへの変換（名前解決）処理をカスタマイズするためのSPIです。これにより、OSのDNS設定やhostsファイルを無視して、独自のロジックで名前解決を行うことができます。

これはテスト環境で特定のエンドポイントをモックサーバーに向けさせたり、独自のサービスディスカバリ機構と連携させたりするのに非常に強力です。

実装するには、InetAddressResolverProviderを継承し、get(Configuration config)メソッドを実装してInetAddressResolverのインスタンスを返します。実際の名前解決ロジックはInetAddressResolverインターフェースのlookupByName(String host, LookupPolicy lookupPolicy)メソッドに記述します。

実装例：特定ホストを固定IPに解決するリゾルバ

<!-- MyResolver.java -->
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.net.spi.InetAddressResolver;
import java.util.stream.Stream;

public class MyResolver implements InetAddressResolver {
    @Override
    public Stream<InetAddress> lookupByName(String host, LookupPolicy lookupPolicy) throws UnknownHostException {
        if ("api.example.com".equalsIgnoreCase(host)) {
            // "api.example.com"へのアクセスを常にローカルホストに向ける
            try {
                return Stream.of(InetAddress.getByAddress(host, new byte[]{127, 0, 0, 1}));
            } catch (UnknownHostException e) {
                // Should not happen
                throw new InternalError(e);
            }
        }
        // それ以外のホストは解決しない（デフォルトのリゾルバにフォールバックさせる）
        throw new UnknownHostException("This resolver only handles api.example.com");
    }

    @Override
    public String lookupByAddress(byte[] addr) throws UnknownHostException {
        // 逆引きはサポートしない
        throw new UnknownHostException("Reverse lookup not supported");
    }
}

<!-- MyResolverProvider.java -->
import java.net.spi.InetAddressResolver;
import java.net.spi.InetAddressResolverProvider;

public class MyResolverProvider extends InetAddressResolverProvider {
    @Override
    public InetAddressResolver get(Configuration configuration) {
        // 常にカスタムリゾルバのインスタンスを返す
        return new MyResolver();
    }
    
    @Override
    public String name() {
        return "My Custom Resolver";
    }
}

登録方法

URLStreamHandlerProviderと同様に、ServiceLoaderの仕組みを使います。META-INF/services/java.net.spi.InetAddressResolverProviderファイルに、実装クラスcom.example.resolver.MyResolverProviderを記述したJARをクラスパスに追加します。