Как вернуть ответ вызывающей функции? (Android-приложение вызывает Java REST-сервер через JSON)

Спасибо за вашу помощь! Я нашел решение, которое работает для моего случая.

Во-первых, поскольку это всего лишь прототип, мне не нужно, чтобы мои запросы были асинхронными, поэтому я заменил ServerConnection на SyncHttpClient:

public class ServerConnection {

    private static final String BASE_URL = "http://10.203.58.11:8080/";

    private static SyncHttpClient client = new SyncHttpClient();

    public static void get(String url, RequestParams params, JsonHttpResponseHandler responseHandler) {
        client.get(getAbsoluteUrl(url), params, responseHandler);
    }
}

Затем Android не позволит мне выполнять запросы в основном потоке. Это не было проблемой с AsyncHttpClient, так как асинхронная часть обрабатывается в собственном потоке. Поэтому мне пришлось добавить темы к моим запросам. Таким образом, мой MainController теперь выглядит примерно так:

public class MainController
{
    private final AtomicLong counter;
    private final HashMap<Long, CallResult> callResults;

    public MainController(){
        counter = new AtomicLong();
        callResults  = new HashMap<>();
    }

public Login getLoginByUsername(String username)
    {
        long callID = counter.incrementAndGet();
        new Thread(new Runnable() {
            @Override
            public void run() {
                ServerConnection.get("person-login-relations?byUsername="+username,null, new JsonHttpResponseHandler(){
                    @Override
                    public void onSuccess(int statusCode, Header[] headers, JSONObject response){
                        try {
                            callResults.put(callID, new CallResult(Login.parseFromJson(response)));
                            System.out.println(callResults.get(callID));

                        } catch (JSONException e) {
                            e.printStackTrace();
                        }
                    }
                });


            }
        })   .start();

        while(callResults.get(callID) == null){
            //wait
        }
        return (Login) callResults.remove(callID).content;
    }
}

Я предполагаю, что цикл while, который я использую для ожидания, теперь работает, потому что он не блокирует поток, отвечающий за выполнение и обработку запроса. Хотя не совсем уверен в этом.

По общему признанию, это может быть не идеальное решение, но это наиболее осуществимое, учитывая мой конкретный контекст.

Через несколько месяцев мне будет поручено переработать приложение, которое я сейчас расширяю для подключения к клиенту. В этот момент я позабочусь о том, чтобы реализовать большинство ваших предложений! Итак, всем, кто читает это решение: вот это обходной путь, потому что мне не нужны асинхронные запросы, и я не должен изменять функции, вызывающие методы, которые вы здесь видите! Я предлагаю вам все же прочитать другие ответы, поскольку они качественно лучше!

Вы использовали GSON от Google, он преобразует объект JSON в объект java, его синтаксис прост, и он вам понравится, я использую его все время. И я использую залп для ответа на HTTP-запрос. Просто используйте GSON, например

GSON gson = new GSON();
LoginObject login = new LoginObject();
login=gson.fromJson(responce,LoginObject.class);

и вуаля все готово.

Если вы не хотите использовать Livedata или Rxjava, вы можете реорганизовать этот метод, чтобы принимать JsonHttpResponseHandler или пользовательский обратный вызов, это не красиво, но работает:

1.

public void getLoginByUsername(String username, JsonHttpResponseHandler callback)
{
    long callID = counter.incrementAndGet();
    System.out.println("Start call");
    ServerConnection.get("myURL",null, callback);

}

а затем вызывая это так:

getLoginByUsername("myUsername", new JsonHttpResponseHandler(){
        @Override
        public void onSuccess(int statusCode, Header[] headers, JSONObject response){
            try {
                Login myLogin = Login.parseFromJson(response);
                //do stuff

            } catch (JSONException e) {
                e.printStackTrace();
            }
        }
    });

or

2.

class MainController {
    private final AtomicLong counter;
    private final HashMap<Long, Object> callResults;

    interface OnLogin{
        void onSuccessLogin(Login login);
    }

    public MainController() {
        counter = new AtomicLong();
        callResults = new HashMap<>();
    }

    public void getLoginByUsername(String username, OnLogin callback)
    {

        ServerConnection.get("myURL",null, new JsonHttpResponseHandler(){
            @Override
            public void onSuccess(int statusCode, Header[] headers, JSONObject response){
                try {
                    Login loginObject = Login.parseFromJson(response);
                    callback.onSuccessLogin(loginObject);

                } catch (JSONException e) {
                    e.printStackTrace();
                }
            }
        });

    }


}

и вы называете это так:

    MainController controller = new MainController();
    controller.getLoginByUsername("myUsername", new MainController.OnLogin() {
        @Override
        public void onSuccessLogin(Login login) {
            //do whatever here
        }
    });

Вы можете легко добиться этого, используя CompletableFuture<?>. Он работает аналогично Promise в JavaScript. Если вам требуется совместимость до уровня API 24, проверьте этот ответ здесь.

Таким образом, ваш getLoginByUsername будет выглядеть примерно так:

public CompletableFuture<Login> loginByUsername(String username) {
    CompletableFuture<Login> promise = new CompletableFuture<Login>();

    System.out.println("Start call");
    ServerConnection.get("myURL",null, new JsonHttpResponseHandler(){
        @Override
        public void onSuccess(int statusCode, Header[] headers, JSONObject response){
            try {
                System.out.println("Call success, enter result:");
                promise.complete(Login.parseFromJson(response));

            } catch (JSONException e) {
                promise.completeExceptionally(e);
            }
        }
    });

    return promise;
}

И ваш сайт вызова примерно такой:

Login login = loginByUsername("user").get();
// Or wait a maximum time
Login login = loginByUsername("user").get(30, TimeUnit.SECONDS);

Никогда не вызывайте get() в UIThread. Это заблокирует пользовательский интерфейс и создаст неудобства для пользователя