retrofit2源碼分析(二)

在第一章節(jié)講到了ServiceMethod的toRequest()方法誓琼,下面就從toRequest()方法方法開(kāi)始分析ServiceMethod,toRequest()的源碼如下:

  Request toRequest(Object... args) throws IOException {
    RequestBuilder requestBuilder = new RequestBuilder(httpMethod, baseUrl, relativeUrl, headers,
        contentType, hasBody, isFormEncoded, isMultipart);

    @SuppressWarnings("unchecked") // It is an error to invoke a method with the wrong arg types.
    ParameterHandler<Object>[] handlers = (ParameterHandler<Object>[]) parameterHandlers;

    int argumentCount = args != null ? args.length : 0;
    if (argumentCount != handlers.length) {
      throw new IllegalArgumentException("Argument count (" + argumentCount
          + ") doesn't match expected count (" + handlers.length + ")");
    }

    for (int p = 0; p < argumentCount; p++) {
      handlers[p].apply(requestBuilder, args[p]);//這里是參數(shù)參數(shù)配置的核心
    }

    return requestBuilder.build();
  }

先來(lái)看一下handlers(也就是parameterHandlers)這個(gè)屬性的功能。parameterHandlers的初始化在ServiceMethod的內(nèi)部類(lèi)Builder的build()方法中初始化。build()方法如下:

public ServiceMethod build() {
      callAdapter = createCallAdapter();
      responseType = callAdapter.responseType();
      if (responseType == Response.class || responseType == okhttp3.Response.class) {
        throw methodError("'"
            + Utils.getRawType(responseType).getName()
            + "' is not a valid response body type. Did you mean ResponseBody?");
      }
      responseConverter = createResponseConverter();

      for (Annotation annotation : methodAnnotations) {
        parseMethodAnnotation(annotation);
      }

      if (httpMethod == null) {
        throw methodError("HTTP method annotation is required (e.g., @GET, @POST, etc.).");
      }

      if (!hasBody) {
        if (isMultipart) {
          throw methodError(
              "Multipart can only be specified on HTTP methods with request body (e.g., @POST).");
        }
        if (isFormEncoded) {
          throw methodError("FormUrlEncoded can only be specified on HTTP methods with "
              + "request body (e.g., @POST).");
        }
      }

      int parameterCount = parameterAnnotationsArray.length;//方法的參數(shù)的所有注解
      parameterHandlers = new ParameterHandler<?>[parameterCount];//初始化
      for (int p = 0; p < parameterCount; p++) {
        Type parameterType = parameterTypes[p];
        if (Utils.hasUnresolvableType(parameterType)) {//參數(shù)類(lèi)型檢查
          throw parameterError(p, "Parameter type must not include a type variable or wildcard: %s",
              parameterType);
        }

        Annotation[] parameterAnnotations = parameterAnnotationsArray[p];
        if (parameterAnnotations == null) {
          throw parameterError(p, "No Retrofit annotation found.");
        }
        //保存了參數(shù)類(lèi)型和參數(shù)的注解
        parameterHandlers[p] = parseParameter(p, parameterType, parameterAnnotations);
      }

      if (relativeUrl == null && !gotUrl) {
        throw methodError("Missing either @%s URL or @Url parameter.", httpMethod);
      }
      if (!isFormEncoded && !isMultipart && !hasBody && gotBody) {
        throw methodError("Non-body HTTP method cannot contain @Body.");
      }
      if (isFormEncoded && !gotField) {
        throw methodError("Form-encoded method must contain at least one @Field.");
      }
      if (isMultipart && !gotPart) {
        throw methodError("Multipart method must contain at least one @Part.");
      }

      return new ServiceMethod<>(this);
    }

這里先補(bǔ)充一點(diǎn)反射的知識(shí)。

Annotation[] annotations = method.getAnnotations();//獲取方法的所有注解
Annotation[][] annos = method.getParameterAnnotations();//獲取方法的參數(shù)的所有注解郁竟。
Type[] t = m.getGenericParameterTypes();//返回方法的參數(shù)列表

Utils.hasUnresolvableType()這個(gè)方法的源碼如下:

  static boolean hasUnresolvableType(Type type) {
    if (type instanceof Class<?>) {
      return false;
    }
    if (type instanceof ParameterizedType) {
      ParameterizedType parameterizedType = (ParameterizedType) type;
      for (Type typeArgument : parameterizedType.getActualTypeArguments()) {
        if (hasUnresolvableType(typeArgument)) {
          return true;
        }
      }
      return false;
    }
    if (type instanceof GenericArrayType) {
      return hasUnresolvableType(((GenericArrayType) type).getGenericComponentType());
    }
    if (type instanceof TypeVariable) {
      return true;
    }
    if (type instanceof WildcardType) {
      return true;
    }
    String className = type == null ? "null" : type.getClass().getName();
    throw new IllegalArgumentException("Expected a Class, ParameterizedType, or "
        + "GenericArrayType, but <" + type + "> is of type " + className);
  }

hasUnresolvableType()其實(shí)就是做了參數(shù)的類(lèi)型檢查。具體各個(gè)類(lèi)型代表的含義由境,可以百度反射相關(guān)知識(shí)棚亩。

parseParameter()方法源碼如下:

    private ParameterHandler<?> parseParameter(
        int p, Type parameterType, Annotation[] annotations) {
      ParameterHandler<?> result = null;
      for (Annotation annotation : annotations) {
        ParameterHandler<?> annotationAction = parseParameterAnnotation(
            p, parameterType, annotations, annotation);

        if (annotationAction == null) {
          continue;
        }

        if (result != null) {
          throw parameterError(p, "Multiple Retrofit annotations found, only one allowed.");
        }

        result = annotationAction;
      }

      if (result == null) {
        throw parameterError(p, "No Retrofit annotation found.");
      }

      return result;
    }

