Built-in Functions

To facilitate obtaining information about attached applications, DebugTools provides some Groovy built-in functions.

Get JVM Instance

By calling gi / getInstances passing in the class object, you can get the current JVM instance array of the class.

Function definition

/**
 * Get all instances of the specified Class in the JVM
 *
 * @param targetClass The class object to be obtained
 * @param <T>         Specific types
 * @return Instance Array
 */
public <T> T[] gi(Class<T> targetClass) {}

/**
 * Get all instances of the specified Class in the JVM
 *
 * @param targetClass The class object to be obtained
 * @param <T>         Specific types
 * @return Instance Array
 */
public <T> T[] getInstances(Class<T> targetClass) {}

Usage example

import org.springframework.context.ApplicationContext
// gi or getInstances to get the jvm instance
gi(ApplicationContext.class)
gi ApplicationContext.class
getInstances(ApplicationContext.class)
getInstances ApplicationContext.class

Spring Bean operation

Injecting Bean Instances

Bean instances are injected by calling rb / registerBean.

Function definition

/**
 * Inject the instance into the Spring container and generate the BeanName according to Spring's BeanName rule
 *
 * @param bean The bean to be obtained
 * @param <T>  Specific type
 */
public <T> void rb(T bean) {}

/**
 * Inject the instance into the Spring container and generate the BeanName according to Spring's BeanName rule
 *
 * @param bean The bean to be obtained
 * @param <T>  Specific type
 */
public <T> void registerBean(T bean) {}

/**
 * Inject an instance into the Spring container and specify the BeanName
 *
 * @param beanName Injected BeanName
 * @param bean     The bean to be obtained
 * @param <T>      Specific type
 */
public <T> void rb(String beanName, T bean) {}

/**
 * Inject an instance into the Spring container and specify the BeanName
 *
 * @param beanName Injected BeanName
 * @param bean     The bean to be obtained
 * @param <T>      Specific type
 */
public <T> void registerBean(String beanName, T bean) {}

Usage example

class TestBean {
    String hello(String name) {
        return "hello " + name
    }
}

def testBean = new TestBean()
rb(testBean)
rb("testBean", testBean)
registerBean(testBean)
registerBean("testBean", testBean)

Get Bean Instance

Get the Spring Bean instance by calling gb / getBean.

Function definition

/**
 * Get all instances of the specified Bean in the Spring container
 *
 * @param beanClass The class object to be obtained
 * @param <T>       Specific Type
 * @return Instance Array
 */
public <T> T[] gb(Class<T> beanClass) {}

/**
 * Get all instances of the specified Bean in the Spring container
 *
 * @param beanClass The class object to be obtained
 * @param <T>       Specific Type
 * @return Instance Array
 */
public <T> T[] getBean(Class<T> beanClass) {}

/**
 * Get all instances of the specified Bean in the Spring container
 *
 * @param beanName The name of the bean to get
 * @param <T>      Specific Type
 * @return Instance Array
 */
public <T> T[] gb(String beanName) {}

/**
 * Get all instances of the specified Bean in the Spring container
 *
 * @param beanName The name of the bean to get
 * @param <T>      Specific Type
 * @return Instance Array
 */
public <T> T[] getBean(String beanName) {}

Usage example

gb(TestBean.class)
// Get the injected testBean and execute the hello method
gb("testBean")[0].hello("debug tools")
gb TestBean.class
getBean(TestBean.class)
getBean("testBean")
getBean TestBean.class

Destroy Bean Instance

Destroy the Spring Bean instance by calling urb / unregisterBean.

Function definition

/**
 * Destroys the bean with the specified name
 *
 * @param beanName The name of the bean to be destroyed
 */
public void urb(String beanName) {}

/**
 * Destroys the bean with the specified name
 *
 * @param beanName The name of the bean to be destroyed
 */
public void unregisterBean(String beanName) {}

Usage example

urb("testBean")
unregisterBean("testBean")

Get the Spring runtime environment

Get the spring.profiles.active configuration information by calling gActive / getSpringProfilesActive.

函数定义

/**
 * Get the spring running environment
 *
 * @return environment
 */
public String gActive() {}

/**
 * Get the spring running environment
 *
 * @return environment
 */
public String getSpringProfilesActive() {}

Usage example

gActive()
getSpringProfilesActive()

Get Spring Configuration Information

Get spring configuration information by calling gsc / getSpringConfig.

Function definition

/**
 * Get spring configuration
 *
 * @param key Configuration key
 * @return Specific configuration information
 */
public Object gsc(String key) {}

/**
 * Get spring configuration
 *
 * @param key Configuration key
 * @return Specific configuration information
 */
public Object getSpringConfig(String key) {}

Usage example

gsc("spring.application.name")
gsc "spring.application.name"
getSpringConfig("spring.application.name")
getSpringConfig "spring.application.name"

Complete Example

import org.springframework.context.ApplicationContext

// Return results
class ResultDTO {
    // Results for gi
    ApplicationContext[] gi
    // Results for gb
    TestBean[] gb
    // The result of calling the hello method
    String helloMethodResult
    // Current Environment
    String active
    // Application Name
    String applicationName
}

// To inject TestBean
class TestBean {

    String hello(String name) {
        return "hello " + name
    }
}

def result = new ResultDTO()

// gi or getInstances to get the jvm instance
def v1 = gi(ApplicationContext.class)
result.gi = v1
gi ApplicationContext.class
getInstances(ApplicationContext.class)
getInstances ApplicationContext.class

def testBean = new TestBean()
// Inject beans into spring
rb(testBean)
//rb("testBean", testBean)
//registerBean(testBean)
//registerBean("testBean", testBean)


// gb or getBean to get spring bean
def v2 = gb(TestBean.class)
result.gb = v2
// Get the injected testBean and execute the hello method
result.helloMethodResult = gb("testBean")[0].hello("debug tools")
gb TestBean.class
getBean(TestBean.class)
getBean("testBean")
getBean TestBean.class

// destroy bean
urb("testBean")
//unregisterBean("testBean")

// Active or get SpringProfilesActive to get the current spring environment
def v3 = gActive()
result.active = v3
getSpringProfilesActive()

// gsc or getSpringConfig to get spring configuration
def v4 = gsc("spring.application.name")
result.applicationName = v4
gsc "spring.application.name"
getSpringConfig("spring.application.name")
getSpringConfig "spring.application.name"
return result

Use debug to view the returned results.