瘋狂創客圈，一個Java 高並發研習社群 【博客園 總入口 】
瘋狂創客圈，傾力推出： 《Netty Zookeeper Redis 高並發實戰》一書， 面試必備 + 面試必備 + 面試必備
寫在前面
大家好，我是作者尼恩。目前和幾個小伙伴一起，組織了一個高並發的實戰社群【瘋狂創客圈】。正在開始高並發、億級流程的 IM 聊天程序 學習和實戰
順便說明下：
本文的內容只是一個初稿、初稿，本文的知識，在《Netty Zookeeper Redis 高並發實戰》一書時，進行大篇幅的完善和更新，並且進行的源碼的升級。 博客和書不一樣，書的內容更加系統化、全面化，更加層層升入、層次分明、更多次的錯誤排查，請大家以書的內容為准。
本文的最終內容， 具體請參考瘋狂創客圈 傾力編著，機械工業出版社出版的 《Netty Zookeeper Redis 高並發實戰》一書 。
使用場景
在瘋狂創客圈的 億級流程的 IM 聊天程序 學習項目中，短連接Web服務器和長連接IM服務器之間，是相互配合的。在分布式集群的環境下，用戶首先通過短連接登錄Web服務器。Web服務器在完成用戶的賬號/密碼驗證，返回uid和token時，還需要通過一定策略，獲取目標IM服務器的IP地址和端口號列表，返回給客戶端。客戶端開始連接IM服務器，連接成功后，發送鑒權請求，鑒權成功則授權的長連接正式建立。
短連接的調用，使用Feign 技術。下面是詳解。
看完之后，Feign 獨立使用，完全可以替換掉目前的Http 客戶端調用方法。
1.1. Feign短連接Restful調用
一般來說，短連接的服務接口，都是基於應用層Http協議的Http api 或者RESTful api實現，通過JSON文本格式返回數據。如何在Java服務端調用其他節點的Http api 或者RESTful api呢？
至少有以下幾種方式：
（1）JDK原生的URLConnection
（2）Apache的Http Client/HttpComponents
（3）Netty的異步HTTP Client
（4）Spring的RestTemplate
目前用的最多的，基本上是第二種，這也是在單體服務時代，最為成熟和穩定的方式，也是效率較高的短連接方式。
插入一個解釋： 什么是RESTful api。REST的全稱是 Representational State Transfer，它是一種API接口的風格、也而不是標准，只是提供了一組調用的原則和約束條件。也就是說，在短連接服務的領域，它算是一種特殊格式的HTTP api。
回到前面的話題，如果同一個Http api/RESTful api 接口，倘若不止一個短連接服務器提供，而是有多個節點提供服務，那么，簡單的使用Http Client調用，就無能為力了。
Http Client/HttpComponents調用不能根據接口的負載、或者其他的條件，去判斷哪一個接口應該調用，哪一個接口不應該調用。解決這個問題的方式是啥呢？
可以使用Feign來調用多個服務器的同一個接口。Feign不僅僅可以進行同接口多服務器的負載均衡，一旦使用了Feign作為http api的客戶端，調用遠程的http接口就會變得像調用本地方法一樣簡單。
Feign是何方神聖？它是Netflix開發的一個聲明式、模板化的HTTP客戶端， Feign的目標是幫助Java工程師更快捷、優雅地調用HTTP API//RESTful api。另外，Feign被無縫集成到了SpringCloud微服務框架，使用Feign后，可以非常方便項目SpringCloud微服務技術。
如果項目使用了SpringCloud技術，那就就可以更加方便的聲明式使用Feign。如果沒有使用SpringCloud，使用Feign也非常之簡單。Netflix Feign目前改名為OpenFeign，最新版本是2018.5發布的9.7.0。OpenFeign在Java應用中，負責處理與遠程Web服務的請求響應，最大限度降低編碼復雜性。可以說是Java應用中調用Web服務的客戶端的利器。
下面就看看在單獨使用Feign的場景下，是怎么調用遠程的http服務。
引入Feign依賴的jar包到pom.xml：
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-core</artifactId>
<version>9.7.0</version>
</dependency>
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-gson</artifactId>
<version>9.7.0</version>
</dependency>
接下來，就可以開始使用Feign來調用遠程的Http API了。
1.1.1. 短連接API的接口准備
前面講到，高並發的IM系統中，用戶的登錄與認證、好友的更新與獲取等等一些低頻的請求，這些都使用短連接來實現。
作為演示，這里僅僅列舉兩個短連接的API接口：
（1） http://localhost:8080/user/{userid}
這個接口的功能，是用戶獲取用戶信息，是一個典型的RESTful類型的接口。{userid}是一個占位符，調用的時候，需要替換成用戶id。 比如說如果用戶id為1，調用的鏈接為：http://localhost:8080/user/1 。
（2） http://localhost:8080/login/{username}/{password}
這個接口的功能，用戶登錄的認證。占位符{username}是表示用戶名稱，占位符{password}表示用戶密碼。 比如說如果用戶名稱為zhangsan，密碼為123調用的鏈接為：http://localhost:8080/login/zhangsan/123 。
上面的接口很簡單，僅僅是為了演示，不能用於生產場景。這些API可以使用Spring MVC 等常見的WEB技術來實現。
1.1.2. 申明遠程接口的本地代理
如何通過Feign技術，來調用上面的這些Http API呢？
第一步，需要創建一個本地的API的代理接口。具體如下：
package com.crazymakercircle.imServer.feignClient;
import feign.Param;
import feign.RequestLine;
public interface UserAction
{
@RequestLine("GET /login/{username}/{password}")
public String loginAction(
@Param("username") String username,
@Param("password") String password);
@RequestLine("GET /user/{userid}")
public String getById(
@Param("userid") Integer userid);
}
在代理接口中，為每一個遠程Http API定義一個方法。
如何將方法對應到遠程接口呢？
在方法的前面，加上一個@RequestLine 注解，注明遠程Http API的請求地址。這個地址不需要從域名和端口開始，只需要從URI的根目錄“/”開始即可。
比如，如果遠程Http API的URL為：http://localhost:8080/user/{userid} ，@RequestLine 聲明的值，只需要配成 /user/{userid} 即可。
如何給接口傳遞參數值呢？
在方法的參數前面， 加上一個 @Param 注解即可。 @Param內容為HTTP鏈接中參數占位符的名稱。綁定好之后，實際這個Java接口中的參數值，會替換到@Param注解中的占位符。
比如：由於getById的唯一參數 userid的 @Param注解中，用到的占位符是userid。那么，通過調用 userAction.getById(100) ，那么userid的值100，就會用來替換掉請求鏈接http://localhost:8080/user/{userid} 中占位符userid，最終得到的請求鏈接為：http://localhost:8080/user/100。
1.1.3. 遠程API的本地調用
在完成遠程API的本地代理接口的定以后，接下來的工作就是調用本地代理，這個工作也是非常的簡單。
還是以瘋狂創客圈的實戰項目，獲取用戶信息、和用戶登錄兩個API的代理接口的調用為例。
實戰的代碼如下：
import com.crazymakercircle.imServer.feignClient.UserAction;
import feign.Feign;
import feign.Request;
import feign.Retryer;
import feign.codec.StringDecoder;
import org.junit.Test;
/**
* Created by 尼恩 at 瘋狂創客圈
*/
//@ContextConfiguration(
// locations = { "classpath:application.properties" })
//@RunWith(SpringJUnit4ClassRunner.class)
//@Configuration
//自動加載配置信息
//@EnableAutoConfiguration
public class LoginActionTest
{
/* // 服務器ip地址
@Value("${server.web.user.url}")
private String userBase;*/
@Test
public void testLogin()
{
UserAction action = Feign.builder()
// .decoder(new GsonDecoder())
.decoder(new StringDecoder())
.options(new Request.Options(1000, 3500))
.retryer(new Retryer.Default(5000, 5000, 3))
.target(
UserAction.class,
// userBase
"http://localhost:8080/"
);
String s = action.loginAction(
"zhangsan",
"zhangsan"
);
System.out.println("s = " + s);
}
@Test
public void testGetById()
{
UserAction action = Feign.builder()
// .decoder(new GsonDecoder())
.decoder(new StringDecoder())
.target(
UserAction.class,
"http://localhost:8080/"
);
String s = action.getById(2);
System.out.println("s = " + s);
}
}
主要的也是最為核心的就一步，構建一個遠程代理接口的本地實例。使用Feign.builder() 構造器模式方法，帶上一票配置方法的鏈式調用。主要的鏈式調用的配置方法介紹如下：
（1）target 配置方法
為構造器配置本地的代理接口，和遠程的根目錄。代理接口類的每一個接口方法前@RequestLine 聲明的值，最終都會加上這個根目錄。這個是最為重要的一個配置方法。代理接口類很重要，最終Feign.builder() 構造器返回的本地代理實例類型，就這個接口。
（2）options配置方法
options方法指定連接超時時長及響應超時時長。
（3）retryer配置方法
retryer方法主要是指定重試策略。
（4）decoder配置方法
decoder方法指定對象解碼方式，這里用的是基於String字符串的解碼方式。如果需要使用Jackson的解碼方式，需要在pom.xml中添加Jackson的依賴。
主要的配置方法，就介紹這些，具體使用和其他的方法，請參見官網。
通過Feign.builder() 構造完成代理實例后，調用遠程API，就變成了調用Java函數一樣的簡單。
建議，如果是獨立調用Http服務，盡量使用Feign。
一是簡單，
二是如果采用httpclient或其他相對較重的框架，對初學者來說編碼量與學習曲線都會是一個挑戰。
三是，既可以獨立使用Feign，又可以方便后續的和Spring Could微服務框架繼承。
總之，何樂而不為呢？
寫在最后
下一篇： zookeeper + netty 實現高並發IM 聊天
瘋狂創客圈 億級流量 高並發IM 學習實戰
- Java (Netty) 聊天程序【 億級流量】實戰 開源項目實戰
- Netty 源碼、原理、JAVA NIO 原理
- Java 面試題 一網打盡
- 瘋狂創客圈 【 博客園 總入口 】