Service框架浅析
概述
Guava包里的Service接口用于封装一个服务对象的运行状态、包括start和stop等方法。例 如web服务 器,RPC服务器、计时器等可以实现这个接口。对此类服务的状态管理并不轻松、 需要对服务的开启/关闭进行妥善管理、特别是在多线程环境下尤为复杂。 Guava包提供了 一些基础类帮助你管理复杂的状态转换逻辑和同步细节。
使用一个服务 一个服务正常生命周期有:
- Service.State.NEW
- Service.State.STARTING
- Service.State.RUNNING
- Service.State.STOPPING
- Service.State.TERMINATED
服务一旦被停止就无法再重新启动了。如果服务在starting、running、stopping状态出现 问题、会进入Service.State.FAILED.状态。调用 startAsync()方法可以异步开启一个服务,同 时返回this对象形成方法调用链。注意:只有在当前服务的状态是NEW时才能调用 startAsync()方法,因此最好在应用中有一个统一的地方初始化相关服务。停止一个服务也 是类似的、使用异步方法stopAsync() 。但是不像startAsync(),多次调用这个方法是安全 的。这是为了方便处理关闭服务时候的锁竞争问题。
Service也提供了一些方法用于等待服务状态转换的完成:
通过 addListener()方法异步添加监听器。此方法允许你添加一个 Service.Listener 、它 会在每次服务状态转换的时候被调用。注意:最好在服务启动之前添加Listener(这时的状 态是NEW)、否则之前已发生的状态转换事件是无法在新添加的Listener上被重新触发的。
同步使用awaitRunning()。这个方法不能被打断、不强制捕获异常、一旦服务启动就会返回。 如果服务没有成功启动,会抛出IllegalStateException异常。同样的, awaitTerminated() 方法会等待服务达到终止状态(TERMINATED 或者 FAILED)。两个方 法都有重载方法允许传入超时时间。
Service 接口本身实现起来会比较复杂、且容易碰到一些捉摸不透的问题。因此我们不推荐 直接实现这个接口。而是请继承Guava包里已经封装好的基础抽象类。每个基础类支持一种 特定的线程模型。
基础实现类
AbstractIdleService
AbstractIdleService 类简单实现了Service接口、其在running状态时不会执行任何动作–因此在running时也不需要启动线程–但需要处理开启/关闭动作。要实现一个此类的服务,只需继承AbstractIdleService类,然后自己实现startUp() 和shutDown()方法就可以了。
protected void startUp() {
servlets.add(new GcStatsServlet());
}
protected void shutDown() {}
如上面的例子、由于任何请求到GcStatsServlet时已经会有现成线程处理了,所以在服务运 行时就不需要做什么额外动作了。
AbstractExecutionThreadService
AbstractExecutionThreadService 通过单线程处理启动、运行、和关闭等操作。你必须重 载run()方法,同时需要能响应停止服务的请求。具体的实现可以在一个循环内做处理:
public void run() {
while (isRunning()) {
// perform a unit of work
}
}
另外,你还可以重载triggerShutdown()方法让run()方法结束返回。重载startUp()和 shutDown()方法是可选的,不影响服务本身状态的管理
protected void startUp() {
dispatcher.listenForConnections(port, queue);
}
protected void run() {
Connection connection;
while ((connection = queue.take() != POISON)) {
process(connection);
}
}
protected void triggerShutdown() {
dispatcher.stopListeningForConnections(queue);
queue.put(POISON);
}
start()内部会调用startUp()方法,创建一个线程、然后在线程内调用run()方法。stop() 会调用 triggerShutdown()方法并且等待线程终止。
AbstractScheduledService
AbstractScheduledService类用于在运行时处理一些周期性的任务。子类可以实现 runOneIteration()方法定义一个周期执行的任务,以及相应的startUp()和shutDown()方 法。为了能够描述执行周期,你需要实现scheduler()方法。通常情况下,你可以使用 AbstractScheduledService.Scheduler类提供的两种调度器: newFixedRateSchedule(initialDelay, delay, TimeUnit) 和 newFixedDelaySchedule(initialDelay, delay, TimeUnit),类似于JDK并发包中 ScheduledExecutorService类提供的两种调度方式。如要自定义schedules则可以使用 CustomScheduler类来辅助实现;具体用法见javadoc。
AbstractService
如需要自定义的线程管理、可以通过扩展 AbstractService类来实现。一般情况下、使用上 面的几个实现类就已经满足需求了,但如果在服务执行过程中有一些特定的线程处理需求、 则建议继承AbstractService类。
继承AbstractService方法必须实现两个方法.
- doStart(): 首次调用startAsync()时会同时调用doStart(),doStart()内部需要处理所 有的初始化工作、如果启动成功则调用notifyStarted()方法;启动失败则调用 notifyFailed()
- doStop(): 首次调用stopAsync()会同时调用doStop(),doStop()要做的事情就是停止服 务,如果停止成功则调用 notifyStopped()方法;停止失败则调用 notifyFailed()方法。
doStart和doStop方法的实现需要考虑下性能,尽可能的低延迟。如果初始化的开销较大, 如读文件,打开网络连接,或者其他任何可能引起阻塞的操作,建议移到另外一个单独的线 程去处理。
使用ServiceManager
除了对Service接口提供基础的实现类,Guava还提供了 ServiceManager类使得涉及到多个 Service集合的操作更加容易。通过实例化ServiceManager类来创建一个Service集合,你可
以通过以下方法来管理它们:
- startAsync() : 将启动所有被管理的服务。如果当前服务的状态都是NEW的话、那么你 只能调用该方法一次、这跟 Service#startAsync()是一样的。
- stopAsync() :将停止所有被管理的服务。
- addListener :会添加一个ServiceManager.Listener,在服务状态转换中会调用该Listener
- awaitHealthy() :会等待所有的服务达到Running状态
- awaitStopped():会等待所有服务达到终止状态
检测类的方法有:
- isHealthy() :如果所有的服务处于Running状态、会返回True
- servicesByState():以状态为索引返回当前所有服务的快照
- startupTimes() :返回一个Map对象,记录被管理的服务启动的耗时、以毫秒为单位,同 时Map默认按启动时间排序。
我们建议整个服务的生命周期都能通过ServiceManager来管理,不过即使状态转换是通过其 他机制触发的、也不 影响ServiceManager方法的正确执行。例如:当一个服务不是通过 startAsync()、而是其他机制启动时,listeners 仍然可 以被正常调用、awaitHealthy() 也能够正常工作。ServiceManager 唯一强制的要求是当其被创建时所有的服务必须处于New 状 态。