聊聊arthas的spring-boot-starter

序

本文主要研究一下arthas的spring-boot-starter

ArthasConfiguration

arthas-spring-boot-starter/src/main/java/com/alibaba/arthas/spring/ArthasConfiguration.java

@ConditionalOnProperty(name = "spring.arthas.enabled", matchIfMissing = true)
@EnableConfigurationProperties({ ArthasProperties.class })
public class ArthasConfiguration {
    private static final Logger logger = LoggerFactory.getLogger(ArthasConfiguration.class);

    @Autowired
    ConfigurableEnvironment environment;

    /**
     * <pre>
     * 1. 提取所有以 arthas.* 開頭的配置項，再統一轉換為Arthas配置
     * 2. 避免某些配置在新版本里支援，但在ArthasProperties裡沒有配置的情況。
     * </pre>
     */
    @ConfigurationProperties(prefix = "arthas")
    @ConditionalOnMissingBean(name="arthasConfigMap")
    @Bean
    public HashMap<String, String> arthasConfigMap() {
        return new HashMap<String, String>();
    }

    @ConditionalOnMissingBean
    @Bean
    public ArthasAgent arthasAgent(@Autowired @Qualifier("arthasConfigMap") Map<String, String> arthasConfigMap,
            @Autowired ArthasProperties arthasProperties) throws Throwable {
        arthasConfigMap = StringUtils.removeDashKey(arthasConfigMap);
        ArthasProperties.updateArthasConfigMapDefaultValue(arthasConfigMap);
        /**
         * @see org.springframework.boot.context.ContextIdApplicationContextInitializer#getApplicationId(ConfigurableEnvironment)
         */
        String appName = environment.getProperty("spring.application.name");
        if (arthasConfigMap.get("appName") == null && appName != null) {
            arthasConfigMap.put("appName", appName);
        }

        // 給配置全加上字首
        Map<String, String> mapWithPrefix = new HashMap<String, String>(arthasConfigMap.size());
        for (Entry<String, String> entry : arthasConfigMap.entrySet()) {
            mapWithPrefix.put("arthas." + entry.getKey(), entry.getValue());
        }

        final ArthasAgent arthasAgent = new ArthasAgent(mapWithPrefix, arthasProperties.getHome(),
                arthasProperties.isSlientInit(), null);

        arthasAgent.init();
        logger.info("Arthas agent start success.");
        return arthasAgent;

    }
}

ArthasConfiguration註冊了arthasConfigMap及arthasAgent兩個bean

ArthasAgent

arthas-agent-attach/src/main/java/com/taobao/arthas/agent/attach/ArthasAgent.java

public class ArthasAgent {
    private static final int TEMP_DIR_ATTEMPTS = 10000;

    private static final String ARTHAS_CORE_JAR = "arthas-core.jar";
    private static final String ARTHAS_BOOTSTRAP = "com.taobao.arthas.core.server.ArthasBootstrap";
    private static final String GET_INSTANCE = "getInstance";
    private static final String IS_BIND = "isBind";

    private String errorMessage;

    private Map<String, String> configMap = new HashMap<String, String>();
    private String arthasHome;
    private boolean slientInit;
    private Instrumentation instrumentation;

    public ArthasAgent() {
        this(null, null, false, null);
    }

    //......

