WLAN 直连(对等连接或 P2P)概览

借助 Wi-Fi 直连 (P2P),具有适当硬件的设备可以通过 Wi-Fi 直接连接到彼此,而无需中间接入点。使用这些 API,您可以在每部设备都支持 Wi-Fi P2P 的情况下发现并连接到其他设备,然后通过比蓝牙连接更长的距离进行快速通信。这对于在用户之间共享数据的应用非常有用,例如多人游戏或照片共享应用。

WLAN P2P API 包含以下主要部分:

  • 用于发现、请求和连接到对等设备的方法,这些方法在 WifiP2pManager 类中定义。
  • 监听器,可让您收到 WifiP2pManager 方法调用的成功或失败通知。调用 WifiP2pManager 方法时,每个方法都可以接收作为参数传入的特定监听器。
  • 用于通知您 Wi-Fi 点对点框架检测到的特定事件(例如连接中断或新发现的对等方)的 intent。

您通常会将 API 的这些三个主要组件搭配使用。例如,您可以向对 discoverPeers() 的调用提供 WifiP2pManager.ActionListener,以便 ActionListener.onSuccess()ActionListener.onFailure() 方法可以通知您。如果 discoverPeers() 方法发现对等方列表已更改,还会广播 WIFI_P2P_PEERS_CHANGED_ACTION intent。

API 概览

WifiP2pManager 类提供了一些方法,可让您与设备上的 Wi-Fi 硬件互动,执行发现和连接对等设备等操作。可执行的操作如下:

表 1. Wi-Fi P2P 方法

方法 说明
initialize() 向 Wi-Fi 框架注册应用。请先调用此方法,然后再调用任何其他 Wi-Fi 点对点方法。
connect() 与具有指定配置的设备建立点对点连接。
cancelConnect() 取消任何正在进行的点对点组协商。
requestConnectInfo() 请求设备的连接信息。
createGroup() 创建一个点对点群组,并将当前设备设为群组所有者。
removeGroup() 移除当前点对点群组。
requestGroupInfo() 请求点对点群组信息。
discoverPeers() 启动对等设备发现。
requestPeers() 请求当前发现的对等方的列表。

借助 WifiP2pManager 方法,您可以传入监听器,以便 Wi-Fi 点对点框架可以通知您的 activity 通话状态。表 2 介绍了可用的监听器接口以及使用这些监听器的相应 WifiP2pManager 方法调用。

表 2. Wi-Fi P2P 监听器

监听器接口 关联的操作
WifiP2pManager.ActionListener connect()cancelConnect()createGroup()removeGroup()discoverPeers()
WifiP2pManager.ChannelListener initialize()
WifiP2pManager.ConnectionInfoListener requestConnectInfo()
WifiP2pManager.GroupInfoListener requestGroupInfo()
WifiP2pManager.PeerListListener requestPeers()

Wi-Fi P2P API 定义了在发生特定 Wi-Fi P2P 事件(例如发现新的对等方或设备的 Wi-Fi 状态发生变化)时广播的 intent。您可以通过创建用于处理这些 intent 的广播接收器,在应用中注册接收这些 intent:

表 3. Wi-Fi 点对点 intent

intent 说明
WIFI_P2P_CONNECTION_CHANGED_ACTION 当设备的 Wi-Fi 连接状态发生变化时进行广播。
WIFI_P2P_PEERS_CHANGED_ACTION 在调用 discoverPeers() 时广播。如果您在应用中处理此 intent,通常会调用 requestPeers() 来获取更新后的对等方列表。
WIFI_P2P_STATE_CHANGED_ACTION 当设备上启用或停用 Wi-Fi 点对点连接时进行广播。
WIFI_P2P_THIS_DEVICE_CHANGED_ACTION 在设备的详细信息(例如设备名称)发生变化时广播。

为 WLAN P2P Intent 创建广播接收器

