Restful API service
I'm looking to make a service which I can use to make calls to a web-based REST API.
Basically I want to start a service on app init then I want to be able to ask that service to request a url and return the results. In the meantime I want to be able to display a progress window or something similar.
Я создал сервис, который в настоящее время использует IDL, я где-то читал, что вам это действительно нужно только для взаимодействия между приложениями, так что подумайте, нужно ли их удалять, но не знаете, как делать обратные вызовы без него. Также, когда я ударил post(Config.getURL("login"), values) приложение, кажется, приостанавливается на некоторое время (кажется странным - мысль о том, что служба основана на том, что она работает в другом потоке!)
В настоящее время у меня есть служба с методами post и get внутри, пара файлов AIDL (для двусторонней связи), ServiceManager, который занимается запуском, остановкой, привязкой и т. Д. К службе, и я динамически создаю обработчик с определенным кодом для обратных вызовов по мере необходимости.
Я не хочу, чтобы кто-нибудь давал мне полную кодовую базу для работы, но некоторые указатели будут с благодарностью.
Код в основном (в основном):
public class RestfulAPIService extends Service {
final RemoteCallbackList<IRemoteServiceCallback> mCallbacks = new RemoteCallbackList<IRemoteServiceCallback>();
public void onStart(Intent intent, int startId) {
super.onStart(intent, startId);
}
public IBinder onBind(Intent intent) {
return binder;
}
public void onCreate() {
super.onCreate();
}
public void onDestroy() {
super.onDestroy();
mCallbacks.kill();
}
private final IRestfulService.Stub binder = new IRestfulService.Stub() {
public void doLogin(String username, String password) {
Message msg = new Message();
Bundle data = new Bundle();
HashMap<String, String> values = new HashMap<String, String>();
values.put("username", username);
values.put("password", password);
String result = post(Config.getURL("login"), values);
data.putString("response", result);
msg.setData(data);
msg.what = Config.ACTION_LOGIN;
mHandler.sendMessage(msg);
}
public void registerCallback(IRemoteServiceCallback cb) {
if (cb != null)
mCallbacks.register(cb);
}
};
private final Handler mHandler = new Handler() {
public void handleMessage(Message msg) {
// Broadcast to all clients the new value.
final int N = mCallbacks.beginBroadcast();
for (int i = 0; i < N; i++) {
try {
switch (msg.what) {
case Config.ACTION_LOGIN:
mCallbacks.getBroadcastItem(i).userLogIn( msg.getData().getString("response"));
break;
default:
super.handleMessage(msg);
return;
}
} catch (RemoteException e) {
}
}
mCallbacks.finishBroadcast();
}
public String post(String url, HashMap<String, String> namePairs) {...}
public String get(String url) {...}
};
Пара файлов AIDL:
package com.something.android
oneway interface IRemoteServiceCallback {
void userLogIn(String result);
}
а также
package com.something.android
import com.something.android.IRemoteServiceCallback;
interface IRestfulService {
void doLogin(in String username, in String password);
void registerCallback(IRemoteServiceCallback cb);
}
и менеджер по обслуживанию:
public class ServiceManager {
final RemoteCallbackList<IRemoteServiceCallback> mCallbacks = new RemoteCallbackList<IRemoteServiceCallback>();
public IRestfulService restfulService;
private RestfulServiceConnection conn;
private boolean started = false;
private Context context;
public ServiceManager(Context context) {
this.context = context;
}
public void startService() {
if (started) {
Toast.makeText(context, "Service already started", Toast.LENGTH_SHORT).show();
} else {
Intent i = new Intent();
i.setClassName("com.something.android", "com.something.android.RestfulAPIService");
context.startService(i);
started = true;
}
}
public void stopService() {
if (!started) {
Toast.makeText(context, "Service not yet started", Toast.LENGTH_SHORT).show();
} else {
Intent i = new Intent();
i.setClassName("com.something.android", "com.something.android.RestfulAPIService");
context.stopService(i);
started = false;
}
}
public void bindService() {
if (conn == null) {
conn = new RestfulServiceConnection();
Intent i = new Intent();
i.setClassName("com.something.android", "com.something.android.RestfulAPIService");
context.bindService(i, conn, Context.BIND_AUTO_CREATE);
} else {
Toast.makeText(context, "Cannot bind - service already bound", Toast.LENGTH_SHORT).show();
}
}
protected void destroy() {
releaseService();
}
private void releaseService() {
if (conn != null) {
context.unbindService(conn);
conn = null;
Log.d(LOG_TAG, "unbindService()");
} else {
Toast.makeText(context, "Cannot unbind - service not bound", Toast.LENGTH_SHORT).show();
}
}
class RestfulServiceConnection implements ServiceConnection {
public void onServiceConnected(ComponentName className, IBinder boundService) {
restfulService = IRestfulService.Stub.asInterface((IBinder) boundService);
try {
restfulService.registerCallback(mCallback);
} catch (RemoteException e) {}
}
public void onServiceDisconnected(ComponentName className) {
restfulService = null;
}
};
private IRemoteServiceCallback mCallback = new IRemoteServiceCallback.Stub() {
public void userLogIn(String result) throws RemoteException {
mHandler.sendMessage(mHandler.obtainMessage(Config.ACTION_LOGIN, result));
}
};
private Handler mHandler;
public void setHandler(Handler handler) {
mHandler = handler;
}
}
Служба init и bind:
// this I'm calling on app onCreate
servicemanager = new ServiceManager(this);
servicemanager.startService();
servicemanager.bindService();
application = (ApplicationState)this.getApplication();
application.setServiceManager(servicemanager);
вызов сервисной функции:
// this lot i'm calling as required - in this example for login
progressDialog = new ProgressDialog(Login.this);
progressDialog.setMessage("Logging you in...");
progressDialog.show();
application = (ApplicationState) getApplication();
servicemanager = application.getServiceManager();
servicemanager.setHandler(mHandler);
try {
servicemanager.restfulService.doLogin(args[0], args[1]);
} catch (RemoteException e) {
e.printStackTrace();
}
...later in the same file...
Handler mHandler = new Handler() {
public void handleMessage(Message msg) {
switch (msg.what) {
case Config.ACTION_LOGIN:
if (progressDialog.isShowing()) {
progressDialog.dismiss();
}
try {
...process login results...
}
} catch (JSONException e) {
Log.e("JSON", "There was an error parsing the JSON", e);
}
break;
default:
super.handleMessage(msg);
}
}
};
11 ответов
Если ваш сервис станет частью вашего приложения, то вы делаете его более сложным, чем нужно. Поскольку у вас есть простой случай использования некоторых данных из веб-службы RESTful, вам следует изучить ResultReceiver и IntentService.
Этот шаблон Service + ResultReceiver работает путем запуска или привязки к службе с помощью startService(), когда вы хотите выполнить какое-либо действие. Вы можете указать операцию, которую нужно выполнить, и передать ее в ResultReceiver (действие) через дополнительные функции в Intent.
В сервисе вы реализуете onHandleIntent для выполнения операции, указанной в Intent. Когда операция завершена, вы используете переданный в ResultReceiver для отправки сообщения обратно в Activity, после чего будет вызван onReceiveResult.
Так, например, вы хотите получить некоторые данные из вашего веб-сервиса.
- Вы создаете намерение и вызываете startService.
- Операция в службе начинается, и она отправляет активности сообщение о том, что она запущена
- Операция обрабатывает сообщение и показывает прогресс.
- Служба завершает операцию и отправляет некоторые данные в вашу деятельность.
- Ваша деятельность обрабатывает данные и помещает их в список
- Служба отправляет вам сообщение о том, что это сделано, и убивает себя.
- Действие получает сообщение о завершении и скрывает диалог прогресса.
Я знаю, что вы упомянули, что вам не нужна кодовая база, но приложение Google I/O 2010 с открытым исходным кодом использует службу, как я описываю.
Обновлено, чтобы добавить пример кода:
Активность.
public class HomeActivity extends Activity implements MyResultReceiver.Receiver {
public MyResultReceiver mReceiver;
public void onCreate(Bundle savedInstanceState) {
mReceiver = new MyResultReceiver(new Handler());
mReceiver.setReceiver(this);
...
final Intent intent = new Intent(Intent.ACTION_SYNC, null, this, QueryService.class);
intent.putExtra("receiver", mReceiver);
intent.putExtra("command", "query");
startService(intent);
}
public void onPause() {
mReceiver.setReceiver(null); // clear receiver so no leaks.
}
public void onReceiveResult(int resultCode, Bundle resultData) {
switch (resultCode) {
case RUNNING:
//show progress
break;
case FINISHED:
List results = resultData.getParcelableList("results");
// do something interesting
// hide progress
break;
case ERROR:
// handle the error;
break;
}
}
Сервис:
public class QueryService extends IntentService {
protected void onHandleIntent(Intent intent) {
final ResultReceiver receiver = intent.getParcelableExtra("receiver");
String command = intent.getStringExtra("command");
Bundle b = new Bundle();
if(command.equals("query") {
receiver.send(STATUS_RUNNING, Bundle.EMPTY);
try {
// get some data or something
b.putParcelableArrayList("results", results);
receiver.send(STATUS_FINISHED, b)
} catch(Exception e) {
b.putString(Intent.EXTRA_TEXT, e.toString());
receiver.send(STATUS_ERROR, b);
}
}
}
}
Расширение ResultReceiver - отредактировано для реализации MyResultReceiver.Receiver
public class MyResultReceiver implements ResultReceiver {
private Receiver mReceiver;
public MyResultReceiver(Handler handler) {
super(handler);
}
public void setReceiver(Receiver receiver) {
mReceiver = receiver;
}
public interface Receiver {
public void onReceiveResult(int resultCode, Bundle resultData);
}
@Override
protected void onReceiveResult(int resultCode, Bundle resultData) {
if (mReceiver != null) {
mReceiver.onReceiveResult(resultCode, resultData);
}
}
}
Разработка клиентских приложений REST для Android стала для меня отличным ресурсом. Спикер не показывает никакого кода, он просто перебирает конструктивные соображения и приемы создания надежного Rest Api в Android. Если вы любите подкаст или нет, я бы порекомендовал дать этому хотя бы одно прослушивание, но лично я слушал его как 4 или 5 раз и, вероятно, собираюсь послушать его снова.
Разработка клиентских приложений REST для Android
Автор: Вирджил Добянский
Описание:
На этом занятии будут представлены архитектурные аспекты разработки приложений RESTful на платформе Android. Основное внимание уделяется шаблонам проектирования, интеграции платформы и проблемам производительности, характерным для платформы Android.
И есть так много соображений, которые я действительно не сделал в первой версии моего API, что мне пришлось рефакторинг
Кроме того, когда я нажимаю на сообщение (Config.getURL("login"), значения), приложение, кажется, приостанавливается на некоторое время (кажется странным - мысль о том, что служба основана на том, что она работает в другом потоке!)
Нет, вам нужно создавать поток самостоятельно, по умолчанию локальный сервис запускается в потоке пользовательского интерфейса.
Я знаю, что @Martyn не хочет полного кода, но я думаю, что эта аннотация хороша для этого вопроса:
10 Android-приложений с открытым исходным кодом, которые должен изучить каждый разработчик Android
Foursquared для Android имеет открытый код и имеет интересный шаблон кода, взаимодействующий с REST API foursquare.
Я очень рекомендую Retrofit клиента REST.
Я нашел этот хорошо написанный пост в блоге чрезвычайно полезным, он также содержит простой пример кода. Автор использует Retrofit для выполнения сетевых вызовов и Otto для реализации шаблона шины данных:
http://www.mdswanson.com/blog/2014/04/07/durable-android-rest-clients.html
Я просто хотел показать вам все в направлении отдельного класса, который я прокатил, который включает в себя всю функциональность.
http://github.com/StlTenny/RestService
Он выполняет запрос как неблокирующий и возвращает результаты в простой для реализации обработчик. Даже поставляется с примером реализации.
Обратите внимание, что решение от Robby Pond почему-то отсутствует: таким образом, вы позволяете выполнять только один вызов API за раз, поскольку IntentService обрабатывает только одно намерение за раз. Часто вы хотите выполнять параллельные вызовы API. Если вы хотите сделать это, вы должны расширить Service вместо IntentService и создать свой собственный поток.
Допустим, я хочу запустить службу для события - onItemClicked() кнопки. Механизм Receiver не будет работать в этом случае, потому что:
a) Я передал Receiver в службу (как в Intent extra) из onItemClicked ()
б) активность переходит на задний план. В onPause() я установил для ссылки получателя в ResultReceiver значение null, чтобы избежать утечки Activity.
в) Деятельность разрушается.
г) Активность создается снова. Однако в этот момент Служба не сможет выполнить обратный вызов для Действия, так как эта ссылка получателя потеряна.
Механизм ограниченной широковещательной рассылки или PendingIntent представляется более полезным в таких сценариях - см. Уведомление об активности от службы.
Здесь есть другой подход, который в основном помогает вам забыть обо всем управлении запросами. Он основан на асинхронном методе очереди и ответе на основе вызываемого / обратного вызова. Основное преимущество заключается в том, что с помощью этого метода вы сможете сделать весь процесс (запрос, получить и проанализировать ответ, sabe to db) полностью прозрачным для вас. Как только вы получите код ответа, работа уже сделана. После этого вам просто нужно позвонить в вашу базу данных, и все готово. Это также помогает в проблемах того, что происходит, когда ваша активность неактивна. Здесь произойдет то, что все ваши данные будут сохранены в вашей локальной базе данных, но ответ не будет обработан вашей деятельностью, это идеальный способ.
Я писал об общем подходе здесь http://ugiagonzalez.com/2012/07/02/theres-life-after-asynctasks-in-android/
Я буду размещать конкретный пример кода в следующих сообщениях. Надеюсь, что это поможет, не стесняйтесь связаться со мной, чтобы поделиться подходом и решить потенциальные сомнения или проблемы.
Кроме того, когда я нажимаю на сообщение (Config.getURL("login"), значения), приложение, кажется, приостанавливается на некоторое время (кажется странным - мысль о том, что служба основана на том, что она работает в другом потоке!)
В этом случае лучше использовать asynctask, который выполняется в другом потоке и возвращает результат обратно в поток пользовательского интерфейса после завершения.
Робби дает отличный ответ, хотя я вижу, что вы все еще ищете дополнительную информацию. Я реализовал вызовы REST API легко, но неправильно. Только когда я посмотрел это видео ввода / вывода Google, я понял, где я ошибся. Это не так просто, как собрать AsyncTask с вызовом get / put HttpUrlConnection.