    public void init() throws IllegalStateException {
        // 嘗試判斷arthas是否已在執行，如果是的話，直接就退出
        try {
            Class.forName("java.arthas.SpyAPI"); // 載入不到會拋異常
            if (SpyAPI.isInited()) {
                return;
            }
        } catch (Throwable e) {
            // ignore
        }

        try {
            if (instrumentation == null) {
                instrumentation = ByteBuddyAgent.install();
            }

            // 檢查 arthasHome
            if (arthasHome == null || arthasHome.trim().isEmpty()) {
                // 解壓出 arthasHome
                URL coreJarUrl = this.getClass().getClassLoader().getResource("arthas-bin.zip");
                if (coreJarUrl != null) {
                    File tempArthasDir = createTempDir();
                    ZipUtil.unpack(coreJarUrl.openStream(), tempArthasDir);
                    arthasHome = tempArthasDir.getAbsolutePath();
                } else {
                    throw new IllegalArgumentException("can not getResources arthas-bin.zip from classloader: "
                            + this.getClass().getClassLoader());
                }
            }

            // find arthas-core.jar
            File arthasCoreJarFile = new File(arthasHome, ARTHAS_CORE_JAR);
            if (!arthasCoreJarFile.exists()) {
                throw new IllegalStateException("can not find arthas-core.jar under arthasHome: " + arthasHome);
            }
            AttachArthasClassloader arthasClassLoader = new AttachArthasClassloader(
                    new URL[] { arthasCoreJarFile.toURI().toURL() });

            /**
             * <pre>
             * ArthasBootstrap bootstrap = ArthasBootstrap.getInstance(inst);
             * </pre>
             */
            Class<?> bootstrapClass = arthasClassLoader.loadClass(ARTHAS_BOOTSTRAP);
            Object bootstrap = bootstrapClass.getMethod(GET_INSTANCE, Instrumentation.class, Map.class).invoke(null,
                    instrumentation, configMap);
            boolean isBind = (Boolean) bootstrapClass.getMethod(IS_BIND).invoke(bootstrap);
            if (!isBind) {
                String errorMsg = "Arthas server port binding failed! Please check $HOME/logs/arthas/arthas.log for more details.";
                throw new RuntimeException(errorMsg);
            }
        } catch (Throwable e) {
            errorMessage = e.getMessage();
            if (!slientInit) {
                throw new IllegalStateException(e);
            }
        }
    }
}    

ArthasAgent的init方法先嚐試載入java.arthas.SpyAPI，若SpyAPI.isInited()為true則直接返回；之後執行ByteBuddyAgent.install()；對於arthasHome為null則嘗試讀取arthas-bin.zip檔案，接著建立AttachArthasClassloader，載入com.taobao.arthas.core.server.ArthasBootstrap，執行其getInstance方法，再對例項執行isBind

ArthasEndPointAutoConfiguration

arthas-spring-boot-starter/src/main/java/com/alibaba/arthas/spring/endpoints/ArthasEndPointAutoConfiguration.java

@ConditionalOnProperty(name = "spring.arthas.enabled", matchIfMissing = true)
public class ArthasEndPointAutoConfiguration {

    @Bean
    @ConditionalOnMissingBean
    @ConditionalOnAvailableEndpoint
    public ArthasEndPoint arthasEndPoint() {
        return new ArthasEndPoint();
    }
}

ArthasEndPointAutoConfiguration則建立ArthasEndPoint

ArthasEndPoint

arthas-spring-boot-starter/src/main/java/com/alibaba/arthas/spring/endpoints/ArthasEndPoint.java

@Endpoint(id = "arthas")
public class ArthasEndPoint {

    @Autowired(required = false)
    private ArthasAgent arthasAgent;

    @Autowired(required = false)
    private HashMap<String, String> arthasConfigMap;

    @ReadOperation
    public Map<String, Object> invoke() {
        Map<String, Object> result = new HashMap<String, Object>();

        if (arthasConfigMap != null) {
            result.put("arthasConfigMap", arthasConfigMap);
        }

        String errorMessage = arthasAgent.getErrorMessage();
        if (errorMessage != null) {
            result.put("errorMessage", errorMessage);
        }

        return result;
    }

}

ArthasEndPoint提供了一個讀方法返回arthasConfigMap

小結

arthas的spring-boot-starter有兩個自動配置，分別是ArthasConfiguration及ArthasEndPointAutoConfiguration，其中ArthasConfiguration註冊了arthasConfigMap及arthasAgent兩個bean，而ArthasEndPointAutoConfiguration則建立ArthasEndPoint。