SpringBootjava
电话面试中,面试官问了一个问题:你知道javajar启动SpringBoot项目,和传统的jar有什么不一样的吗?
问题大概是这样,当时不太清楚怎么回答,面试结束之后知道面试估计是挂了,请教了一下面试官这个问题应该从哪方面去考虑呢?
大概记得面试官说,。。。自定义类加载器知道吗?。。。(中间一些内容就没听进去了)
我:原来是从这方面去考虑呀,感谢面试官的指点!
事后赶紧学了学,也走读了下启动过程的源码,终于知道他说的自定义类加载器了,也就知道他问这个问题的目的所在了。
凡是你接触过一点点SpringBoot项目,你一定知道通过javajarxxx。jar命令便能把一个SpringBoot服务启动起来。(如果你还没接触过,这里的内容可以日后再看,先轻微了解一下SpringBoot项目的玩法)
一个看似简陋的javajar究竟干了什么,就把咱们手写的应用(咱们的项目可能叫XXXApplication。java)启动了呢?
这就是本文的目的,解读一下javajar都做了什么。
至少面试的时候能搭上话,能说两句,不会像我一样只能哦哦哦的
温馨提示:技术文章阅读起来有些晕车,建议打开写作平台给咱们提供的文章目录进行阅读先有个概览
了解一个技术点,直接扎到源码堆里,云里雾里,很难受,容易让人望而生畏。
这时候可以先从整体或者非源码的角度了解一下它的运作机制,心里有个底,如果再感兴趣,就可以找一些细节,慢慢击破,可能效果更好,更能让人坚持下去。
这也是我后面准备学习源码的思路,就写一下。
虽然也是这样劝自己,可是还是看不懂,尴尬了,哈哈哈。。。
咱们就先拿这个javajarxxx。jar来说:
SpringBoot在可执行Fatjar包中定义了自己的一套规则,比如第三方依赖jar包在lib目录下,jar包的URL路径使用自定义的规则并且这个规则需要使用org。springframework。boot。loader。jar。Handler处理器处理。
Fatjar的MainClass使用org。springframework。boot。loader。JarLauncher,也就是执行javajarxxx。jar首先会触发JarLauncher的main方法的执行,而不是咱们的应用的xxx。xxx。xxx。XXXApplication。
不过不用急,JarLaunchermain会执行一些逻辑,做一些物料准备,最终会触发咱们的XXXApplicationmain启动应用。
先看个启动过程概览,日后研究不会慌!
还不会画时序图,不搞个呢又感觉少了些直观的东西,就勉强搞了个,这张图的主要目的是提供启动过程的调用关系。
怕时序图表达不够完善,再把简要代码贴一下,哈哈
提示:后面的东西需要一些耐心。
了解一些SpringBoot的抽象概念
了解一下SpringBootLoader所抽象出来的一些概念,对走读SpringBootloader源码有些帮助
Launcher:各种Launcher的基础抽象类,用于启动应用程序,跟Archive配合使用。
目前有3种实现,分别是JarLauncherWarLauncherPropertiesLauncher
继承关系如下
Archive:归档文件的基础抽象类。JarFileArchive就是jar包文件的抽象。
它提供了一些方法比如getUrl会返回这个Archive对应的URL。getManifest方法会获得Manifest数据等。ExplodedArchive是文件目录的抽象。
JarFile:对jar包的封装,每个JarFileArchive都会对应一个JarFile。JarFile被构造的时候会解析内部结构,去获取jar包里的各个文件或文件夹,这些文件或文件夹会被封装到Entry中,也存储在JarFileArchive中。如果Entry是个jar,会解析成JarFileArchive。
JarFile是Springbootloader继承JDKJarFile提供的类。
比如一个JarFileArchive对应的URL为:jar:file:C:UsersAdministratorDesktopdemodemoargetjarlauncher0。0。1SNAPSHOT。jar!
它对应的JarFile为:C:UsersAdministratorDesktopdemodemoargetjarlauncher0。0。1SNAPSHOT。jar
这个JarFile有很多Entry,比如:METAINFMETAINFMANIFEST。MF。。。。。。BOOTINFlibspringbootstarter1。5。10。RELEASE。jarBOOTINFlibspringboot1。5。10。RELEASE。jar。。。
JarFileArchive内部的一些依赖jar对应的URL
(SpringBoot使用org。springframework。boot。loader。jar。Handler处理器来处理这些URL)jar:file:C:UsersAdministratorDesktopdemodemotargetjarlauncher0。0。1SNAPSHOT。jar!libspringboot1。5。10。RELEASE。jar!jar:file:C:UsersAdministratorDesktopdemodemotargetjarlauncher0。0。1SNAPSHOT。jar!libspringboot1。5。10。RELEASE。jar!orgspringframeworkbootloaderJarLauncher。class
我们看到如果有jar包中包含jar,或者jar包中包含jar包里面的class文件,那么会使用!分隔开,这种方式只有org。springframework。boot。loader。jar。Handler能处理,它是SpringBoot内部扩展出来一种URL协议(其实这个非常重要,对于后面说的自定义加载器,拓展URL协议是基石)。
可执行jar目录结构
注意:咱们以SpringBoot1。5。10版本来分析
本来想直接用SpringBoot2。3。x作为debug环境的,也看了一圈网文,发现比2。3。x比1。x版本多了一些概念,比如分层的JarModel,自己又不会,弄过来直接搪塞过去也不太好,就先放弃了,最终使用不算太老的1。5。10版本。
SpringBoot提供了一个插件springbootmavenplugin用于把程序打包成一个可执行的jar包。
在pom文件里加入这个插件即可:buildpluginsplugingroupIdorg。springframework。bootgroupIdspringbootmavenpluginartifactIdpluginpluginsbuild
然后我们在Terminal执行mavenpackage打包完生成的jarlauncher0。0。1SNAPSHOT。jar(我们称之为Fatjar)内部的结构如下:BOOTINFclassesapplication。propertiescomexamplejarlauncherJarlauncherApplication。classlibspringboot1。5。10。RELEASE。jarspringbootloader1。5。10。RELEASE。jar。。。。。。。METAINFMANIFEST。MFmavencom。exampledemopom。propertiespom。xmlorgspringframeworkbootloaderExecutableArchiveLauncher。classJarLauncher。classLaunchedURLClassLoader。classLauncher。classMainMethodRunner。class。。。。。。
打包出来fatjar内部有三个文件夹:METAINF文件夹:程序入口,其中MANIFEST。MF(资源清单)用于描述jar包的信息BOOTINF目录:放置我们的程序代码和第三方依赖的jar包org目录:SpringBootloader相关的源代码,我们程序启动就靠他了
MANIFEST。MF文件的内容:ManifestVersion:1。0ImplementationTitle:demoImplementationVersion:0。0。1SNAPSHOTArchiverVersion:PlexusArchiverBuiltBy:AdministratorImplementationVendorId:com。exampleSpringBootVersion:1。5。10。RELEASEImplementationVendor:PivotalSoftware,Inc。MainClass:org。springframework。boot。loader。JarLauncherStartClass:com。example。jarlauncher。JarlauncherApplicationSpringBootClasses:BOOTINFclassesSpringBootLib:BOOTINFlibCreatedBy:ApacheMaven3。5。2BuildJdk:1。8。0162ImplementationURL:http:projects。spring。iospringbootdemo
我们看到,它的MainClass是org。springframework。boot。loader。JarLauncher,当我们使用javajar执行jar包的时候会调用JarLauncher的main方法,而不是调用我们编写的com。example。jarlauncher。JarlauncherApplication。
接下来咱们走读一下代码,看看实际怎么运行的吧!JarLauncher的执行过程提示:走读的时候时不时结合概览中的时序图,可能好些。
JarLauncher的main方法:publicstaticvoidmain(String〔〕args){构造JarLauncher,然后调用它的launch方法newJarLauncher()。launch(args);}
JarLauncher被构造的时候会调用父类ExecutableArchiveLauncher的构造方法。
ExecutableArchiveLauncher的构造方法内部会去构造Archive,这里构造了JarFileArchive。构造JarFileArchive的过程中还会构造很多东西,比如JarFile,EntrypublicabstractclassExecutableArchiveLauncherextendsLauncher{privatefinalArchivearchive;构造器会初始化代表fatjar的ArchivepublicExecutableArchiveLauncher(){this。archivecreateArchive();}由父类Launcher实现protectedfinalArchivecreateArchive()throwsException{ProtectionDomainprotectionDomaingetClass()。getProtectionDomain();CodeSourcecodeSourceprotectionDomain。getCodeSource();URIlocation(codeSourcenull?null:codeSource。getLocation()。toURI());Stringpath(locationnull?null:location。getSchemeSpecificPart());if(pathnull){thrownewIllegalStateException(Unabletodeterminecodesourcearchive);}FilerootnewFile(path);if(!root。exists()){thrownewIllegalStateException(Unabletodeterminecodesourcearchivefromroot);}最终会new一个Arichive,内部生产的JarFile这个逼对FatJar资源加载非常重要return(root。isDirectory()?newExplodedArchive(root):newJarFileArchive(root));}OverrideprotectedListgetClassPathArchives()throwsException{ListarchivesnewArrayList(获取内部所有有的Arichivethis。archive。getNestedArchives(newEntryFilter(){Overridepublicbooleanmatches(Entryentry){returnisNestedArchive(entry);}}));空实现,没用postProcessClassPathArchives(archives);returnarchives;}}
JarLauncher的launch方法:protectedvoidlaunch(String〔〕args){try{在系统属性中设置注册了自定义的URL协议处理器:org。springframework。boot。loader。jar。Handler。初始化URL的时候,如果URL中没有指定处理器,会去系统属性中查询JarFile。registerUrlProtocolHandler();getClassPathArchives方法会去找lib目录下对应的第三方依赖JarFileArchive,同时也会找项目自身的JarFileArchive根据getClassPathArchives得到的JarFileArchive集合去创建类加载器ClassLoader。这里会构造一个LaunchedURLClassLoader类加载器,这个类加载器继承URLClassLoader,并使用这些JarFileArchive集合的URL构造成URLClassPath多说两句句,1。URLClassPath这个属性很重要,自定义ClassLoader,findClass就靠它了!2。可以关注一下构造LaunchedURLClassLoader时,archive。getUrl方法,这里就涉及到自定义URL协议处理器了,JarFile等。毕竟实现jarinjar功能靠他们这些小罗罗。ClassLoaderclassLoadercreateClassLoader(getClassPathArchives());getMainClass方法会去项目自身的Archive中的Manifest中找出key为StartClass的类调用重载方法launchlaunch(args,getMainClass(),classLoader);}catch(Exceptionex){ex。printStackTrace();System。exit(1);}}Archive的getMainClass方法,不过由ExecutableArchiveLauncher实现这里会找出StartClass标识的com。example。jarlauncher。JarlauncherApplication这个类publicStringgetMainClass()throwsException{ManifestmanifestgetManifest();StringmainClassnull;if(manifest!null){mainClassmanifest。getMainAttributes()。getValue(StartClass);}if(mainClassnull){thrownewIllegalStateException(NoStartClassmanifestentryspecifiedinthis);}returnmainClass;}launch重载方法protectedvoidlaunch(String〔〕args,StringmainClass,ClassLoaderclassLoader)throwsException{设置LaunchedURLClassLoader为线程上下文加载器Thread。currentThread()。setContextClassLoader(classLoader);创建一个MainMethodRunner并运行createMainMethodRunner(mainClass,args,classLoader)。run();}
MainMethodRunner的run方法:publicvoidrun()throwsException{使用线程上下文类加载器加载主类Classlt;?mainClassThread。currentThread()。getContextClassLoader()。loadClass(this。mainClassName);反射执行,至此咱们的应用程序就启动起来啦,good,启动流程走读结束,开心!可以跟面试官扯些了MethodmainMethodmainClass。getDeclaredMethod(main,String〔〕。class);mainMethod。invoke(null,newObject〔〕{this。args});}
StartClass的main方法调用之后,内部会构造Spring容器,启动内置Servlet容器等过程(后面的就不说了,不是本文关注的点,况且也没细研究呢)
好了,到这里咱们已经把javajar的启动过程整体了解了一遍,开心吧!关于自定义的类加载器
看看传说中的LaunchedURLClassLoader有什么神奇的
LaunchedURLClassLoader重写了loadClass方法,走读一下protectedClasslt;?loadClass(Stringname,booleanresolve)throwsClassNotFoundException{Handler。setUseFastConnectionExceptions(true);try{try{在调用findClass之前定义package,确保嵌套JAR清单与包相关联definePackageIfNecessary(name);}catch(IllegalArgumentExceptionex){if(getPackage(name)null){thrownewAssertionError(Packagenamehasalreadybeendefinedbutitcouldnotbefound);}}调用父类loadClass走正常的加载委派流程returnsuper。loadClass(name,resolve);}finally{Handler。setUseFastConnectionExceptions(false);}}其实只看上面1。5。10版本的loadClass实现,毫无亮点,基本就是普通的双亲委派过程。
而且LaunchedURLClassLoader使用的findClass是从父类URLClassLoader继承的。
最终loadClass会走到LaunchedURLClassLoader的父类URLClassLoaderfindClassprotectedClasslt;?findClass(finalStringname)throwsClassNotFoundException{finalClasslt;?result;try{resultAccessController。doPrivileged(newPrivilegedExceptionActionClasslt;?(){publicClasslt;?run()throwsClassNotFoundException{把类名解析成路径并加上。class后缀Stringpathname。replace(。,)。concat(。class);基于之前得到的第三方jar包依赖以及自己的jar包得到URL数组,进行遍历找出对应类名的资源比如path是orgspringframeworkbootloaderJarLauncher。class,它在jar:file:UsersFormatDevelopgitrepositoryspringbootanalysisspringbootexecutablejartargetexecutablejar1。0SNAPSHOT。jar!libspringbootloader1。3。5。RELEASE。jar!中被找出那么找出的资源对应的URL为jar:file:UsersFormatDevelopgitrepositoryspringbootanalysisspringbootexecutablejartargetexecutablejar1。0SNAPSHOT。jar!libspringbootloader1。3。5。RELEASE。jar!orgspringframeworkbootloaderJarLauncher。class加载fatjarclass的关键部分!!!Resourceresucp。getResource(path,false);if(res!null){找到了资源try{returndefineClass(name,res);}catch(IOExceptione){thrownewClassNotFoundException(name,e);}}else{thrownewClassNotFoundException(name);}}},acc);}catch(java。security。PrivilegedActionExceptionpae){throw(ClassNotFoundException)pae。getException();}if(resultnull){thrownewClassNotFoundException(name);}returnresult;}
上面的findClass的过程,都是在关键代码Resourceresucp。getResource(path,false);这里完成的。
ucp也即JDK提供的sun。misc。URLClassPath
又画了个图,可以看到URLClassPathgetResource涉及哪些基础组件支持。
会用到URL,URLStreamHandler,org。springframework。boot。loader。jar。Handler,最终获取到Resource,完成classload。
所以,
个人结论:LaunchedURLClassLoader是借助他山之力,关键还在于SpringBoot对URLjar协议的拓展,Archeive,JarFile的抽象
LaunchedURLClassLoader加载测试
咱们手动模拟一下JarLauncher的加载过程,创建LaunchedURLClassLoader,然后加载个类试试好不好使?publicclassLaunchedURLClassLoaderTest{publicstaticvoidmain(String〔〕args)throwsException{注册org。springframework。boot。loader。jar。HandlerURL协议处理器JarFile。registerUrlProtocolHandler();构造LaunchedURLClassLoader类加载器,这里使用了1个URL,对应jar包中依赖包springbootloader会使用org。springframework。boot。loader。jar。Handler处理器处理LaunchedURLClassLoaderclassLoadernewLaunchedURLClassLoader(newURL〔〕{newURL(jar:file:C:UsersAdministratorDesktopdemodemotargetjarlauncher0。0。1SNAPSHOT。jar!BOOTINFlibspringbootloader1。5。10。RELEASE。jar!)},DemoApplication。class。getClassLoader());加载类classLoader。loadClass(org。springframework。boot。loader。JarLauncher);}}
把这个case跑通之后,JarLauncher的启动流程就没啥问题了吧?
赠送一个IDEADebugFatJar启动的环境
说了这么多启动流程,如何才能直观的debug到SpringBootLoader的执行过程呢?
下面咱们就来做这事,很简单,几分钟搞定。代码准备
直接在start。spring。io初始化一个的SpringBoot应用就行,版本改成1。5。10。
我这给个GitHub代码模板吧,点击去克隆
注意一点,maven要添加springbootloader的依赖,一起打到jar里去。!SpringBootloaderdependencygroupIdorg。springframework。bootgroupIdspringbootloaderartifactIddependency
然后mvnpackage,把应用打包成可执行jar。IDEA配置
1、配置以Jar应用的方式启动
2、配置Jar路径,然后Apply
3、找到启动类JarLauncher,打上断点,debug方式启动
如果你觉得这篇文章对你有帮助点赞关注,然后私信回复【888】即可获取Java进阶全套视频以及源码学习资料