java-buildpack源碼分析之Detect

Detect

該buildpack的探測的內容包含：容器，JRE，框架。具體內容在components.yml中能夠看到：

# Configuration for components to use in the buildpack
---
containers:
- "JavaBuildpack::Container::DistZip"
- "JavaBuildpack::Container::Groovy"
- "JavaBuildpack::Container::JavaMain"
- "JavaBuildpack::Container::PlayFramework"
- "JavaBuildpack::Container::Ratpack"
- "JavaBuildpack::Container::SpringBoot"
- "JavaBuildpack::Container::SpringBootCLI"
- "JavaBuildpack::Container::Tomcat"
# In order to use Oracle JREs instead of OpenJDK, you must comment out the OpenJDK line and uncomment the Oracle line.
# Please see the documentation for more detail.
jres:
- "JavaBuildpack::Jre::OpenJdkJRE"
# - "JavaBuildpack::Jre::OracleJRE"
frameworks:
- "JavaBuildpack::Framework::AppDynamicsAgent"
- "JavaBuildpack::Framework::JavaOpts"
- "JavaBuildpack::Framework::MariaDbJDBC"
- "JavaBuildpack::Framework::NewRelicAgent"
- "JavaBuildpack::Framework::PlayFrameworkAutoReconfiguration"
- "JavaBuildpack::Framework::PlayFrameworkJPAPlugin"
- "JavaBuildpack::Framework::PostgresqlJDBC"
- "JavaBuildpack::Framework::SpringAutoReconfiguration"
- "JavaBuildpack::Framework::SpringInsight"

由該文件能夠知道該buidpack支持的容器，JRE和框架。固然你能夠本身添加。

detect的入口是bin/detect，該腳本很是簡單，調用JavaBuildpack的with_buildpack靜態方法建立實例，而後在代碼塊裏調用JavaBuildpack.detect方法。最後將detect的結果組成一個字符串輸出，若是探測不對，則什麼也不輸出。

components = JavaBuildpack::Buildpack.with_buildpack(build_dir, 'Detect failed with exception %s') do |buildpack| # 這裏with_buildpack建立了一個JavaBuildpack::Buildpack的實例，查看buildpack.rb能夠看到
  buildpack.detect
end.compact

接下來看JavaBuildpack::Buildpack類，在buildpack.rb中。

with_buildpack方法

是在class << self中的，所以它是一個靜態方法，在看方法定義：

def with_buildpack(app_dir, message)
    app_dir = Pathname.new(File.expand_path(app_dir))  # app_dir變成一個Pathname實例
    application = Component::Application.new(app_dir)  # 建立application實例
    Logging::LoggerFactory.instance.setup app_dir # 初始化日誌
    yield new(app_dir, application) if block_given? # **建立一個對象，而且調用外部給的代碼塊**
  rescue => e
    handle_error(e, message)
end

特別注意其中註釋加**的那句，語法比較繞

detect方法

detect方法分別對應用使用的容器，JRE，框架探測

def detect
  tags = tag_detection('container', @containers, true)
  tags.concat tag_detection('JRE', @jres, true) unless tags.empty? # 若是不爲空則鏈接tags
  tags.concat tag_detection('framework', @frameworks, false) unless tags.empty?
  tags << "java-buildpack=#{@buildpack_version.to_s false}" unless tags.empty? # 加上buildpack版本
  tags = tags.flatten.compact.sort
  @logger.debug { "Detection Tags: #{tags}" }
  tags
end

detection方法

調用每一個組件的detect方法，這些實際上是子組件（如：容器大項中的tomcat子項），並將結果集合返回。

def detection(type, components, unique)
  detected = []
  tags = []
  components.each do |component|
    result = component.detect
    next unless result # 若是結果不爲空則跳出循環
    detected << component
    tags << result
  end
  fail "Application can be run by more than one #{type}: #{names detected}" if unique && detected.size > 1
  [detected, tags]
end

具體項目的detect方法

這裏重點關注下tomcat的detect方法，tomcat.rb

tomcat的類定義：

class Tomcat < JavaBuildpack::Component::ModularComponent

初始化方法

def initialize(context, &version_validator)
  super(context, &version_validator)
  @sub_components = supports? ? sub_components(context) : [] # tomcat支持嗎？，若是支持，初始化子項目，注意：這裏兩個問號，前一個是方法support?後一個是問號表達式
end

能夠知道Tomcat是繼承自ModularComponent，detect方法是在ModularComponent中定義的，

def detect
  supports? ? @sub_components.map(&:detect).flatten.compact : nil # 若是支持探測子項目
end

tomcat的support?方法

def supports?
  web_inf? && !JavaBuildpack::Util::JavaMainUtils.main_class(@application) # WEB-INF目錄存在，且不存在Main方法
end
private
def web_inf?
  (@application.root + 'WEB-INF').exist? # 其實檢查的是，WEB-INF目錄是否存在
end

再看子項目有哪些？

def sub_components(context)
  [
  TomcatInstance.new(sub_configuration_context(context, 'tomcat')),
  TomcatLifecycleSupport.new(sub_configuration_context(context, 'lifecycle_support')),
  TomcatLoggingSupport.new(sub_configuration_context(context, 'logging_support')),
  TomcatAccessLoggingSupport.new(sub_configuration_context(context, 'access_logging_support')),
  TomcatRedisStore.new(sub_configuration_context(context, 'redis_store')),
  TomcatInsightSupport.new(context)
  ]
end

TomcatInstance的detect

先從配置文件config/tomcat.yml中找到tomcat的版本及下載路徑

tomcat:
version: 8.0.+
repository_root: "{default.repository.root}/tomcat"

 

 而後從repository_root(默認是：https://download.run.pivotal.io/) 下載tomcat/index.yml，該文件包含了全部版本的tomcat的下載路徑，找到具體的版本，如：8.0+指，8.0以上的版本，找到了8.0.14。

須要說明的是：

tomcat支持以後，TomcatInstance是默認支持的，由於tomcat instance就是基本的tomcat包， TomcatLifecycleSupport，TomcatLoggingSupport，TomcatAccessLoggingSupport也是默認支持的。

若是須要會話共享，複製，設置了service環境變量，TomcatRedisStore則是支持的。

而TomcatInsightSupport尚不支持。