springboot之基于maven管理的springboot项目的加载方式

时间：2025-04-21 07:32:10

JarFile URL的扩展

Spring boot能做到以一个fat jar来启动，最重要的一点是它实现了jar in jar的加载方式。

JDK原始的JarFile URL的定义可以参考这里：

/javase/7/docs/api/java/net/

原始的JarFile URL是这样子的：

jar:file:/tmp/target/demo-0.0.1-SNAPSHOT.jar!/

jar包里的资源的URL：

jar:file:/tmp/target/demo-0.0.1-SNAPSHOT.jar!/com/example/SpringBootDemoApplication.class

可以看到对于Jar里的资源，定义以’!/’来分隔。原始的JarFile URL只支持一个’!/’。

Spring boot扩展了这个协议，让它支持多个’!/’，就可以表示jar in jar，jar in directory的资源了。

比如下面的URL表示demo-0.0.这个jar里lib目录下面的spring-beans-4.2.里面的：

jar:file:/tmp/target/demo-0.0.1-SNAPSHOT.jar!/lib/spring-beans-4.2.3.RELEASE.jar!/META-INF/MANIFEST.MF
自定义URLStreamHandler，扩展JarFile和JarURLConnection

在构造一个URL时，可以传递一个Handler，而JDK自带有默认的Handler类，应用可以自己注册Handler来处理自定义的URL。

public URL(String protocol,
           String host,
           int port,
           String file,
           URLStreamHandler handler)
    throws MalformedURLException

参考： 
/javase/8/docs/api/java/net/#-

Spring boot通过注册了一个自定义的Handler类来处理多重jar in jar的逻辑。

这个Handler内部会用SoftReference来缓存所有打开过的JarFile。

在处理像下面这样的URL时，会循环处理’!/’分隔符，从最上层出发，先构造出demo-0.0.这个JarFile，再构造出spring-beans-4.2.这个JarFile，然后再构造出指向的JarURLConnection。

jar:file:/tmp/target/demo-0.0.1-SNAPSHOT.jar!/lib/spring-beans-4.2.3.RELEASE.jar!/META-INF/MANIFEST.MF
//
public class Handler extends URLStreamHandler {
    private static final String SEPARATOR = "!/";
    private static SoftReference<Map<File, JarFile>> rootFileCache;
    @Override
    protected URLConnection openConnection(URL url) throws IOException {
        if (this.jarFile != null) {
            return new JarURLConnection(url, this.jarFile);
        }
        try {
            return new JarURLConnection(url, getRootJarFileFromUrl(url));
        }
        catch (Exception ex) {
            return openFallbackConnection(url, ex);
        }
    }
    public JarFile getRootJarFileFromUrl(URL url) throws IOException {
        String spec = ();
        int separatorIndex = (SEPARATOR);
        if (separatorIndex == -1) {
            throw new MalformedURLException("Jar URL does not contain !/ separator");
        }
        String name = (0, separatorIndex);
        return getRootJarFile(name);
    }
ClassLoader如何读取到Resource

对于一个ClassLoader，它需要哪些能力？

  • 查找资源
  • 读取资源

对应的API是：

public URL findResource(String name)
public InputStream getResourceAsStream(String name)

上面提到，Spring boot构造LaunchedURLClassLoader时，传递了一个URL[]数组。数组里是lib目录下面的jar的URL。

对于一个URL，JDK或者ClassLoader如何知道怎么读取到里面的内容的？

实际上流程是这样子的：

  • ()
  • ()
  • (URL)

最终调用的是JarURLConnection的getInputStream()函数。

//
    @Override
    public InputStream getInputStream() throws IOException {
        connect();
        if (this.()) {
            throw new IOException("no entry name specified");
        }
        return this.();
    }

从一个URL，到最终读取到URL里的内容，整个过程是比较复杂的，总结下：