借助广播接收器,您可以接收 Android 系统广播的 intent,以便应用响应您感兴趣的事件。创建广播接收器以处理 Wi-Fi P2P intent 的基本步骤如下:

  1. 创建一个扩展 BroadcastReceiver 类的类。对于类的构造函数,您将使用 WifiP2pManagerWifiP2pManager.Channel 和此广播接收器将注册到的 activity 的参数。这样,广播接收器就可以向 activity 发送更新,并在需要时访问 Wi-Fi 硬件和通信通道。

  2. 在广播接收器中,检查 onReceive() 方法中您感兴趣的意图。根据收到的意图执行任何必要的操作。例如,如果广播接收器收到 WIFI_P2P_PEERS_CHANGED_ACTION intent,您可以调用 requestPeers() 方法来获取当前发现的对等方的列表。

以下代码展示了如何创建典型的广播接收器。广播接收器将 WifiP2pManager 对象和 activity 作为参数,并在广播接收器收到 intent 时使用这两个类来适当地执行所需的操作:

Kotlin

/**
* A BroadcastReceiver that notifies of important Wi-Fi p2p events.
*/
class WiFiDirectBroadcastReceiver(
       private val manager: WifiP2pManager,
       private val channel: WifiP2pManager.Channel,
       private val activity: MyWifiActivity
) : BroadcastReceiver() {

   override fun onReceive(context: Context, intent: Intent) {
       val action: String = intent.action
       when (action) {
           WifiP2pManager.WIFI_P2P_STATE_CHANGED_ACTION -> {
               // Check to see if Wi-Fi is enabled and notify appropriate activity
           }
           WifiP2pManager.WIFI_P2P_PEERS_CHANGED_ACTION -> {
               // Call WifiP2pManager.requestPeers() to get a list of current peers
           }
           WifiP2pManager.WIFI_P2P_CONNECTION_CHANGED_ACTION -> {
               // Respond to new connection or disconnections
           }
           WifiP2pManager.WIFI_P2P_THIS_DEVICE_CHANGED_ACTION -> {
               // Respond to this device's wifi state changing
           }
       }
   }
}

Java

/**
* A BroadcastReceiver that notifies of important Wi-Fi p2p events.
*/
public class WiFiDirectBroadcastReceiver extends BroadcastReceiver {

   private WifiP2pManager manager;
   private Channel channel;
   private MyWiFiActivity activity;

   public WiFiDirectBroadcastReceiver(WifiP2pManager manager, Channel channel,
           MyWifiActivity activity) {
       super();
       this.manager = manager;
       this.channel = channel;
       this.activity = activity;
   }

   @Override
   public void onReceive(Context context, Intent intent) {
       String action = intent.getAction();

       if (WifiP2pManager.WIFI_P2P_STATE_CHANGED_ACTION.equals(action)) {
           // Check to see if Wi-Fi is enabled and notify appropriate activity
       } else if (WifiP2pManager.WIFI_P2P_PEERS_CHANGED_ACTION.equals(action)) {
           // Call WifiP2pManager.requestPeers() to get a list of current peers
       } else if (WifiP2pManager.WIFI_P2P_CONNECTION_CHANGED_ACTION.equals(action)) {
           // Respond to new connection or disconnections
       } else if (WifiP2pManager.WIFI_P2P_THIS_DEVICE_CHANGED_ACTION.equals(action)) {
           // Respond to this device's wifi state changing
       }
   }
}

在搭载 Android 10 及更高版本的设备上,以下广播 intent 是非粘性 intent:

WIFI_P2P_CONNECTION_CHANGED_ACTION
应用可以使用 requestConnectionInfo()requestNetworkInfo()requestGroupInfo() 检索当前的连接信息。
WIFI_P2P_THIS_DEVICE_CHANGED_ACTION
应用可以使用 requestDeviceInfo() 检索当前的连接信息。

创建 WLAN P2P 应用

创建 Wi-Fi P2P 应用涉及为应用创建和注册广播接收器、发现对等设备、连接到对等设备以及向对等设备传输数据。以下部分将介绍如何完成此操作。

初始设置

