Usando ProxyFactoryBean para crear un proxy AOP

Si utiliza un contenedor Spring IoC (ApplicationContext o BeanFactory) para sus objetos comerciales (¡y debería hacerlo!), su tarea es utilizar una de las implementaciones FactoryBean de Spring AOP. (Recuerde que el bean de fábrica introduce una capa de indirección, que le permite crear otros tipos de objetos).

La forma principal de crear un proxy AOP en Spring es usar org.springframework.aop.framework.ProxyFactoryBean. Le brinda control total sobre los cortes, los consejos que se aplican y su orden. Sin embargo, existen opciones más simples que son preferibles si no necesita dicho control.

Conceptos básicos

ProxyFactoryBean, al igual que otras implementaciones de FactoryBean de Spring, introduce un nivel de direccionamiento indirecto. Si define un ProxyFactoryBean con el nombre foo, los objetos que hacen referencia a foo no ven la instancia de ProxyFactoryBean en sí, pero el objeto, creado por la implementación del método getObject() en ProxyFactoryBean. Este método crea un proxy AOP que envuelve el objeto de destino.

Una de las ventajas más importantes de usar un ProxyFactoryBean u otra clase compatible con IoC para crear un proxy AOP es que y los cortes también se pueden controlar a través de IoC. Esta es una característica eficaz que le permite adoptar ciertos enfoques que son difíciles de implementar utilizando otros marcos de AOP. Por ejemplo, la propia placa puede hacer referencia a objetos de aplicación (además del objetivo, que debe estar en cualquier marco AOP), aprovechando al máximo la modularidad que aporta la inyección de dependencia.

Propiedades de JavaBean

Como y para la mayoría de las implementaciones FactoryBean proporcionadas por Spring, la clase ProxyFactoryBean es en sí misma una clase JavaBean. Sus propiedades se utilizan para:

• Especificar el destino que necesita ser proxy.

• Especificar si se utiliza CGLIB (descrito a continuación , consulte también la sección "Proxies basados en JDK y CGLIB").

Algunas propiedades clave se heredan de org.springframework.aop.framework.ProxyConfig (superclase para todas las fábricas de proxy AOP en Spring). Estas propiedades clave constan de:

• proxyTargetClass: es true si la clase de destino será proxy en lugar de las interfaces de la clase de destino. . Si esta propiedad se establece en true, se crean proxies CGLIB.

• optimize: controla si se utilizan métodos de optimización agresivos para servidores proxy creados con CGLIB. Esta opción no debe usarse a la ligera a menos que comprenda cómo el proxy AOP correspondiente controla la optimización. Actualmente sólo se utiliza para el proxy CGLIB. El parámetro no afecta a los proxies JDK dinámicos.

• frozen: si la configuración del proxy tiene la propiedad frozen, entonces cambia ya no está permitido. Esto se puede utilizar tanto para una optimización ligera como en los casos en los que no desea que las personas que llaman puedan manipular el proxy (a través de la interfaz Advised) después de que se haya creado. El valor predeterminado de esta propiedad es false, por lo que se permiten cambios (como agregar sugerencias adicionales).

• exposeProxy : Define si el proxy actual debe abrirse en ThreadLocal para que el destino pueda acceder a él. Si el objetivo necesita obtener un proxy y la propiedad exposeProxy está establecida en true, el objetivo puede usar el método AopContext.currentProxy().

Otras propiedades específicas de ProxyFactoryBean son:

• proxyInterfaces: Nombres de interfaz de matriz String. Si no se especifica esta propiedad, entonces se utiliza el proxy CGLIB para la clase de destino.

• interceptorNames: matriz String de nombres Advisor, interceptores u otros consejos a aplicar. El orden juega un papel importante, todo sucede en orden de prioridad. Por lo tanto, el primer interceptor de la lista será el primero en interceptar la llamada.

  Los nombres son los nombres de los beans en la fábrica actual, incluidos los nombres de los beans de las fábricas principales. En este caso, no puede mencionar referencias de beans, ya que esto hará que ProxyFactoryBean ignore el parámetro del objeto singleton en la sugerencia.

  Puede agregar el nombre del interceptor con un asterisco (l*). Esto hará que se apliquen todos los beans asesores con nombres que comiencen con la parte anterior al asterisco.

• singleton: si la fábrica debe devolver un único objeto, sin importar la frecuencia con la que Se llama al método getObject(). Varias implementaciones de FactoryBean proporcionan dicho método. El valor predeterminado es true. Si necesita utilizar una sugerencia con estado (por ejemplo, para mixins con estado), use sugerencias de prototipo junto con un valor de propiedad singleton de false.

Proxies basados en JDK y CGLIB

Esta sección sirve como documentación prescriptiva sobre cómo ProxyFactoryBean elige entre crear un proxy basado en JDK o CGLIB para un objeto de destino en particular (que debe ser proxy). ).

