gRPC学习记录(五)--拦截器分析
對于此類調(diào)用攔截器是必不可少的,本篇就分析下攔截器的實現(xiàn).(博主本來想分析源碼的,但是水平不足,并發(fā)知識欠缺,看的不是很懂,哎,仍需努力),另外貌似不同版本有些差異,這里使用的是1.0.3版本.
1.一個攔截器的小例子
在分析之前先看一種設(shè)計.
有一個接口如下:
/*** 主調(diào)用接口*/ public abstract class Client {public abstract void start(String say); } /*** 上述接口實現(xiàn)類*/ public class ClientImp extends Client {public void start(String say) {System.out.println(say);} }對此接口相關(guān)的轉(zhuǎn)換器:
/*** 用于包裝Client到另一個Client*/ public abstract class ForwardingClient extends Client{//要包裝的對象protected abstract Client delegate();public void start(String say) {delegate().start(say);} } /*** 一個簡單的包裝實現(xiàn)類,必須要傳入要包裝的對象*/ public class ForwardingClientImpl extends ForwardingClient{//被委托對象private final Client client;public ForwardingClientImpl(Client client) {this.client = client;}protected Client delegate() {return client;} }然后在下列方法中調(diào)用:
public class InterceptTest {public static void main(String[] args) {Client client = new ClientImp();//主要想執(zhí)行的方法//構(gòu)造第一個攔截器Client intercept1 = new ForwardingClientImpl(client){public void start(String say) {System.out.println("攔截器1");super.start(say);}};//構(gòu)造第二個攔截器Client intercept2 = new ForwardingClientImpl(intercept1){public void start(String say) {System.out.println("攔截器2");super.start(say);}};//執(zhí)行主方法intercept2.start("這是要執(zhí)行的方法");} }毫無疑問會輸出
攔截器2 攔截器1 這是要執(zhí)行的方法分析一下針對Client接口,通過ForwardingClient可以實現(xiàn)自身的嵌套調(diào)用,從而達(dá)到了類似攔截器的效果.在gRPC中有很多類似的嵌套類,其本質(zhì)和上面差不多,上面例子有助于對gRPC攔截器的掌握.
2.gRPC的ClientCall
該抽象類就是用來調(diào)用遠(yuǎn)程方法的,實現(xiàn)了發(fā)送消息和接收消息的功能,該接口由兩個泛型ReqT和ReqT,分別對應(yīng)著請求發(fā)送的信息,和請求收到的回復(fù).
ClientCall抽象類主要有兩個部分組成,一是public abstract static class Listener<T>用于監(jiān)聽服務(wù)端回復(fù)的消息,另一部分是針對客戶端請求調(diào)用的一系列過程,如下代碼流程所示:
該類中方法都是抽象方法,規(guī)定了整個調(diào)用順序,如下:
在ClientCall的子類中有ForwardingClientCall<ReqT, RespT>,該類的作用和之前的Demo一樣,用于包裝ClientCall,然后實現(xiàn)委托嵌套調(diào)用,里面方法都如下代碼所示:
public void start(Listener<RespT> responseListener, Metadata headers) {delegate().start(responseListener, headers);}public void request(int numMessages) {delegate().request(numMessages);}那和之前的Demo一對比,攔截器怎么使用就變得很容易了.
創(chuàng)建一個客戶端攔截器,其中為header添加了token參數(shù).之所以要實現(xiàn)ClientInterceptor接口,因為Channel本身也是可以嵌套的類,所以創(chuàng)建ClientCall也是被一層一層的調(diào)用.
調(diào)用輸出如下:
創(chuàng)建client1 攔截器1,在此可以對header參數(shù)進(jìn)行修改這是針對客戶端調(diào)用前的攔截,對于客戶端收到的回復(fù)攔截則通過ClientCall的靜態(tài)內(nèi)部類Listener來實現(xiàn),該Listener也是可以嵌套的,其內(nèi)有如下方法:
public void onHeaders(Metadata headers) {} public void onMessage(T message) {} public void onClose(Status status, Metadata trailers) {} public void onReady() {}對之前start方法改造下,讓其判斷返回的header中有沒有傳送過去的token,沒有則該請求視為失敗.
public void start(Listener<RespT> responseListener, Metadata headers) {System.out.println("攔截器1,在此可以對header參數(shù)進(jìn)行修改");Metadata.Key<String> token = Metadata.Key.of("token",Metadata.ASCII_STRING_MARSHALLER);headers.put(token,"123456");Listener<RespT> forwardListener = new ForwardingClientCallListener.SimpleForwardingClientCallListener<RespT>(responseListener) {public void onHeaders(Metadata headers) {Metadata.Key<String> token = Metadata.Key.of("token",Metadata.ASCII_STRING_MARSHALLER);if (!"123456".equals(headers.get(token))){System.out.println("返回參數(shù)無token,關(guān)閉該鏈接");super.onClose(Status.DATA_LOSS,headers);}super.onHeaders(headers);}};super.start(forwardListener, headers);}最后再Channel創(chuàng)建的時候使用intercept(new ClientInterruptImpl())加入攔截器這樣就簡單實現(xiàn)了客戶端的攔截了.
3.gRPC的ServerCall
有一點要搞明白,ClientCall是針對客戶端要調(diào)用的方法的,而ServerCall是針對ClientCall的.看如下例子:
public class ServerInterruptImpl implements ServerInterceptor{public <ReqT, RespT> ServerCall.Listener<ReqT> interceptCall(ServerCall<ReqT, RespT> call,Metadata headers, ServerCallHandler<ReqT, RespT> next) {System.out.println("執(zhí)行server攔截器1,獲取token");//獲取客戶端參數(shù)Metadata.Key<String> token = Metadata.Key.of("token", Metadata.ASCII_STRING_MARSHALLER);String tokenStr = headers.get(token);if (StringUtil.isNullOrEmpty(tokenStr)){System.out.println("未收到客戶端token,關(guān)閉此連接");call.close(Status.DATA_LOSS,headers);}//服務(wù)端寫回參數(shù)ServerCall<ReqT, RespT> serverCall = new ForwardingServerCall.SimpleForwardingServerCall<ReqT, RespT>(call) {public void sendHeaders(Metadata headers) {System.out.println("執(zhí)行server攔截器2,寫入token");headers.put(token,tokenStr);super.sendHeaders(headers);}};return next.startCall(serverCall,headers);} }當(dāng)服務(wù)端接收到請求的時候就會打印出來如下的日志.這樣就實現(xiàn)了服務(wù)端接手前的攔截和寫回時的攔截.
執(zhí)行server攔截器1,獲取token 收到的信息:world:0 執(zhí)行server攔截器2,寫入token關(guān)于更多使用還在琢磨中,目前欠缺并發(fā)知識,所以下一步打算看看并發(fā)相關(guān)的資料.
附錄:
相關(guān)代碼: https://github.com/nl101531/JavaWEB
作者:此博廢棄_更新在個人博客
鏈接:https://www.jianshu.com/p/6a2f6db0a967
來源:簡書
著作權(quán)歸作者所有。商業(yè)轉(zhuǎn)載請聯(lián)系作者獲得授權(quán),非商業(yè)轉(zhuǎn)載請注明出處。
總結(jié)
以上是生活随笔為你收集整理的gRPC学习记录(五)--拦截器分析的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: gRPC学习记录(四)--官方Demo
- 下一篇: 一个更优的零知识证明:Bulletpro