在使用 Wi-Fi P2P API 之前,您必须确保您的应用可以访问硬件,并且设备支持 Wi-Fi P2P 协议。如果支持 Wi-Fi 点对点,您可以获取 WifiP2pManager 的实例、创建并注册广播接收器,然后开始使用 Wi-Fi 点对点 API。

  1. 请求使用设备上的 Wi-Fi 硬件的权限,并在 Android 清单中声明您的应用具有正确的最低 SDK 版本:

    <uses-sdk android:minSdkVersion="14" />
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
    <uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
    <uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <!-- If your app targets Android 13 (API level 33)
         or higher, you must declare the NEARBY_WIFI_DEVICES permission. -->
    <uses-permission android:name="android.permission.NEARBY_WIFI_DEVICES"
                     <!-- If your app derives location information from
                          Wi-Fi APIs, don't include the "usesPermissionFlags"
                          attribute. -->
                     android:usesPermissionFlags="neverForLocation" />
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"
                     <!-- If any feature in your app relies on precise location
                          information, don't include the "maxSdkVersion"
                          attribute. -->
                     android:maxSdkVersion="32" />
    

    除了上面的权限外,以下 API 还需要启用位置信息模式:

  2. 检查 Wi-Fi P2P 是否处于开启状态且受支持。在广播接收器收到 WIFI_P2P_STATE_CHANGED_ACTION intent 时检查此情况是一个不错的选择。通知 activity Wi-Fi P2P 状态,并做出相应响应:

    Kotlin

    override fun onReceive(context: Context, intent: Intent) {
    ...
    val action: String = intent.action
    when (action) {
       WifiP2pManager.WIFI_P2P_STATE_CHANGED_ACTION -> {
           val state = intent.getIntExtra(WifiP2pManager.EXTRA_WIFI_STATE, -1)
           when (state) {
               WifiP2pManager.WIFI_P2P_STATE_ENABLED -> {
                   // Wifi P2P is enabled
               }
               else -> {
                   // Wi-Fi P2P is not enabled
               }
           }
       }
    }
    ...
    }

    Java

    @Override
    public void onReceive(Context context, Intent intent) {
    ...
    String action = intent.getAction();
    if (WifiP2pManager.WIFI_P2P_STATE_CHANGED_ACTION.equals(action)) {
       int state = intent.getIntExtra(WifiP2pManager.EXTRA_WIFI_STATE, -1);
       if (state == WifiP2pManager.WIFI_P2P_STATE_ENABLED) {
           // Wifi P2P is enabled
       } else {
           // Wi-Fi P2P is not enabled
       }
    }
    ...
    }
  3. 在 activity 的 onCreate() 方法中,获取 WifiP2pManager 的实例,并通过调用 initialize() 将您的应用注册到 Wi-Fi P2P 框架。此方法会返回 WifiP2pManager.Channel,用于将您的应用连接到 Wi-Fi 点对点连接框架。您还应使用 WifiP2pManagerWifiP2pManager.Channel 对象以及对 activity 的引用创建广播接收器的实例。这样,广播接收器便可以通知 activity 感兴趣的事件并相应地更新它。此外,您还可以根据需要操控设备的 Wi-Fi 状态:

    Kotlin

    val manager: WifiP2pManager? by lazy(LazyThreadSafetyMode.NONE) {
       getSystemService(Context.WIFI_P2P_SERVICE) as WifiP2pManager?
    }
    
    var channel: WifiP2pManager.Channel? = null
    var receiver: BroadcastReceiver? = null
    
    override fun onCreate(savedInstanceState: Bundle?) {
       ...
    
       channel = manager?.initialize(this, mainLooper, null)
       channel?.also { channel ->
           receiver = WiFiDirectBroadcastReceiver(manager, channel, this)
       }
    }

    Java

    WifiP2pManager manager;
    Channel channel;
    BroadcastReceiver receiver;
    ...
    @Override
    protected void onCreate(Bundle savedInstanceState){
       ...
       manager = (WifiP2pManager) getSystemService(Context.WIFI_P2P_SERVICE);
       channel = manager.initialize(this, getMainLooper(), null);
       receiver = new WiFiDirectBroadcastReceiver(manager, channel, this);
       ...
    }
  4. 创建 intent 过滤器,并添加与广播接收器检查的 intent 相同的 intent:

    Kotlin

    val intentFilter = IntentFilter().apply {
       addAction(WifiP2pManager.WIFI_P2P_STATE_CHANGED_ACTION)
       addAction(WifiP2pManager.WIFI_P2P_PEERS_CHANGED_ACTION)
       addAction(WifiP2pManager.WIFI_P2P_CONNECTION_CHANGED_ACTION)
       addAction(WifiP2pManager.WIFI_P2P_THIS_DEVICE_CHANGED_ACTION)
    }

    Java

    IntentFilter intentFilter;
    ...
    @Override
    protected void onCreate(Bundle savedInstanceState){
       ...
       intentFilter = new IntentFilter();
       intentFilter.addAction(WifiP2pManager.WIFI_P2P_STATE_CHANGED_ACTION);
       intentFilter.addAction(WifiP2pManager.WIFI_P2P_PEERS_CHANGED_ACTION);
       intentFilter.addAction(WifiP2pManager.WIFI_P2P_CONNECTION_CHANGED_ACTION);
       intentFilter.addAction(WifiP2pManager.WIFI_P2P_THIS_DEVICE_CHANGED_ACTION);
       ...
    }
  5. 在 activity 的 onResume() 方法中注册广播接收器,并在 activity 的 onPause() 方法中取消注册广播接收器:

    Kotlin

    /* register the broadcast receiver with the intent values to be matched */
    override fun onResume() {
       super.onResume()
       receiver?.also { receiver ->
           registerReceiver(receiver, intentFilter)
       }
    }
    
    /* unregister the broadcast receiver */
    override fun onPause() {
       super.onPause()
       receiver?.also { receiver ->
           unregisterReceiver(receiver)
       }
    }

    Java

    /* register the broadcast receiver with the intent values to be matched */
    @Override
    protected void onResume() {
       super.onResume();
       registerReceiver(receiver, intentFilter);
    }
    /* unregister the broadcast receiver */
    @Override
    protected void onPause() {
       super.onPause();
       unregisterReceiver(receiver);
    }
  6. 获取 WifiP2pManager.Channel 并设置广播接收器后,您的应用便可以发出 Wi-Fi 点对点方法调用并接收 Wi-Fi 点对点 intent。

  7. 通过调用 WifiP2pManager 中的方法,使用 Wi-Fi 点对点功能实现您的应用。