接著看parseParameterAnnotation()的源碼:

private ParameterHandler<?> parseParameterAnnotation(
        int p, Type type, Annotation[] annotations, Annotation annotation) {
      //如果注解是Url
      if (annotation instanceof Url) {
        if (gotUrl) {
          throw parameterError(p, "Multiple @Url method annotations found.");
        }
        if (gotPath) {
          throw parameterError(p, "@Path parameters may not be used with @Url.");
        }
        if (gotQuery) {
          throw parameterError(p, "A @Url parameter must not come after a @Query");
        }
        if (relativeUrl != null) {
          throw parameterError(p, "@Url cannot be used with @%s URL", httpMethod);
        }

        gotUrl = true;

        if (type == HttpUrl.class
            || type == String.class
            || type == URI.class
            || (type instanceof Class && "android.net.Uri".equals(((Class<?>) type).getName()))) {
          return new ParameterHandler.RelativeUrl();//如果沒(méi)有異常蓖议,返回Url對(duì)應(yīng)的ParameterHandler。
        } else {
          throw parameterError(p,
              "@Url must be okhttp3.HttpUrl, String, java.net.URI, or android.net.Uri type.");
        }

      } else if (annotation instanceof Path) {
        if (gotQuery) {
          throw parameterError(p, "A @Path parameter must not come after a @Query.");
        }
        if (gotUrl) {
          throw parameterError(p, "@Path parameters may not be used with @Url.");
        }
        if (relativeUrl == null) {
          throw parameterError(p, "@Path can only be used with relative url on @%s", httpMethod);
        }
        gotPath = true;

        Path path = (Path) annotation;
        String name = path.value();
        validatePathName(p, name);

        Converter<?, String> converter = retrofit.stringConverter(type, annotations);
        return new ParameterHandler.Path<>(name, converter, path.encoded());

      } 

    ……

    }

RelativeUrl類(lèi)的定義如下(其他的注解定義和使用方式都差不多讥蟆,就不一一說(shuō)明):

 static final class RelativeUrl extends ParameterHandler<Object> {
    @Override void apply(RequestBuilder builder, Object value) {
      builder.setRelativeUrl(value);
    }
  }

RequestBuilder的setRelativeUrl()方法定義如下:

  void setRelativeUrl(Object relativeUrl) {
    //url不能為空
    if (relativeUrl == null) throw new NullPointerException("@Url parameter is null.");
    this.relativeUrl = relativeUrl.toString();
  }

關(guān)于parameterHandlers就介紹到這里勒虾,總結(jié)起來(lái)就是parameterHandlers里面存放的是類(lèi)似于RelativeUrl這樣的類(lèi),專(zhuān)門(mén)用于處理各種注解瘸彤。ServiceMethod的toRequest()方法修然,都會(huì)調(diào)用parameterHandlers里面的ParameterHandler的apply()方法。調(diào)用完之后质况,所有的參數(shù)都填入到RequestBuilder中去了愕宋。到此,Retrofit就完成了數(shù)據(jù)的收集功能结榄。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末中贝,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子潭陪,更是在濱河造成了極大的恐慌雄妥,老刑警劉巖,帶你破解...
    沈念sama閱讀 217,826評(píng)論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件依溯,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡瘟则,警方通過(guò)查閱死者的電腦和手機(jī)黎炉,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,968評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)醋拧,“玉大人慷嗜,你說(shuō)我怎么就攤上這事〉ず荆” “怎么了庆械?”我有些...
    開(kāi)封第一講書(shū)人閱讀 164,234評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)菌赖。 經(jīng)常有香客問(wèn)我缭乘,道長(zhǎng),這世上最難降的妖魔是什么琉用? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,562評(píng)論 1 293
  • 正文 為了忘掉前任堕绩,我火速辦了婚禮,結(jié)果婚禮上邑时,老公的妹妹穿的比我還像新娘奴紧。我一直安慰自己,他們只是感情好晶丘,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,611評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布黍氮。 她就那樣靜靜地躺著唐含,像睡著了一般。 火紅的嫁衣襯著肌膚如雪沫浆。 梳的紋絲不亂的頭發(fā)上捷枯,一...
    開(kāi)封第一講書(shū)人閱讀 51,482評(píng)論 1 302
  • 那天,我揣著相機(jī)與錄音件缸,去河邊找鬼铜靶。 笑死,一個(gè)胖子當(dāng)著我的面吹牛他炊,可吹牛的內(nèi)容都是我干的争剿。 我是一名探鬼主播,決...
    沈念sama閱讀 40,271評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼痊末,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼蚕苇!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起凿叠,我...
    開(kāi)封第一講書(shū)人閱讀 39,166評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤涩笤,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后盒件,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體蹬碧,經(jīng)...
    沈念sama閱讀 45,608評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,814評(píng)論 3 336
  • 正文 我和宋清朗相戀三年炒刁,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了恩沽。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,926評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡翔始,死狀恐怖罗心,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情城瞎,我是刑警寧澤渤闷,帶...
    沈念sama閱讀 35,644評(píng)論 5 346
  • 正文 年R本政府宣布,位于F島的核電站脖镀,受9級(jí)特大地震影響飒箭,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜认然,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,249評(píng)論 3 329
  • 文/蒙蒙 一补憾、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧卷员,春花似錦盈匾、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,866評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)岩瘦。三九已至,卻和暖如春窿撬,著一層夾襖步出監(jiān)牢的瞬間启昧,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,991評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工劈伴, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留密末,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,063評(píng)論 3 370
  • 正文 我出身青樓跛璧,卻偏偏與公主長(zhǎng)得像严里,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子追城,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,871評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容