作者 | Lyndsey Padget
譯者 |月滿西樓
今天我們來聊聊 Java中的微服務。雖說 Java EE提供了一個強大的平臺，供我們創建、部署和管理企業級微服務，但在本文中，我將展示如何創建一個儘可能小的 RESTful微服務。
放心，在這個過程中，我們不會浪費時間精力去重複做些數據處理之類的事情。我們會通過 JBoss RESTEasy來進行搭建。而確保該微服務的輕量級，目的是為了向大家展示，在一個全新或者現存的微服務前端，建立一個 RESTful接口，真的非常簡單。
與此同時，我會進一步證明，通過 RESTEasy構建的微服務具備很大的靈活性，不僅可以兼容包括 JSON，XML在內的多種數據傳輸格式，還支持將其部署到 Apache Tomcat[1]服務器而非 JBoss企業應用平臺 (EAP)[2]上。誠然，每個工具都有自己的優勢，但是我認為先在 KISS原則 [3]下探討技術可用性會很有幫助，然後才是根據軟件的長期目標和需求來決定應該為服務架構添加哪些特性。
本文中提到的代碼示例都可以在 GitHub[4]上查閱，包括“starter” 和 “final”這兩個分支。下面是我採用的環境，當然你的實際情況可能有所不同:
Java Development Kit[5] (JDK)1.8.0-131 (amd64)
apache Tomcat[6] 9
apache Maven[7] 3.5.0
Eclipse Java EE IDE[8] 4.7.0 (Oxygen)
Linux Mint[9] 18.2 (Sonya)64位
就技術而言...
微服務 [10]是一種體積小、更為精煉的服務，其目標是“做好一件事”。微服務之間通過一些接口進行交互是很普遍的現象。如果該接口可以通過 web訪問 (使用 HTTP)，那麼它就是一個 web服務。部分 web服務是基於 RESTful這種架構風格的，另一些則不是。注意，微服務並不都是 web服務，web服務並不都是 RESTful web服務，RESTful web服務也並不都是微服務！
REST和 XML……能否共存？
如果你此前在使用 RESTful web服務時，沒用過除 JSON 以外的文本數據交換格式 [11]來進行內容傳輸，那麼你可能會認為二者是不相關的。但是回想下，REST是定義 API的一種架構風格，REST和 JSON這兩者又碰巧一起流行起來 (注意，這並非偶然)。XML多年的發展使其擁有大量的客戶群，能夠接納和提供 XML數據傳輸格式的 RESTful web服務, 不管是對那些已經依賴於這類內容交互系統的組織，還是對僅僅是更熟悉 XML的用戶來說，都非常有用。當然，通常情況下，JSON依然是首選，因為其消息體更小，但有時 XML只是一個更簡單的“sell”。擁有一個能同時支持這兩種格式的 RESTful微服務是最理想的 ;從部署的角度來說，它不僅簡潔，具備可擴展性，還有足夠的靈活性，可以支持不同類型的內容，從而滿足那些其他有調用需求的應用程序。
為什麼選擇 RESTEasy？
RESTEasy[12]是 Jboss的一個框架，可以用來構建 RESTful web服務。通過 RESTEasy構建的 RESTful web服務，可以根據四個函數庫來實現對 XML和 JSON這兩種數據傳輸格式的支持：
resteasy-jaxrs，實現了 JAX-RS 2.0 (用於 RESTful Web服務的 Java API) [13]
-
resteasy-jaxb-provider，其 JAXB[14]綁定能有效支持 XML
resteasy-jettison-provider，用 Jettison[15]將 XML轉換為 JSON
resteasy-servlet-initializer，將服務部署到 Servlet 3.0容器 (在 Tomcat服務器上)
首先，創建一個內含 pom.xml數據包的 web服務項目:
<code> <project> <modelversion>4.0.0/<modelversion> <groupid>com.lyndseypadget/<groupid> <artifactid>resteasy/<artifactid> <packaging>war/<packaging> <version>0.0.1-SNAPSHOT/<version> <name>resteasy/<name> <repositories> <repository>org.jboss.resteasy http://repository.jboss.org/maven2/ /<repository> /<repositories> <dependencies> <dependency> <groupid>org.jboss.resteasy/<groupid> <artifactid>resteasy-jaxrs/<artifactid> <version>3.1.4.Final/<version> /<dependency> <dependency> <groupid>org.jboss.resteasy/<groupid> <artifactid>resteasy-jaxb-provider/<artifactid> <version>3.1.4.Final/<version> /<dependency> <dependency> <groupid>org.jboss.resteasy/<groupid> <artifactid>resteasy-jettison-provider/<artifactid> <version>3.1.4.Final/<version> /<dependency> <dependency> <groupid>org.jboss.resteasy/<groupid> <artifactid>resteasy-servlet-initializer/<artifactid> <version>3.1.4.Final/<version> /<dependency> /<dependencies> <build> <plugins> <plugin> <groupid>org.apache.maven.plugins/<groupid> <artifactid>maven-compiler-plugin/<artifactid> <version>2.0.2/<version> <configuration> <source>1.8/<source> <target>1.8/<target> /<configuration> /<plugin> /<plugins> <finalname>resteasy/<finalname> /<build> /<project>/<code>
（左右滑動可查看全部代碼，下同）
這些數據庫的大小大概在 830KB。當然，這些直接的依賴環境（dependency），運用 Maven一起構建項目也會帶來部分傳遞性依賴。
接下來，我將用“Maven方法”來構建這個項目，例如在 src/main/java中，使用 Maven構建命令等，不想用 Maven的話，你也可以直接從下載頁面 [16]下載 RESTEasy jar數據包。下載的時候不用理會 RESTEasy站點上彈出的這個提示:JBoss僅僅是在嘗試引導你採用更“企業化”的方法。你只需點擊“繼續下載”，來開展後面的操作。
項目設計
下面這個微服務可以用非常簡單的方法來演示一些基本概念。如下圖所示，它包括 5個等級。
此處，FruitApplication是微服務的切入點。FruitService提供了主要的路徑 (/fruits)，同時它也充當了路由器的功能。蘋果和水果都是模型；水果包含一些抽象的功能，蘋果則會具體地擴展它的功能。
和你設想一致的是，FruitComparator可以提供比較功能。不熟悉 Java comparator的讀者，可以在這篇文章中瞭解一下對象的等同性和比較，這裡我用字符來取代。雖然 FruitComparator不是一個模型，但我更喜歡將比較器與它想要比較的對象類型保持相類似的命名。
模型
讓我們從 Fruit這級開始
<code>package com.lyndseypadget.resteasy.model; import javax.xml.bind.annotation.XmlElement; public abstract class Fruit { private String id; private String variety; @XmlElement public String getId { return id; } public void setId(String id) { this.id = id; } @XmlElement public String getVariety { return variety; } public void setVariety(String variety) { this.variety = variety; } }/<code>然後 Apple這級對其展開：
<code>package com.lyndseypadget.resteasy.model; import javax.xml.bind.annotation.XmlElement; import javax.xml.bind.annotation.XmlRootElement; @XmlRootElement(name = "apple") public class Apple extends Fruit { private String color; @XmlElement public String getColor { return color; } public void setColor(String color) { this.color = color; } }/<code>以上並不是什麼特別驚人的代碼，你可能會覺得都不值得拿出來炫耀，就是一個 Java繼承的簡單實例。但重點在於這兩個註釋 @XmlElement 和 @XmlRootElement，它們定義了 XML apple結構的樣子:
<code><apple>1 <variety>Golden delicious/<variety> <color>yellow/<color> /<apple>/<code>
因為沒有約定明顯的構造函數:Java使用了隱式的、無參數的默認構造函數，所以一些更微妙的事情在發生。這個無參數的構造函數對 JAXB 施展魔法般效果的工作是十分必要的（本文解釋了這一點，以及必要的話，如何用 XMLAdapter來讓它工作）。
現在我們有了一個對象：被定義的蘋果。它有三個屬性: ID、多樣性和顏色。
服務
FruitService 被用來作為與微服務交互的主要路徑 (/fruits)。在本例中，我使用 @path註釋直接在該層級中定義了第一個路徑，/fruits/apples。隨著 RESTful微服務的擴展，你可能希望在自己的層級中定義多個最終路徑 (例如 /apples, /bananas, /oranges)。
<code>package com.lyndseypadget.resteasy; import java.util.ArrayList; import java.util.Collections; import java.util.Comparator; import java.util.List; import java.util.Map; import java.util.TreeMap; import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.Produces; import javax.ws.rs.core.MediaType; import com.lyndseypadget.resteasy.model.Apple; import com.lyndseypadget.resteasy.model.FruitComparator; @Path("/fruits") public class FruitService { private static Map<string> apples = new TreeMap<string>; private static Comparator comparator = new FruitComparator; @GET @Path("/apples") @Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON }) public List getApples { List retVal = new ArrayList(apples.values); Collections.sort(retVal, comparator); return retVal; } }/<string>/<string>/<code>這張蘋果的地圖幫助我們根據 id跟蹤蘋果的數據，從而模擬某些類型的數據持久層。利用 getApples方法（常用的 HTTP請求方式）將會返回地圖跟蹤到的相關蘋果數據。GET /apples route是用 @GET和 @path註釋定義的，它可以生成數據傳輸格式 XML或 JSON的內容。
這個方法需要返回一個 List< apple >對象，然後用這個比較器按品種屬性來對列表進行排序。
FruitComparator看起來是像這樣的:
<code>package com.lyndseypadget.resteasy.model; import java.util.Comparator; public class FruitComparator implements Comparator { public int compare(F f1, F f2) { return f1.getVariety.compareTo(f2.getVariety); } }/<code>注意，如果想要對蘋果的一個特定屬性進行排序，比如顏色，我們就必須創建一個新的比較器去取代，並取個名字，比如 AppleComparator。
應用程序
在 RESTEasy3.1.x中, 你需要定義一個擴展應用的層級。RESTEasy示例文檔說明這是一個單例模式註冊表（singleton registry），如下所示:
<code>package com.lyndseypadget.resteasy; import javax.ws.rs.core.Application; import java.util.HashSet; import java.util.Set; public class FruitApplication extends Application { HashSet singletons = new HashSet; public FruitApplication { singletons.add(new FruitService); } @Override public Set<class> getClasses { HashSet<class> set = new HashSet<class>; return set; } @Override public Set getSingletons { return singletons; } }/<class>/<class>/<class>/<code>如果僅為了說明本例，就不需要對這個層級做太多工作，但是我們需要在 web.xml文件中將它連接起來，這會在後面的章節“web服務連接”中進行介紹。
對象的構建集合
GET /apples調用將返回如下數據：
<code> <collection> <apple>1 <variety>Golden delicious/<variety> <color>yellow/<color> /<apple> /<collection>/<code>
<code>[ { "apple": { "id": 1, "variety": "Golden delicious", "color": "yellow" } } ]/<code>但是，我們可以將數據更改成看起來稍有點不同：
<code> <apples> <apple>1 <variety>Golden delicious/<variety> <color>yellow/<color> /<apple> /<apples>/<code>
<code> { "apples": { "apple": { "id": 1, "variety": "Golden delicious", "color": "yellow" } } }/<code>第二個選項在 XML中看起來更好一些，但是對 JSON產生了不太好的影響。如果你喜歡這個結構，可以用它自己的類型打包 List< Apple >，並修改 FruitService.getApples方法來返回這種類型:
<code>package com.lyndseypadget.resteasy.model; import java.util.ArrayList; import java.util.Collection; import java.util.Collections; import java.util.Comparator; import java.util.List; import javax.xml.bind.annotation.XmlAccessType; import javax.xml.bind.annotation.XmlAccessorType; import javax.xml.bind.annotation.XmlElement; import javax.xml.bind.annotation.XmlRootElement; @XmlAccessorType(XmlAccessType.FIELD) @XmlRootElement(name = "apples") public class Apples { private static Comparator comparator = new FruitComparator; @XmlElement(name = "apple", type = Apple.class) private List apples; public List getApples { Collections.sort(apples, comparator); return apples; } public void setApples(Collection apples) { this.apples = new ArrayList(apples); } }/<code> 這些註釋有效地“重新標記”了根元素，即 collection/list。通過讀取用於 javax.xml.bind.annotation的 javadoc文檔，你可以嘗試用它和不同的 XML Schema映射註釋。
當然，如果實在不能搞定一般的方法簽名（method signature），則可以編碼寫入不同的方法——一個用於 XML，另一個用於 JSON。
一些 web服務連接
從將該服務部署到 Tomcat開始，我用一個放在 src/main/webapp/web inf/web.xml的 web應用部署描述符文件。它所包含的內容如下：
<code> <web-app> <display-name>resteasy/<display-name> <context-param> <param-name>javax.ws.rs.core.Application/<param-name> <param-value>com.lyndseypadget.resteasy.FruitApplication/<param-value> /<context-param> <context-param> <param-name>resteasy.servlet.mapping.prefix/<param-name> <param-value>/v1/<param-value> /<context-param> <listener> <listener-class> org.jboss.resteasy.plugins.server.servlet.ResteasyBootstrap /<listener-class> /<listener> <servlet> <servlet-name>Resteasy/<servlet-name> <servlet-class>org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher/<servlet-class> /<servlet> <servlet-mapping> <servlet-name>Resteasy/<servlet-name> <url-pattern>/v1/*/<url-pattern> /<servlet-mapping> /<web-app>/<code>
沒錯，“servlet-name”表示 servlet(即 Service)的名稱是 Resteasy。servlet-mapping url-pattern (/v1/*)要求 Tomcat服務器將包含該模式的傳入請求傳輸到 Resteasy服務。關於如何建立這個文件的更多信息，以及可用的不同選項，請參閱 Tomcat的應用程序部署文檔 [17]。
構建及部署
從項目的根目錄中，可以運行以下內容來構建 WAR(web application resource，web應用程序資源)文件:
<code>mvn clean install/<code>
這將在 target文件夾中創建一個包含 WAR文件的新文件夾。雖然用 Maven或其他工具來部署該文件也可以，但我只用一個簡單的複製命令就可以。需要注意的是，每次將 WAR重新部署到 Tomcat服務器時，應該首先暫停服務器運行，並刪除服務應用程序文件夾 (在本例中，是這個文件夾：< tomcatDirectory >/webapps/resteasy)和舊的 WAR文件 (< tomcatDirectory >/webapps/resteasy.war)。
<code>[sudo] cp target/resteasy.war <tomcatdirectory>/webapps/resteasy.war/<tomcatdirectory>/<code>
如果此時 Tomcat服務器正在運行，那麼會即刻部署 web服務。如果不是，下次服務器啟動時，該服務也會被自動部署上去。然後,就可以通過如下地址訪問 web服務：http://< tomcatHost >:< tomcatPort >/resteasy/v1/fruits/apples。我的範例中是這個地址 http://localhost:8080/resteasy/v1/fruits/apples。
通過“內容協商（Content negotiation）”測試服務
內容協商（Content negotiation）是一種機制，它可以提供不同資源 (URI)的表現形式。最基本的，這意味著可以:
詳細設置 Accept header，以指示希望從服務中接受的內容類型
詳細設置 Content-Type header，以指示發送給服務的內容類型
要獲取更多關於內容協商（Content negotiation）和 header的信息，請參閱 RFC 2616[18]的第 12和 14章。在本例中，你真正需要了解的是:
@Produces annotation（註釋）指明瞭該方法能夠生成哪些內容 (這將嘗試匹配請求上的 Accept header)。
-
@Consumes annotation（註釋）指明瞭該方法能夠使用哪些內容 (這將嘗試匹配請求的 content-type header)。
如果您試圖對一個有效端點進行 HTTP調用，但是內容不能被協商，這意味著沒有 @Produces匹配該 Accept數據，或者沒有 @Consumes匹配 Content-Type數據，將被返回 HTTP狀態碼 415:不支持的數據傳輸格式。
返回常見數據傳輸格式的 GET調用實際上可以直接進入瀏覽器。對於 GET /apples這樣的調用，默認情況下您將獲得 XML:
不過，使用像 Postman[19]這類工具可能會更有幫助，因為它明確地指定 Accept header作為 application/xml:
這兩種方法都返回了一些有效但沒有多大意義的 XML，即一個空的蘋果列表。但是這裡有一些很酷的東西。將 Accept header更改為 application/json，太好了，瞧！JSON*生效*了:
不只是“讀取”
你可能會發現，很多 RESTful web服務的例子，都是隻讀的，部分也不會有進一步的提示，比如如何去創建、更新和刪除這些操作。雖然我們現在已經有了 web服務的框架，但這是一個不能更改的空列表，這並沒多大意義。所以我們應該運用一些其他方法，將蘋果添加到這個列表中或從列表中將其刪除。
<code>package com.lyndseypadget.resteasy; import java.util.ArrayList; import java.util.Collections; import java.util.Comparator; import java.util.List; import java.util.Map; import java.util.TreeMap; import javax.ws.rs.Consumes; import javax.ws.rs.DELETE; import javax.ws.rs.GET; import javax.ws.rs.POST; import javax.ws.rs.Path; import javax.ws.rs.PathParam; import javax.ws.rs.Produces; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; import com.lyndseypadget.resteasy.model.Apple; import com.lyndseypadget.resteasy.model.FruitComparator; @Path("/fruits") public class FruitService { private static Comparator comparator = new FruitComparator; private static Map apples = new TreeMap; private static int appleCount = 0; @GET @Path("/apples") @Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON }) public List getApples { List retVal = new ArrayList(apples.values); Collections.sort(retVal, comparator); return retVal; } @GET @Path("/apples/{id}") @Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON }) public Response getApple(@PathParam("id") String id) { Apple found = apples.get(id); if(found == ) { return Response.status(404).build; } return Response.ok(found).build; } @DELETE @Path("/apples/{id}") public Response deleteApple(@PathParam("id") String id) { apples.remove(id); return Response.status(200).build; } @POST @Path("/apples") @Consumes({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON }) public Response createApple(Apple apple) { String newId = Integer.toString(++appleCount); apple.setId(newId); apples.put(newId, apple); return Response.status(201).header("Location", newId).build; } }/<code>如此，就增加了一些新的功能:
通過 id檢索蘋果數據 (如果在地圖中沒有找到，則返回狀態代碼 404)
通過 id刪除蘋果數據
創建新的蘋果數據 (如果成功的話，返回狀態代碼 201)
這些方法完善了很多功能，確保了服務可以按照預期工作。更新蘋果 (使用 @PUT和 /或 @PATCH)，以及更多的關於端點、邏輯和管理持久性方面的功能操作，都留給讀者你們來練習吧。
當我們再次進行構建和部署時會發現 (如果用 Maven或者 Tomcat來進行設置，請參閱上文“構建和部署”)，現在已經可以在服務中創建、檢索和刪除蘋果了。而且即使不在服務器上做任何重新配置，也可以在 XML和 JSON之間進行選擇性調用。
來創建一個擁有“application/json”內容類型和 JSON主體的蘋果，如下圖所示:
這是另一個例子:創建一個具有“application/xml”內容類型和 XML主體的蘋果。
在 XML中檢索所有的蘋果數據:
在 JSON中通過 id檢索 apple 2的數據：
通過 id刪除 apple 1的數據：
在 JSON中檢索所有蘋果的數據：
小結
在此我們已經探討了 RESTEasy架構如何在 Java web服務中無縫支持 XML和 JSON數據傳輸格式。我還解釋了 REST、Media type(數據傳輸格式)、web服務和微服務之間的技術差異，因為在這些術語中有很多容易混淆的灰色地帶。
我這裡列舉的例子可能有點勉強，生活中我其實從來沒有真正需要過水果相關的數據，我也沒有在食品行業工作過。之所以用水果來舉例，是因為我覺得這個“規模”能有助於大家理解微服務的概念，你也可以想象其他例如蔬菜，罐頭或海鮮這樣的微服務是如何共同構成一個食物分配系統。現實世界中，食品雜貨店的食物分配系統實際上非常複雜，它必須考慮到包括銷售、優惠券、過期日期、營養信息等各方面的問題。
當然，你可以選擇其他方式去對系統進行分割，但當你需要一種快速高效、輕量級工具來支持多種數據格式時，RESTEasy真的是個非常不錯的選擇。
參考地址：
[1]、[2]、[6] https://tomcat.apache.org/
[3] https://en.wikipedia.org/wiki/KISS_principle
[4] https://github.com/lyndseypadget/resteasy-demo
[5] http://www.oracle.com/technetwork/java/javase/downloads/index.html
[7] https://maven.apache.org/
[8] https://www.eclipse.org/downloads/
[9] https://linuxmint.com/edition.php?id=237
[10] https://stackify.com/what-are-microservices/
[11] https://www.iana.org/assignments/media-types/media-types.xhtml
[12] http://resteasy.jboss.org/
[13] https://jcp.org/aboutJava/communityprocess/final/jsr339/index.html
[14] http://www.oracle.com/technetwork/articles/javase/index-140168.html
[15] https://github.com/jettison-json/jettison
[16] http://resteasy.jboss.org/downloads
[17] https://tomcat.apache.org/tomcat-9.0-doc/appdev/deployment.html
[18] https://www.ietf.org/rfc/rfc2616.txt
[19] https://www.getpostman.com/
期望得到更多優質技術乾貨，歡迎加入 EAWorld社區，與近萬名技術人一起成長。入群暗號：328
閱讀更多 InfoQ 的文章
