Skip to content

README.md

Latest commit

 

History

History
235 lines (178 loc) · 9.82 KB

README.md

File metadata and controls

235 lines (178 loc) · 9.82 KB
FIT运行时

[TOC]

运行时形态

公共软件包

用户通过FIT所提供的软件包，将FIT运行时安装在操作系统中，并通过FIT所提供的命令行启动FIT运行时。

此时操作系统中存在FIT_HOME目录，并将其中的bin目录配置到Path环境变量，此时可通过fit命令启动FIT应用程序。

All In One

待补充

类加载程序

整体思路

在一个FIT应用中，所运行的组件有FIT框架和FIT插件。为了确保各组件间的类隔离，FIT框架与各个插件均使用独立的ClassLoader，从而达到三方包不冲突的目标。

但其中，FIT框架与各个插件可能通过Genericable进行通信，例如在某个插件中实现了Fitable，并在FIT框架或其他插件中通过Genericable进行调用，此时即需要这些Genericable在FIT框架与所有插件中呈现为同一个类，因此需要在同一个ClassLoader中被加载。

同时，FIT框架为插件实现提供了诸多API与工具方法，分别承载在fit-api和fit-util中，也需要被FIT框架及所有插件同时使用。

因此类加载程序的整体思路如下图所示。

avatar

其中：

  • SharedClassLoader，用以加载fit-api、fit-util及所有的Genericable定义，被FIT框架及所有插件使用。
  • FrameworkClassLoader，其双亲委派到SharedClassLoader，用以加载FIT框架。
  • PluginClassLoader，双亲委派到SharedClassloader，用以加载FIT插件，每个插件拥有独立的PluginClassLoader实例。

通过这样的实现，使FIT框架与所有插件使用相同的fit-api、fit-util及Genericable定义。而FIT框架与各插件均使用各自的Class Loader，从而达到类隔离的目标。

场景差异

为了实现上述的目标和结构，需要由FIT控制ClassLoader的创建过程，从而构建出所需的结构。

在直接启动一个FIT应用时，这个目标是很容易实现的。FIT应用通过fit-launcher模块启动fit-runtime，FIT框架的整体架构由fit-runtime承载并提供入口。此时整体的ClassLoader由fit-launcher创建并构建预期结构，并通过FrameworkClassLoader创建FitRuntime实例，进而加载并启动整个应用程序。

但是当用户直接编写main方法，并以此启动应用时，用户会在所编写的main方法中启动FitRuntime，FitRuntime会由AppClassLoader加载，其中会包含fit-api、fit-util以及FIT框架所使用到的Genericable，此时无法修改AppClassLoader的上层类加载程序并将公共包转移到其中，因此需要有特殊的手段来解决这个问题。

综上，ClassLoader的结构因实际情况而形成两个场景。

场景一：fit-launcher创建期望ClassLoader结构，并由FrameworkClassLoader加载FitRuntime

在此场景中，fit-launcher基于AppClassLoader创建SharedClassLoader，加载fit-api、fit-util及其他公共包，并提供后续的包注册能力。 之后fit-launcher再基于SharedClassLoader创建FrameworkClassLoader。

此时类加载程序的结构如下图。

avatar

场景二：AppClassLoader直接加载FitRuntime

在该场景下，FrameworkClassLoader直接使用AppClassLoader，其中包含fit-api、fit-util、框架实现、用户主插件实现及框架与主插件中使用到的所有Genericable。

此时用户主插件与FIT框架在同在FrameworkClassLoader，需要由用户解决三方包冲突问题。

为了避免框架与用户主插件，与其他插件产生的类冲突，需要额外基于FrameworkClassLoader的上层类加载程序创建SharedClassLoader，其包含FrameworkClassLoader的引用，并将fit-api、fit-util及所有Genericable托管到FrameworkClassLoader。

托管方式为，重写SharedClassLoader的loadClass方法，当所需加载的类型为fit-api、fit-util或FrameworkClassLoader存在的Genericable时，直接从FrameworkClassLoader中获取对应类型，并返回给调用方。

此时类加载程序的结构图如下：

avatar

应用程序配置

运行时配置优先级

avatar

框架配置

@startuml
hide empty members

skinparam backgroundColor #EEEBDC
skinparam roundcorner 20
skinparam sequenceArrowThickness 2
skinparam ClassFontName Consolas

skinparam class {
BackgroundColor<<REFERENCE>> LightGray
}

class DefaultConfigChain <<REFERENCE>> {}

interface FitRuntime {
+ {abstract} profile() : String
+ {abstract} entry() : Class
+ {abstract} config() : <color:blue><u>Config</u></color>
+ {abstract} loaderOfConfigs() : <color:blue><u>ConfigLoader</u></color>
+ {abstract} registryOfSharedJars() : <color:blue><u>SharedJarRegistry</u></color>
+ {abstract} resolverOfBeans() : <color:blue><u>BeanResolver</u></color>
+ {abstract} resolverOfDependencies() : <color:blue><u>DependencyResolver</u></color>
+ {abstract} resolverOfAnnotations() : <color:blue><u>AnnotationMetadataResolver</u></color>
+ {abstract} root() : <color:blue><u>Plugin</u></color>
+ {abstract} repoOfPlugins() : <color:blue><u>PluginRepo</u></color>
+ {abstract} pluginCandidates() : List<String>
}