以下部分介绍了如何执行常见操作,例如发现和连接到对等方。

发现对等设备

调用 discoverPeers() 以检测范围内且可供连接的可用对等方。对此函数的调用是异步的,如果您创建了 WifiP2pManager.ActionListener,系统会使用 onSuccess()onFailure() 将成功或失败结果传达给您的应用。onSuccess() 方法只会通知您发现过程是否成功,而不会提供有关其发现的实际对等设备(如果有)的任何信息。以下代码示例展示了如何进行此设置。

Kotlin

manager?.discoverPeers(channel, object : WifiP2pManager.ActionListener {

   override fun onSuccess() {
       ...
   }

   override fun onFailure(reasonCode: Int) {
       ...
   }
})

Java

manager.discoverPeers(channel, new WifiP2pManager.ActionListener() {
   @Override
   public void onSuccess() {
       ...
   }

   @Override
   public void onFailure(int reasonCode) {
       ...
   }
});

如果发现过程成功并检测到对等设备,系统会广播 WIFI_P2P_PEERS_CHANGED_ACTION intent,您可以在广播接收器中监听该 intent 以获取对等设备列表。当您的应用收到 WIFI_P2P_PEERS_CHANGED_ACTION intent 时,您可以使用 requestPeers() 请求发现的对等方的列表。以下代码展示了如何进行此设置。

Kotlin

override fun onReceive(context: Context, intent: Intent) {
   val action: String = intent.action
   when (action) {
       ...
       WifiP2pManager.WIFI_P2P_PEERS_CHANGED_ACTION -> {
           manager?.requestPeers(channel) { peers: WifiP2pDeviceList? ->
               // Handle peers list
           }
       }
       ...
   }
}

Java

