इस पोस्ट में, हम स्प्रिंग में एस्पेक्ट-ओरिएंटेड प्रोग्रामिंग (एओपी) के आंतरिक यांत्रिकी को उजागर करेंगे। ध्यान यह समझने पर होगा कि एओपी लॉगिंग जैसी कार्यक्षमता कैसे प्राप्त करता है, जिसे अक्सर "जादू" का एक रूप माना जाता है। कोर जावा कार्यान्वयन के माध्यम से चलते हुए, हम देखेंगे कि यह वास्तव में किसी जादुई चीज़ के बजाय जावा के प्रतिबिंब, प्रॉक्सी पैटर्न और एनोटेशन के बारे में कैसे है।

आवश्यक शर्तें

• जावा कोर प्रॉक्सी एपीआई
• प्रतिबिंब एपीआई
• एनोटेशन एपीआई

ये सभी java.lang.reflect,java.lang.annotation, और javassist.util.proxy पैकेज का हिस्सा हैं।

मूल तंत्र

स्प्रिंग एओपी के मूल में प्रॉक्सी ऑब्जेक्ट, विधि इंटरसेप्टर और प्रतिबिंब की अवधारणा निहित है। इस पैटर्न में मुख्य खिलाड़ी मेथडहैंडलर (या इनवोकेशन हैंडलर) है। यह हैंडलर विधि कॉल को इंटरसेप्ट करके प्रॉक्सी ऑब्जेक्ट के व्यवहार को नियंत्रित करता है। जब प्रॉक्सी पर कोई विधि लागू की जाती है, तो यह हैंडलर से होकर गुजरती है, जहां प्रतिबिंब के माध्यम से एनोटेशन का आत्मनिरीक्षण किया जा सकता है। लागू किए गए एनोटेशन के आधार पर, आवश्यक तर्क (जैसे, लॉगिंग) को पहले, बाद में या अपवाद पर निष्पादित किया जा सकता है।

इसे तोड़ना

1. प्रॉक्सी ऑब्जेक्ट: ये गतिशील रूप से बनाए गए ऑब्जेक्ट हैं जो आपके वास्तविक व्यावसायिक ऑब्जेक्ट के लिए खड़े होते हैं, विधि हैंडलर के माध्यम से विधि कॉल को रूट करते हैं।
2. आह्वान संचालक: यहीं पर अवरोधन का जादू होता है। प्रतिबिंब का उपयोग करके, हैंडलर लक्ष्य विधि पर मौजूद एनोटेशन की जांच कर सकता है और तदनुसार व्यवहार को बदल सकता है।
3. कस्टम एनोटेशन: आप कस्टम एनोटेशन को परिभाषित कर सकते हैं, जो लॉगिंग, सुरक्षा जांच या लेनदेन प्रबंधन जैसी अतिरिक्त कार्यक्षमता को ट्रिगर करने के लिए मार्कर के रूप में काम करते हैं।

उदाहरण: मान लीजिए कि हम कुछ विधि निष्पादन से पहले और बाद में लॉगिंग जोड़ना चाहते हैं। हर जगह हार्ड-कोडिंग लॉगिंग के बजाय, हम @BeforeMethod और @AfterMethod के साथ तरीकों को एनोटेट कर सकते हैं। हमारा हैंडलर इस एनोटेशन के लिए विधि का निरीक्षण करता है और गतिशील रूप से उचित लॉगिंग तर्क जोड़ता है।

हमारे उदाहरण के लिए नियंत्रक और सेवा कैसी दिखती हैं, इसकी कक्षाएं नीचे दी गई हैं।

WorkerController.java

package edu.pk.poc.aop.controller;

import edu.pk.poc.aop.annotation.AfterMethod;
import edu.pk.poc.aop.annotation.All;
import edu.pk.poc.aop.annotation.BeforeMethod;
import edu.pk.poc.aop.helper.ProxyFactory;
import edu.pk.poc.aop.service.Worker;
import edu.pk.poc.aop.service.WorkerService;
import edu.pk.poc.aop.service.WorkerServiceImpl;

