動的プロキシのサンプルコード — Spring

1手で書いた包み役

を使わず、同じを実装した包み役のを手で書いた例です。呼び出す側は Greeter 型として扱うだけなので、包み役に差し替えても気づきません。この方法では、包みたいインターフェースとの数だけ同じようなコードを書くことになります。

Java

interface Greeter {
    String greet(String name);
}

class RealGreeter implements Greeter {
    public String greet(String name) {
        System.out.println("    RealGreeter.greet running");
        return "Hello, " + name;
    }
}

// 手で書いた包み役。同じ interface を実装し、中で本物を呼ぶ
class LoggingGreeter implements Greeter {
    private final Greeter target;

    LoggingGreeter(Greeter target) {
        this.target = target;
    }

    public String greet(String name) {
        System.out.println("  before greet");
        String result = target.greet(name);
        System.out.println("  after  greet");
        return result;
    }
}

class Main {
    public static void main(String[] args) {
        // 呼び出し側は Greeter 型として扱うだけなので、包み役に差し替えてもコードは変わらない
        Greeter g = new LoggingGreeter(new RealGreeter());
        System.out.println("calling g.greet:");
        System.out.println("result: " + g.greet("wrapper"));
        System.out.println("class: " + g.getClass().getName());
    }
}

2同じことを動的プロキシで行う

包み役のクラスを書かずに、Proxy.newProxyInstance で実行時に作らせた例です。出力の前半は手書きの場合と同じ形になります。後半から、プロキシは Greeter ではあるが RealGreeter ではないこと、java.lang.reflect.Proxy を親に持つ別のクラスであることが分かります。

Java

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Proxy;

interface Greeter {
    String greet(String name);
}

class RealGreeter implements Greeter {
    public String greet(String name) {
        System.out.println("    RealGreeter.greet running");
        return "Hello, " + name;
    }
}

class Main {
    public static void main(String[] args) {
        Greeter real = new RealGreeter();

        // インターフェースのどのメソッドが呼ばれても、この1つのラムダ(無名の関数)に届く
        InvocationHandler handler = (proxy, method, methodArgs) -> {
            System.out.println("  before " + method.getName());
            Object result = method.invoke(real, methodArgs);
            System.out.println("  after  " + method.getName());
            return result;
        };

        // 包み役のクラスを自分では書かず、実行時に作らせる
        Greeter g = (Greeter) Proxy.newProxyInstance(
                Greeter.class.getClassLoader(),
                new Class<?>[] { Greeter.class },
                handler);

        System.out.println("calling g.greet:");
        String s = g.greet("proxy");
        System.out.println("result: " + s);

        System.out.println("real class : " + real.getClass().getName());
        System.out.println("proxy class: " + g.getClass().getName());
        System.out.println("g instanceof Greeter    : " + (g instanceof Greeter));
        System.out.println("g instanceof RealGreeter: " + (g instanceof RealGreeter));
        System.out.println("superclass : " + g.getClass().getSuperclass().getName());
    }
}

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Proxy;

interface Greeter {
    String greet(String name);
}

class RealGreeter implements Greeter {
    public String greet(String name) {
        System.out.println("    RealGreeter.greet running");
        return "Hello, " + name;
    }
}

class Main {
    public static void main(String[] args) {
        Greeter real = new RealGreeter();

// インターフェースのどのメソッドが呼ばれても、この1つのラムダ(無名の関数)に届く
        InvocationHandler handler = (proxy, method, methodArgs) -> {
            System.out.println("  before " + method.getName());
            Object result = method.invoke(real, methodArgs);
            System.out.println("  after  " + method.getName());
            return result;
        };

// 包み役のクラスを自分では書かず、実行時に作らせる
        Greeter g = (Greeter) Proxy.newProxyInstance(
                Greeter.class.getClassLoader(),
                new Class<?>[] { Greeter.class },
                handler);

System.out.println("calling g.greet:");
        String s = g.greet("proxy");
        System.out.println("result: " + s);

System.out.println("real class : " + real.getClass().getName());
        System.out.println("proxy class: " + g.getClass().getName());
        System.out.println("g instanceof Greeter    : " + (g instanceof Greeter));
        System.out.println("g instanceof RealGreeter: " + (g instanceof RealGreeter));
        System.out.println("superclass : " + g.getClass().getSuperclass().getName());
    }
}