  • spring boot注册了一个Handler来处理”jar:”这种协议的URL
  • spring boot扩展了JarFile和JarURLConnection，内部处理jar in jar的情况
  • 在处理多重jar in jar的URL时，spring boot会循环处理，并缓存已经加载到的JarFile
  • 对于多重jar in jar，实际上是解压到了临时目录来处理，可以参考JarFileArchive里的代码
  • 在获取URL的InputStream时，最终获取到的是JarFile里的JarEntryData

这里面的细节很多，只列出比较重要的一些点。

然后，URLClassLoader是如何getResource的呢？

URLClassLoader在构造时，有URL[]数组参数，它内部会用这个数组来构造一个URLClassPath:

URLClassPath ucp = new URLClassPath(urls);

在 URLClassPath 内部会为这些URLS 都构造一个Loader，然后在getResource时，会从这些Loader里一个个去尝试获取。 
如果获取成功的话，就像下面那样包装为一个Resource。

Resource getResource(final String name, boolean check) {
    final URL url;
    try {
        url = new URL(base, (name, false));
    } catch (MalformedURLException e) {
        throw new IllegalArgumentException("name");
    }
    final URLConnection uc;
    try {
        if (check) {
            (url);
        }
        uc = ();
        InputStream in = ();
        if (uc instanceof JarURLConnection) {
            /* Need to remember the jar file so it can be closed
             * in a hurry.
             */
            JarURLConnection juc = (JarURLConnection)uc;
            jarfile = (());
        }
    } catch (Exception e) {
        return null;
    }
    return new Resource() {
        public String getName() { return name; }
        public URL getURL() { return url; }
        public URL getCodeSourceURL() { return base; }
        public InputStream getInputStream() throws IOException {
            return ();
        }
        public int getContentLength() throws IOException {
            return ();
        }
    };
}

从代码里可以看到，实际上是调用了()。这样完整的链条就可以连接起来了。

注意，URLClassPath这个类的代码在JDK里没有自带，在这里看到 /file//java/root/jdk/openjdk/7u40-b43/sun/misc/#506

在IDE/开放目录启动Spring boot应用

在上面只提到在一个fat jar里启动Spring boot应用的过程，下面分析IDE里Spring boot是如何启动的。

在IDE里，直接运行的Main函数是应用自己的Main函数：

@SpringBootApplication
public class SpringBootDemoApplication {

