如何閱讀 Spring Cloud OpenFein 源碼

背景

一直以來,使用 Spring Cloud OpenFeign 都是閱讀官方文檔,雖然也大概知道其實現原理,但終究是沒有"證據"的。關于 Spring 的源碼閱讀,自認為是一件十分令人頭疼的事情。最近,在學習 Feign 的原生 API,乘此機會,也就閱讀一下 Spring Cloud OpenFeign 的源碼,并將分享出來,希望能幫到有需要的人吧。

概述

關于 Spring Cloud OpenFeign 源碼的博客有很多,但是,不知道為什么,照著博客,一邊讀博客,一邊讀源碼,還一邊 debug,總是認為還有很多不清楚的地方。究其原因,我認為,博客都是按照源碼的流程講解,雖然附上了大段代碼,可能還是無法清晰的理解。不知道你們是不是,反正我是這樣的。

目標

首先,我們明確一下今天探究的問題:

  1. 我們知道,當我們使用 @FeignClient,是使用了JDK動態代理,那么是如何實現的,那一步創建的代理類。

  2. 當我們知道第一個問題后,我們就基本清楚整個流程了,那么,我們就可以手寫一個簡易的入門測試了。

源碼

啟動流程

  • org.springframework.cloud.openfeign.EnableFeignClients
  • org.springframework.cloud.openfeign.FeignAutoConfiguration
  • org.springframework.cloud.openfeign.FeignClientsRegistrar
  • org.springframework.cloud.openfeign.FeignClientsRegistrar#registerBeanDefinitions
  • org.springframework.cloud.openfeign.FeignClientsRegistrar#registerFeignClient
  • org.springframework.cloud.openfeign.FeignClientFactoryBean#getObject
  • org.springframework.cloud.openfeign.Targeter
  • feign.Feign.Builder#build
  • feign.SynchronousMethodHandler.Factory
  • feign.ReflectiveFeign.ParseHandlersByName
  • feign.ReflectiveFeign#ReflectiveFeign
  • feign.Feign#newInstance
  • feign.ReflectiveFeign#newInstance
  • feign.InvocationHandlerFactory#create
  • feign.InvocationHandlerFactory.Default#create
  • feign.ReflectiveFeign.FeignInvocationHandler#FeignInvocationHandler

貼上圖吧,看看完整版的

注冊流程:

01.jpg

自動配置:

02.jpg

調用流程

  • feign.ReflectiveFeign.FeignInvocationHandler#invoke
  • feign.InvocationHandlerFactory.MethodHandler#invoke
  • feign.SynchronousMethodHandler#invoke
03.jpg

MyRpc

經過上面的流程,我們手寫一個 RPC。

下面給出主要代碼。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import({MyRpcRegister.class, MyRpcAutoConfig.class})
public @interface EnableMyRpc {
}

getObject()

@Data
public class MyRpcFactoryBean implements FactoryBean<Object> {

    private String url;

    private String contextPath;

    private String name;

    private Class<?> type;

    private BeanFactory beanFactory;

    private MyClient myClient;

    @Override
    public Object getObject() {

        Map<Method, RpcBean> map = new HashMap<>();

        Method[] methods = type.getMethods();

        myClient = beanFactory.getBean(MyClient.class);

        for (Method method : methods) {
            Annotation[] annotations = method.getAnnotations();
            String httpMethod = "";
            String path = "";
            for (Annotation annotation : annotations) {
                if (annotation.annotationType() == PostMapping.class) {
                    httpMethod = "POST";
                    path = ((PostMapping) annotation).value()[0];
                    break;
                } else if (annotation.annotationType() == GetMapping.class) {
                    httpMethod = "GET";
                    path = ((GetMapping) annotation).value()[0];
                    break;
                } else if (annotation.annotationType() == RequestMapping.class) {
                    RequestMapping requestMapping = ((RequestMapping) annotation);
                    httpMethod = requestMapping.method()[0].name();
                    path = requestMapping.value()[0];
                    break;
                }
            }
            RpcBean rpcBean = new RpcBean()
                    .setUrl(url + contextPath)
                    .setPath(path)
                    .setHttpMethod(httpMethod)
                    .setMyClient(myClient)
                    ;
            map.put(method, rpcBean);
        }

        ClassLoader loader = type.getClassLoader();

        return Proxy.newProxyInstance(loader, new Class<?>[] {type}, new MyRpcInvocationHandler(map));
    }

    @Override
    public Class<?> getObjectType() {
        return type;
    }

}

handler

@Slf4j
public class MyRpcInvocationHandler implements InvocationHandler {

    private final Map<Method, RpcBean> map;

    public MyRpcInvocationHandler(Map<Method, RpcBean> map) {
        this.map = map;
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {

        log.info("proxy handler");

        return request(method, args);
    }

    public Object request(Method method, Object[] args) {
        String result = "";
        RpcBean rpcBean = map.get(method);
        Parameter[] parameters = method.getParameters();
        Class<?> returnType = method.getReturnType();
        String url = rpcBean.getUrl() + rpcBean.getPath();
        String httpMethod = rpcBean.getHttpMethod();
        String param = getParam(httpMethod, parameters, args);
        log.info("url: [{}], param: [{}]", url, param);
        MyClient myClient = rpcBean.getMyClient();
        if ("POST".equals(httpMethod)) {
            result = myClient.post(url, param);
        } else if ("GET".equals(httpMethod)) {
            result = myClient.get(url, param);
        }
        if (StringUtils.hasText(result)) {
            return JsonUtils.convertObject(result, returnType);
        }
        return "";
    }

    public String getParam(String httpMethod, Parameter[] parameters, Object[] args) {
        if ("POST".equals(httpMethod)) {
            return JsonUtils.convertString(args[0]);
        } else if ("GET".equals(httpMethod)) {
            if (Objects.isNull(parameters) || parameters.length == 0
                    || Objects.isNull(args) || args.length == 0) {
                return "";
            }
            String param = "";
            StringBuilder urlBuilder = new StringBuilder(param);
            for (int i = 0; i < parameters.length; i++) {
                if (Objects.nonNull(args[i])) {
                    urlBuilder.append(String.format("%s=%s&", parameters[i].getName(), args[i]));
                }
            }
            param = urlBuilder.toString();
            param = param.substring(0, param.length() - 1);
            return param;
        }
        return "";
    }
}

完整代碼

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,461評論 6 532
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,538評論 3 417
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,423評論 0 375
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,991評論 1 312
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,761評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,207評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,268評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,419評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,959評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,782評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,983評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,528評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,222評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,653評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,901評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,678評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,978評論 2 374

推薦閱讀更多精彩內容