パラメータを使用した改造とGET


92

Retrofitを使用してGoogleGeoCodeAPIにリクエストを送信しようとしています。サービスインターフェイスは次のようになります。

public interface FooService {    
    @GET("/maps/api/geocode/json?address={zipcode}&sensor=false")
    void getPositionByZip(@Path("zipcode") int zipcode, Callback<String> cb);
}

私がサービスを呼び出すとき:

OkHttpClient okHttpClient = new OkHttpClient();

RestAdapter restAdapter = new RestAdapter.Builder().setEndpoint(Constants.GOOGLE_GEOCODE_URL).setClient(new OkClient(okHttpClient)).build();

FooService service = restAdapter.create(FooService.class);

service.getPositionByZip(zipCode, new Callback<String>() {
    @Override public void success(String jsonResponse, Response response) {
       ...
    }
@Override public void failure(RetrofitError retrofitError) {
    }
});

次のスタックトレースを受け取ります。

06-07 13:18:55.337: E/AndroidRuntime(3756): FATAL EXCEPTION: Retrofit-Idle
06-07 13:18:55.337: E/AndroidRuntime(3756): Process: com.marketplacehomes, PID: 3756
06-07 13:18:55.337: E/AndroidRuntime(3756): java.lang.IllegalArgumentException: FooService.getPositionByZip: URL query string "address={zipcode}&sensor=false" must not have replace block.
06-07 13:18:55.337: E/AndroidRuntime(3756):     at retrofit.RestMethodInfo.methodError(RestMethodInfo.java:120)
06-07 13:18:55.337: E/AndroidRuntime(3756):     at retrofit.RestMethodInfo.parsePath(RestMethodInfo.java:216)
06-07 13:18:55.337: E/AndroidRuntime(3756):     at retrofit.RestMethodInfo.parseMethodAnnotations(RestMethodInfo.java:162)
06-07 13:18:55.337: E/AndroidRuntime(3756):     at 

StackOverflowの質問を見てみました:レトロフィット:@GETコマンドの複数のクエリパラメーター?しかし、それは当てはまらないようでした。

私はここからコードをほぼ逐語的に取得しました:http//square.github.io/retrofit/なので、問題を理解するのに少し迷っています。

考え?

回答:


154

AFAIKは{...}、パスとしてのみ使用でき、query-param内では使用できません。代わりにこれを試してください:

public interface FooService {    

    @GET("/maps/api/geocode/json?sensor=false")
    void getPositionByZip(@Query("address") String address, Callback<String> cb);
}

渡すパラメーターの数が不明な場合は、次のように使用できます。

public interface FooService {    

    @GET("/maps/api/geocode/json")
    @FormUrlEncoded
    void getPositionByZip(@FieldMap Map<String, String> params, Callback<String> cb);
}

複数のクエリパラメータを追加する方法
Gilberto Ibarra 2015

2
@GilbertoIbarra err、さらに追加することにより:void getPositionByZip(@Query("address") String address, @Query("number") String number, Callback<String> cb);
Bart Kiers 2015

9
FormUrlEncodedは、リクエスト本文(@POSTなど)を持つHTTPメソッドでのみ指定できます
jiashie 2017年

8
ここでの間違った答え、@ FormUrlEncodedはGETでは使用できません
mr.icetea 2018

1
@FormUrlEncoded@GETアノテーションでは機能しません
Black_Zerg 2018年

40

@QueryMap 代わりに私のために働いた FieldMap

GETパラメータがたくさんある場合、それらをURLに渡す別の方法はHashMapです。

class YourActivity extends Activity {

private static final String BASEPATH = "http://www.example.com";

private interface API {
    @GET("/thing")
    void getMyThing(@QueryMap Map<String, String> params, new Callback<String> callback);
}

public void onCreate(Bundle savedInstanceState) {
   super.onCreate(savedInstanceState);
   setContentView(R.layout.your_layout);

   RestAdapter rest = new RestAdapter.Builder().setEndpoint(BASEPATH).build();
   API service = rest.create(API.class);

   Map<String, String> params = new HashMap<String, String>();
   params.put("key1", "val1");
   params.put("key2", "val2");
   // ... as much as you need.

   service.getMyThing(params, new Callback<String>() {
       // ... do some stuff here.
   });
}
}

呼び出されるURLはhttp://www.example.com/thing/?key1=val1&key2=val2になります


4

また、ビルドするURLパラメーターが複雑な場合は、手動でビルドする必要があることも明確にしたいと思います。つまり、クエリがexample.com/?latlng=-37,147である場合、lat値とlng値を個別に提供する代わりに、latlng文字列を外部で作成してから、パラメータとして提供する必要があります。

public interface LocationService {    
    @GET("/example/")
    void getLocation(@Query(value="latlng", encoded=true) String latlng);
}

encoded=trueが必要であることに注意してください。そうでない場合、レトロフィットは文字列パラメータのコンマをエンコードします。使用法:

String latlng = location.getLatitude() + "," + location.getLongitude();
service.getLocation(latlng);

1

Kotlinでの完全な作業例、APIキーを1111に置き換えました...

        val apiService = API.getInstance().retrofit.create(MyApiEndpointInterface::class.java)
        val params = HashMap<String, String>()
        params["q"] =  "munich,de"
        params["APPID"] = "11111111111111111"

        val call = apiService.getWeather(params)

        call.enqueue(object : Callback<WeatherResponse> {
            override fun onFailure(call: Call<WeatherResponse>?, t: Throwable?) {
                Log.e("Error:::","Error "+t!!.message)
            }

            override fun onResponse(call: Call<WeatherResponse>?, response: Response<WeatherResponse>?) {
                if (response != null && response.isSuccessful && response.body() != null) {
                    Log.e("SUCCESS:::","Response "+ response.body()!!.main.temp)

                    temperature.setText(""+ response.body()!!.main.temp)

                }
            }

        })

1
より明確にするためにgetWeather(params)メソッド定義を配置できますか?
supro_ 9619年
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.