384      阿裏雲  技術社區[雲棲]

Java微服務開發指南 -- 使用Dropwizard構建微服務

使用Dropwizard構建微服務

    Dropwizard的曆史要早於Spring Boot和WildFly Swarm，它最早是在2011.12發布的v0.1.0版本，在本文編寫的過程中，它已經發布了v0.9.2版本，而v1.0.0版本也在準備中了。Dropwizard是Coda Hale在Yammer公司時創立的，它旨在提升公司分布式係統的架構（現在叫：微服務）。雖然它最早被用來構建REST Web 服務，而現在它具備了越來越多的功能，但是它的目標始終是作為輕量化、為生產環境準備且容易使用的web框架。

目前Dropwizard已經發布了v1.1.0版本

    Dropwizard與Spring Boot類似，也是構建微服務可選的工具，但是它顯得比Spring Boot更加規範一些。它使用的組件一般不會做可選替換，而好處是可以不需要那麼多的修飾，比如寫基於REST的web服務。比方說，Dropwizard選擇使用Jetty作為Servlet容器，REST庫使用Jersey，序列化和反序列化使用了Jackson，而想將其中的Jetty替換成Undertow就沒有那麼容易。

    Dropwizard默認也不具備依賴注入的容器（像Spring或者CDI），你當然可以自行添加，但是Dropwizard推薦你把微服務弄的簡單一些，不需要這些額外的組件。Spring Boot 隱藏的非常多的底層實現，而這些內容十分的複雜，就像Spring隱藏了通過注解可以完成Bean注入這個複雜的場景一樣。雖然注解很好用，也解決了某些領域比較瑣碎的代碼，但是當你想在生產環境DEBUG或者排查問題時，這些東西往往會把簡單的問題搞得很複雜。Dropwizard推薦所有的內容都顯示的使用，你得到的輸出也就更加的肯定和明確。

原文涉及到生產環境的DEBUG，筆者認為更多的是問題排查

    就像Spring Boot一樣，Dropwizard推薦將整個工程打包成一個可執行的jar，通過這種方式開發人員不用在擔心程序運行的應用服務器是什麼，需要什麼額外的配置，應用再也不需要被構建成war包了，而且也不會有那麼多複雜層級的類加載器了。Dropwizard中的類加載也是扁平結構的，它和我們常用的應用服務器不一樣，應用服務器往往具備多層級如同圖一般的類加載器，這會涉及到類加載器的優先級，而這些在不同的應用服務器的實現上都是大相徑庭的。運行在獨立進程中的Dropwizard實例也便於進行各自的JVM調優和監控，因為運行在應用服務器上的多個應用，很可能由於一個應用導致的GC或者內存溢出，進而導致整個應用服務器的崩潰，畢竟它們是在同一個進程中。

Dropwizard技術棧

    Dropwizard在優秀的三方庫協助下，提供了不錯的抽象層，使之更有效率，更簡單的編寫生產用途的微服務。

• Servlet容器使用Jetty
• REST/JAX-RS實現使用Jersey
• JSON序列化使用Jackson
• 集成Hibernate Validator
• Guava
• Metrics
• SLF4J + Logback
• 數據訪問層上使用JDBI

    Dropwizard偏執的認為框架就是用來寫代碼的，因此對於框架的底層技術棧的調整，原則上Dropwizard是拒絕的。正因為它這麼做，使得Dropwizard開發起代碼來更快，而且配置更加容易。Jetty、Jersey和Jackson都是廣為人知的項目，使用它們來構造用於生產環境的web服務，看起來沒什麼毛病，而google的Guava作為提供了工具類的包顯然經得住考驗，而Dropwizard Metrics更是一個強大工具，它能夠暴露出應用相當多的運行細節，而正因為此，Dropwizard Metrics被廣泛的使用於Spring Boot和WildFly Swarm。

    Dropwizard暴露了如下抽象，如果你能掌握這些簡單的抽象，你就能很快的使用Dropwizard進行開發了。

• Application
  包含了public void main()方法
• Environment
  放置servlet、resources、filters、health checks、task的地方
• Configuration
  用於改變環境或者係統配置的地方
• Commands
  當我們啟動微服務後，使用它來與微服務交互
• Resources
  REST/JAX-RS資源
• Tasks
  對於應用的管理，比如改變日誌級別或者暫停數據庫連接等

    當你啟動一個Dropwizard應用，一個Jetty服務就會啟動，同時它會創建兩個Handler：一個在8080，為你的應用提供服務，另一個在8081，這個提供管理功能。Dropwizard之所以這麼做，是因為不想將管理功能通過8080進行暴露，這樣你可以把端口隱藏在防火牆後麵。諸如Metrics和健康檢查，這些也是暴露在管理端口上的，區分的很大原因是考慮安全問題。

