使得网络服务可发现 · Android Training官方培训课程中文版

> 编写:[naizhengtan](https://github.com/naizhengtan) - 原文:[http://developer.android.com/training/connect-devices-wirelessly/nsd.html](http://developer.android.com/training/connect-devices-wirelessly/nsd.html) 添加网络服务发现（Network Service Discovery）到你的app中可以使你的用户辨识在局域网且支持你的app所请求的服务的设备。这种技术在端对端应用中能够提供大量帮助，例如文件共享、联机游戏等。Android提供了网络服务发现（NSD）相应的API，大大降低了其实现难度。本讲将简要介绍如何创建NSD应用，使其能够在本地网络内广播自己的名称和链接信息，并且扫描网络发现其他NSD设备。最后，将介绍如何连接到运行着同样应用的另一台设备上。 ### 注册NSD服务 > **Note：** 这一步骤是选做的。如果你并不关心自己的服务是否被广播，你可以跳过这一步，直接尝试[发现网络中的服务](#)。在局域网内注册自己服务的第一步是创建[NsdServiceInfo](http://developer.android.com/reference/android/net/nsd/NsdServiceInfo.html)对象。此对象包含的信息能够帮助其他设备决定是否要连接到你所提供的服务。 ~~~ public void registerService(int port) { // Create the NsdServiceInfo object, and populate it. NsdServiceInfo serviceInfo = new NsdServiceInfo(); // The name is subject to change based on conflicts // with other services advertised on the same network. serviceInfo.setServiceName("NsdChat"); serviceInfo.setServiceType("_http._tcp."); serviceInfo.setPort(port); .... } ~~~ 这段代码将所提供的服务命名为“NsdChat”。该名称将对所有局域网络中的设备可见。需要注意的是，在网络内该名称必须是独一无二的。Android系统会自动处理冲突的服务名称。如果同时有两个名为“NsdChat”的应用，其中一个会被自动转换为“NsdChat(1)”。第二个参数设置了服务类型，即，使用的通信协议和传输层协议，语法是“_< protocol >._< transportlayer >”。在上面的代码中，服务使用了TCP协议上的HTTP协议。如果应用想要提供打印服务（例如，一台网络打印机）应该将服务的类型设置为“_ipp._tcp”。 > **Note:** 互联网编号分配机构（International Assigned Numbers Authority，简称IANA）提供用于服务发现协议（例如NSD和Bonjour）的官方服务种类列表。你可以下载该列表了解相应的服务名称和端口号码。如果你想起用新的服务种类，应该向IANA官方提交申请。当为你的服务设置端口号时，应该尽量避免将其硬编码在代码中，防止与其他应用产生冲突。例如，如果你的应用仅仅使用端口1337，就可能与其他使用1337端口的应用发生冲突。解决方法是，不要硬编码，使用下一个可用的端口。不必担心其他应用无法知晓服务的端口号，因为该信息将包含在服务的广播包中。接收到广播后，其他应用将从广播包中得知服务端口号，并通过端口连接到你的服务上。如果你使用的是socket，你可以将端口号初始值设置为0来使用下一个可用端口。 ~~~ public void initializeServerSocket() { // Initialize a server socket on the next available port. mServerSocket = new ServerSocket(0); // Store the chosen port. mLocalPort = mServerSocket.getLocalPort(); ... } ~~~ 现在，你已经成功的创建了[NsdServiceInfo](http://developer.android.com/reference/android/net/nsd/NsdServiceInfo.html)对象，接下来要做的是实现[RegistrationListener](http://developer.android.com/reference/android/net/nsd/NsdManager.RegistrationListener.html)接口。该接口包含了注册在Android系统中的一系列回调函数，作用是通知应用程序服务注册/注销的成功和失败。 ~~~ public void initializeRegistrationListener() { mRegistrationListener = new NsdManager.RegistrationListener() { @Override public void onServiceRegistered(NsdServiceInfo NsdServiceInfo) { // Save the service name. Android may have changed it in order to // resolve a conflict, so update the name you initially requested // with the name Android actually used. mServiceName = NsdServiceInfo.getServiceName(); } @Override public void onRegistrationFailed(NsdServiceInfo serviceInfo, int errorCode) { // Registration failed! Put debugging code here to determine why. } @Override public void onServiceUnregistered(NsdServiceInfo arg0) { // Service has been unregistered. This only happens when you call // NsdManager.unregisterService() and pass in this listener. } @Override public void onUnregistrationFailed(NsdServiceInfo serviceInfo, int errorCode) { // Unregistration failed. Put debugging code here to determine why. } }; } ~~~ 万事俱备只欠东风，调用[registerService()](http://developer.android.com/reference/android/net/nsd/NsdManager.html#registerService(android.net.nsd.NsdServiceInfo, int, android.net.nsd.NsdManager.RegistrationListener)方法，真正注册服务。因为该方法是异步的，所以在服务注册之后的操作都需要在[onServiceRegistered()](http://developer.android.com/reference/android/net/nsd/NsdManager.RegistrationListener.html#onServiceRegistered(android.net.nsd.NsdServiceInfo))方法中进行。 ~~~ public void registerService(int port) { NsdServiceInfo serviceInfo = new NsdServiceInfo(); serviceInfo.setServiceName("NsdChat"); serviceInfo.setServiceType("_http._tcp."); serviceInfo.setPort(port); mNsdManager = Context.getSystemService(Context.NSD_SERVICE); mNsdManager.registerService( serviceInfo, NsdManager.PROTOCOL_DNS_SD, mRegistrationListener); } ~~~ ### 发现网络中的服务网络充斥着我们的生活，从网络打印机到网络摄像头，再到联网井字棋。网络服务发现是能让你的应用融入这一切功能的关键。你的应用需要侦听网络内服务的广播，发现可用的服务，过滤无效的信息。与注册网络服务类似，服务发现需要两步骤：正确配置发现监听者(Discover Listener)，以及调用[discoverServices()](http://developer.android.com/reference/android/net/nsd/NsdManager.html#discoverServices(java.lang.String, int, android.net.nsd.NsdManager.DiscoveryListener))这个异步API。首先，实例化一个实现[NsdManager.DiscoveryListener](http://developer.android.com/reference/android/net/nsd/NsdManager.DiscoveryListener.html)接口的匿名类。下列代码是一个简单的范例： ~~~ public void initializeDiscoveryListener() { // Instantiate a new DiscoveryListener mDiscoveryListener = new NsdManager.DiscoveryListener() { // Called as soon as service discovery begins. @Override public void onDiscoveryStarted(String regType) { Log.d(TAG, "Service discovery started"); } @Override public void onServiceFound(NsdServiceInfo service) { // A service was found! Do something with it. Log.d(TAG, "Service discovery success" + service); if (!service.getServiceType().equals(SERVICE_TYPE)) { // Service type is the string containing the protocol and // transport layer for this service. Log.d(TAG, "Unknown Service Type: " + service.getServiceType()); } else if (service.getServiceName().equals(mServiceName)) { // The name of the service tells the user what they'd be // connecting to. It could be "Bob's Chat App". Log.d(TAG, "Same machine: " + mServiceName); } else if (service.getServiceName().contains("NsdChat")){ mNsdManager.resolveService(service, mResolveListener); } } @Override public void onServiceLost(NsdServiceInfo service) { // When the network service is no longer available. // Internal bookkeeping code goes here. Log.e(TAG, "service lost" + service); } @Override public void onDiscoveryStopped(String serviceType) { Log.i(TAG, "Discovery stopped: " + serviceType); } @Override public void onStartDiscoveryFailed(String serviceType, int errorCode) { Log.e(TAG, "Discovery failed: Error code:" + errorCode); mNsdManager.stopServiceDiscovery(this); } @Override public void onStopDiscoveryFailed(String serviceType, int errorCode) { Log.e(TAG, "Discovery failed: Error code:" + errorCode); mNsdManager.stopServiceDiscovery(this); } }; } ~~~ NSD API通过使用该接口中的方法通知用户程序何时发现开始、何时发现失败、何时找到可用服务、何时服务丢失（丢失意味着“不再可用”）。在上述代码中，当发现了可用的服务时，程序做了几次检查。 1. 比较发现的服务名称与本地的服务，判断是否发现的是本机的服务（这是合法的）。 1. 检查服务的类型，确认是否可以接入。 1. 检查服务的名称，确认接入了正确的应用。我们并不需要每次都检查服务名称，仅当你想要接入特定的应用时，再去判断。例如，应用只想与运行在其他设备上的相同应用通信。然而，如果应用仅仅想接入到一台网络打印机，那么看到服务类型是“_ipp._tcp”的服务就足够了。当配置好发现回调函数后，调用[discoverService()](http://developer.android.com/reference/android/net/nsd/NsdManager.html#discoverServices(java.lang.String, int, android.net.nsd.NsdManager.DiscoveryListener))函数，其参数包括试图发现的服务种类、发现使用的协议、以及上一步创建的监听者。 ~~~ mNsdManager.discoverServices( SERVICE_TYPE, NsdManager.PROTOCOL_DNS_SD, mDiscoveryListener); ~~~ ### 连接到网络上的服务当你的代码发现了网上可接入的服务，第一件必须做的事情是确认服务的连接信息。调用[resolveService()](http://developer.android.com/reference/android/net/nsd/NsdManager.html#resolveService(android.net.nsd.NsdServiceInfo, android.net.nsd.NsdManager.ResolveListener))方法，并将实现了[NsdManager.ResolveListener](http://developer.android.com/reference/android/net/nsd/NsdManager.ResolveListener.html)的对象和在[服务发现](#)过程中得到的[NsdSerServiceInfo](http://developer.android.com/reference/android/net/nsd/NsdServiceInfo.html)对象传入。通过该方法，可以将连接信息从[NsdSerServiceInfo](http://developer.android.com/reference/android/net/nsd/NsdServiceInfo.html)对象中解析出来。 ~~~ public void initializeResolveListener() { mResolveListener = new NsdManager.ResolveListener() { @Override public void onResolveFailed(NsdServiceInfo serviceInfo, int errorCode) { // Called when the resolve fails. Use the error code to debug. Log.e(TAG, "Resolve failed" + errorCode); } @Override public void onServiceResolved(NsdServiceInfo serviceInfo) { Log.e(TAG, "Resolve Succeeded. " + serviceInfo); if (serviceInfo.getServiceName().equals(mServiceName)) { Log.d(TAG, "Same IP."); return; } mService = serviceInfo; int port = mService.getPort(); InetAddress host = mService.getHost(); } }; } ~~~ 当服务解析完成后，你将获得服务的详细资料，包括其IP地址和端口号。此时，你有了服务的地址和端口，可以通过创建自己网络连接与服务进行通讯。 ### 当程序退出时注销服务在应用的生命周期中正确的开启和关闭NSD服务是十分关键的。在程序退出时注销服务可以防止其他程序因为不知道服务退出而反复尝试连接的行为。另外，服务发现是一种开销很大的操作，应该随着父[Activity](# "An activity represents a single screen with a user interface.")的暂停而停止，当用户返回该界面是再开启。因此，开发者应该重载[Activity](# "An activity represents a single screen with a user interface.")的生命周期函数，并正确操作服务的广播和发现。 ~~~ //In your application's Activity @Override protected void onPause() { if (mNsdHelper != null) { mNsdHelper.tearDown(); } super.onPause(); } @Override protected void onResume() { super.onResume(); if (mNsdHelper != null) { mNsdHelper.registerService(mConnection.getLocalPort()); mNsdHelper.discoverServices(); } } @Override protected void onDestroy() { mNsdHelper.tearDown(); mConnection.tearDown(); super.onDestroy(); } // NsdHelper's tearDown method public void tearDown() { mNsdManager.unregisterService(mRegistrationListener); mNsdManager.stopServiceDiscovery(mDiscoveryListener); } ~~~