Android學習筆記----跨進程調用Service(AIDL)

/*********************************************************************************************************************/

跨進程的Service調用（AIDL）

/*********************************************************************************************************************/

AIDL Service (android interface definition language) service

作用：跨進程通信，（ContentProvider的作用是跨進程數據共享）

參考：java中的RMI（remote method invocation）遠程方法調用

與RMI的區別：

 Android並不是直接返回Service對象給客戶端，而是將Service的代理對象通過onbind()方法返回給客戶端。因此，Android AIDL遠程接口的實現類就是那個IBinder實現類。

與綁定本地Service的區別：

綁定本地Service的時候，本地Service的onBind()方法會直接把IBinder對象本身傳遞給ServiceConnection的onServiceConnected方法的第二個參數。

綁定遠程Service的時候，遠程Service的onBind()方法只是將Binder對象的代理傳給客戶端的ServiceConnection的onServiceConnected方法的第二個參數。

客戶端獲取了遠程Service的IBinder對象的代理之後，就可以通過IBinder對象，去回調遠程Service的方法跟屬性了。

語言：AIDL語言，即android interface definition language

AIDL語言語法很簡單，語法跟Java接口很相似，但存在如下差異：

AIDL定義接口的源代碼，必須以.aidl結尾

AIDL接口中用到的數據類型，除了基本類型，String，List,Map,CharSequence之外，其他類型全部都需要導包，即使他們在同一個包中也需要導入包。

跨進程調用的Service的步驟 

創建AIDL文件

例，我們在應用中定義如下AIDL接口代碼

AidlService\src\org\crazyit\service\ICat.aidl

package org.crazyit.service;

interface ICat
{
String getColor();
double getWeight();
}

注：將AIDL文件放在service包下即可。

定義好AIDL接口之後，ADT工具會自動在service目錄下生成一個ICat.java接口，在該接口裏麪包含一個Stub內部類，該內部類實現了IBinder，ICat兩個接口，這個Stub類將會作爲遠程Service的回調類，-----他實現了IBinder接口，因此他可以作爲Service的onBind()方法的返回值。

將接口暴露給客戶端

上一步定義好一個AIDL接口之後，接下來就可以定義一個Service實現類了，該Servive的onBind()方法所返回的IBinder對象應該是ADT生成的ICat.Stub的子類實例。至於其他部分，則與開發本地Service完全一樣。

/**
 *
 */
        package org.crazyit.service;

        import java.util.Timer;
        import java.util.TimerTask;

        import org.crazyit.service.ICat.Stub;

        import android.app.Service;
        import android.content.Intent;
        import android.os.IBinder;
        import android.os.RemoteException;

/**
 * Description:
 * <br/>網站: <a href="http://www.crazyit.org">瘋狂Java聯盟</a>
* <br/>Copyright (C), 2001-2014, Yeeku.H.Lee
 * <br/>This program is protected by copyright laws.
 * <br/>Program Name:
 * <br/>Date:
 * @author  Yeeku.H.Lee [email protected]
 * @version  1.0
 */
public class AidlService extends Service
{
        private CatBinder catBinder;
        Timer timer = new Timer();
        String[] colors = new String[]{
            "紅色",
            "黃色",
            "黑色"
        };
        double[] weights = new double[]{
             2.3,
             3.1,
             1.58
        };
        private String color;
        private double weight;
        // 繼承Stub，也就是實現額ICat接口，並實現了IBinder接口
        public class CatBinder extends Stub
        {
            @Override
            public String getColor() throws RemoteException
            {
                return color;
            }
            @Override
            public double getWeight() throws RemoteException
            {
                return weight;
            }
        }
        @Override
        public void onCreate()
        {
            super.onCreate();
            catBinder = new CatBinder();
            timer.schedule(new TimerTask()
            {
                @Override
                public void run()
                {
                    // 隨機地改變Service組件內color、weight屬性的值。
                    int rand = (int)(Math.random() * 3);
                    color = colors[rand];
                    weight = weights[rand];
                    System.out.println("--------" + rand);
                 }
                } , 0 , 800);
        }
        @Override
        public IBinder onBind(Intent arg0)
        {
            /* 返回catBinder對象
           * 在綁定本地Service的情況下，該catBinder對象會直接
           * 傳給客戶端的ServiceConnection對象
           * 的onServiceConnected方法的第二個參數；
           * 在綁定遠程Service的情況下，只將catBinder對象的代理
           * 傳給客戶端的ServiceConnection對象
           * 的onServiceConnected方法的第二個參數；
           */
            return catBinder; //①
        }
        @Override
        public void onDestroy()
        {
            timer.cancel();
        }
}

通過以上介紹可以看出，開發AIDL遠程Service其實也很簡單，只是需要比開發本地Service多定義一個AIDL接口而已。