Si la clase del objeto de destino que se va a utilizar como proxy ( (en adelante simplemente llamada clase de destino), no implementa ninguna interfaz, se crea un proxy basado en CGLIB. Este es el escenario más simple porque los servidores proxy JDK se basan en interfaces y la falta de interfaces significa que el proxy JDK no es posible en absoluto. Puede conectar el bean de destino y especificar una lista de interceptores configurando la propiedad interceptorNames. Tenga en cuenta que se crea un proxy basado en CGLIB incluso si la propiedad proxyTargetClass en ProxyFactoryBean se estableció en false. (Hacer esto no tiene sentido y es mejor eliminar esta propiedad de la definición del bean porque es redundante en el mejor de los casos y confusa en el peor.)

Si la clase objetivo implementa una (o más) interfaces, entonces la El tipo de proxy creado depende de la configuración de ProxyFactoryBean.

Si la propiedad proxyTargetClass en ProxyFactoryBean se estableció en true, entonces se crea un proxy basado en CGLIB. Esto es lógico y coherente con el principio de mínima sorpresa. Incluso si la propiedad proxyInterfaces en ProxyFactoryBean se estableció en uno o más nombres de interfaz completos, el hecho de que la propiedad proxyTargetClass esté establecida en true hace que se produzca proxy basado en CGLIB.

Si la propiedad proxyInterfaces en ProxyFactoryBean se estableció en uno o más completamente nombres de interfaz calificados, se crea un proxy basado en el JDK. El proxy creado implementa todas las interfaces que se especificaron en la propiedad proxyInterfaces. Si la clase de destino implementa muchas más interfaces que las especificadas en la propiedad proxyInterfaces, eso es genial, pero esas interfaces adicionales no serán implementadas por el proxy devuelto.

Si el proxyInterfaces en ProxyFactoryBean no se especificó, pero la clase de destino implementa una (o más) interfaces, ProxyFactoryBean detecta automáticamente el hecho de que la clase de destino se implementa en al menos una interfaz y se crea un proxy basado en el JDK. Las interfaces que en realidad son proxy son todas las interfaces que implementa la clase de destino. Esto es esencialmente lo mismo que especificar una lista de todas y cada una de las interfaces que la clase de destino implementa para la propiedad proxyInterfaces. Sin embargo, requiere mucho menos trabajo y es menos probable que se cometan errores tipográficos.

Interfaces de proxy

Veamos un ejemplo simple de ProxyFactoryBean en acción. Este ejemplo incluye:

• El bean de destino que será proxy. Esta es la definición del bean personTarget en el ejemplo.

• Advisor y Interceptor se utiliza para proporcionar asesoramiento.

• Defina un bean proxy AOP para especificar el objeto de destino (el bean personTarget), las interfaces para el proxy y el consejos que se aplicarán.

El siguiente listado muestra un ejemplo:

   <bean id="personTarget" class="com.mycompany.PersonImpl">
    <property name="name" value="Tony"/>
    <property name="age" value="51"/>
</bean>
<bean id="myAdvisor" class="com.mycompany.MyAdvisor">
    <property name="someProperty" value="Custom string property value"/>
</bean>
<bean id="debugInterceptor" class="org.springframework.aop.interceptor.DebugInterceptor">
</bean>
<bean id="person"
      class="org.springframework.aop.framework.ProxyFactoryBean">
    <property name="proxyInterfaces" value="com.mycompany.Person"/>
    <property name="target" ref="personTarget"/>
    <property name="interceptorNames">
        <list>
            <value>myAdvisor</value>
            <value>debugInterceptor</value>
        </list>
    </property>
</bean>

Tenga en cuenta que la propiedad interceptorNames acepta una lista String que contiene nombres de beans interceptores o asesores en la fábrica actual. Puede utilizar asesores, interceptores, objetos con consejos "antes", "después del retorno" y "lanzar excepción". El orden de los asesores es importante.

La definición del bean person mostrada anteriormente se puede utilizar en lugar de la implementación Person de la siguiente manera:

Persona persona = (Persona) factory.getBean("persona");

val person = factory.getBean("person") as Person;

 
<bean id="personUser" class="com.mycompany.PersonUser">
    <property name="person"><ref bean="person"/></property>
</bean>

<bean id="myAdvisor" class="com.mycompany.MyAdvisor">
    <property name="someProperty" value="Custom string property value"/>
</bean>
<bean id="debugInterceptor" class="org.springframework.aop.interceptor.DebugInterceptor"/>
<bean id="person" class="org.springframework.aop.framework.ProxyFactoryBean">
    <property name="proxyInterfaces" value="com.mycompany.Person"/>
     <!-- Use an internal bean rather than a local reference to the target -->
    <property name="target">
        <bean class="com.mycompany.PersonImpl">
            <property name="name" value="Tony"/>
            <property name="age" value="51"/>
        </bean>
    </property>
    <property name="interceptorNames">
        <list>
            <value>myAdvisor</value>
            <value>debugInterceptor</value>
        </list>
    </property>
</bean>

<bean id="proxy" class="org.springframework.aop.framework.ProxyFactoryBean">
    <property name="target" ref="service"/>
    <property name="interceptorNames">
        <list>
            <value>global* </value>
        </list>
    </property>
</bean>
<bean id="global_debug" class="org.springframework.aop.interceptor.DebugInterceptor"/>
<bean id="global_performance" class="org.springframework.aop.interceptor.PerformanceMonitorInterceptor"/>