開始

    Dropwizard沒有那些美輪美奐用於創建工程的工具，它隻有一個最簡單的方式：maven archetype，或者在已經搭建好的項目中，增加一些maven配置。當然你可以使用jboss-forge來完成工程的創建，用它來添加對應的依賴等等，但是本章，我們還是使用maven archetype。

    選擇一個目錄，然後輸入一段maven命令，可以完成項目的創建。

$ mvn -B archetype:generate -DarchetypeGroupId=io.dropwizard.archetypes -DarchetypeArtifactId=java-simple -DarchetypeVersion=1.1.0 -DgroupId=com.murdock.examples.dropwizard -DartifactId=hola-dropwizard -Dversion=1.0 -Dname=HolaDropwizard

本示例演示，在microservices-camp目錄下運行

    該命令會在microservices-camp目錄下創建一個名為hola-dropwizard的工程，你可以選擇將其導入到自己的IDE中，或者你可以在hola-dropwizard目錄下運行mvn clean install完成構建。

    導入hola-dropwizard工程後，你可以看到如下結構：

    Dropwizard已經創建了你需要開發放置的包，它推薦你按照約定進行開發。

• api
  放置REST資源需要使用的POJOs，你可以理解為domain objects或者DTOs
• cli
  放置你需要添加給應用的Dropwizard命令
• client
  客戶端工具類放在這裏
• db
  和數據庫相關的代碼
• health
  運行時刻暴露在管理端口的微服務健康檢查邏輯
• resources
  REST資源

    同樣我們還可以看到一家創建好的類型HolaDropwizardApplication和HolaDropwizardConfiguration，它們使用來啟動和配置應用的。先看一下HolaDropwizardApplication長得樣子。

public class HolaDropwizardApplication extends Application<HolaDropwizardConfiguration> {

    public static void main(final String[] args) throws Exception {
        new HolaDropwizardApplication().run(args);
    }

    @Override
    public String getName() {
        return "HolaDropwizard";
    }

    @Override
    public void initialize(final Bootstrap<HolaDropwizardConfiguration> bootstrap) {
        // TODO: application initialization
    }

    @Override
    public void run(final HolaDropwizardConfiguration configuration,
                    final Environment environment) {
        // TODO: implement application
    }

}

    這個類包含了一個public static void main()方法，可以想象，它是入口，而getName()方法將會在應用啟動時展示。initialize()和run()方法是用來啟動應用的地方。

    配置類型已經創建了，但是目前是空的。

public class HolaDropwizardConfiguration extends Configuration {
    // TODO: implement service configuration
}

    雖然Dropwizard沒有定義自己的maven plugin，但是它為我們生成了pom.xml。打開pom.xml，可以看到Dropwizard使用maven-shade-plugin將依賴打包成一個jar，這意味著工程依賴的jar包和代碼將全部解壓，然後重新組合成一個jar。而針對這個構建好的jar，我們可以使用maven-jar-plugin運行它。

    我們唯一需要的一個插件就是exec-maven-plugin，這樣我們就可以像使用mvn spring-boot:run一樣運行它。

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>exec-maven-plugin</artifactId>
    <configuration>
        <mainClass>
            com.murdock.examples.dropwizard.HolaDropwizardApplication
        </mainClass>
        <arguments>
            <argument>server</argument>
        </arguments>
    </configuration>
</plugin>

    接下來，可以在hola-dropwizard使用mvn exec:java來啟動它。看到如下內容，代表啟動成功了。

    你可以打開瀏覽器，訪問默認的REST端點：https://localhost:8080，這會不會返回很多內容，你可能看到：

{
code: 404,
message: "HTTP 404 Not Found"
}

    如果你訪問管理端口：https://localhost:8081，你會看到一個簡單頁麵以及鏈接，這裏麵是當前應用的運行時信息。

你好，世界

    現在使用Dropwizard構建的工程已經準備好了，讓我們添加一個REST端點。我們會在/api/holaV1暴露一個HTTP/REST端點，訪問它，將會返回 Hola Dropwizard @ X，而 X 指的是運行應用的機器IP。如果想做到這個，首先需要在resources包下麵新建類型，比如：HolaRestResourceV1（記住，類型放置的包，必須符合Dropwizard的約定）。添加一個方法hola()，然後在其中返回所需的內容。

public class HolaRestResourceV1 {