該Service類開發完成以後，需要在AndroidManifest.xml文件中，進行相關配置

<service android:name= ".AidlService">

    <intent-filter>

            <action android:name = "org.crazyit.aidl.action.AIDL_SERVICE"/>

    </intent-filter>

</service>

客戶端訪問AIDLService

AIDL定義了兩個進程之間的通信接口，因此不僅服務器端需要AIDL接口，客戶端同樣需要前面定義的AIDL接口，因此開發客戶端的第一步就是將Service端的AIDL接口文件複製到客戶端應用中,複製到客戶端後，ADT工具會自動爲AIDL接口生成相應的實現。

客戶端綁定遠程Service的步驟:

創建ServiceConnection對象

以ServiceConnection對象作爲參數，調用Context的bindService()方法綁定遠程Service即可。

與綁定本地Service不同的是，綁定遠程Service的ServiceConnection並不能直接獲取Service的onBind()方法返回的對象，他只能獲取到onBind()方法返回的對象的代理，因此在ServiceConnection的onServiceConnected方法中需要通過如下代碼進行處理：

catService = ICat.Stub.asInterface(service);

        package org.crazyit.client;

        import org.crazyit.service.ICat;

        import android.app.Activity;
        import android.app.Service;
        import android.content.ComponentName;
        import android.content.Intent;
        import android.content.ServiceConnection;
        import android.os.Bundle;
        import android.os.IBinder;
        import android.os.RemoteException;
        import android.view.View;
        import android.view.View.OnClickListener;
        import android.widget.Button;
        import android.widget.EditText;

/**
 * Description: <br/>
* site: <a href="http://www.crazyit.org">crazyit.org</a> <br/>
* Copyright (C), 2001-2012, Yeeku.H.Lee <br/>
* This program is protected by copyright laws. <br/>
* Program Name: <br/>
* Date:
 *
 * @author Yeeku.H.Lee [email protected]
 * @version 1.0
 */
public class AidlClient extends Activity
{
    private ICat catService;
    private Button get;
    EditText color, weight;
    private ServiceConnection conn = new ServiceConnection()
    {
        @Override
        public void onServiceConnected(ComponentName name, IBinder service)
        {
            // 獲取遠程Service的onBind方法返回的對象的代理
            catService = ICat.Stub.asInterface(service);
         }

        @Override
        public void onServiceDisconnected(ComponentName name)
        {
            catService = null;
        }
    };

        @Override
        public void onCreate(Bundle savedInstanceState)
        {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.main);
            get = (Button) findViewById(R.id.get);
            color = (EditText) findViewById(R.id.color);
            weight = (EditText) findViewById(R.id.weight);
            // 創建所需綁定的Service的Intent
            Intent intent = new Intent();
            intent.setAction("org.crazyit.aidl.action.AIDL_SERVICE");
            // 綁定遠程Service
            bindService(intent, conn, Service.BIND_AUTO_CREATE);
            get.setOnClickListener(new OnClickListener()
            {
                @Override
                public void onClick(View arg0)
                {
                        try
                        {
                            // 獲取、並顯示遠程Service的狀態
                            color.setText(catService.getColor());
                            weight.setText(catService.getWeight() + "");
                        }
                        catch (RemoteException e)
                        {
                             e.printStackTrace();
                        }
                 }
           });
        }

        @Override
        public void onDestroy()
        {
            super.onDestroy();
            // 解除綁定
            this.unbindService(conn);
        }
}

傳遞複雜數據的AIDL Service

本實例也是一個調用AIDL Service的例子，與前面實例不同的是，該實例所傳輸的數據類型，是自定義的數據類型。

本實例用到了兩個自定義類型：Person與Pet，其中Person對象作爲調用遠程Service的參數，而Pet作爲返回值，就像RMI要求遠程調用的參數跟返回值都必須實現Serializable接口，Android要求遠程Service的參數跟返回值都必須實現Parcelable接口。

實現Parcelable接口不僅要求實現該接口裏定義的方法，而且要求在實現類中定義一個名爲CREATOR，類型爲Parcelable.Creator的靜態Field。除此之外，還要求使用AIDL代碼來定義這些自定義類型。

注意:實現Parcelable接口相當於Android提供的一種自定義序列化機制。Java序列化機制要求序列化類必須實現Serializable接口，而Android序列化機制，則要求序列化類必須實現Parcelable接口。

要定義Person類，先要用AIDL來定義Person類

........\src\org\crazyit\service\Person.aidl

parcelable Person; 

使用AIDL定義自定義類只需要一行代碼即可，如上。

接下來定義一個實現Parcelable接口的Person類

........\src\org\crazyit\service\Person.java

/**
 *
 */
package org.crazyit.service;