class GlobalConfig {
- profile : String
- annotatedImports : <color:blue><u>ConfigChain</u></color>
- resourceResolver : <color:blue><u>ResourceResolver</u></color>
- configLoader : <color:blue><u>ConfigLoader</u></color>
+ importConfig(String) : <color:blue><u>Config</u></color>
}
GlobalConfig -up-> DefaultConfigChain
note right of GlobalConfig::"importConfig(String)"
Imports <color:blue><b>Config</b></color> from resource
with specific key.
end note

@enduml
@startuml
hide empty members

skinparam backgroundColor #EEEBDC
skinparam roundcorner 20
skinparam sequenceArrowThickness 2
skinparam ClassFontName Consolas

(*) --> "Parse <color:blue><b>Config</b></color> from CLI arguments"
--> "Load <color:blue><b>Config</b></color> from system properties"
--> "Load <color:blue><b>Config</b></color> from environment variables"
--> if "Has <b><i>config-file</i></b> config value?\nIn CLI, System Properties or\nEnvironment Variables <color:blue><b>Config</b></color>" then
    -> [yes] "Load <color:blue><b>Config</b></color> from <b><i>config-file</i></b>"
    -> "Load default builtin <color:blue><b>Config</b></color>\nSuch as <b><i>fit.yaml</i></b> and so on" as LoadDefaultBuiltin
    else
    --> [no] LoadDefaultBuiltin
--> (*)
@enduml

核心类图

hide empty members

skinparam backgroundColor #EEEBDC
skinparam roundcorner 20
skinparam sequenceArrowThickness 2
skinparam ClassFontName Consolas

interface FitRuntime {
+ {abstract} location() : URL
+ {abstract} entry() : Class
+ {abstract} config() : <color:blue><u>Config</u></color>
+ {abstract} root() : <color:blue><u>Plugin</u></color>
+ {abstract} plugins() : List<<color:blue><u>Plugin</u></color>>
+ {abstract} resources() : <color:blue><u>ResourceTree</u></color>
.. <color:red><b>Components</b></color> ..
+ {abstract} sharedClassLoader() : ClassLoader
+ {abstract} registryOfSharedJars() : <color:blue><u>SharedJarRegistry</u></color>
+ {abstract} loaderOfConfigs() : <color:blue><u>ConfigLoader</u></color>
+ {abstract} resolverOfBeans() : <color:blue><u>BeanResolver</u></color>
+ {abstract} resolverOfDependencies() : <color:blue><u>DependencyResolver</u></color>
+ {abstract} resolverOfAnnotations() : <color:blue><u>AnnotationMetadataResolver</u></color>
+ {abstract} publisherOfEvents() : <color:blue><u>EventPublisher</u></color>
.. <color:red><b>Environment</b></color> ..
+ {abstract} profile() : String
.. <color:red><b>Operations</b></color> ..
+ {abstract} started() : boolean
+ {abstract} start() : void
}
note left of FitRuntime::"entry()"
The entry class of the runtime. Only
active when a main plugin exists.
end note
note left of FitRuntime::"config()"
The global config of the runtime. It
will be loaded from CLI arguments,
system properties, external config
file and environment variables.
end note
note left of FitRuntime::"root()"
The root plugin of the runtime. It
will always be the FIT framework.
end note

interface Plugin {
+ {abstract} metadata() : <color:blue><u>PluginMetadata</u></color>
+ {abstract} config() : <color:blue><u>PluginConfig</u></color>
+ {abstract} pluginClassLoader() : ClassLoader
+ {abstract} runtime() : <color:blue><u>FitRuntime</u></color>
+ {abstract} resources() : <color:blue><u>ResourceTree</u></color>
+ {abstract} parent() : <color:blue><u>Plugin</u></color>
+ {abstract} children() : <color:blue><u>PluginCollection</u></color>
.. <color:red><b>Components</b></color> ..
+ {abstract} resolverOfResources() : <color:blue><u>ResourceResolver</u></color>
+ {abstract} publisherOfEvents() : <color:blue><u>EventPublisher</u></color>
+ {abstract} container() : <color:blue><u>BeanContainer</u></color>
+ {abstract} sr() : <color:blue><u>StringResource</u></color>
.. <color:red><b>Operations</b></color> ..
+ {abstract} started() : boolean
+ {abstract} start() : void
--
A plugin <b>MUST</b> be packaged as a <b>JAR</b>.
}
FitRuntime *-right-> Plugin : has

interface PluginMetadata {
+ {abstract} group() : String
+ {abstract} name() : String
+ {abstract} version() : String
+ {abstract} location() : URL
+ {abstract} category() : <color:blue><u>PluginCategory</u></color>
+ {abstract} level() : int
}
Plugin o.up.> PluginMetadata
Scenario Location of FitRuntime (relative of fit-runtime)
All In One ../../
Software Package ../

RootPlugin

All In One

img.png

  • SharedClassLoader
  • FrameworkClassLoader
  • PluginClassLoader