    public String hola() throws UnknownHostException {
        String hostname = null;
        try {
            hostname = InetAddress.getLocalHost()
                    .getHostAddress();
        } catch (UnknownHostException e) {
            hostname = "unknown";
        }
        return "Hola Dropwizard @ " + hostname;
    }
}

    可以針對這個hola()方法做測試。

添加HTTP端點

    這看起來很像Spring Boot，我們想創建REST端點以及服務，也是在POJO上增加一些JAX-RS的注解。

@Path("/api")
public class HolaRestResourceV1 {

    @Path("/holaV1")
    @GET
    public String hola() throws UnknownHostException {
        String hostname = null;
        try {
            hostname = InetAddress.getLocalHost()
                    .getHostAddress();
        } catch (UnknownHostException e) {
            hostname = "unknown";
        }
        return "Hola Dropwizard @ " + hostname;
    }
}

    現在，打開之間生成的HolaDropwizardApplication，在run()方法中添加新創建的HolaRestResourceV1（REST資源）。

@Override
public void run(final HolaDropwizardConfiguration configuration,
                final Environment environment) {
    environment.jersey().register(new HolaRestResourceV1());
}

    接著就可以在hola-dropwizard目錄下執行mvn clean package exec:java，隨著應用的啟動，我們打開瀏覽器訪問https://localhost:8080/api/holaV1，可以看到如下內容。

外部配置

    Dropwizard提供了針對內置組件的諸多配置（比如：servlet引擎或者數據源）方式，你可以使用配置文件來完成配置。可以使用係統環境變量或者Java System properties來進行配置，這樣可以使應用運行在不同的環境上。如同之前介紹的Spring Boot，Dropwizard也可以將配置綁定到指定的實例上。在接下來的例子中，我們就將helloapp.*下麵的配置，綁定到HolaRestResourceV2上。不像Spring Boot通過application.properties完成配置，Dropwizard隻支持YAML。

    在工程的根目錄（hola-dropwizard）下（注意：不是類路徑下），創建一個conf/application.yml（如果conf目錄不存在，你需要創建它），我們將配置文件放置在該目錄中，先給conf/application.yml添加一些內容：

helloapp:
  saying: Hola Dropwizard @

    這樣我們為屬性指定了值，如果我們需要為某些環境更改這個值，該如何做呢？可以通過Java System properties來做到，可以通過定義-Ddw.helloapp.saying=Guten Tag。注意dw.*代表著Dropwizard可以覆蓋該配置的值，但是如果需要使用操作係統變量來進行覆蓋呢，如何做到？

helloapp:
  saying: ${HELLOAPP_SAYING:-Guten Tag aus}

    可以看到對saying的配置首先回去查看環境變量HELLOAPP_SAYING，如果該環境變量不存在，那麼就會使用默認的Guten Tag aus，默認Dropwizard不會從環境變量中獲取配置，如果需要讓Dropwizard使用環境變量，需要做一些額外改動。打開HolaDropwizardApplication，編輯initialize()方法。

@Override
public void initialize(final Bootstrap<HolaDropwizardConfiguration> bootstrap) {
    bootstrap.setConfigurationSourceProvider(
            new SubstitutingSourceProvider(bootstrap.getConfigurationSourceProvider(),
                    new EnvironmentVariableSubstitutor(false)));
}

    接下來創建配置，我們定義了一個專門的配置類型，這個配置類型用於接受來自helloapp下的配置，接下來看如何將配置類型和application.yml綁定。在resources包下，創建一個類型。

public class HelloSayingFactory {
    @NotEmpty
    private String saying;

    @JsonProperty
    public String getSaying() {
        return saying;
    }

    @JsonProperty
    public void setSaying(String saying) {
        this.saying = saying;
    }

}

    這個簡單的Java Bean上增加了一些注解，比如：Jackson和Bean Validator，這個配置對象將會包裝在application.yml中，處於helloapp之下的配置。這一刻，隻有一個配置屬性saying，下麵需要將HolaDropwizardConfiguration與它關聯起來。

public class HolaDropwizardConfiguration extends Configuration {

    private HelloSayingFactory sayingFactory;

    @JsonProperty("helloapp")
    public HelloSayingFactory getSayingFactory() {
        return sayingFactory;
    }

    @JsonProperty("helloapp")
    public void setSayingFactory(
            HelloSayingFactory sayingFactory) {
        this.sayingFactory = sayingFactory;
    }
}

筆者注：HolaDropwizardConfiguration代表著指定的application.yml，而helloapp是配置中的一個節點，而該節點以下的結構，將會設置到類型HelloSayingFactory實例中

    接下來需要將配置引入到REST資源中，在resources包下，創建類型HolaRestResourceV2。