PeerListListener myPeerListListener;
...
if (WifiP2pManager.WIFI_P2P_PEERS_CHANGED_ACTION.equals(action)) {

   // request available peers from the wifi p2p manager. This is an
   // asynchronous call and the calling activity is notified with a
   // callback on PeerListListener.onPeersAvailable()
   if (manager != null) {
       manager.requestPeers(channel, myPeerListListener);
   }
}

requestPeers() 方法也是异步的,可在有对等方列表可用时使用 onPeersAvailable()(在 WifiP2pManager.PeerListListener 接口中定义)通知您的 activity。onPeersAvailable() 方法会为您提供 WifiP2pDeviceList,您可以迭代该对象以查找要连接的对等方。

连接到对等设备

获取可能的对等方列表并选择要连接的设备后,调用 connect() 方法即可连接到该设备。此方法调用需要一个 WifiP2pConfig 对象,该对象包含要连接到的设备的相关信息。WifiP2pManager.ActionListener 可以通知您连接成功或失败。以下代码展示了如何创建与设备的连接。

Kotlin

val device: WifiP2pDevice = ...
val config = WifiP2pConfig()
config.deviceAddress = device.deviceAddress
channel?.also { channel ->
   manager?.connect(channel, config, object : WifiP2pManager.ActionListener {

       override fun onSuccess() {
           //success logic
       }

       override fun onFailure(reason: Int) {
           //failure logic
       }
   }
)}

Java

//obtain a peer from the WifiP2pDeviceList
WifiP2pDevice device;
WifiP2pConfig config = new WifiP2pConfig();
config.deviceAddress = device.deviceAddress;
manager.connect(channel, config, new ActionListener() {

   @Override
   public void onSuccess() {
       //success logic
   }

   @Override
   public void onFailure(int reason) {
       //failure logic
   }
});

转移数据

建立连接后,您就可以使用套接字在设备之间传输数据。数据传输的基本步骤如下:

  1. 创建 ServerSocket。此套接字会等待来自指定端口的客户端的连接,并会一直阻塞到连接建立为止,因此请在后台线程中执行此操作。
  2. 创建客户端 Socket。客户端使用服务器套接字的 IP 地址和端口连接到服务器设备。
  3. 将数据从客户端发送到服务器。当客户端套接字成功连接到服务器套接字后,您可以使用字节流将数据从客户端发送到服务器。
  4. 服务器套接字会等待客户端连接(使用 accept() 方法)。此调用会一直阻塞,直到客户端连接,因此请在其他线程中调用此方法。建立连接后,服务器设备可以接收来自客户端的数据。

以下示例(修改自 Wi-Fi 点对点演示)展示了如何创建此客户端-服务器套接字通信,以及如何将 JPEG 图片从客户端传输到具有服务的服务器。如需查看完整的有效示例,请编译并运行演示。

Kotlin

class FileServerAsyncTask(
       private val context: Context,
       private var statusText: TextView
) : AsyncTask<Void, Void, String?>() {

   override fun doInBackground(vararg params: Void): String? {
       /**
        * Create a server socket.
        */
       val serverSocket = ServerSocket(8888)
       return serverSocket.use {
           /**
            * Wait for client connections. This call blocks until a
            * connection is accepted from a client.
            */
           val client = serverSocket.accept()
           /**
            * If this code is reached, a client has connected and transferred data
            * Save the input stream from the client as a JPEG file
            */
           val f = File(Environment.getExternalStorageDirectory().absolutePath +
                   "/${context.packageName}/wifip2pshared-${System.currentTimeMillis()}.jpg")
           val dirs = File(f.parent)

           dirs.takeIf { it.doesNotExist() }?.apply {
               mkdirs()
           }
           f.createNewFile()
           val inputstream = client.getInputStream()
           copyFile(inputstream, FileOutputStream(f))
           serverSocket.close()
           f.absolutePath
       }
   }

   private fun File.doesNotExist(): Boolean = !exists()

   /**
    * Start activity that can handle the JPEG image
    */
   override fun onPostExecute(result: String?) {
       result?.run {
           statusText.text = "File copied - $result"
           val intent = Intent(android.content.Intent.ACTION_VIEW).apply {
               setDataAndType(Uri.parse("file://$result"), "image/*")
           }
           context.startActivity(intent)
       }
   }
}