import android.os.Parcel;
import android.os.Parcelable;

/**
 * Description:
 * <br/>網站: <a href="http://www.crazyit.org">瘋狂Java聯盟</a>
* <br/>Copyright (C), 2001-2014, Yeeku.H.Lee
 * <br/>This program is protected by copyright laws.
 * <br/>Program Name:
 * <br/>Date:
 * @author  Yeeku.H.Lee [email protected]
 * @version  1.0
 */
public class Person implements Parcelable
{
    private Integer id;
    private String name;
    private String pass;


    public Person()
    {
    }
    public Person(Integer id, String name, String pass)
    {
        super();
        this.id = id;
        this.name = name;
        this.pass = pass;
    }
    public Integer getId()
    {
        return id;
    }
    public void setId(Integer id)
    {
        this.id = id;
    }
    public String getName()
    {
        return name;
    }
    public void setName(String name)
    {
        this.name = name;
    }
    public String getPass()
    {
        return pass;
    }
    public void setPass(String pass)
    {
        this.pass = pass;
    }
    @Override
    public int hashCode()
    {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((name == null) ? 0 : name.hashCode());
        result = prime * result + ((pass == null) ? 0 : pass.hashCode());
        return result;
    }
    @Override
    public boolean equals(Object obj)
    {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (getClass() != obj.getClass())
            return false;
        Person other = (Person) obj;
        if (name == null)
        {
            if (other.name != null)
                return false;
            }
        else if (!name.equals(other.name))
            return false;
        if (pass == null)
        {
            if (other.pass != null)
                return false;
         }
         else if (!pass.equals(other.pass))
              return false;
        return true;
     }

    @Override
    public int describeContents()
    {
        return 0;
    }

    @Override
    public void writeToParcel(Parcel dest, int flags)
    {
        //把該對象所包含的數據寫到Parcel
        dest.writeInt(id);
        dest.writeString(name);
        dest.writeString(pass);
    }

    // 添加一個靜態成員,名爲CREATOR,該對象實現了Parcelable.Creator接口
    public static final Parcelable.Creator<Person> CREATOR = new Parcelable.Creator<Person>()
    {
        @Override
        public Person createFromParcel(Parcel source)
        {
            // 從Parcel中讀取數據，返回Person對象
            return new Person(source.readInt(), source.readString(), source.readString());
        }

        @Override
        public Person[] newArray(int size)
        { 
            return new Person[size];
        }
    };
}

實現Parcelable接口主要是實現writeToParcel(Parcel dest,int flags)方法，該方法負責把Person對象的數據寫入到Parcel中。於此同時，該方法必須定義一個類型爲

Parcelable.Creator<Person>,名爲CREATOR的靜態變量，該靜態常量的值負責從Parcel數據包中恢復Person對象，因此該對象定義的createFromPerson()方法用於恢復Person對象。

實際上讓Person實現Parcelable接口也是一種序列化機制，只是Android沒有直接使用Java提供的序列化機制，而是選擇使用這種輕量化的序列化機制。

定義Pet類的方法跟定義Person類一樣，此處不再給出代碼。

接下來使用AIDL來定義通信接口

........\src\org\crazyit\service\IPet.aidl

package org.crazyit.service;

import org.crazyit.service.Pet;

import org.crazyit.service.Person;

interface IPet{

    //定義一個Person對象，作爲傳入參數

   List<Pet> getPets(in Person owner);
}

在AIDL接口中定義方法時，需要指定參數的傳遞模式，對於Java語言來講，一般都是採用傳入參數的方式，因此上面指定爲in模式。

ADT工具會自動生成相應的java文件，這不需要開發者關心