@Path("/api")
public class HolaRestResourceV2 {

    private String saying;

    public HolaRestResourceV2(String saying) {
        this.saying = saying;
    }

    @Path("/holaV2")
    @GET
    public String hola() throws UnknownHostException {
        String hostname = null;
        try {
            hostname = InetAddress.getLocalHost()
                    .getHostAddress();
        } catch (UnknownHostException e) {
            hostname = "unknown";
        }
        return saying + " " + hostname;
    }
}

    由於Dropwizard沒有依賴注入框架的幫助，所以你需要依靠自己將配置注入到REST資源中。編輯HolaDropwizardApplication：

@Override
public void run(final HolaDropwizardConfiguration configuration,
                final Environment environment) {
    environment.jersey().register(new HolaRestResourceV1());
    environment.jersey().register(new HolaRestResourceV2(configuration.getSayingFactory().getSaying()));
}

    到目前為止，一個具備配置注入的項目已經基本搭建完成，這個例子中對於配置，我們故意設計的複雜一些，目的是還原一個真實場景。雖然開起來零碎的步驟不少，但是可以看到最關鍵的幾個步驟：定義application.yml，並且將HolaDropwizardConfiguration與之綁定，而後續配置的添加就變得很簡單了。

    如果想在maven中運行，還需要將配置文件的位置傳遞給Dropwizard，所以還需要編輯一下pom.xml

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>exec-maven-plugin</artifactId>
    <configuration>
        <mainClass>
            com.murdock.examples.dropwizard.HolaDropwizardApplication
        </mainClass>
        <arguments>
            <argument>server</argument>
            <argument>conf/application.yml</argument>
        </arguments>
    </configuration>
</plugin>

    在項目目錄hola-dropwizard下，執行mvn clean package exec:java，然後打開瀏覽器訪問https://localhost:8080/api/holaV2，可以看到：

    接下來停止應用，然後導出一個環境變量，再啟動它，隨後訪問原來的頁麵：

$ export HELLOAPP_SAYING="Hello Dropwizard @ "
$ echo $HELLOAPP_SAYING
Hello Dropwizard @
$ mvn clean package exec:java

暴露應用Metrics和信息

    Dropwizard中做的最好的是將Metrics作為了一等公民，Dropwizard從一開始就考慮了Metrics，而非像其他框架一樣事後考慮，所以當一個Dropwizard應用啟動的同時，8081管理端口就暴露了Metrics信息。我們隻需要在對應的REST資源上增加一些注解就可以做到。

    在HolaRestResourceV2中的hola()方法，增加注解@Timed，它將跟蹤該服務的調用耗時與次數等信息，當然還有其他的Metrics組件可供選擇。

• @Metered
  服務調用頻率
• @ExceptionMetered
  異常拋出頻率

不能都添加上，隻能選擇一種

    重新啟動Dropwizard應用，然後訪問幾次https://localhost:8080/api/holaV2，然後用瀏覽器打開https://localhost:8081/metrics?pretty=true，然後搜索hola，你可以看到類似如下內容：

com.murdock.examples.dropwizard.resources.HolaRestResourceV2.hola:{
  count: 3,
  max: 5.0143579240000005,
  mean: 5.006734606111542,
  min: 5.002627207000001,
  p50: 5.004089423,
  p75: 5.0143579240000005,
  p95: 5.0143579240000005,
  p98: 5.0143579240000005,
  p99: 5.0143579240000005,
  p999: 5.0143579240000005,
  stddev: 0.0051299569217563845,
  m15_rate: 0.003305709235676515,
  m1_rate: 0.04423984338571901,
  m5_rate: 0.009754115099857198,
  mean_rate: 0.11808407104043579,
  duration_units: "seconds",
  rate_units: "calls/second"
}

如果在maven之外運行

    Dropwizard通過maven-shade-plugin打包成了一個jar，所以隻需要通過java -jar就可以運行，我們唯一需要知道的就是傳遞配置給Dropwizard，比如這樣：java -jar target/hola-dropwizard-1.0.jar server conf/application.yml。

調用其他服務

    在微服務環境下，服務之間需要相互調用，和之前的Spring Boot應用一樣，Dropwizard提供了自己的REST客戶端供我們使用。類似之前在Spring Boot的章節，我們使用Dropwizard完成這項工作。

在開始之前，先在hola-dropwizard項目中添加依賴。

<dependency>
  <groupId>io.dropwizard</groupId>
  <artifactId>dropwizard-client</artifactId>
</dependency>

    首先創建GreeterSayingFactory配置，在這個配置中將描述調用hola-backend的具體URL和端口等信息。

