要在应用中执行网络操作,您的 manifest 必须包含以下权限
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
安全网络通信的最佳实践
在向应用添加网络功能之前,您需要确保应用中的数据和信息在通过网络传输时保持安全。为此,请遵循以下网络安全最佳实践
- 最大限度地减少通过网络传输的敏感或个人用户数据量。
- 通过 SSL 发送应用的所有网络流量。
- 考虑创建网络安全配置,这允许您的应用信任自定义证书颁发机构 (CA) 或限制其信任的系统 CA 集合以实现安全通信。
有关如何应用安全网络原则的更多信息,请参阅网络安全提示。
选择 HTTP 客户端
大多数连接网络的应用使用 HTTP 发送和接收数据。Android 平台包含 HttpsURLConnection
客户端,它支持 TLS、流式上传和下载、可配置的超时、IPv6 和连接池。
还有提供用于网络操作的高级 API 的第三方库。它们支持各种便捷功能,例如请求主体的序列化和响应主体的反序列化。
- Retrofit:Square 出品的适用于 JVM 的类型安全 HTTP 客户端,构建在 OkHttp 之上。Retrofit 允许您以声明方式创建客户端接口,并支持多个序列化库。
- Ktor:JetBrains 出品的 HTTP 客户端,完全为 Kotlin 构建,并由协程驱动。Ktor 支持各种引擎、序列化器和平台。
解析 DNS 查询
运行 Android 10(API 级别 29)及更高版本的设备内置支持通过明文查找和 DNS-over-TLS 模式进行专门的 DNS 查找。DnsResolver
API 提供通用的异步解析,允许您查找 SRV
、NAPTR
和其他记录类型。响应解析由应用自行完成。
在运行 Android 9(API 级别 28)及更低版本的设备上,平台 DNS 解析器仅支持 A
和 AAAA
记录。这允许您查找与名称关联的 IP 地址,但不支持任何其他记录类型。
对于基于 NDK 的应用,请参阅 android_res_nsend
。
使用仓库封装网络操作
为了简化执行网络操作的过程并减少应用各个部分的重复代码,您可以使用仓库设计模式。仓库是一个处理数据操作并在某些特定数据或资源上提供清晰 API 抽象的类。
您可以使用 Retrofit 声明一个接口,该接口指定网络操作的 HTTP 方法、URL、参数和响应类型,如下例所示
Kotlin
interface UserService { @GET("/users/{id}") suspend fun getUser(@Path("id") id: String): User }
Java
public interface UserService { @GET("/user/{id}") Call<User> getUserById(@Path("id") String id); }
在仓库类中,函数可以封装网络操作并公开其结果。这种封装确保调用仓库的组件无需知道数据的存储方式。未来对数据存储方式的任何更改也仅限于仓库类。例如,您可能有一个远程更改,例如 API 端点的更新,或者您可能希望实现本地缓存。
Kotlin
class UserRepository constructor( private val userService: UserService ) { suspend fun getUserById(id: String): User { return userService.getUser(id) } }
Java
class UserRepository { private UserService userService; public UserRepository( UserService userService ) { this.userService = userService; } public Call<User> getUserById(String id) { return userService.getUser(id); } }
为避免创建无响应的 UI,请勿在主线程上执行网络操作。默认情况下,Android 要求您在主 UI 线程以外的其他线程上执行网络操作。如果您尝试在主线程上执行网络操作,则会抛出 NetworkOnMainThreadException
。
在前面的代码示例中,网络操作并未实际触发。UserRepository
的调用方必须使用协程或 enqueue()
函数来实现线程化。有关详细信息,请参阅 codelab 从互联网获取数据,其中演示了如何使用 Kotlin 协程实现线程化。
应对配置更改
当发生配置更改时(例如屏幕旋转),您的 fragment 或 activity 会被销毁并重新创建。未保存在 fragment activity 实例状态中的任何数据(只能容纳少量数据)都会丢失。如果发生这种情况,您可能需要再次发起网络请求。
您可以使用 ViewModel
来使您的数据在配置更改后仍保留。ViewModel
组件旨在以生命周期感知的方式存储和管理 UI 相关数据。使用上述的 UserRepository
,ViewModel
可以发起必要的网络请求,并使用 LiveData
将结果提供给您的 fragment 或 activity。
Kotlin
class MainViewModel constructor( savedStateHandle: SavedStateHandle, userRepository: UserRepository ) : ViewModel() { private val userId: String = savedStateHandle["uid"] ?: throw IllegalArgumentException("Missing user ID") private val _user = MutableLiveData<User>() val user = _user as LiveData<User> init { viewModelScope.launch { try { // Calling the repository is safe as it moves execution off // the main thread val user = userRepository.getUserById(userId) _user.value = user } catch (error: Exception) { // Show error message to user } } } }
Java
class MainViewModel extends ViewModel { private final MutableLiveData<User> _user = new MutableLiveData<>(); LiveData<User> user = (LiveData<User>) _user; public MainViewModel( SavedStateHandle savedStateHandle, UserRepository userRepository ) { String userId = savedStateHandle.get("uid"); Call<User> userCall = userRepository.getUserById(userId); userCall.enqueue(new Callback<User>() { @Override public void onResponse(Call<User> call, Response<User> response) { if (response.isSuccessful()) { _user.setValue(response.body()); } } @Override public void onFailure(Call<User> call, Throwable t) { // Show error message to user } }); } }
阅读相关指南
要了解有关此主题的更多信息,请参阅以下相关指南