接下來需要定義一個Service，讓Service的onBind()方法返回IPet實現類的實例。該Service類的代碼如下。

    /**
    *
    */
    package org.crazyit.service;

    import java.util.ArrayList;
    import java.util.HashMap;
    import java.util.List;
    import java.util.Map;

    import org.crazyit.service.IPet.Stub;

    import android.app.Service;
    import android.content.Intent;
    import android.os.IBinder;
    import android.os.RemoteException;

    /**
     * Description:
     * <br/>網站: <a href="http://www.crazyit.org">瘋狂Java聯盟</a>
     * <br/>Copyright (C), 2001-2014, Yeeku.H.Lee
     * <br/>This program is protected by copyright laws.
     * <br/>Program Name:
     * <br/>Date:
     * @author  Yeeku.H.Lee [email protected]
     * @version  1.0
     */
    public class ComplexService extends Service
    {
        private PetBinder petBinder;
        private static Map<Person , List<Pet>> pets = new HashMap<Person , List<Pet>>();
        static
        {
            // 初始化pets Map集合
            ArrayList<Pet> list1 = new ArrayList<Pet>();
            list1.add(new Pet("旺財" , 4.3));
            list1.add(new Pet("來福" , 5.1));
            pets.put(new Person(1, "sun" , "sun") , list1);
            ArrayList<Pet> list2 = new ArrayList<Pet>();
            list2.add(new Pet("kitty" , 2.3));
            list2.add(new Pet("garfield" , 3.1));
            pets.put(new Person(2, "bai" , "bai") , list2);
        }
        // 繼承Stub，也就是實現額IPet接口，並實現了IBinder接口
        public class PetBinder extends Stub
        {
            @Override
            public List<Pet> getPets(Person owner) throws RemoteException
            {
                // 返回Service內部的數據
                return pets.get(owner);
            }
        }
        @Override
        public void onCreate()
        {
             super.onCreate();
             petBinder = new PetBinder();
        }
        @Override
        public IBinder onBind(Intent arg0)
        {
        /* 返回catBinder對象
       * 在綁定本地Service的情況下，該catBinder對象會直接
       * 傳給客戶端的ServiceConnection對象
       * 的onServiceConnected方法的第二個參數；
       * 在綁定遠程Service的情況下，只將catBinder對象的代理
       * 傳給客戶端的ServiceConnection對象
       * 的onServiceConnected方法的第二個參數；
       */
        return petBinder; //①
        }
        @Override
        public void onDestroy()
        {
        }
    }

在AndroidManifest.xml中配置Service，跟之前一樣。

定義客戶端，將IPet.aidl文件複製過去，同時還要將Person.aidl，Person.java,Pet.aidl,Pet.java文件複製過去。

客戶端依然按之前方式綁定遠程Service,並在ServiceConnection實現類的onServiceConnected()方法中獲得遠程Service的onBind()方法返回的代理對象即可。

package org.crazyit.client;

import java.util.List;

import org.crazyit.service.IPet;
import org.crazyit.service.Person;
import org.crazyit.service.Pet;

import android.app.Activity;
import android.app.Service;
import android.content.ComponentName;
import android.content.Intent;
import android.content.ServiceConnection;
import android.os.Bundle;
import android.os.IBinder;
import android.os.RemoteException;
import android.view.View;
import android.view.View.OnClickListener;
import android.widget.ArrayAdapter;
import android.widget.Button;
import android.widget.EditText;
import android.widget.ListView;

/**
 * Description: <br/>
* site: <a href="http://www.crazyit.org">crazyit.org</a> <br/>
* Copyright (C), 2001-2012, Yeeku.H.Lee <br/>
* This program is protected by copyright laws. <br/>
* Program Name: <br/>
* Date: 
 * @author Yeeku.H.Lee [email protected]
 * @version 1.0
 */
public class ComplexClient extends Activity
{
    private IPet petService;
    private Button get;
    EditText personView;
    ListView showView;
    private ServiceConnection conn = new ServiceConnection()
    {
        @Override
        public void onServiceConnected(ComponentName name, IBinder service)
        {
            // 獲取遠程Service的onBind方法返回的對象的代理
            petService = IPet.Stub.asInterface(service);
        }

        @Override
        public void onServiceDisconnected(ComponentName name)
        {
            petService = null;
        }
    };

    @Override
    public void onCreate(Bundle savedInstanceState)
    {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main);
        personView = (EditText) findViewById(R.id.person);
        showView = (ListView) findViewById(R.id.show);
        get = (Button) findViewById(R.id.get);
        // 創建所需綁定的Service的Intent
        Intent intent = new Intent();
        intent.setAction("org.crazyit.aidl.action.COMPLEX_SERVICE");
        // 綁定遠程Service
        bindService(intent, conn, Service.BIND_AUTO_CREATE);
        get.setOnClickListener(new OnClickListener()
        {
            @Override
            public void onClick(View arg0)
            {
                try
                 {
                    String personName = personView.getText().toString();
                    // 調用遠程Service的方法
                    List<Pet> pets = petService.getPets(new Person(1,personName, personName)); //①
                    // 將程序返回的List包裝成ArrayAdapter
                    ArrayAdapter<Pet> adapter = new ArrayAdapter<Pet>(ComplexClient.this,android.R.layout.simple_list_item_1, pets);
                    showView.setAdapter(adapter);
                }
                catch (RemoteException e)
                {
                    e.printStackTrace();
                }
            }
        });
    }

    @Override
    public void onDestroy()
    {
        super.onDestroy();
        // 解除綁定
        this.unbindService(conn);
    }
}

除了由用戶自行開發啓動的服務之外，安卓還提供了大量的系統服務，開發者只要在程序中調用Context的如下方法即可獲得這些系統服務，

getSystemService(String ServiceName),根據服務名稱來獲得服務

完整代碼鏈接 代碼下載