dfx是一个基于插件架构（使用pf4j）的远程服务容器，它可以快速地帮助开发者基于现有的Java类创建远程restful服务。它的运行命令如下：
java -jar dfx-0.1-fat.jar -Dconf=conf -Dpf4j.pluginsDir=build/libs/plugins
其中：
- conf中定义了插件和暴露的url的映射
- pf4j.pluginsDir是pf4j的需要用到的参数，指明插件所在的目录。若不指明，插件目录则为当前目录下的plugins子目录。
配置文件的语法为Groovy，下面是conf的一个示例：
import io.vertx.core.http.HttpMethod
port = 7000
host = "127.0.0.1"
watchCycle = 5001
circuitBreaker {
maxFailures = 5
timeout = 10000
resetTimeout = 30000
}
cors {
allowedOriginPattern = '*'
allowedMethods = [HttpMethod.POST]
allowedHeaders = ['content-type']
}
mappings {
"/method1" {
plugin = "top.dteam.dfx.plugin.implment.Plugin1"
}
"/method2" {
plugin = "top.dteam.dfx.plugin.implment.Plugin2"
}
}
文件本身的内容已经说明白了配置的语法，这里不再赘述。开发者需要注意的是，plugin所对应的是插件的全限定名。
port、host、watchCycle、circuitBreaker的缺省值如下：
- port：8080
- host："0.0.0.0"
- watchCycle：5000 ms
- circuitBreakerOptions：
- maxFailures：3次
- timeout：5000 ms
- resetTimeout：10000 ms
如果要让Web前端能正常访问dfx中部署的服务，需要打开cors。同时，这里请留意引入“import io.vertx.core.http.HttpMethod”。
CORS的配置项如下：
- allowedOriginPattern
- allowedHeaders
- allowedMethods
- exposedHeaders
- maxAgeSeconds
- allowCredentials
同时请注意：当allowedOriginPattern为“*”时，allowCredentials不允许为“true”。
dfx的理念是：每个插件对应一个restful url。通过实现对应的接口（Accessible），完成restful service的开发。
为了保持简单和通用性，Accessible接口如下：
public interface Accessible extends ExtensionPoint{
Map invoke(Map parameters);
}
其中：
- ExtensionPoint来自pf4j，请参见其文档。
- 每个远程方法的入参和返回参数均为Map，可视为JSON的对等物。
插件工程的例子和模板可以参见这里，其依赖dfx-i，它仅包含Accessible接口。
插件开发完之后，运行下面的gradle命令来将其打包：
gradle plugin
这样就得到了一个plugin压缩包，在打包前请检查插件工程的build.gradle中manifest部分：
classes.doLast {
jar.manifest {
attributes("Manifest-Version": 1.0,
"Archiver-Version": "Plexus Archiver",
"Created-By": "Gradle",
"Built-By": "Hu Jian",
"Build-Jdk": JavaVersion.current(),
"Plugin-Class": "top.dteam.dfx.plugin.implment.Plugin1",
"Plugin-Id": "dfx-plugin1",
"Plugin-Provider": "Hu Jian",
"Plugin-Version": version)
writeTo("$buildDir/classes/main/META-INF/MANIFEST.MF")
}
}
其中的Plugin-Class和Plugin-Id请留意不要与其他插件发生冲突。
插件开发完毕之后，将其复制到相应的插件目录之下就完成了部署。启动dfx之后，应该能出现以下字样：
2017-11-01 07:04:59,382 [vert.x-eventloop-thread-0] INFO top.dteam.dfx.MainVerticle - top.dteam.dfx.plugin.implment.Plugin2 is loaded ...
2017-11-01 07:04:59,382 [vert.x-eventloop-thread-0] INFO top.dteam.dfx.MainVerticle - top.dteam.dfx.plugin.implment.Plugin1 is loaded ...
2017-11-01 07:05:00,130 [vert.x-eventloop-thread-0] INFO top.dteam.dfx.MainVerticle - dfx is listening at 0.0.0.0:7000 ...
此时，通过向暴露出的url发送请求即可：
curl -d '{"name":"name1"}' http://localhost:7000/method1
请注意，发送json作为请求体。
dfx支持热更新，它会监视conf文件和plugins目录的变化，监控周期由配置文件里的watchCycle指定。目前的reload方式简单粗暴：当发现任意一个变化时，会重新加载整个服务，即相当于重启。
更新plugin时请按照以下步骤进行：
- 更新conf文件配置（如有必要）
- 删除pluygins目录下对应plugin的目录和zip文件
- 复制新的plugin zip文件到plugins目录
提示：建议讲上述过程脚本化，避免更新过程中反复重启。
- git clone
- gradle shadowJar，生成dfx的fatjar
- gradle test，运行测试代码
在发起Pull Request时，请同时提交测试代码，并保证现有测试代码【对于测试，我们推荐Spock】能全部通过，;)。