3作られたクラスの中身

実行時に作られたプロキシのクラスを書き出してで見たものです( 25、なインターフェースの場合)。greet の本体は、を取り出し、Method と引数の配列を積んで InvocationHandler.invoke を呼び、戻り値を String として返すだけです。前後に何をするかは、すべてハンドラの側に書かれます。

$ javap -p -c 'jdk/proxy1/$Proxy0.class'(JDK 25、抜粋)追跡ログ

public final class jdk.proxy1.$Proxy0 extends java.lang.reflect.Proxy implements demo.PublicGreeter {
...
  public final java.lang.String greet(java.lang.String) throws ;
    Code:
         0: aload_0
         1: getfield      #19                 // Field java/lang/reflect/Proxy.h:Ljava/lang/reflect/InvocationHandler;
         4: aload_0
         5: getstatic     #55                 // Field m3:Ljava/lang/reflect/Method;
         8: iconst_1
         9: anewarray     #11                 // class java/lang/Object
        12: dup
        13: iconst_0
        14: aload_1
        15: aastore
        16: invokeinterface #25,  4           // InterfaceMethod java/lang/reflect/InvocationHandler.invoke:(Ljava/lang/Object;Ljava/lang/reflect/Method;[Ljava/lang/Object;)Ljava/lang/Object;
        21: checkcast     #82                 // class java/lang/String
        24: areturn

4クラスの名前は条件で変わる

インターフェースの種類を変えて、作られたクラスの名前を出した実測です。public なインターフェースでは jdk.proxy1.$Proxy0、public でないものでは同じの demo.$Proxy1 になり、同じインターフェースで2回作るとクラスは使い回されました。最後の行から、toString の呼び出しもハンドラに届くことが分かります。

$ java demo.ProxyNames(JDK 25、抜粋)コマンド出力

jdk.proxy1.$Proxy0  module=module jdk.proxy1  modifiers=public final  interfaces=[interface demo.PublicGreeter]
demo.$Proxy1  module=unnamed module @4554617c  modifiers=final  interfaces=[interface demo.PackagePrivateGreeter]
jdk.proxy1.$Proxy2  module=module jdk.proxy1  modifiers=public final  interfaces=[interface java.lang.Runnable, interface java.lang.Comparable]
jdk.proxy1.$Proxy0  module=module jdk.proxy1  modifiers=public final  interfaces=[interface demo.PublicGreeter]
p1 and p4 share one proxy class? true
handled greet
handled toString

5クラスはプロキシにできない

インターフェースの代わりにふつうのクラスを渡すと、IllegalArgumentException になります。下の出力はを捕まえなかった場合の実物で、String のようなクラスやを渡しても同じ is not an interface というメッセージでした。インターフェースを持たないクラスを包むには、別の方法が必要になります。

例外を捕まえなかった場合(JDK 25、catch を外した別のクラス Uncaught で実行)コマンド出力

Exception in thread "main" java.lang.IllegalArgumentException: PlainService is not an interface
	at java.base/java.lang.reflect.Proxy$ProxyBuilder.validateProxyInterfaces(Proxy.java:608)
	at java.base/java.lang.reflect.Proxy$ProxyBuilder.<init>(Proxy.java:560)
...
	at java.base/java.lang.reflect.Proxy.newProxyInstance(Proxy.java:924)
	at Uncaught.main(Uncaught.java:5)

Java

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Proxy;

// interface を持たない、ふつうのクラス
class PlainService {
    public String work() {
        return "done";
    }
}

class Main {
    public static void main(String[] args) {
        InvocationHandler handler = (proxy, method, methodArgs) -> null;
        try {
            // interface の代わりにクラスを渡してみる
            Object p = Proxy.newProxyInstance(
                    PlainService.class.getClassLoader(),
                    new Class<?>[] { PlainService.class },
                    handler);
            System.out.println("created: " + p.getClass().getName());
        } catch (IllegalArgumentException e) {
            System.out.println("caught: " + e);
        }
    }
}

サンプルコードで身につける: 動的プロキシ

1手で書いた包み役

2同じことを動的プロキシで行う

3作られたクラスの中身

4クラスの名前は条件で変わる

5クラスはプロキシにできない

図やコードに出てくる用語(タップで説明)