Другие основные статьи по Java:Базовое изучение Java (справочник)
После предыдущего раздела мы говорили оОбъект класса и механизм отражения, в этом разделе будет рассказано об основном применении механизма отражения в java — динамических прокси. Прежде чем говорить о динамическом прокси, мы сначала поговорим о режиме прокси и статическом прокси.
1. Агентский режим
Шаблон прокси является широко используемым шаблоном проектирования Java.Его характеристика заключается в том, что класс прокси имеет такие же отношения с классом делегата.同样的接口, прокси-класс в основном отвечает за предварительную обработку сообщений для класса делегата, фильтрацию сообщений, пересылку сообщений в класс делегата и постобработку сообщений. Между классом-посредником и классом-делегатом обычно существует ассоциативное отношение. Объект класса-посредника связан с объектом класса-делегата. методы объекта класса делегата, предоставляют определенные услуги. Проще говоря, когда мы обращаемся к фактическому объекту, мы получаем доступ к нему через прокси-объект. Режим прокси вводит определенную степень косвенности при доступе к фактическому объекту. Из-за этой косвенности можно подключить несколько целей, таких как Spring.AOP. Схема структуры прокси-режима (картинка из "Dahua Design Mode"):
2. Статический прокси
1. Статический прокси
Статический прокси: исходный код создается программистом или автоматически генерируется специальным инструментом, то есть интерфейс, прокси-класс, прокси-класс и т. д. определяются во время компиляции. Перед запуском программы создается файл .class прокси-класса.
2. Простая реализация статического прокси
В соответствии с приведенной выше диаграммой классов режима прокси, давайте напишем простой пример статического прокси. Сначала определите товарный интерфейс
public interface ProductService {
void addProduct(String productName);
}
Затем определите реализацию товара
public class ProductServiceImpl implements ProductService{
public void addProduct(String productName) {
System.out.println("正在添加"+productName);
}
}
На данный момент мы определяем сотрудника по продажам продуктов.Когда сотрудник добавляет продукт, он сначала проверяет, является ли продукт квалифицированным, а затем сообщает об этом после его добавления.
public class ProductEmployee implements ProductService{
ProductServiceImpl productService;
public ProductEmployee(ProductServiceImpl productService) {
this.productService = productService;
}
@Override
public void addProduct(String productName) {
System.out.println("检查产品"+productName);
productService.addProduct(productName);
System.out.println("添加完成");
}
public static void main(String[] args) {
ProductServiceImpl impl = new ProductServiceImpl();
ProductEmployee productEmployee = new ProductEmployee (impl);
productEmployee .addProduct("book");
}
}
/*output
检查产品book
正在添加book
添加完成
Главное в режиме прокси - иметь публичный интерфейс (ProductService), определенный класс (ProductServiceImpl), прокси-класс (ProductEmployee), прокси-класс содержит экземпляр конкретного класса и выполняет метод конкретного класса экземпляр от своего имени. Как упоминалось выше, шаблон прокси должен ввести определенную степень косвенности при доступе к фактическому объекту, и из-за этой косвенности может быть присоединено несколько применений. Наиболее простым является Аспектно-ориентированное программирование (АОП) в Spring.Мы можем выполнять некоторые операции до pointcut и выполнять некоторые операции после pointcut.Этот pointcut является методом. Класс, в котором находятся эти методы, должен быть проксирован, а некоторые другие операции вырезаны в прокси-процессе.
3. Динамический агент
Статические прокси имеют много недостатков.Каждый раз, когда нужен класс прокси, нужно добавлять новый класс.Когда классов прокси становится все больше и больше, он становится очень большим и раздутым. А когда вам нужно изменить методы в прокси-классе, вам нужно изменить код метода для каждого прокси-класса, чем больше прокси-классов, тем это сложнее. На этом этапе нам нужно использовать наш动态代理. Метод прокси, созданный классом прокси во время работы программы, называется динамическим прокси.
В приведенном выше примере со статическим прокси класс прокси (ProductEmployee) определяется сам по себе и компилируется перед запуском программы. Однако динамический прокси, класс прокси не определен в коде Java, а динамически генерируется во время выполнения в соответствии с нашими «инструкциями» в коде Java. Преимущество динамических прокси по сравнению со статическими прокси заключается в том, что функции прокси-классов могут обрабатываться унифицированным образом без изменения методов в каждом прокси-классе.
Простая реализация динамического прокси
Нам нужно определить класс реализации InvocationHandler
public class ProductInvocationHandler implements InvocationHandler {
// 目标对象
private Object target;
/**
* 构造方法
* @param target 目标对象
*/
public ProductInvocationHandler(Object target) {
this.target = target;
}
/**
* 执行目标对象的方法
*/
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
// 在目标对象的方法执行之前简单的打印一下
System.out.println("检查产品");
// 执行目标对象的方法
Object result = method.invoke(target, args);
// 在目标对象的方法执行之后简单的打印一下
System.out.println("添加完成");
return result;
}
/**
* 获取目标对象的代理对象
* @return 代理对象
*/
public Object getProxy() {
return Proxy.newProxyInstance(Thread.currentThread().getContextClassLoader(),
target.getClass().getInterfaces(), this);
}
}
Затем вызовите этот класс для создания прокси-объекта и запустите метод
public static void main(String[] args) {
ProductService impl = new ProductServiceImpl();
ProductInvocationHandler productInvocationHandler = new ProductInvocationHandler(impl);
ProductService proxy = (ProductService) productInvocationHandler.getProxy();
proxy.addProduct("book");
}
/* output
检查产品
正在添加book
添加完成
Принципиальный анализ динамического агента
В приведенном выше примере мы видим, что в механизме динамического прокси есть два важных класса и интерфейса.InvocationHandler（接口）иProxy（类）, эти два класса Proxy и интерфейс InvocationHandler являются ядром нашей реализации динамического прокси;
InvocationHandler
Интерфейс InvocationHandler — это интерфейс, реализуемый обработчиком вызова экземпляра прокси.Каждый экземпляр прокси будет иметь связанный с ним обработчик вызова (InvocationHandler). При вызове экземпляра прокси вызов метода кодируется и назначается методу вызова его обработчика вызова (InvocationHandler). Следовательно, вызов метода экземпляра прокси-объекта завершается с помощью метода вызова в InvocationHandler, и метод вызова решает, какой метод вызывать прокси-сервер, в соответствии с входящим объектом прокси, именем метода и параметрами.
Сейчас это может показаться немного запутанным и трудным для понимания.После того, как вы изучите генерацию прокси-класса Proxy ниже, он будет лучше понят, когда вы вернетесь.
Proxy
Класс Proxy — это класс, используемый для создания прокси-объекта. В приведенном выше простом примере мы видим, что создание прокси-объекта получено с помощью метода NewProxyInstance класса Proxy. Тогда давайте примем это за вход и углубимся в класс Proxy.
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)
throws IllegalArgumentException
{
//如果h为空将抛出异常
Objects.requireNonNull(h);
final Class<?>[] intfs = interfaces.clone();//拷贝被代理类实现的一些接口，用于后面权限方面的一些检查
final SecurityManager sm = System.getSecurityManager();
if (sm != null) {
//在这里对某些安全权限进行检查，确保我们有权限对预期的被代理类进行代理
checkProxyAccess(Reflection.getCallerClass(), loader, intfs);
}
/*
* 查找或生成指定的代理类
*/
Class<?> cl = getProxyClass0(loader, intfs);
/*
* 使用指定的调用处理程序（invocation handler）获取代理类的构造函数对象
*/
try {
if (sm != null) {
checkNewProxyPermission(Reflection.getCallerClass(), cl);
}
//获取代理类的构造函数
final Constructor<?> cons = cl.getConstructor(constructorParams);
final InvocationHandler ih = h;
//假如代理类的构造函数是private的，就使用反射来set accessible
if (!Modifier.isPublic(cl.getModifiers())) {
AccessController.doPrivileged(new PrivilegedAction<Void>() {
public Void run() {
cons.setAccessible(true);
return null;
}
});
}
//根据代理类的构造函数来生成代理类的对象并返回
return cons.newInstance(new Object[]{h});
} catch (IllegalAccessException|InstantiationException e) {
throw new InternalError(e.toString(), e);
} catch (InvocationTargetException e) {
Throwable t = e.getCause();
if (t instanceof RuntimeException) {
throw (RuntimeException) t;
} else {
throw new InternalError(t.toString(), t);
}
} catch (NoSuchMethodException e) {
throw new InternalError(e.toString(), e);
}
}
Комментарии в тексте четко обозначили логику выполнения этого метода, и в центре внимания этого метода находятся три строки кода.
-
Class<?> cl = getProxyClass0(loader, intfs);Класс, который генерирует прокси-класс -
final Constructor<?> cons = cl.getConstructor(constructorParams);Получить конструктор прокси-класса -
return cons.newInstance(new Object[]{h});Создать экземпляр прокси-класса через конструктор
Наиболее важным из них является метод getProxy0, поскольку последние два являются распространенными методами отражения.
getProxyClass0(loader, intfs)
Следуем коду этого метода:
/**
* 生成一个代理类，但是在调用本方法之前必须进行权限检查
*/
private static Class<?> getProxyClass0(ClassLoader loader,
Class<?>... interfaces) {
//如果接口数量大于65535，抛出非法参数错误
if (interfaces.length > 65535) {
throw new IllegalArgumentException("interface limit exceeded");
}
// 如果在缓存中有对应的代理类，那么直接返回
// 否则代理类将有 ProxyClassFactory 来创建
return proxyClassCache.get(loader, interfaces);
}
Упомянутый здесь ProxyClassFactory является статическим классом класса Proxy.
/**
* 一个工厂函数，用于生成、定义和返回给定ClassLoader和接口数组的代理类。
*
*/
private static final class ProxyClassFactory
implements BiFunction<ClassLoader, Class<?>[], Class<?>>
{
// 代理类的名字的前缀统一为“$Proxy”
private static final String proxyClassNamePrefix = "$Proxy";
// 每个代理类前缀后面都会跟着一个唯一的编号，如$Proxy0、$Proxy1、$Proxy2
private static final AtomicLong nextUniqueNumber = new AtomicLong();
@Override
public Class<?> apply(ClassLoader loader, Class<?>[] interfaces) {
Map<Class<?>, Boolean> interfaceSet = new IdentityHashMap<>(interfaces.length);
for (Class<?> intf : interfaces) {
/*
* 验证类加载器加载接口得到对象是否与由apply函数参数传入的对象相同
*/
Class<?> interfaceClass = null;
try {
interfaceClass = Class.forName(intf.getName(), false, loader);
} catch (ClassNotFoundException e) {
}
if (interfaceClass != intf) {
throw new IllegalArgumentException(
intf + " is not visible from class loader");
}
/*
* 验证这个Class对象是不是接口
*/
if (!interfaceClass.isInterface()) {
throw new IllegalArgumentException(
interfaceClass.getName() + " is not an interface");
}
/*
* 验证这个接口是否重复
*/
if (interfaceSet.put(interfaceClass, Boolean.TRUE) != null) {
throw new IllegalArgumentException(
"repeated interface: " + interfaceClass.getName());
}
}
String proxyPkg = null; // 声明代理类所在的package
int accessFlags = Modifier.PUBLIC | Modifier.FINAL;
/*
* 记录一个非公共代理接口的包，以便在同一个包中定义代理类。同时验证所有非公共
* 代理接口都在同一个包中
*/
for (Class<?> intf : interfaces) {
int flags = intf.getModifiers();
if (!Modifier.isPublic(flags)) {
accessFlags = Modifier.FINAL;
String name = intf.getName();
int n = name.lastIndexOf('.');
String pkg = ((n == -1) ? "" : name.substring(0, n + 1));
if (proxyPkg == null) {
proxyPkg = pkg;
} else if (!pkg.equals(proxyPkg)) {
throw new IllegalArgumentException(
"non-public interfaces from different packages");
}
}
}
if (proxyPkg == null) {
// 如果全是公共代理接口，那么生成的代理类就在com.sun.proxy package下
proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
}
/*
* 为代理类生成一个name package name + 前缀+唯一编号
* 如 com.sun.proxy.$Proxy0.class
*/
long num = nextUniqueNumber.getAndIncrement();
String proxyName = proxyPkg + proxyClassNamePrefix + num;
/*
* 生成指定代理类的字节码文件
*/
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
proxyName, interfaces, accessFlags);
try {
return defineClass0(loader, proxyName,
proxyClassFile, 0, proxyClassFile.length);
} catch (ClassFormatError e) {
/*
* A ClassFormatError here means that (barring bugs in the
* proxy class generation code) there was some other
* invalid aspect of the arguments supplied to the proxy
* class creation (such as virtual machine limitations
* exceeded).
*/
throw new IllegalArgumentException(e.toString());
}
}
}
Как видно из комментариев, ProxyClassFactory — это файл байт-кода прокси-класса, сгенерированный методом ProxyGenerator.generateProxyClass. Поскольку этот пакет jar не является общедоступным, мы можем найти его в Baidu Google или проверить его через OpenJDK, Эта часть кода в основном одинакова.OpenJDK ProxyGenerator.java
public static byte[] generateProxyClass(final String name,
Class[] interfaces)
{
ProxyGenerator gen = new ProxyGenerator(name, interfaces);
//生成获取字节码
final byte[] classFile = gen.generateClassFile();
//是否将二进制保存到本地文件中，saveGeneratedFiles由参数sun.misc.ProxyGenerator.saveGeneratedFiles决定。
if (saveGeneratedFiles) {
java.security.AccessController.doPrivileged(
new java.security.PrivilegedAction<Void>() {
public Void run() {
try {
FileOutputStream file =
new FileOutputStream(dotToSlash(name) + ".class");
file.write(classFile);
file.close();
return null;
} catch (IOException e) {
throw new InternalError(
"I/O exception saving generated file: " + e);
}
}
});
}
return classFile;
}
Мы продолжаем следить за методом gen.generateClassFile(), который генерирует байт-код.
private byte[] generateClassFile() {
/* ============================================================
* Step 1: 为所有方法组装ProxyMethod对象，以为其生成代理调度代码
*/
//生成proxy代理类的hashcode，equals，toString方法
addProxyMethod(hashCodeMethod, Object.class);
addProxyMethod(equalsMethod, Object.class);
addProxyMethod(toStringMethod, Object.class);
//添加各个接口的方法
//这就是为什么我们能够通过代理调用接口方法实现的原因
for (int i = 0; i < interfaces.length; i++) {
Method[] methods = interfaces[i].getMethods();
for (int j = 0; j < methods.length; j++) {
addProxyMethod(methods[j], interfaces[i]);
}
}
//检查返回类型
for (List<ProxyMethod> sigmethods : proxyMethods.values()) {
checkReturnTypes(sigmethods);
}
/* ============================================================
* Step 2: 为我们生成的类中的所有字段和方法组装FieldInfo和MethodInfo结构。
*/
//编译成class的相关内容
try {
methods.add(generateConstructor());
for (List<ProxyMethod> sigmethods : proxyMethods.values()) {
for (ProxyMethod pm : sigmethods) {
fields.add(new FieldInfo(pm.methodFieldName,
"Ljava/lang/reflect/Method;", ACC_PRIVATE
| ACC_STATIC));
methods.add(pm.generateMethod());
}
}
methods.add(generateStaticInitializer());
} catch (IOException e) {
throw new InternalError("unexpected I/O Exception");
}
if (methods.size() > 65535) {
throw new IllegalArgumentException("method limit exceeded");
}
if (fields.size() > 65535) {
throw new IllegalArgumentException("field limit exceeded");
}
/* ============================================================
* Step 3: 将组织好的class文件写入到文件中
*/
//在开始编写最终类文件之前，请确保为以下项保留了常量池索引
cp.getClass(dotToSlash(className));
cp.getClass(superclassName);
for (int i = 0; i < interfaces.length; i++) {
cp.getClass(dotToSlash(interfaces[i].getName()));
}
//设置为只读模式，在此之后不允许添加新的常量池，因为我们将要编写一个final常量池表。
cp.setReadOnly();
ByteArrayOutputStream bout = new ByteArrayOutputStream();
DataOutputStream dout = new DataOutputStream(bout);
try {
//以下是class文件的结构，想深入了解的话可以看深入Java虚拟机
// u4 magic;
dout.writeInt(0xCAFEBABE);
// u2 minor_version;
dout.writeShort(CLASSFILE_MINOR_VERSION);
// u2 major_version;
dout.writeShort(CLASSFILE_MAJOR_VERSION);
cp.write(dout); // (write constant pool)
// u2 access_flags;
dout.writeShort(ACC_PUBLIC | ACC_FINAL | ACC_SUPER);
// u2 this_class;
dout.writeShort(cp.getClass(dotToSlash(className)));
// u2 super_class;
dout.writeShort(cp.getClass(superclassName));
// u2 interfaces_count;
dout.writeShort(interfaces.length);
// u2 interfaces[interfaces_count];
for (int i = 0; i < interfaces.length; i++) {
dout.writeShort(cp.getClass(dotToSlash(interfaces[i].getName())));
}
// u2 fields_count;
dout.writeShort(fields.size());
// field_info fields[fields_count];
for (FieldInfo f : fields) {
f.write(dout);
}
// u2 methods_count;
dout.writeShort(methods.size());
// method_info methods[methods_count];
for (MethodInfo m : methods) {
m.write(dout);
}
// u2 attributes_count;
dout.writeShort(0); // (no ClassFile attributes for proxy classes)
} catch (IOException e) {
throw new InternalError("unexpected I/O Exception");
}
return bout.toByteArray();
}
Просмотр созданного прокси-класса Proxy
На данный момент мы в основном проанализировали роль Java Proxy в динамическом прокси. Однако у вас могут возникнуть вопросы по поводу конкретной структуры класса прокси, созданного динамическим прокси. Чтобы лучше понять структуру прокси-класса Proxy (кстати, для углубления впечатления), мы могли бы также сгенерировать соответствующий файл класса из бинарника, созданного generateProxyClass через FileOutputStream
public static void main(String[] args) {
String name = "ProductServiceProxy";
byte[] data = sun.misc.ProxyGenerator.generateProxyClass(name,
new Class[] { ProductService.class });
try {
FileOutputStream out = new FileOutputStream(name + ".class");
out.write(data);
out.close();
} catch (Exception e) {
e.printStackTrace();
}
}
После запуска в корневом каталоге проекта будет найден файл ProductServiceProxy.class, открываем его путем декомпиляции
import com.example.javabase.proxyDemo.ProductService;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;
public final class ProductServiceProxy
extends Proxy
implements ProductService
{
private static Method m1;
private static Method m2;
private static Method m3;
private static Method m0;
public ProductServiceProxy(InvocationHandler paramInvocationHandler)
{
super(paramInvocationHandler);
}
public final boolean equals(Object paramObject)
{
try
{
return ((Boolean)this.h.invoke(this, m1, new Object[] { paramObject })).booleanValue();
}
catch (Error|RuntimeException localError)
{
throw localError;
}
catch (Throwable localThrowable)
{
throw new UndeclaredThrowableException(localThrowable);
}
}
public final String toString()
{
try
{
return (String)this.h.invoke(this, m2, null);
}
catch (Error|RuntimeException localError)
{
throw localError;
}
catch (Throwable localThrowable)
{
throw new UndeclaredThrowableException(localThrowable);
}
}
public final void addProduct(String paramString)
{
try
{
this.h.invoke(this, m3, new Object[] { paramString });
return;
}
catch (Error|RuntimeException localError)
{
throw localError;
}
catch (Throwable localThrowable)
{
throw new UndeclaredThrowableException(localThrowable);
}
}
public final int hashCode()
{
try
{
return ((Integer)this.h.invoke(this, m0, null)).intValue();
}
catch (Error|RuntimeException localError)
{
throw localError;
}
catch (Throwable localThrowable)
{
throw new UndeclaredThrowableException(localThrowable);
}
}
static
{
try
{
m1 = Class.forName("java.lang.Object").getMethod("equals", new Class[] { Class.forName("java.lang.Object") });
m2 = Class.forName("java.lang.Object").getMethod("toString", new Class[0]);
m3 = Class.forName("com.example.javabase.proxyDemo.ProductService").getMethod("addProduct", new Class[] { Class.forName("java.lang.String") });
m0 = Class.forName("java.lang.Object").getMethod("hashCode", new Class[0]);
return;
}
catch (NoSuchMethodException localNoSuchMethodException)
{
throw new NoSuchMethodError(localNoSuchMethodException.getMessage());
}
catch (ClassNotFoundException localClassNotFoundException)
{
throw new NoClassDefFoundError(localClassNotFoundException.getMessage());
}
}
}
Сверху мы можем четко видеть, что метод метода прокси-класса, наконец, отражается отражением invocationHandler.invoke к прокси-классу. Вероятно, структурированная структура включает в себя 4 части:
- Статическое поле: все методы проксируемого интерфейса имеют соответствующую переменную статического метода;
- Конструктор: отсюда передайте логику InvocationHandler;
- Для каждого прокси-метода: логика почти такая же, как у h.invoke, в основном вызывается логика invocatinoHandler, которую мы определили для запуска соответствующего метода на целевом объекте target;
- Статический блок: в основном через отражение для инициализации переменных статического метода;
в то же время,Поскольку все прокси-классы наследуются от класса Proxy, поэтому динамический прокси JDK может проксировать только интерфейс, а механизм наследования Java предназначен для того, чтобы эти классы динамических прокси не могли реализовать динамический прокси класса.