public class WorkerController {
    WorkerService workerService = ProxyFactory.createProxy(WorkerServiceImpl.class);
    /**
     * This Method 1s annotated with @BeforeMethod and @AfterMethod, So the log statements
     * will be generated before and after method call.
     */
    @BeforeMethod
    @AfterMethod
    public void engageFullTimeWorker() throws Exception {
        Worker fullTimeWorker = new Worker();
        fullTimeWorker.setName("FullTime-Worker");
        fullTimeWorker.setPartTime(false);
        fullTimeWorker.setDuration(9);
        workerService.doWork(fullTimeWorker);
    }
    /**
     * This Method is annotated with @All, So the log statements will be generated before and after method call
     * along with exception if raised.
     */
    @All
    public void engagePartTimeWorker() throws Exception {
        Worker partTimeWorker = new Worker();
        partTimeWorker.setName("PartTime-Worker");
        partTimeWorker.setPartTime(true);
        partTimeWorker.setDuration(4);
        workerService.doWork(partTimeWorker);
    }
}

WorkerServiceImpl.java

package edu.pk.poc.aop.service;

import edu.pk.poc.aop.annotation.AfterMethod;

public class WorkerServiceImpl implements WorkerService {
    /**
     * Here this method is annotated with only @AfterMethod, So only log statement
     * will be generated after method call
     */
    @AfterMethod
    @Override
    public void doWork(Worker worker) throws Exception {
        if (worker.isPartTime()) {
            throw new Exception("Part time workers are not permitted to work.");
        }
        System.out.print("A full time worker is working for "   worker.getDuration()   " hours :: ");
        for (int i = 1; i 



मुख्य.जावा टेस्ट क्लास


package edu.pk.poc.aop.test;

import edu.pk.poc.aop.controller.WorkerController;
import edu.pk.poc.aop.helper.ProxyFactory;
import edu.pk.util.Logger;

public class Main {
    public static void main(String[] args) {
        WorkerController controller = ProxyFactory.createProxy(WorkerController.class);
        Logger logger = new Logger();
        try {
            System.out.println("Testing @BeforeMethod and @AfterMethod");
            System.out.println("-----------------------------------------");
            controller.engageFullTimeWorker();
            System.out.println("Testing @All");
            System.out.println("-----------------------------------------");
            controller.engagePartTimeWorker();
        } catch (Exception e) {
            logger.error("Exception caught in Main class");
        }
    }
}




आउटपुट


Testing @BeforeMethod and @AfterMethod
-----------------------------------------
>>> Entering into edu.pk.poc.aop.controller.WorkerController.engageFullTimeWorker()
A full time worker is working for 9 hours :: * * * * * * * * 
>>> Exiting from edu.pk.poc.aop.service.WorkerServiceImpl.doWork()
>>> Exiting from edu.pk.poc.aop.controller.WorkerController.engageFullTimeWorker()
Testing @All
-----------------------------------------
>>> Entering into edu.pk.poc.aop.controller.WorkerController.engagePartTimeWorker()
>>> Exception in edu.pk.poc.aop.controller.WorkerController.engagePartTimeWorker()
Exception caught in Main class





  
  
  यह काम किस प्रकार करता है


जब किसी प्रॉक्सी ऑब्जेक्ट पर एक विधि लागू की जाती है, तो कॉल को हैंडलर द्वारा इंटरसेप्ट किया जाता है, जो लक्ष्य विधि पर सभी एनोटेशन का निरीक्षण करने के लिए प्रतिबिंब का उपयोग करता है। उन एनोटेशन के आधार पर, हैंडलर निर्णय लेता है कि विधि प्रविष्टि/निकास को लॉग करना है, अपवादों को लॉग करना है, या लॉगिंग को पूरी तरह से छोड़ देना है।

यहां बताया गया है कि आप इसकी कल्पना कैसे कर सकते हैं:

• निष्पादन से पहले: लॉग विधि प्रविष्टि।
• निष्पादन के बाद: लॉग विधि से बाहर निकलें या सफलता।
• सभी: लॉग विधि प्रविष्टि, विधि प्रविष्टि और यदि उठाया गया है तो अपवाद पर। यह गतिशील व्यवहार दर्शाता है कि स्प्रिंग एओपी किसी जादुई चाल को नियोजित करने के बजाय कोर जावा एपीआई का लाभ उठाता है।

एनोटेशन परिभाषित करें

package edu.pk.poc.aop.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface AfterMethod {

}

package edu.pk.poc.aop.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface BeforeMethod {

}

package edu.pk.poc.aop.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface All {

}

प्रॉक्सी फैक्ट्री को परिभाषित करें

package edu.pk.poc.aop.helper;

/**
 * The {@code ProxyFactory} class is responsible for creating proxy objects using the Javassist library.
 * It allows for dynamic generation of proxies for classes or interfaces, with support for method interception.
 */
public class ProxyFactory {

    /**
     * A Javassist ProxyFactory instance used to generate proxy classes.
     */
    private static final javassist.util.proxy.ProxyFactory factory = new javassist.util.proxy.ProxyFactory();

    /**
     * Creates a proxy object for the given class or interface.
     * If the class is an interface, the proxy implements the interface.
     * If it's a concrete class, the proxy extends the class.
     *
     * @param    the type of the class or interface for which the proxy is to be created
     * @param klass the {@code Class} object representing the class or interface to proxy
     * @return a proxy instance of the specified class or interface, or {@code null} if proxy creation fails
     */
    public static  T createProxy(Class klass) {
        if (klass.isInterface())
            factory.setInterfaces(new Class[]{klass});
        else
            factory.setSuperclass(klass);
        try {
            return (T) factory.create(new Class>[0], new Object[0], new AOPLoggingMethodHandler());
        } catch (Exception e) {
            System.err.println(e.getMessage());
        }
        return null;
    }
}

मेथडहैंडलर को परिभाषित करें

package edu.pk.poc.aop.helper;

import edu.pk.poc.aop.annotation.AfterMethod;
import edu.pk.poc.aop.annotation.All;
import edu.pk.poc.aop.annotation.BeforeMethod;
import edu.pk.poc.aop.annotation.OnException;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;

import edu.pk.util.Logger;
import javassist.util.proxy.MethodHandler;

public class AOPLoggingMethodHandler implements MethodHandler {

    private static final Logger logger = new Logger();

    public Object invoke(Object self, Method thisMethod, Method proceed, Object[] args) throws Throwable {
        if (proceed != null) { // Concrete Method
            Object result = null;
            String className = resolveClassName(self);
            try {
                if (isAnnotationPresent(thisMethod, BeforeMethod.class) || isAnnotationPresent(thisMethod, All.class)) {
                    logger.info(">>> Entering into "   className   "."   thisMethod.getName()   "()");
                }
                result = proceed.invoke(self, args);
                if (isAnnotationPresent(thisMethod, AfterMethod.class) || isAnnotationPresent(thisMethod, All.class)) {
                    logger.info(">>> Exiting from "   className   "."   thisMethod.getName()   "()");
                }
            } catch (Throwable t) {
                if (isAnnotationPresent(thisMethod, OnException.class) || isAnnotationPresent(thisMethod, All.class)) {
                    logger.error(">>> Exception in "   className   "."   thisMethod.getName()   "()");
                }
                throw t;
            }
            return result;
        }
        throw new RuntimeException("Method is Abstract");
    }

    private boolean isAnnotationPresent(Method method, Class klass) {
        Annotation[] declaredAnnotationsByType = method.getAnnotationsByType(klass);
        return declaredAnnotationsByType != null && declaredAnnotationsByType.length > 0;
    }

    private String resolveClassName(Object self) {
        String className = self.getClass().getName();
        if (className.contains("_$$")) {
            className = className.substring(0, className.indexOf("_$$"));
        }
        return className;
    }
}

निष्कर्ष

स्प्रिंग एओपी क्रॉस-कटिंग चिंताओं के लिए एक शक्तिशाली उपकरण है, लेकिन यह कुछ भी क्रांतिकारी नहीं कर रहा है। यह प्रतिबिंब और प्रॉक्सी जैसी मूल जावा अवधारणाओं पर बनाया गया है, जो भाषा में ही उपलब्ध हैं। इसे समझकर, आप बेहतर ढंग से समझ सकते हैं कि स्प्रिंग डेवलपर की सुविधा के लिए इन निचले स्तर के यांत्रिकी को कैसे सरल बनाता है।