    public static void main(String[] args) {
        (, args);
    }
}

其实在IDE里启动Spring boot应用是最简单的一种情况，因为依赖的Jar都让IDE放到classpath里了，所以Spring boot直接启动就完事了。

还有一种情况是在一个开放目录下启动Spring boot启动。所谓的开放目录就是把fat jar解压，然后直接启动应用。

java org.springframework.boot.loader.JarLauncher

这时，Spring boot会判断当前是否在一个目录里，如果是的，则构造一个ExplodedArchive（前面在jar里时是JarFileArchive），后面的启动流程类似fat jar的。

Embead Tomcat的启动流程

判断是否在web环境

(false)函数可以设定项目的运行环境为非web环境，调用AnnotationConfigApplicationContext函数设定；false改为true即可设定为web环境，调用AnnotationConfigEmbeddedWebApplication函数设定

spring boot在启动时，先通过一个简单的查找Servlet类的方式来判断是不是在web环境：

private static final String[] WEB_ENVIRONMENT_CLASSES = { "",
    "" };

private boolean deduceWebEnvironment() {
    for (String className : WEB_ENVIRONMENT_CLASSES) {
        if (!(className, null)) {
            return false;
        }
    }
    return true;
}

如果是的话，则会创建AnnotationConfigEmbeddedWebApplicationContext，否则Spring context就是AnnotationConfigApplicationContext：

//
    protected ConfigurableApplicationContext createApplicationContext() {
        Class<?> contextClass = this.applicationContextClass;
        if (contextClass == null) {
            try {
                contextClass = (this.webEnvironment
                        ? DEFAULT_WEB_CONTEXT_CLASS : DEFAULT_CONTEXT_CLASS);
            }
            catch (ClassNotFoundException ex) {
                throw new IllegalStateException(
                        "Unable create a default ApplicationContext, "
                                + "please specify an ApplicationContextClass",
                        ex);
            }
        }
        return (ConfigurableApplicationContext) (contextClass);
    }
获取EmbeddedServletContainerFactory的实现类

spring boot通过获取EmbeddedServletContainerFactory来启动对应的web服务器。

常用的两个实现类是TomcatEmbeddedServletContainerFactory和JettyEmbeddedServletContainerFactory。

启动Tomcat的代码：

//TomcatEmbeddedServletContainerFactory
@Override
public EmbeddedServletContainer getEmbeddedServletContainer(
        ServletContextInitializer... initializers) {
    Tomcat tomcat = new Tomcat();
    File baseDir = (this.baseDirectory != null ? this.baseDirectory
            : createTempDir("tomcat"));
    (());
    Connector connector = new Connector(this.protocol);
    ().addConnector(connector);
    customizeConnector(connector);
    (connector);
    ().setAutoDeploy(false);
    ().setBackgroundProcessorDelay(-1);
    for (Connector additionalConnector : this.additionalTomcatConnectors) {
        ().addConnector(additionalConnector);
    }
    prepareContext((), initializers);
    return getTomcatEmbeddedServletContainer(tomcat);
}

会为tomcat创建一个临时文件目录，如： 
/tmp/tomcat.2233614112516545210.8080，做为tomcat的basedir。里面会放tomcat的临时文件，比如work目录。

还会初始化Tomcat的一些Servlet，比如比较重要的default/jsp servlet：

private void addDefaultServlet(Context context) {
    Wrapper defaultServlet = ();
    ("default");
    ("");
    ("debug", "0");
    ("listings", "false");
    (1);
    // Otherwise the default location of a Spring DispatcherServlet cannot be set
    (true);
    (defaultServlet);
    ("/", "default");
}

private void addJspServlet(Context context) {
    Wrapper jspServlet = ();
    ("jsp");
    (getJspServletClassName());
    ("fork", "false");
    (3);
    (jspServlet);
    ("*.jsp", "jsp");
    ("*.jspx", "jsp");
}

spring boot的web应用如何访问Resource

当spring boot应用被打包为一个fat jar时，是如何访问到web resource的？

实际上是通过Archive提供的URL，然后通过Classloader提供的访问classpath resource的能力来实现的。

比如需要配置一个，这个可以直接放在代码里的src/main/resources/static目录下。

对于欢迎页，spring boot在初始化时，就会创建一个ViewController来处理：

//ResourceProperties
public class ResourceProperties implements ResourceLoaderAware {

    private static final String[] SERVLET_RESOURCE_LOCATIONS = { "/" };

    private static final String[] CLASSPATH_RESOURCE_LOCATIONS = {
            "classpath:/META-INF/resources/", "classpath:/resources/",
            "classpath:/static/", "classpath:/public/" };
//WebMvcAutoConfigurationAdapter
        @Override
        public void addViewControllers(ViewControllerRegistry registry) {
            Resource page = this.();
            if (page != null) {
                ("Adding welcome page: " + page);
                ("/").setViewName("forward:");
            }
        }
template

像页面模板文件可以放在src/main/resources/template目录下。但这个实际上是模板的实现类自己处理的。比如ThymeleafProperties类里的：

public static final String DEFAULT_PREFIX = "classpath:/templates/";
jsp

jsp页面和template类似。实际上是通过spring mvc内置的JstlView来处理的。

可以通过配置来设定jsp页面的目录：

: /WEB-INF/jsp/

spring boot里统一的错误页面的处理

对于错误页面，Spring boot也是通过创建一个BasicErrorController来统一处理的。

@Controller
@RequestMapping("${:${:/error}}")
public class BasicErrorController extends AbstractErrorController

对应的View是一个简单的HTML提醒：

    @Configuration
    @ConditionalOnProperty(prefix = "", name = "enabled", matchIfMissing = true)
    @Conditional()
    protected static class WhitelabelErrorViewConfiguration {

        private final SpelView defaultErrorView = new SpelView(
                "<html><body><h1>Whitelabel Error Page</h1>"
                        + "<p>This application has no explicit mapping for /error, so you are seeing this as a fallback.</p>"
                        + "<div id='created'>${timestamp}</div>"
                        + "<div>There was an unexpected error (type=${error}, status=${status}).</div>"
                        + "<div>${message}</div></body></html>");