Java

public static class FileServerAsyncTask extends AsyncTask {

   private Context context;
   private TextView statusText;

   public FileServerAsyncTask(Context context, View statusText) {
       this.context = context;
       this.statusText = (TextView) statusText;
   }

   @Override
   protected String doInBackground(Void... params) {
       try {

           /**
            * Create a server socket and wait for client connections. This
            * call blocks until a connection is accepted from a client
            */
           ServerSocket serverSocket = new ServerSocket(8888);
           Socket client = serverSocket.accept();

           /**
            * If this code is reached, a client has connected and transferred data
            * Save the input stream from the client as a JPEG file
            */
           final File f = new File(Environment.getExternalStorageDirectory() + "/"
                   + context.getPackageName() + "/wifip2pshared-" + System.currentTimeMillis()
                   + ".jpg");

           File dirs = new File(f.getParent());
           if (!dirs.exists())
               dirs.mkdirs();
           f.createNewFile();
           InputStream inputstream = client.getInputStream();
           copyFile(inputstream, new FileOutputStream(f));
           serverSocket.close();
           return f.getAbsolutePath();
       } catch (IOException e) {
           Log.e(WiFiDirectActivity.TAG, e.getMessage());
           return null;
       }
   }

   /**
    * Start activity that can handle the JPEG image
    */
   @Override
   protected void onPostExecute(String result) {
       if (result != null) {
           statusText.setText("File copied - " + result);
           Intent intent = new Intent();
           intent.setAction(android.content.Intent.ACTION_VIEW);
           intent.setDataAndType(Uri.parse("file://" + result), "image/*");
           context.startActivity(intent);
       }
   }
}

在客户端上,使用客户端套接字连接到服务器套接字并传输数据。此示例会在客户端设备的文件系统中传输 JPEG 文件。

Kotlin

val context = applicationContext
val host: String
val port: Int
val len: Int
val socket = Socket()
val buf = ByteArray(1024)
...
try {
   /**
    * Create a client socket with the host,
    * port, and timeout information.
    */
   socket.bind(null)
   socket.connect((InetSocketAddress(host, port)), 500)

   /**
    * Create a byte stream from a JPEG file and pipe it to the output stream
    * of the socket. This data is retrieved by the server device.
    */
   val outputStream = socket.getOutputStream()
   val cr = context.contentResolver
   val inputStream: InputStream = cr.openInputStream(Uri.parse("path/to/picture.jpg"))
   while (inputStream.read(buf).also { len = it } != -1) {
       outputStream.write(buf, 0, len)
   }
   outputStream.close()
   inputStream.close()
} catch (e: FileNotFoundException) {
   //catch logic
} catch (e: IOException) {
   //catch logic
} finally {
   /**
    * Clean up any open sockets when done
    * transferring or if an exception occurred.
    */
   socket.takeIf { it.isConnected }?.apply {
       close()
   }
}

Java

Context context = this.getApplicationContext();
String host;
int port;
int len;
Socket socket = new Socket();
byte buf[]  = new byte[1024];
...
try {
   /**
    * Create a client socket with the host,
    * port, and timeout information.
    */
   socket.bind(null);
   socket.connect((new InetSocketAddress(host, port)), 500);

   /**
    * Create a byte stream from a JPEG file and pipe it to the output stream
    * of the socket. This data is retrieved by the server device.
    */
   OutputStream outputStream = socket.getOutputStream();
   ContentResolver cr = context.getContentResolver();
   InputStream inputStream = null;
   inputStream = cr.openInputStream(Uri.parse("path/to/picture.jpg"));
   while ((len = inputStream.read(buf)) != -1) {
       outputStream.write(buf, 0, len);
   }
   outputStream.close();
   inputStream.close();
} catch (FileNotFoundException e) {
   //catch logic
} catch (IOException e) {
   //catch logic
}

/**
* Clean up any open sockets when done
* transferring or if an exception occurred.
*/
finally {
   if (socket != null) {
       if (socket.isConnected()) {
           try {
               socket.close();
           } catch (IOException e) {
               //catch logic
           }
       }
   }
}