public class GreeterSayingFactory {
    @NotEmpty
    private String saying;
    @NotEmpty
    private String host;
    @NotEmpty
    private int port;
    private JerseyClientConfiguration jerseyClientConfig =
            new JerseyClientConfiguration();

    @JsonProperty("jerseyClient")
    public JerseyClientConfiguration getJerseyClientConfig() {
        return jerseyClientConfig;
    }

    public String getSaying() {
        return saying;
    }

    public void setSaying(String saying) {
        this.saying = saying;
    }

    public String getHost() {
        return host;
    }

    public void setHost(String host) {
        this.host = host;
    }

    public int getPort() {
        return port;

    }

    public void setPort(int port) {
        this.port = port;
    }
}

    然後需要將application.yml中的配置設置到GreeterSayingFactory中，所以需要將greeter下麵的配置完成設置，這時，需要繼續編輯HolaDropwizardConfiguration，增加以下兩個方法。

@JsonProperty("greeter")
public GreeterSayingFactory getGreeterSayingFactory() {
    return greeterSayingFactory;
}

@JsonProperty("greeter")
public void setGreeterSayingFactory(
        GreeterSayingFactory greeterSayingFactory) {
    this.greeterSayingFactory = greeterSayingFactory;
}

    對於GreeterSayingFactory中屬性的具體配置，需要在conf/application.yml中編輯，增加以下內容：

greeter:
  saying: ${GREETER_SAYING:-Guten Tag Dropwizard}
  host: ${GREETER_BACKEND_HOST:-localhost}
  port: ${GREETER_BACKEND_PORT:-8080}

    通過這樣就可以使用係統環境變量對應用做不同的配置了，到此配置基本結束，我們編寫一個REST端點用於提供HTTP服務。

@Path("/api")
public class GreeterRestResource {
    private String saying;
    private String backendServiceHost;
    private int backendServicePort;
    private Client client;

    public GreeterRestResource(final String saying, String host, int port, Client client) {
        this.saying = saying;
        this.backendServiceHost = host;
        this.backendServicePort = port;
        this.client = client;
    }

    @Path("/greeting/{bookId}")
    @GET
    @Timed
    public String greeting(@PathParam("bookId") Long bookId) {
        String backendServiceUrl =
                String.format("https://%s:%d",
                        backendServiceHost, backendServicePort);

        Map map = client.target(backendServiceUrl).path("hola-backend").path("rest").path("books").path(
                bookId.toString()).request().accept("application/json").get(Map.class);

        return map.toString();
    }
}

    可以看到，通過訪問：https://localhost:8080/api/greeting/1，能夠進行Book資源的查詢工作，但是可以看到GreeterRestResource的構造函數，需要一個javax.ws.rs.client.Client。前麵提到，Dropwizard沒有依賴注入的幫助，一切都要靠自己來完成組裝，所以最後還需要編輯HolaDropwizardApplication，在run()方法中，增加以下內容：

// greeter service
GreeterSayingFactory greeterSayingFactory = configuration.getGreeterSayingFactory();
Client greeterClient =
        new JerseyClientBuilder(environment)
                .using(greeterSayingFactory.getJerseyClientConfig()).build("greeterClient");
environment.jersey().register(new GreeterRestResource(
        greeterSayingFactory.getSaying(),
        greeterSayingFactory.getHost(),
        greeterSayingFactory.getPort(), greeterClient));

    Dropwizard提供了兩種REST調用方式：HttpComponents和Jersey/JAX-RS，默認使用的後者，我們就使用它來完成調用。接下來我們在開發機上部署了hola-backend，它的ip是11.239.175.192，你的環境也許是其他。我們需要將ip設置到環境變量GREETER_BACKEND_HOST上。在hola-dropwizard工程目錄下執行：

$ export GREETER_BACKEND_HOST="11.239.175.192"
$ echo $GREETER_BACKEND_HOST
11.239.175.192
$ mvn clean package exec:java

    訪問https://localhost:8080/api/greeting/1，可以看到如下內容：

小結

    本章介紹了Dropwizard的基本知識，可以看到一個不同於Spring Boot的方式去暴露REST端點、以及不同的方式進行應用配置，如果你想深入了解Dropwizard可以訪問如下內容。

• Dropwizard Core
• Dropwizard Getting Started
• Client API
• Dropwizard on GitHub
• Dropwizard examples on GitHub

最後更新：2017-11-03 15:05:02

  上一篇：  Java微服務開發指南 -- 使用WildFly Swarm構建微服務

  下一篇：  Java微服務開發指南 -- 使用Spring Boot構建微服務