Android远程服务编写和调用教程

2016-02-26 15:31:43

  说明

  网上汗牛充栋的文章都是介绍Android远程服务的,一个个将Binder机制、AIDL讲得头头是道,然而没有几个人能够给出清晰的范例说明如何用最快的方法学会编写和调用一个Android远程服务。若你仅仅是想如何编写或者调用Android的远程服务,而懒得去理解Binder机制是如何运行的,那么本篇文章正好适合你。毕竟现在人人都会开车,但没有几个人明白发动机到底是如何运作的。

  源代码

  代码包在此,包括一个服务端和一个客户端,无需下载分:

  http://download.csdn.net/detail/logicteamleader/9407694

  预备知识

  读者应该有基本的java知识,和Android简单app的开发经验。

  环境

  代码运行环境:

  1.ADT2014版本;

  2.android:minSdkVersion=”8”;android:targetSdkVersion=”20”

  3.workspace中已经生成了appcompatv7,它的版本是android-22;

  远程服务开发教程

  在开始开发之前,先弄清楚几个概念:

  1. IPC:进程间通信,你只需要知道Android是依赖这个东西来进行远程服务调用的就可以了。

  2. Binder机制:Android发明的一种IPC机制,据说非常非常的好,你就当它是个黑盒子,通过这个黑盒子就可以进行远程服务调用了,而且Android中的很多机制都是通过它实现的。

  3. AIDL语言:一种专门用来写远程接口的语言,看它的名字就知道了,Android Interface Definition

  Language。AIDL语言可以被android提供的编译器编译为Java源代码,这个Java源代码将会被服务的和客户端使用,用来简化远程服务开发流程。如果你当初玩过CORBA,那就更能明白什么是IDL语言了

  4. IInterface接口、IBinder接口、IBinder类等等:都是用来实现Binder机制的接口和类,在本教程中,你就当它们是Binder黑盒子的一部分,不需要了解。

  再说一点,其实Android提供的ApiDemos中就有一个远程服务的标准范例,但是其一是它没有将服务端和客户端分开写,其二是例子中掺杂了太多其他的功能,因此理解起来较为困难。这个例子是com.example.android.apis.app.RemoteService,有兴趣的可以在看完本文后再去详细研究。

  第一步,创建一个普通Android应用

  应用名为WxbRemoteService,这个应用可以删掉其Activity类,但是为了简单,我们就保留所有自动创建的代码。

  第二步,编写AIDL

  AIDL语言的语法和Java其实很像,你甚至可以先编写一个Java接口,然后删掉public、protected、private这些权限限定词即可。例子如下IWxbService.aidl:

  1. package com.dumaisoft.wxbremoteservice; 
  2.  
  3. interface IWxbService { 
  4.  
  5. void setName(String name); 
  6.  
  7. String getName(); 
  8.  

  注意几点:

  1.接口名和aidl文件名相同。

  2.接口和方法前不用加访问权限修饰符public,private,protected等,也不能用final,static。

  3.Aidl默认支持的类型包话java基本类型(int、long、boolean等)和(String、List、Map、 CharSequence),使用这些类型时不需要import声明。对于List和Map中的元素类型必须是Aidl支持的类型。如果使用自定义类型作 为参数或返回值,自定义类型必须实现Parcelable接口。

  4.自定义类型和AIDL生成的其它接口类型在aidl描述文件中,应该显式import,即便在该类和定义的包在同一个包中。

  5.在aidl文件中所有非Java基本类型参数必须加上in、out、inout标记,以指明参数是输入参数、输出参数还是输入输出参数。

  6.Java原始类型默认的标记为in,不能为其它标记

  IWxbService.aidl文件的位置是在com.dumaisoft.wxbremoteservice包中,只要语法正确,则会在ADT的gen目录下的com.dumaisoft.wxbremoteservice包中生成java文件IWxbService.java。

  IWxbService.aidl定义了一个远程接口,它包含两个方法getName和setName。

  第三步,编写服务类

  添加一个WxbService类,它继承了Service类,源代码如下:

  

  1. package com.dumaisoft.wxbremoteservice; 
  2.  
  3.   import com.dumaisoft.wxbremoteservice.IWxbService.Stub; 
  4.  
  5.   import android.app.Service; 
  6.  
  7.   import android.content.Intent; 
  8.  
  9.   import android.os.IBinder; 
  10.  
  11.   import android.os.RemoteException; 
  12.  
  13.   public class WxbService extends Service { 
  14.  
  15.   private ServiceImpl serviceImpl; 
  16.  
  17.   //继承由IWxbService.aidl生成的com.dumaisoft.wxbremoteservice.IWxbService.Stub类 
  18.  
  19.   class ServiceImpl extends Stub{ 
  20.  
  21.   private String _name; 
  22.  
  23.   @Override 
  24.  
  25.   public void setName(String name) throws RemoteException { 
  26.  
  27.   _name = name; 
  28.  
  29.   } 
  30.  
  31.   @Override 
  32.  
  33.   public String getName() throws RemoteException { 
  34.  
  35.   return _name; 
  36.  
  37.   } 
  38.  
  39.   } 
  40.  
  41.   //将ServiceImpl做一个简单的单例模式 
  42.  
  43.   private ServiceImpl getInstance(){ 
  44.  
  45.   if(serviceImpl == null){ 
  46.  
  47.   serviceImpl = new ServiceImpl(); 
  48.  
  49.   } 
  50.  
  51.   return serviceImpl; 
  52.  
  53.   } 
  54.  
  55.   @Override 
  56.  
  57.   public IBinder onBind(Intent intent) { 
  58.  
  59.   return getInstance(); 
  60.  
  61.   } 
  62.  
  63.   } 

  通过研究代码可知,和普通的服务类相比,远程服务类最大的区别就是它拥有一个名为ServiceImpl的成员变量,这个成员变量继承了Stub类,并实现了Stub类的getName和setName方法。这个Stub类就是由 IWxbService.aidl生成的IWxbService.java提供的。我们不用研究其源代码,只用知道它的用法:

  第一:让Service的一个成员变量继承Stub,并实现远程接口的方法;

  第二:在Service的onBind方法中返回一个Stub子类的实例。

  第四步,配置AndroidManifest.xml

  加上如下代码:

  1. <service android:name="WxbService"
  2.             <intent-filter> 
  3.                 <action android:name="com.dumaisoft.wxbremoteservice.REMOTE_SREVICE"/> 
  4.             </intent-filter> 
  5.         </service> 

  注意action的name为”com.dumaisoft.wxbremoteservice.REMOTE_SREVICE”,这个由开发者保证不重名即可。

  第五步,安装app到手机上

  安装完成后,你的远程服务就被注册到Binder黑盒子中了,任何客户端只要知道你的远程服务action名称和接口,就可以bind服务,并调用接口。

  远程服务调用教程

  第一步,创建一个android应用

  应用名为WxbRemoteServiceClient,src包中自动生成了com.dumaisoft.wxbremoteserviceclient包。

  第二步,引入远程服务的AIDL文件

  在src包中创建com.dumaisoft.wxbremoteservice包(为了与服务端的包名相同),然后将上面编写的IWxbService.aidl文件拷贝入此目录。显然,在本工程的gen目录中也生成了IWxbService.java文件。

  第三步,编写调用远程服务的代码

  代码如下:

  1. package com.dumaisoft.wxbremoteserviceclient; 
  2.  
  3.  import com.dumaisoft.wxbremoteservice.IWxbService; 
  4.  
  5.  import android.app.Activity; 
  6.  
  7.  import android.app.Service; 
  8.  
  9.  import android.content.ComponentName; 
  10.  
  11.  import android.content.Intent; 
  12.  
  13.  import android.content.ServiceConnection; 
  14.  
  15.  import android.os.Bundle; 
  16.  
  17.  import android.os.IBinder; 
  18.  
  19.  import android.os.RemoteException; 
  20.  
  21.  import android.view.View; 
  22.  
  23.  import android.view.View.OnClickListener; 
  24.  
  25.  import android.widget.Button; 
  26.  
  27.  import android.widget.Toast; 
  28.  
  29.  public class MainActivity extends Activity { 
  30.  
  31.  private Button btnBind; 
  32.  
  33.  private Button btnSetName; 
  34.  
  35.  private Button btnGetName; 
  36.  
  37.  private IWxbService serviceProxy; //远程服务的代理 
  38.  
  39.  private ServiceConnection conn = new ServiceConnection() { 
  40.  
  41.  @Override 
  42.  
  43.  public void onServiceDisconnected(ComponentName name) { 
  44.  
  45.  } 
  46.  
  47.  @Override 
  48.  
  49.  public void onServiceConnected(ComponentName name, IBinder service) { 
  50.  
  51.  //获取远程服务代理 
  52.  
  53.  serviceProxy = IWxbService.Stub.asInterface(service); 
  54.  
  55.  } 
  56.  
  57.  }; 
  58.  
  59.  @Override 
  60.  
  61.  protected void onCreate(Bundle savedInstanceState) { 
  62.  
  63.  super.onCreate(savedInstanceState); 
  64.  
  65.  setContentView(R.layout.activity_main); 
  66.  
  67.  btnBind = (Button) this.findViewById(R.id.btnBind); 
  68.  
  69.  btnSetName = (Button) this.findViewById(R.id.btnSetName); 
  70.  
  71.  btnGetName = (Button) this.findViewById(R.id.btnGetName); 
  72.  
  73.  btnBind.setOnClickListener(new OnClickListener() { 
  74.  
  75.  @Override 
  76.  
  77.  public void onClick(View v) { 
  78.  
  79.  Intent service = new Intent(); 
  80.  
  81.  //Remote Service Action name 
  82.  
  83.  service.setAction("com.dumaisoft.wxbremoteservice.REMOTE_SREVICE"); 
  84.  
  85.  bindService(service, conn, Service.BIND_AUTO_CREATE); 
  86.  
  87.  } 
  88.  
  89.  }); 
  90.  
  91.  btnSetName.setOnClickListener(new OnClickListener() { 
  92.  
  93.  @Override 
  94.  
  95.  public void onClick(View v) { 
  96.  
  97.  try { 
  98.  
  99.  serviceProxy.setName("MyName"); 
  100.  
  101.  } catch (RemoteException e) { 
  102.  
  103.  e.printStackTrace(); 
  104.  
  105.  } 
  106.  
  107.  } 
  108.  
  109.  }); 
  110.  
  111.  btnGetName.setOnClickListener(new OnClickListener() { 
  112.  
  113.  @Override 
  114.  
  115.  public void onClick(View v) { 
  116.  
  117.  try { 
  118.  
  119.  String name = serviceProxy.getName(); 
  120.  
  121.  Toast.makeText(getApplicationContext(), name, Toast.LENGTH_LONG).show(); 
  122.  
  123.  } catch (RemoteException e) { 
  124.  
  125.  e.printStackTrace(); 
  126.  
  127.  } 
  128.  
  129.  } 
  130.  
  131.  }); 
  132.  
  133.  } 
  134.  
  135.  } 
  136.  
  137.   

  注意几点:

  一、创建一个ServiceConnection的匿名子类,在其onServiceConnected方法中获取远程服务代理对象serviceProxy。事实上,onServiceConnected方法会在bindService方法调用时被调用,因此能确保一定可以获得远程服务的代理对象;

  二、IWxbService.Stub.asInterface(service)方法也是由IWxbService.java文件提供的,其内部机制不用研究,只需要知道它会返回一个IWxbService接口的对象,该对象可以通过Binder黑盒子调用远程服务的setName和getName方法;

  三、使用Intent指定action为”com.dumaisoft.wxbremoteservice.REMOTE_SREVICE”,即可正确的bind到远程服务。

  四、bind成功后,就可以通过远程服务的代理对象,使用远程服务的功能了。

  小结

  至此,读者应该能比较快速的开发出一个远程服务,并能编写客户端轻松的调用它了。还有一点需要说明的是,除了使用AIDL来进行远程服务的编写和调用外,还可以直接使用IBinder、Binder等接口和类来进行远程服务编写调用。毕竟AIDL只是一种编写binder框架的工具。

  若真的想详细了解binder机制,可以去详细阅读aidl生成的代码,并阅读其他大神的文章。

为您推荐