        @Bean(name = "error")
        @ConditionalOnMissingBean(name = "error")
        public View defaultErrorView() {
            return this.defaultErrorView;
        }

spring boot的这个做法很好，避免了传统的web应用来出错时，默认抛出异常，容易泄密。

spring boot应用的maven打包过程

先通过maven-shade-plugin生成一个包含依赖的jar，再通过spring-boot-maven-plugin插件把spring boot loader相关的类，还有打包到jar里。

spring boot里有颜色日志的实现

当在shell里启动spring boot应用时，会发现它的logger输出是有颜色的，这个特性很有意思。

可以通过这个设置来关闭：

spring.output.ansi.enabled=false

原理是通过AnsiOutputApplicationListener ，这个来获取这个配置，然后设置logback在输出时，加了一个 ColorConverter，通过 ，对一些字段进行了渲染。

一些代码小技巧

实现ClassLoader时，支持JDK7并行加载

可以参考LaunchedURLClassLoader里的LockProvider

public class LaunchedURLClassLoader extends URLClassLoader {

    private static LockProvider LOCK_PROVIDER = setupLockProvider();
    private static LockProvider setupLockProvider() {
        try {
            ();
            return new Java7LockProvider();
        }
        catch (NoSuchMethodError ex) {
            return new LockProvider();
        }
    }

    @Override
    protected Class<?> loadClass(String name, boolean resolve)
            throws ClassNotFoundException {
        synchronized (LaunchedURLClassLoader.LOCK_PROVIDER.getLock(this, name)) {
            Class<?> loadedClass = findLoadedClass(name);
            if (loadedClass == null) {
                (true);
                try {
                    loadedClass = doLoadClass(name);
                }
                finally {
                    (false);
                }
            }
            if (resolve) {
                resolveClass(loadedClass);
            }
            return loadedClass;
        }
    }
检测jar包是否通过agent加载的

InputArgumentsJavaAgentDetector，原理是检测jar的URL是否有”-javaagent:”的前缀。

private static final String JAVA_AGENT_PREFIX = "-javaagent:";
获取进程的PID

ApplicationPid，可以获取PID。

    private String getPid() {
        try {
            String jvmName = ().getName();
            return ("@")[0];
        }
        catch (Throwable ex) {
            return null;
        }
    }
包装Logger类

spring boot里自己包装了一套logger，支持java, log4j, log4j2, logback，以后有需要自己包装logger时，可以参考这个。

在包下面。

获取原始启动的main函数

通过堆栈里获取的方式，判断main函数，找到原始启动的main函数。

private Class<?> deduceMainApplicationClass() {
    try {
        StackTraceElement[] stackTrace = new RuntimeException().getStackTrace();
        for (StackTraceElement stackTraceElement : stackTrace) {
            if ("main".equals(())) {
                return (());
            }
        }
    }
    catch (ClassNotFoundException ex) {
        // Swallow and continue
    }
    return null;
}

spirng boot的一些缺点：

当spring boot应用以一个fat jar方式运行时，会遇到一些问题。以下是个人看法：

  • 日志不知道放哪，默认是输出到stdout的
  • 数据目录不知道放哪, jenkinns的做法是放到 ${}/.jenkins 下面
  • 相对目录API不能使用，(“/”) 返回的是NULL
  • spring boot应用喜欢把配置都写到代码里，有时会带来混乱。一些简单可以用xml来表达的配置可能会变得难读，而且凌乱。

总结

spring boot通过扩展了jar协议，抽象出Archive概念，和配套的JarFile，JarUrlConnection，LaunchedURLClassLoader，从而实现了上层应用无感知的all in one的开发体验。尽管Executable war并不是spring提出的概念，但spring boot让它发扬光大。

spring boot是一个惊人的项目，可以说是spring的第二春，spring-cloud-config, spring-session, metrics, remote shell等都是深爱开发者喜爱的项目、特性。几乎可以肯定设计者是有丰富的一线开发经验，深知开发人员的痛点。

大量参考： /hengyunabc/article/details/50120001

相关文章